# API

Use the API reference to check function signatures, tensor layouts, parameters,
and working-memory requirements. The reference is generated from the heliaCORE
headers and includes public kernels, wrappers, buffer-size queries, and support
helpers. For a direct integration, start with a public kernel or wrapper and
follow its documented constraints.

- [Kernel index](https://ambiqai.github.io/ns-cmsis-nn/reference/kernel-index/): Search functions by name and filter by operator group or data type.
- [Calling kernels](https://ambiqai.github.io/ns-cmsis-nn/guide/using-kernels/calling-kernels/): Prepare tensors and parameters, choose a wrapper, and check the result.
- [API compatibility](https://ambiqai.github.io/ns-cmsis-nn/guide/coverage/compared-with-cmsis-nn/): Understand the relationship to Arm CMSIS-NN and the additional heliaCORE APIs.

## Browse by kernel family

- [Convolution](https://ambiqai.github.io/ns-cmsis-nn/reference/api/#convolution-functions): Conv2D, depthwise, transpose convolution, wrappers, and buffer helpers.
- [Fully connected](https://ambiqai.github.io/ns-cmsis-nn/reference/api/#fully-connected-layer-functions): Dense layers, batch matmul paths, and scratch sizing helpers.
- [Elementwise](https://ambiqai.github.io/ns-cmsis-nn/reference/api/#elementwise-functions): Add, sub, mul, square difference, min/max, batch norm, select, and arithmetic glue.
- [Reduction and comparison](https://ambiqai.github.io/ns-cmsis-nn/reference/api/#basic-math-and-reduction): Argmin/argmax, min/max reductions, comparisons, means, vector sums, and where.
- [Activation](https://ambiqai.github.io/ns-cmsis-nn/reference/api/#activation-functions): ReLU, LeakyReLU, PReLU, Hard-Swish, Logistic, Tanh, and clamp.
- [Data movement](https://ambiqai.github.io/ns-cmsis-nn/reference/api/#data-movement): Pad, reshape, transpose, concatenate, gather, resize, strided slice, tile, broadcast, scatter, mirror pad, and sequence/slice-update utilities.
- [Pooling, softmax, quantization](https://ambiqai.github.io/ns-cmsis-nn/reference/api/#classifier-tail): Classifier tail APIs plus dtype conversion and requantization utilities.
- [Sequence](https://ambiqai.github.io/ns-cmsis-nn/reference/api/#sequence-functions): LSTM, GRU, and SVDF functions for temporal workloads.
- [Types and support](https://ambiqai.github.io/ns-cmsis-nn/reference/api/): Structs, enums, files, and low-level support helpers in the full generated index.

For file-by-file browsing, structs, enums, and the complete generated tree, open
the [generated C API reference](https://ambiqai.github.io/ns-cmsis-nn/reference/api/).

## Types and Support

Structs, enums, files, and lower-level support helpers are intentionally kept in
the [full generated C API index](https://ambiqai.github.io/ns-cmsis-nn/reference/api/) to avoid
duplicating declarations across the grouped operator view and the complete
generated reference.