# Model

```cpp
#include <qbruntime/model.h>

class mobilint::Model
```

Represents an AI model loaded from an MXQ file.

This class loads an AI model from an MXQ file and provides functions to launch it on the NPU and perform inference.

## NHWC float-to-float inference

Performs inference with input and output elements of type float in NHWC (batch N, height H, width W, channels C) or HWC format.

Two input-output type pairs are supported:

1. [`std::vector<NDArray<float>>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) for both input and output

   - Recommended approach, as [`NDArray`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) allows the qbruntime to avoid unnecessary data copies internally.
2. `std::vector<float*>` for input and `std::vector<std::vector<float>>` for output

   - Provided for user convenience, but results in unavoidable extra copies within the qbruntime.

| Member | Description |
| --- | --- |
| [`infer`](<#infer>) ×10 | Performs inference. |

### infer

```cpp
StatusCode infer(const std::vector<NDArray<float>> &input, std::vector<NDArray<float>> &output)
```

Performs inference.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NHWC or HWC format.
- `output` *\[out\]* — A reference to a vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) that will store the inference results.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<NDArray<float>> infer(const std::vector<NDArray<float>> &input, StatusCode &sc)
```

This overload differs from the above function in that it directly returns the inference results instead of modifying an output parameter.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NHWC or HWC format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) containing the inference results.

```cpp
StatusCode infer(const std::vector<float *> &input, std::vector<std::vector<float>> &output)
```

This overload is provided for convenience but may result in additional data copies within the qbruntime.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in HWC format.
- `output` *\[out\]* — A reference to a vector of float vectors that will store the inference results.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<std::vector<float>> infer(const std::vector<float *> &input, StatusCode &sc)
```

This overload is provided for convenience but may result in additional data copies within the qbruntime.

Unlike the above overload, this function returns the inference results directly instead of modifying an output parameter.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in HWC format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of float vectors containing the inference results.

```cpp
StatusCode infer(const std::vector<float *> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape)
```

This overload is provided for convenience but may result in additional data copies within the qbruntime.

Unlike other overloads, this version allows explicitly specifying the shape of each input data, which can be in NHWC or HWC format.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in NHWC or HWC format.
- `output` *\[out\]* — A reference to a vector of float vectors that will store the inference results.
- `shape` *\[in\]* — A vector of vectors, where each inner vector specifies the shape of the corresponding input data.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<std::vector<float>> infer(const std::vector<float *> &input, const std::vector<std::vector<int64_t>> &shape, StatusCode &sc)
```

This overload is provided for convenience but may result in additional data copies within the qbruntime.

Unlike the above overload, this function returns the inference results directly instead of modifying an output parameter.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in NHWC or HWC format.
- `shape` *\[in\]* — A vector of vectors, where each inner vector specifies the shape of the corresponding input data.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of float vectors containing the inference results.

```cpp
StatusCode infer(const std::vector<NDArray<float>> &input, std::vector<NDArray<float>> &output, uint32_t cache_size)
```

This overload supports inference with KV cache.

> [!NOTE]
>
> This function is relevant for LLM models that use KV cache.

**Parameters**

- `input` *\[in\]* — A vector of NDArrays, where each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) represents input data in NHWC or HWC format.
- `output` *\[out\]* — A reference to a vector of NDArrays that will store the inference results.
- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<NDArray<float>> infer(const std::vector<NDArray<float>> &input, uint32_t cache_size, StatusCode &sc)
```

This overload supports inference with KV cache.

Unlike the above overload, this function returns the inference results directly instead of modifying an output parameter.

> [!NOTE]
>
> This function is relevant for LLM models that use KV cache.

**Parameters**

- `input` *\[in\]* — A vector of NDArrays, where each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) represents input data in NHWC or HWC format.
- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of NDArrays containing the inference results.

```cpp
StatusCode infer(const std::vector<float *> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size)
```

This overload supports inference with KV cache.

> [!NOTE]
>
> This function is relevant for LLM models that use KV cache.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in NHWC or HWC format.
- `output` *\[out\]* — A reference to a vector of float vectors that will store the inference results.
- `shape` *\[in\]* — A vector of vectors, where each inner vector specifies the shape of the corresponding input data.
- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<std::vector<float>> infer(const std::vector<float *> &input, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size, StatusCode &sc)
```

This overload supports inference with KV cache.

Unlike the above overload, this function returns the inference results directly instead of modifying an output parameter.

> [!NOTE]
>
> This function is relevant for LLM models that use KV cache.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in NHWC or HWC format.
- `shape` *\[in\]* — A vector of vectors, where each inner vector specifies the shape of the corresponding input data.
- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of float vectors containing the inference results.

## NCHW float-to-float inference

Performs inference with input and output elements of type float in NCHW (batch N, channels C, height H, width W) or CHW format.

Two input-output type pairs are supported:

1. [`std::vector<NDArray<float>>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) for both input and output

   - Recommended approach, as [`NDArray`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) allows the qbruntime to avoid unnecessary data copies internally.
2. `std::vector<float*>` for input and `std::vector<std::vector<float>>` for output

   - Provided for user convenience, but results in unavoidable extra copies within the qbruntime.

> [!NOTE]
>
> CHW is not the recommended format, as the NPU natively operates on HWC-ordered data. When input is provided in CHW format, it will be transposed internally, introducing additional overhead.

> [!NOTE]
>
> If your data is in HWC format, use [`Model::infer`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/#infer>) instead of [`Model::inferCHW`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/#inferchw>), as it avoids unnecessary format conversion.

| Member | Description |
| --- | --- |
| [`inferCHW`](<#inferchw>) ×10 | Performs inference. |

### inferCHW

```cpp
StatusCode inferCHW(const std::vector<NDArray<float>> &input, std::vector<NDArray<float>> &output)
```

Performs inference.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NCHW or CHW format.
- `output` *\[out\]* — A reference to a vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) that will store the inference results.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<NDArray<float>> inferCHW(const std::vector<NDArray<float>> &input, StatusCode &sc)
```

This overload differs from the above function in that it directly returns the inference results instead of modifying an output parameter.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NCHW or CHW format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) containing the inference results.

