interface_i_prepared_model.md 3.3 KB
Newer Older
Z
z00524957 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
# IPreparedModel


## 概述

定义模型编译后的对象,包含编译后模型导出、模型推理接口。

**Since:**
3.2
**Version:**
2.0
**相关模块:**

[NNRt](_n_n_rt.md)


## 汇总


### Public 成员函数

  | 名称 | 描述 | 
| -------- | -------- |
| [ExportModelCache](#exportmodelcache) ([out] struct [SharedBuffer](_shared_buffer.md)[] modelCache) | 导出模型缓存。  | 
| [GetInputDimRanges](#getinputdimranges) ([out] unsigned int[][] minInputDims, [out] unsigned int[][] maxInputDims) | 获取模型输入支持的维度范围。如果模型输入为固定维度,则维度最大值与最小值相同。  | 
| [Run](#run) ([in] struct [IOTensor](_i_o_tensor.md)[] inputs, [in] struct [IOTensor](_i_o_tensor.md)[] outputs, [out] int[][] outputsDims) | 推理模型  | 


## 成员函数说明


### ExportModelCache()

  
```
IPreparedModel::ExportModelCache ([out] struct SharedBuffer[] modelCache)
```
**描述:**
导出模型缓存。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| modelCache | 模型缓存数组,元素顺序与导出时元素顺序一致,SharedBuffer定义请查看[SharedBuffer](_shared_buffer.md)。 | 

**返回:**

返回0表示成功

返回非0表示失败,负数为HDF标准错误码,正数为NNRt定义的专用错误码(请查看[NNRT_ReturnCode](_n_n_rt.md#nnrt_returncode)


### GetInputDimRanges()

  
```
IPreparedModel::GetInputDimRanges ([out] unsigned int minInputDims[][], [out] unsigned int maxInputDims[][] )
```
**描述:**
获取模型输入支持的维度范围。如果模型输入为固定维度,则维度最大值与最小值相同。

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| minInputDims | 二维数组存放模型输入数据的最小维度值,数组第1维表示模型输入tensor的数量,第2维表示输入tensor的维度数量。  | 
| maxInputDims | 二维数组存放模型输入数据的最大维度值,数组第1维表示模型输入tensor的数量,第2维表示输入tensor的维度数量。 | 

**返回:**

返回0表示成功

返回非0表示失败,负数为HDF标准错误码,正数为NNRt定义的专用错误码(请查看[NNRT_ReturnCode](_n_n_rt.md#nnrt_returncode)


### Run()

  
```
IPreparedModel::Run ([in] struct IOTensor[] inputs, [in] struct IOTensor[] outputs, [out] int outputsDims[][] )
```
**描述:**
推理模型

**参数:**

  | 名称 | 描述 | 
| -------- | -------- |
| inputs | 模型推理的输入数据,输入的顺序与模型中定义的输入顺序一致,输入数据类型参考IOTensor定义[IOTensor](_i_o_tensor.md)  | 
| outputs | 模型推理的输出数据,推理完后需要往outputs的sharedBuffer中写入输出数据,IOTensor定义请查看[IOTensor](_i_o_tensor.md)  | 
| outputsDims | 模型推理输出数据的形状,输出顺序与outputs顺序一一对应。  | 
| isOutputBufferEnough | 模型推理输出数据的SharedBuffer空间是否足够,足够的话返回true,不足则返回false,输出顺序与outputs顺序一一对应。 | 

**返回:**

返回0表示成功

返回非0表示失败,负数为HDF标准错误码,正数为NNRt定义的专用错误码(请查看[NNRT_ReturnCode](_n_n_rt.md#nnrt_returncode)