```cpp
StatusCode inferCHW(const std::vector<float *> &input, std::vector<std::vector<float>> &output)
```

This overload is provided for convenience but may result in additional data copies within the qbruntime.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in CHW format.
- `output` *\[out\]* — A reference to a vector of float vectors that will store the inference results.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<std::vector<float>> inferCHW(const std::vector<float *> &input, StatusCode &sc)
```

This overload is provided for convenience but may result in additional data copies within the qbruntime.

Unlike the above overload, this function returns the inference results directly instead of modifying an output parameter.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in CHW format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of float vectors containing the inference results.

```cpp
StatusCode inferCHW(const std::vector<float *> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape)
```

This overload is provided for convenience but may result in additional data copies within the qbruntime.

Unlike other overloads, this version allows explicitly specifying the shape of each input data, which can be in NCHW or CHW format.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in NCHW or CHW format.
- `output` *\[out\]* — A reference to a vector of float vectors that will store the inference results.
- `shape` *\[in\]* — A vector of vectors, where each inner vector specifies the shape of the corresponding input data.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<std::vector<float>> inferCHW(const std::vector<float *> &input, const std::vector<std::vector<int64_t>> &shape, StatusCode &sc)
```

This overload is provided for convenience but may result in additional data copies within the qbruntime.

Unlike the above overload, this function returns the inference results directly instead of modifying an output parameter.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in NCHW or CHW format.
- `shape` *\[in\]* — A vector of vectors, where each inner vector specifies the shape of the corresponding input data.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of float vectors containing the inference results.

```cpp
StatusCode inferCHW(const std::vector<NDArray<float>> &input, std::vector<NDArray<float>> &output, uint32_t cache_size)
```

This overload supports inference with KV cache.

> [!NOTE]
>
> This function is relevant for LLM models that use KV cache.

**Parameters**

- `input` *\[in\]* — A vector of NDArrays, where each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) represents input data in NCHW or CHW format.
- `output` *\[out\]* — A reference to a vector of NDArrays that will store the inference results.
- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<NDArray<float>> inferCHW(const std::vector<NDArray<float>> &input, uint32_t cache_size, StatusCode &sc)
```

This overload supports inference with KV cache.

Unlike the above overload, this function returns the inference results directly instead of modifying an output parameter.

> [!NOTE]
>
> This function is relevant for LLM models that use KV cache.

**Parameters**

- `input` *\[in\]* — A vector of NDArrays, where each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) represents input data in NCHW or CHW format.
- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of NDArrays containing the inference results.

```cpp
StatusCode inferCHW(const std::vector<float *> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size)
```

This overload supports inference with KV cache.

> [!NOTE]
>
> This function is relevant for LLM models that use KV cache.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in NCHW or CHW format.
- `output` *\[out\]* — A reference to a vector of float vectors that will store the inference results.
- `shape` *\[in\]* — A vector of vectors, where each inner vector specifies the shape of the corresponding input data.
- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.

**Returns**

A status code indicating whether the inference operation completed successfully or encountered an error.

```cpp
std::vector<std::vector<float>> inferCHW(const std::vector<float *> &input, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size, StatusCode &sc)
```

This overload supports inference with KV cache.

Unlike the above overload, this function returns the inference results directly instead of modifying an output parameter.

> [!NOTE]
>
> This function is relevant for LLM models that use KV cache.

**Parameters**

- `input` *\[in\]* — A vector of float pointers, where each pointer represents input data in NCHW or CHW format.
- `shape` *\[in\]* — A vector of vectors, where each inner vector specifies the shape of the corresponding input data.
- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the inference operation was successful or encountered an error.

**Returns**

A vector of float vectors containing the inference results.

## NHWC uint8\_t-to-float inference

Performs inference with input and output elements of type `uint8_t` in NHWC (batch N, height H, width W, channels C) or HWC format.

| Member | Description |
| --- | --- |
| [`infer`](<#infer-2>) ×10 |  |

### infer

```cpp
StatusCode infer(const std::vector<NDArray<uint8_t>> &input, std::vector<NDArray<float>> &output)
```

```cpp
std::vector<NDArray<float>> infer(const std::vector<NDArray<uint8_t>> &input, StatusCode &sc)
```

```cpp
StatusCode infer(const std::vector<uint8_t *> &input, std::vector<std::vector<float>> &output)
```

```cpp
std::vector<std::vector<float>> infer(const std::vector<uint8_t *> &input, StatusCode &sc)
```

```cpp
StatusCode infer(const std::vector<uint8_t *> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape)
```

```cpp
std::vector<std::vector<float>> infer(const std::vector<uint8_t *> &input, const std::vector<std::vector<int64_t>> &shape, StatusCode &sc)
```

```cpp
StatusCode infer(const std::vector<NDArray<uint8_t>> &input, std::vector<NDArray<float>> &output, uint32_t cache_size)
```

```cpp
std::vector<NDArray<float>> infer(const std::vector<NDArray<uint8_t>> &input, uint32_t cache_size, StatusCode &sc)
```

```cpp
StatusCode infer(const std::vector<uint8_t *> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size)
```

```cpp
std::vector<std::vector<float>> infer(const std::vector<uint8_t *> &input, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size, StatusCode &sc)
```

## NCHW uint8\_t-to-float inference

Performs inference with input and output elements of type `uint8_t` in NCHW (batch N, channels C, height H, width W) or CHW format.

| Member | Description |
| --- | --- |
| [`inferCHW`](<#inferchw-2>) ×10 |  |

### inferCHW

```cpp
StatusCode inferCHW(const std::vector<NDArray<uint8_t>> &input, std::vector<NDArray<float>> &output)
```

```cpp
std::vector<NDArray<float>> inferCHW(const std::vector<NDArray<uint8_t>> &input, StatusCode &sc)
```

```cpp
StatusCode inferCHW(const std::vector<uint8_t *> &input, std::vector<std::vector<float>> &output)
```

```cpp
std::vector<std::vector<float>> inferCHW(const std::vector<uint8_t *> &input, StatusCode &sc)
```

```cpp
StatusCode inferCHW(const std::vector<uint8_t *> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape)
```

```cpp
std::vector<std::vector<float>> inferCHW(const std::vector<uint8_t *> &input, const std::vector<std::vector<int64_t>> &shape, StatusCode &sc)
```

```cpp
StatusCode inferCHW(const std::vector<NDArray<uint8_t>> &input, std::vector<NDArray<float>> &output, uint32_t cache_size)
```

```cpp
std::vector<NDArray<float>> inferCHW(const std::vector<NDArray<uint8_t>> &input, uint32_t cache_size, StatusCode &sc)
```

```cpp
StatusCode inferCHW(const std::vector<uint8_t *> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size)
```

```cpp
std::vector<std::vector<float>> inferCHW(const std::vector<uint8_t *> &input, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size, StatusCode &sc)
```

## NHWC int8\_t-to-int8\_t inference

Performs inference with input and output elements of type `int8_t` in NHWC (batch N, height H, width W, channels C) or HWC format.

Using these inference APIs requires manual scaling (quantization) of float values to `int8_t` for input and `int8_t` to float for output.

> [!NOTE]
>
> These APIs are intended for advanced use rather than typical usage.

| Member | Description |
| --- | --- |
| [`infer`](<#infer-3>) ×10 |  |

### infer

```cpp
StatusCode infer(const std::vector<NDArray<int8_t>> &input, std::vector<NDArray<int8_t>> &output)
```

```cpp
std::vector<NDArray<int8_t>> infer(const std::vector<NDArray<int8_t>> &input, StatusCode &sc)
```

```cpp
StatusCode infer(const std::vector<int8_t *> &input, std::vector<std::vector<int8_t>> &output)
```

```cpp
std::vector<std::vector<int8_t>> infer(const std::vector<int8_t *> &input, StatusCode &sc)
```

```cpp
StatusCode infer(const std::vector<int8_t *> &input, std::vector<std::vector<int8_t>> &output, const std::vector<std::vector<int64_t>> &shape)
```

```cpp
std::vector<std::vector<int8_t>> infer(const std::vector<int8_t *> &input, const std::vector<std::vector<int64_t>> &shape, StatusCode &sc)
```

```cpp
StatusCode infer(const std::vector<NDArray<int8_t>> &input, std::vector<NDArray<int8_t>> &output, uint32_t cache_size)
```

```cpp
std::vector<NDArray<int8_t>> infer(const std::vector<NDArray<int8_t>> &input, uint32_t cache_size, StatusCode &sc)
```

```cpp
StatusCode infer(const std::vector<int8_t *> &input, std::vector<std::vector<int8_t>> &output, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size)
```

```cpp
std::vector<std::vector<int8_t>> infer(const std::vector<int8_t *> &input, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size, StatusCode &sc)
```

## NCHW int8\_t-to-int8\_t inference

Performs inference with input and output elements of type `int8_t` in NCHW (batch N, channels C, height H, width W) or CHW format.

Using these inference APIs requires manual scaling (quantization) of float values to `int8_t` for input and `int8_t` to float for output.

> [!NOTE]
>
> These APIs are intended for advanced use rather than typical usage.

| Member | Description |
| --- | --- |
| [`inferCHW`](<#inferchw-3>) ×10 |  |

### inferCHW

```cpp
StatusCode inferCHW(const std::vector<NDArray<int8_t>> &input, std::vector<NDArray<int8_t>> &output)
```

```cpp
std::vector<NDArray<int8_t>> inferCHW(const std::vector<NDArray<int8_t>> &input, StatusCode &sc)
```

```cpp
StatusCode inferCHW(const std::vector<int8_t *> &input, std::vector<std::vector<int8_t>> &output)
```

```cpp
std::vector<std::vector<int8_t>> inferCHW(const std::vector<int8_t *> &input, StatusCode &sc)
```

```cpp
StatusCode inferCHW(const std::vector<int8_t *> &input, std::vector<std::vector<int8_t>> &output, const std::vector<std::vector<int64_t>> &shape)
```

```cpp
std::vector<std::vector<int8_t>> inferCHW(const std::vector<int8_t *> &input, const std::vector<std::vector<int64_t>> &shape, StatusCode &sc)
```

```cpp
StatusCode inferCHW(const std::vector<NDArray<int8_t>> &input, std::vector<NDArray<int8_t>> &output, uint32_t cache_size)
```

```cpp
std::vector<NDArray<int8_t>> inferCHW(const std::vector<NDArray<int8_t>> &input, uint32_t cache_size, StatusCode &sc)
```

```cpp
StatusCode inferCHW(const std::vector<int8_t *> &input, std::vector<std::vector<int8_t>> &output, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size)
```

```cpp
std::vector<std::vector<int8_t>> inferCHW(const std::vector<int8_t *> &input, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size, StatusCode &sc)
```

## NHWC int8\_t-to-float inference

Performs inference with input and output elements of type `int8_t` in NHWC (batch N, height H, width W, channels C) or HWC format.

Using these inference APIs requires manual scaling (quantization) of float values to `int8_t` for input.

> [!NOTE]
>
> These APIs are intended for advanced use rather than typical usage.

| Member | Description |
| --- | --- |
| [`inferToFloat`](<#infertofloat>) ×5 |  |

### inferToFloat

```cpp
std::vector<NDArray<float>> inferToFloat(const std::vector<NDArray<int8_t>> &input, StatusCode &sc)
```

```cpp
std::vector<std::vector<float>> inferToFloat(const std::vector<int8_t *> &input, StatusCode &sc)
```

```cpp
std::vector<std::vector<float>> inferToFloat(const std::vector<int8_t *> &input, const std::vector<std::vector<int64_t>> &shape, StatusCode &sc)
```

```cpp
std::vector<NDArray<float>> inferToFloat(const std::vector<NDArray<int8_t>> &input, uint32_t cache_size, StatusCode &sc)
```

```cpp
std::vector<std::vector<float>> inferToFloat(const std::vector<int8_t *> &input, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size, StatusCode &sc)
```

## NCHW int8\_t-to-float inference

Performs inference with input and output elements of type `int8_t` in NCHW (batch N, channels C, height H, width W) or CHW format.

Using these inference APIs requires manual scaling (quantization) of float values to `int8_t` for input.

> [!NOTE]
>
> These APIs are intended for advanced use rather than typical usage.

| Member | Description |
| --- | --- |
| [`inferCHWToFloat`](<#inferchwtofloat>) ×5 |  |

### inferCHWToFloat

```cpp
std::vector<NDArray<float>> inferCHWToFloat(const std::vector<NDArray<int8_t>> &input, StatusCode &sc)
```

```cpp
std::vector<std::vector<float>> inferCHWToFloat(const std::vector<int8_t *> &input, StatusCode &sc)
```

```cpp
std::vector<std::vector<float>> inferCHWToFloat(const std::vector<int8_t *> &input, const std::vector<std::vector<int64_t>> &shape, StatusCode &sc)
```

```cpp
std::vector<NDArray<float>> inferCHWToFloat(const std::vector<NDArray<int8_t>> &input, uint32_t cache_size, StatusCode &sc)
```

```cpp
std::vector<std::vector<float>> inferCHWToFloat(const std::vector<int8_t *> &input, const std::vector<std::vector<int64_t>> &shape, uint32_t cache_size, StatusCode &sc)
```

## NHWC Buffer-to-Buffer inference

Performs inference using input and output elements in the NPU’s internal data type. The inference operates on buffers allocated via the following APIs:

- `Model::acquireInputBuffer`
- `Model::acquireOutputBuffer`
- `Model::acquireInputBuffers`
- `Model::acquireOutputBuffers`
- `ModelVariantHandle::acquireInputBuffer`
- `ModelVariantHandle::acquireOutputBuffer`
- `ModelVariantHandle::acquireInputBuffers`
- `ModelVariantHandle::acquireOutputBuffers`

Additionally, `Model::repositionInputs`, `Model::repositionOutputs`, `ModelVariantHandle::repositionInputs` and `ModelVariantHandle::repositionOutputs` must be used properly.

> [!NOTE]
>
> These APIs are intended for advanced use rather than typical usage.

| Member | Description |
| --- | --- |
| [`inferBuffer`](<#inferbuffer>) ×2 |  |

### inferBuffer

```cpp
StatusCode inferBuffer(const std::vector<Buffer> &input, std::vector<Buffer> &output, const std::vector<std::vector<int64_t>> &shape={}, uint32_t cache_size=0)
```

```cpp
StatusCode inferBuffer(const std::vector<std::vector<Buffer>> &input, std::vector<std::vector<Buffer>> &output, const std::vector<std::vector<int64_t>> &shape={}, uint32_t cache_size=0)
```

## NHWC Buffer-to-float inference

Performs inference using input and output elements in the NPU’s internal data type. The inference operates on buffers allocated via the following APIs:

- `Model::acquireInputBuffer`
- `Model::acquireInputBuffers`
- `ModelVariantHandle::acquireInputBuffer`
- `ModelVariantHandle::acquireInputBuffers`

Additionally, `Model::repositionInputs` and `ModelVariantHandle::repositionInputs` must be used properly.

> [!NOTE]
>
> These APIs are intended for advanced use rather than typical usage.

| Member | Description |
| --- | --- |
| [`inferBufferToFloat`](<#inferbuffertofloat>) ×4 |  |

### inferBufferToFloat

```cpp
StatusCode inferBufferToFloat(const std::vector<Buffer> &input, std::vector<NDArray<float>> &output, const std::vector<std::vector<int64_t>> &shape={}, uint32_t cache_size=0)
```

```cpp
StatusCode inferBufferToFloat(const std::vector<std::vector<Buffer>> &input, std::vector<NDArray<float>> &output, const std::vector<std::vector<int64_t>> &shape={}, uint32_t cache_size=0)
```

```cpp
StatusCode inferBufferToFloat(const std::vector<Buffer> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape={}, uint32_t cache_size=0)
```

```cpp
StatusCode inferBufferToFloat(const std::vector<std::vector<Buffer>> &input, std::vector<std::vector<float>> &output, const std::vector<std::vector<int64_t>> &shape={}, uint32_t cache_size=0)
```

## Asynchronous Inference

Performs inference asynchronously.

To use asynchronous inference, the model must be created using a [`ModelConfig`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/modelconfig/index.md>) object with the async pipeline configured to be enabled. This is done by calling [ModelConfig::setAsyncPipelineEnabled(true)](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/modelconfig/#setasyncpipelineenabled>) before passing the configuration to [`Model::create`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/#create>).

Example:

```cpp
using namespace mobilint;

ModelConfig mc;

// Enables support for `inferAsync` and `inferAsyncCHW`
mc.setAsyncPipelineEnabled(true);

StatusCode sc;
std::unique_ptr<Model> model = Model::create("resnet50.mxq", mc, sc);
if (!sc) {
   // Handle error appropriately
}

// Now `inferAsync` can be called.
Future future = model->inferAsync(input, sc);
```

> [!NOTE]
>
> Functions in the `inferAsync` family (`inferAsync`, `inferAsyncCHW`, `inferAsyncToFloat`, `inferAsyncCHWToFloat`) typically return immediately. However, they may block if the input queue in the qbruntime is full.

> [!NOTE]
>
> For all functions in the `inferAsync` family (`inferAsync`, `inferAsyncCHW`, `inferAsyncToFloat`, `inferAsyncCHWToFloat`), the data provided through the `input` parameter must remain unmodified until the asynchronous inference has completed. Modifying this data during execution may result in invalid results.

> [!NOTE]
>
> Currently, only CNN-based models are supported, as asynchronous execution is particularly effective for this type of workload.

> [!NOTE]
>
> Limitations:
>
> - RNN/LSTM and LLM models are not supported yet.
> - Models requiring CPU offloading are not supported yet.
> - Currently, only single-batch inference is supported (i.e., N = 1).
> - Currently, [Buffer](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/buffer/index.md>) inference is not supported. The following types are supported in the synchronous API for advanced use cases, but are not yet available for asynchronous inference:
>
>   - [Buffer](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/buffer/index.md>) to [Buffer](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/buffer/index.md>)
>   - [Buffer](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/buffer/index.md>) to float

| Member | Description |
| --- | --- |
| [`inferAsync`](<#inferasync>) ×3 | Initiates asynchronous inference with input in NHWC (batch N, height H, width W, channels C) or HWC format. |
| [`inferAsyncCHW`](<#inferasyncchw>) ×3 | Initiates asynchronous inference with input in NCHW (batch N, channels C, height H, width W) or CHW format. |
| [`inferAsyncToFloat`](<#inferasynctofloat>) | This overload supports int8\_t-to-float asynchronous inference. |
| [`inferAsyncCHWToFloat`](<#inferasyncchwtofloat>) | This overload supports int8\_t-to-float asynchronous inference. |

### inferAsync

```cpp
Future<float> inferAsync(const std::vector<NDArray<float>> &input, StatusCode &sc)
```

Initiates asynchronous inference with input in NHWC (batch N, height H, width W, channels C) or HWC format.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NHWC or HWC format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the asynchronous inference request was successfully initiated or encountered an error.

**Returns**

A future that can be used to retrieve the inference result.

```cpp
Future<int8_t> inferAsync(const std::vector<NDArray<int8_t>> &input, StatusCode &sc)
```

This overload supports int8\_t-to-int8\_t asynchronous inference.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<int8_t>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NHWC or HWC format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the asynchronous inference request was successfully initiated or encountered an error.

**Returns**

A future that can be used to retrieve the inference result.

```cpp
Future<float> inferAsync(const std::vector<NDArray<uint8_t>> &input, StatusCode &sc)
```

This overload supports uint8\_t-to-float asynchronous inference.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<uint8_t>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NHWC or HWC format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the asynchronous inference request was successfully initiated or encountered an error.

**Returns**

A future that can be used to retrieve the inference result.

### inferAsyncCHW

```cpp
Future<float> inferAsyncCHW(const std::vector<NDArray<float>> &input, StatusCode &sc)
```

Initiates asynchronous inference with input in NCHW (batch N, channels C, height H, width W) or CHW format.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<float>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NCHW or CHW format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the asynchronous inference request was successfully initiated or encountered an error.

**Returns**

A future that can be used to retrieve the inference result.

```cpp
Future<int8_t> inferAsyncCHW(const std::vector<NDArray<int8_t>> &input, StatusCode &sc)
```

This overload supports int8\_t-to-int8\_t asynchronous inference.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<int8_t>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NCHW or CHW format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the asynchronous inference request was successfully initiated or encountered an error.

**Returns**

A future that can be used to retrieve the inference result.

```cpp
Future<float> inferAsyncCHW(const std::vector<NDArray<uint8_t>> &input, StatusCode &sc)
```

This overload supports uint8\_t-to-float asynchronous inference.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<uint8_t>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NCHW or CHW format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the asynchronous inference request was successfully initiated or encountered an error.

**Returns**

A future that can be used to retrieve the inference result.

### inferAsyncToFloat

```cpp
Future<float> inferAsyncToFloat(const std::vector<NDArray<int8_t>> &input, StatusCode &sc)
```

This overload supports int8\_t-to-float asynchronous inference.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<int8_t>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NHWC or HWC format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the asynchronous inference request was successfully initiated or encountered an error.

**Returns**

A future that can be used to retrieve the inference result.

### inferAsyncCHWToFloat

```cpp
Future<float> inferAsyncCHWToFloat(const std::vector<NDArray<int8_t>> &input, StatusCode &sc)
```

This overload supports int8\_t-to-float asynchronous inference.

**Parameters**

- `input` *\[in\]* — A vector of [`NDArray<int8_t>`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>). Each [NDArray](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/ndarray/index.md>) must be in NCHW or CHW format.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the asynchronous inference request was successfully initiated or encountered an error.

**Returns**

A future that can be used to retrieve the inference result.

## Buffer Management APIs

These APIs are required when calling `Model::inferBuffer` or `Model::inferBufferToFloat`.

Buffers are acquired using:

- `acquireInputBuffer`
- `acquireOutputBuffer`

Any acquired buffer must be released using:

- `releaseBuffer`
- `releaseBuffers`

Repositioning is handled by:

- `repositionInputs`
- `repositionOutputs`

> [!NOTE]
>
> These APIs are intended for advanced use rather than typical usage.

| Member | Description |
| --- | --- |
| [`acquireInputBuffer`](<#acquireinputbuffer>) |  |
| [`acquireOutputBuffer`](<#acquireoutputbuffer>) |  |
| [`acquireInputBuffers`](<#acquireinputbuffers>) |  |
| [`acquireOutputBuffers`](<#acquireoutputbuffers>) |  |
| [`releaseBuffer`](<#releasebuffer>) |  |
| [`releaseBuffers`](<#releasebuffers>) |  |
| [`repositionInputs`](<#repositioninputs>) ×4 |  |
| [`repositionOutputs`](<#repositionoutputs>) ×4 |  |

### acquireInputBuffer

```cpp
std::vector<Buffer> acquireInputBuffer(const std::vector<std::vector<int>> &seqlens={}) const
```

### acquireOutputBuffer

```cpp
std::vector<Buffer> acquireOutputBuffer(const std::vector<std::vector<int>> &seqlens={}) const
```

### acquireInputBuffers

```cpp
std::vector<std::vector<Buffer>> acquireInputBuffers(const int batch_size, const std::vector<std::vector<int>> &seqlens={}) const
```

### acquireOutputBuffers

```cpp
std::vector<std::vector<Buffer>> acquireOutputBuffers(const int batch_size, const std::vector<std::vector<int>> &seqlens={}) const
```

### releaseBuffer

```cpp
StatusCode releaseBuffer(std::vector<Buffer> &buffer) const
```

### releaseBuffers

```cpp
StatusCode releaseBuffers(std::vector<std::vector<Buffer>> &buffers) const
```

### repositionInputs

```cpp
StatusCode repositionInputs(const std::vector<float *> &input, std::vector<Buffer> &input_buf, const std::vector<std::vector<int>> &seqlens={}) const
```

```cpp
StatusCode repositionInputs(const std::vector<uint8_t *> &input, std::vector<Buffer> &input_buf, const std::vector<std::vector<int>> &seqlens={}) const
```

```cpp
StatusCode repositionInputs(const std::vector<float *> &input, std::vector<std::vector<Buffer>> &input_buf, const std::vector<std::vector<int>> &seqlens={}) const
```

```cpp
StatusCode repositionInputs(const std::vector<uint8_t *> &input, std::vector<std::vector<Buffer>> &input_buf, const std::vector<std::vector<int>> &seqlens={}) const
```

### repositionOutputs

```cpp
StatusCode repositionOutputs(const std::vector<Buffer> &output_buf, std::vector<float *> &output, const std::vector<std::vector<int>> &seqlens={}) const
```

```cpp
StatusCode repositionOutputs(const std::vector<Buffer> &output_buf, std::vector<std::vector<float>> &output, const std::vector<std::vector<int>> &seqlens={}) const
```

```cpp
StatusCode repositionOutputs(const std::vector<std::vector<Buffer>> &output_buf, std::vector<float *> &output, const std::vector<std::vector<int>> &seqlens={}) const
```

```cpp
StatusCode repositionOutputs(const std::vector<std::vector<Buffer>> &output_buf, std::vector<std::vector<float>> &output, const std::vector<std::vector<int>> &seqlens={}) const
```

## KV Cache Management

> [!NOTE]
>
> These APIs are used for LLM models that utilize KV cache.

| Member | Description |
| --- | --- |
| [`dumpCacheMemory`](<#dumpcachememory>) ×3 | Dumps the KV cache memory into buffers. |
| [`loadCacheMemory`](<#loadcachememory>) ×2 | Loads the KV cache memory from buffers. |
| [`filterCacheTail`](<#filtercachetail>) | Filter the tail of the KV cache memory. |
| [`moveCacheTail`](<#movecachetail>) | Moves the tail of the KV cache memory to the end of the head. |

### dumpCacheMemory

```cpp
StatusCode dumpCacheMemory(std::vector<std::vector<int8_t>> &bufs)
```

Dumps the KV cache memory into buffers.

Writes the current KV cache data into provided buffers.

**Parameters**

- `bufs` *\[out\]* — A reference to vectors of byte vectors that will store the KV cache data.

**Returns**

A status code indicating whether the dump operation was successful or if an error occurred.

```cpp
std::vector<std::vector<int8_t>> dumpCacheMemory(StatusCode &sc)
```

Dumps the KV cache memory into buffers.

Writes the KV cache data into buffers and returns them.

**Parameters**

- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the dump operation was successful or if an error occurred.

**Returns**

A vector of byte vectors containing the KV cache data.

```cpp
StatusCode dumpCacheMemory(const std::string &cache_dir)
```

Dumps KV cache memory to files in the specified directory.

Writes the KV cache data to binary files within the given directory. Each file is named using the format: `cache_<layer_hash>.bin`.

**Parameters**

- `cache_dir` *\[in\]* — Path to the directory where KV cache files will be saved.

**Returns**

A status code indicating whether the dump operation was successful or if an error occurred.

### loadCacheMemory

```cpp
StatusCode loadCacheMemory(const std::vector<std::vector<int8_t>> &bufs)
```

Loads the KV cache memory from buffers.

Restores the KV cache from the provided buffers.

**Parameters**

- `bufs` *\[in\]* — A reference to a vector of byte vectors containing the KV cache data.

**Returns**

A status code indicating whether the load operation was successful or if an error occurred.

```cpp
StatusCode loadCacheMemory(const std::string &cache_dir)
```

Loads the KV cache memory from files in the specified directory.

Reads KV cache data from files within the given directory and restores them. Each file is named using the format: `cache_<layer_hash>.bin`.

**Parameters**

- `cache_dir` *\[in\]* — Path to the directory where KV cache files are saved.

**Returns**

A status code indicating whether the load operation was successful or if an error occurred.

### filterCacheTail

```cpp
int filterCacheTail(int cache_size, int tail_size, const std::vector<bool> &mask, StatusCode &sc)
```

Filter the tail of the KV cache memory.

Retains the desired caches in the tail of the KV cache memory, excludes the others, and shifts the remaining caches forward.

**Parameters**

- `cache_size` *\[in\]* — The number of tokens accumulated in the KV cache so far.
- `tail_size` *\[in\]* — The tail size of the KV cache to filter (\<=32).
- `mask` *\[in\]* — A mask indicating tokens to retain or exclude at the tail of the KV cache.
- `sc` *\[out\]* — A status code indicating the outcome of the tail filtering.

**Returns**

New cache size after tail filtering.

### moveCacheTail

```cpp
int moveCacheTail(int num_head, int num_tail, int cache_size, StatusCode &sc)
```

Moves the tail of the KV cache memory to the end of the head.

Slice the tail of the KV cache memory up to the specified size and moves it to the designated cache position.

**Parameters**

- `num_head` *\[in\]* — The size of the KV cache head where the tail is appended.
- `num_tail` *\[in\]* — The size of the KV cache tail to be moved.
- `cache_size` *\[in\]* — The total number of tokens accumulated in the KV cache so far.
- `sc` *\[out\]* — A status code indicating the result of the tail move.

**Returns**

The updated cache size after moving the tail.

## Deprecated APIs

> [!NOTE]
>
> These APIs are deprecated and should not be used.

| Member | Description |
| --- | --- |
| [`infer`](<#infer-4>) ×2 |  |
| [`getLatencyConsumed`](<#getlatencyconsumed>) |  |
| [`getLatencyFinished`](<#getlatencyfinished>) |  |

### infer

```cpp
StatusCode infer(const std::vector<float *> &input, std::vector<std::vector<float>> &output, int batch_size)
```

> [!WARNING]
>
> **Deprecated**
>
> Use `infer(input, output, shape)` instead.

```cpp
std::vector<std::vector<float>> infer(const std::vector<float *> &input, int batch_size, StatusCode &sc)
```

> [!WARNING]
>
> **Deprecated**
>
> Use `infer(input, shape, sc)` instead.

### getLatencyConsumed

```cpp
uint64_t getLatencyConsumed(const int npu_op_idx) const
```

> [!WARNING]
>
> **Deprecated**

### getLatencyFinished

```cpp
uint64_t getLatencyFinished(const int npu_op_idx) const
```

> [!WARNING]
>
> **Deprecated**

## Static functions

| Member | Description |
| --- | --- |
| [`create`](<#create>) ×2 | Creates a [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object from the specified MXQ model file. |

### create

```cpp
static std::unique_ptr<Model> create(const std::string &mxq_path, StatusCode &sc)
```

Creates a [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object from the specified MXQ model file.

Parses the MXQ file and constructs a [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object. The model is initialized in single-core mode with all NPU local cores included.

> [!NOTE]
>
> The created [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object must be launched before performing inference. See [Model::launch](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/#launch>) for more details.

**Parameters**

- `mxq_path` *\[in\]* — The path to the MXQ model file.
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the model was successfully created or if an error occurred.

**Returns**

A unique pointer to the created [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object.

```cpp
static std::unique_ptr<Model> create(const std::string &mxq_path, const ModelConfig &config, StatusCode &sc)
```

Creates a [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object from the specified MXQ model file and configuration.

Parses the MXQ file and constructs a [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object using the provided configuration, initializing the model with the given settings.

> [!NOTE]
>
> The created [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object must be launched before performing inference. See [Model::launch](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/#launch>) for more details.

**Parameters**

- `mxq_path` *\[in\]* — The path to the MXQ model file.
- `config` *\[in\]* — The configuration settings to initialize the [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>).
- `sc` *\[out\]* — A reference to a status code that will be updated to indicate whether the model was successfully created or if an error occurred.

**Returns**

A unique pointer to the created [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>) object.

## Member functions

| Member | Description |
| --- | --- |
| [`Model`](<#model>) ×2 |  |
| [`operator=`](<#operator-assign>) ×2 |  |
| [`launch`](<#launch>) | Launches the model on the specified [Accelerator](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/accelerator/index.md>), which represents the actual NPU. |
| [`dispose`](<#dispose>) | Disposes of the model loaded onto the NPU. |
| [`getCoreMode`](<#getcoremode>) | Retrieves the core mode of the model. |
| [`isTarget`](<#istarget>) | Checks if the NPU core specified by [CoreId](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/coreid/index.md>) is the target of the model. In other words, whether the model is configured to use the given NPU core. |
| [`getTargetCores`](<#gettargetcores>) | Returns the NPU cores the model is configured to use. |
| [`inferSpeedrun`](<#inferspeedrun>) | Development-only API for measuring pure NPU inference speed. |
| [`getNumModelVariants`](<#getnummodelvariants>) | Returns the total number of model variants available in this model. |
| [`getModelVariantHandle`](<#getmodelvarianthandle>) | Retrieves a handle to the specified model variant. |
| [`getModelInputShape`](<#getmodelinputshape>) | Returns the input shape of the model. |
| [`getModelOutputShape`](<#getmodeloutputshape>) | Returns the output shape of the model. |
| [`getInputBufferInfo`](<#getinputbufferinfo>) | Returns the input buffer information for the model. |
| [`getOutputBufferInfo`](<#getoutputbufferinfo>) | Returns the output buffer information of the model. |
| [`getInputScale`](<#getinputscale>) | Returns the input quantization scale(s) of the model. |
| [`getOutputScale`](<#getoutputscale>) | Returns the output quantization scale(s) of the model. |
| [`getModelInputDataType`](<#getmodelinputdatatype>) | Returns a data type for model inputs. |
| [`getModelOutputDataType`](<#getmodeloutputdatatype>) | Returns a data type for model outputs. |
| [`getIdentifier`](<#getidentifier>) | Returns the model's unique identifier. |
| [`getModelPath`](<#getmodelpath>) | Returns the path to the MXQ model file associated with the [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>). |
| [`getCacheInfos`](<#getcacheinfos>) | Returns informations of KV-cache of the model. |

### Model

```cpp
Model(const Model &other)=delete
```

```cpp
Model(Model &&other) noexcept
```

### operator=

```cpp
Model & operator=(const Model &rhs)=delete
```

```cpp
Model & operator=(Model &&rhs) noexcept
```

### launch

```cpp
StatusCode launch(Accelerator &acc)
```

Launches the model on the specified [Accelerator](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/accelerator/index.md>), which represents the actual NPU.

**Parameters**

- `acc` *\[in\]* — The accelerator on which to launch the model.

**Returns**

A status code indicating whether the model was successfully launched or if an error occurred.

### dispose

```cpp
StatusCode dispose()
```

Disposes of the model loaded onto the NPU.

Releases any resources associated with the model on the NPU.

**Returns**

A status code indicating whether the disposal was successful or if an error occurred.

### getCoreMode

```cpp
CoreMode getCoreMode() const
```

Retrieves the core mode of the model.

**Returns**

The [CoreMode](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/#coremode>) of the model.

### isTarget

```cpp
bool isTarget(CoreId core_id) const
```

Checks if the NPU core specified by [CoreId](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/coreid/index.md>) is the target of the model. In other words, whether the model is configured to use the given NPU core.

**Parameters**

- `core_id` *\[in\]* — The [CoreId](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/coreid/index.md>) to check.

**Returns**

True if the model is configured to use the specified [CoreId](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/coreid/index.md>), false otherwise.

### getTargetCores

```cpp
std::vector<CoreId> getTargetCores() const
```

Returns the NPU cores the model is configured to use.

**Returns**

A vector of CoreIds representing the target NPU cores.

### inferSpeedrun

```cpp
StatusCode inferSpeedrun(int variant_idx=0)
```

Development-only API for measuring pure NPU inference speed.

Runs NPU inference without uploading inputs and without retrieving outputs.

**Parameters**

- `variant_idx` *\[in\]* — Index of model variant to run

**Returns**

A status code indicating the result.

### getNumModelVariants

```cpp
int getNumModelVariants() const
```

Returns the total number of model variants available in this model.

The `variant_idx` parameter passed to [`Model::getModelVariantHandle`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/#getmodelvarianthandle>) must be in the range \[0, return value of this function).

**Returns**

The total number of model variants.

### getModelVariantHandle

```cpp
std::unique_ptr<ModelVariantHandle> getModelVariantHandle(int variant_idx, StatusCode &sc) const
```

Retrieves a handle to the specified model variant.

Use the returned [`ModelVariantHandle`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/modelvarianthandle/index.md>) to query details such as input and output shapes for the selected variant.

**Parameters**

- `variant_idx` *\[in\]* — Index of the model variant to retrieve. Must be in the range \[0, [getNumModelVariants()](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/#getnummodelvariants>)).
- `sc` *\[out\]* — A reference to a [StatusCode](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/#statuscode>) variable that will be updated to indicate success or failure.

**Returns**

A unique pointer to the corresponding [`ModelVariantHandle`](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/modelvarianthandle/index.md>) if successful; otherwise, nullptr.

### getModelInputShape

```cpp
const std::vector<std::vector<int64_t>> & getModelInputShape() const
```

Returns the input shape of the model.

**Returns**

A reference to the input shape of the model.

### getModelOutputShape

```cpp
const std::vector<std::vector<int64_t>> & getModelOutputShape() const
```

Returns the output shape of the model.

**Returns**

A reference to the output shape of the model.

### getInputBufferInfo

```cpp
const std::vector<BufferInfo> & getInputBufferInfo() const
```

Returns the input buffer information for the model.

**Returns**

A reference to a vector of input buffer information.

### getOutputBufferInfo

```cpp
const std::vector<BufferInfo> & getOutputBufferInfo() const
```

Returns the output buffer information of the model.

**Returns**

A reference to a vector of output buffer information.

### getInputScale

```cpp
std::vector<Scale> getInputScale() const
```

Returns the input quantization scale(s) of the model.

**Returns**

A vector of input scales.

### getOutputScale

```cpp
std::vector<Scale> getOutputScale() const
```

Returns the output quantization scale(s) of the model.

**Returns**

A vector of output scales.

### getModelInputDataType

```cpp
DataType getModelInputDataType() const
```

Returns a data type for model inputs.

**Returns**

An input data type.

### getModelOutputDataType

```cpp
DataType getModelOutputDataType() const
```

Returns a data type for model outputs.

**Returns**

An output data type.

### getIdentifier

```cpp
uint32_t getIdentifier() const
```

Returns the model's unique identifier.

This identifier distinguishes multiple models within a single user program. It is assigned incrementally, starting from 0 (e.g., 0, 1, 2, 3, ...).

**Returns**

The model identifier.

### getModelPath

```cpp
std::string getModelPath() const
```

Returns the path to the MXQ model file associated with the [Model](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/model/index.md>).

**Returns**

The MXQ file path.

### getCacheInfos

```cpp
std::vector<CacheInfo> getCacheInfos() const
```

Returns informations of KV-cache of the model.

**Returns**

A vector of [CacheInfo](<https://docs.mobilint.com/runtime/kr/v1.1/api/cpp/cacheinfo/index.md>) objects.
