_mind_spore.md 33.5 KB
Newer Older
G
ge-yafang 已提交
1 2 3
# MindSpore


4
## 概述
G
ge-yafang 已提交
5

6
提供MindSpore Lite的模型推理相关接口。
G
ge-yafang 已提交
7

8
\@Syscap SystemCapability.Ai.MindSpore
G
ge-yafang 已提交
9

Z
zengyawen 已提交
10
**起始版本:**
G
ge-yafang 已提交
11 12 13 14 15 16 17 18 19

9


## 汇总


### 文件

20 21 22
| 名称                            | 描述                                                         |
| ------------------------------- | ------------------------------------------------------------ |
| [context.h](context_8h.md)      | 提供了Context相关的接口,可以配置运行时信息。<br>引用文件:\<mindspore/context.h> |
Z
zengyawen 已提交
23
| [data_type.h](data__type_8h.md) | 声明了张量的数据的类型。<br>引用文件:\<mindspore/data_type.h> |
24 25 26 27 28
| [format.h](format_8h.md)        | 提供张量数据的排列格式。<br>引用文件:\<mindspore/format.h>  |
| [model.h](model_8h.md)          | 提供了模型相关接口,可以用于模型创建、模型推理等。<br>引用文件:\<mindspore/model.h> |
| [status.h](status_8h.md)        | 提供了Mindspore Lite运行时的状态码。<br>引用文件:\<mindspore/status.h> |
| [tensor.h](tensor_8h.md)        | 提供了张量相关的接口,可用于创建和修改张量信息。<br>引用文件:\<mindspore/tensor.h> |
| [types.h](types_8h.md)          | 提供了MindSpore Lite支持的模型文件类型和设备类型。<br>引用文件:\<mindspore/types.h> |
G
ge-yafang 已提交
29 30 31 32


### 结构体

33 34
| 名称                                                         | 描述                                                 |
| ------------------------------------------------------------ | ---------------------------------------------------- |
G
ge-yafang 已提交
35
| [OH_AI_TensorHandleArray](_o_h___a_i___tensor_handle_array.md) | 张量数组结构体,用于存储张量数组指针和张量数组长度。 |
36 37
| [OH_AI_ShapeInfo](_o_h___a_i___shape_info.md)                | 维度信息,最大的维度为**MS_MAX_SHAPE_NUM**。         |
| [OH_AI_CallBackParam](_o_h___a_i___call_back_param.md)       | 回调函数中传入的算子信息。                           |
G
ge-yafang 已提交
38 39 40 41


### 宏定义

42 43
| 名称                                             | 描述                                         |
| ------------------------------------------------ | -------------------------------------------- |
44
| [OH_AI_MAX_SHAPE_NUM](#oh_ai_max_shape_num)   32 | 张量维度的最大值。 |
G
ge-yafang 已提交
45 46 47 48


### 类型定义

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
| 名称                                                         | 描述                                               |
| ------------------------------------------------------------ | -------------------------------------------------- |
| [OH_AI_ContextHandle](#oh_ai_contexthandle)                  | Mindspore的上下文信息的指针,该指针会指向Context。 |
| [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle)            | Mindspore的运行设备信息的指针。                    |
| [OH_AI_DataType](#oh_ai_datatype)                            | MSTensor保存的数据支持的类型。                     |
| [OH_AI_Format](#oh_ai_format)                                | MSTensor保存的数据支持的排列格式。                 |
| [OH_AI_ModelHandle](#oh_ai_modelhandle)                      | 指向模型对象的指针。                               |
| [OH_AI_TensorHandleArray](#oh_ai_tensorhandlearray)          | 张量数组结构体,用于存储张量数组指针和张量数组长度 |
| [OH_AI_ShapeInfo](_o_h___a_i___shape_info.md)                | 维度信息,最大的维度为MS_MAX_SHAPE_NUM。           |
| [OH_AI_CallBackParam](#oh_ai_callbackparam)                  | 回调函数中传入的算子信息。                         |
| [OH_AI_KernelCallBack](#oh_ai_kernelcallback)) (const [OH_AI_TensorHandleArray](_o_h___a_i___tensor_handle_array.md) inputs, const [OH_AI_TensorHandleArray](_o_h___a_i___tensor_handle_array.md) outputs, const [OH_AI_CallBackParam](_o_h___a_i___call_back_param.md) kernel_Info) | 回调函数指针。                                     |
| [OH_AI_Status](#oh_ai_status)                                | Minspore的状态码。                                 |
| [OH_AI_TensorHandle](#oh_ai_tensorhandle)                    | 指向张量对象句柄。                                 |
| [OH_AI_ModelType](#oh_ai_modeltype)                          | 模型文件的类型。                                   |
| [OH_AI_DeviceType](#oh_ai_devicetype)                        | 设备类型信息,包含了目前支持的设备类型。           |
| [OH_AI_NNRTDeviceType](#oh_ai_nnrtdevicetype)                | NNRT管理的硬件设备类型                             |
| [OH_AI_PerformanceMode](#oh_ai_performancemode)              | NNRT硬件的工作性能模式                             |
| [OH_AI_Priority](#oh_ai_priority)                            | NNRT推理任务优先级                                 |
| [NNRTDeviceDesc](#nnrtdevicedesc)                            | NNRT设备信息描述,包含设备ID,设备名称等信息。     |
G
ge-yafang 已提交
68 69 70 71


### 枚举

72 73 74 75 76 77 78 79 80 81 82
| 名称                                                         | 描述                                     |
| ------------------------------------------------------------ | ---------------------------------------- |
| [OH_AI_DataType](#oh_ai_datatype-1) {<br/>OH_AI_DATATYPE_UNKNOWN = 0, <br/>OH_AI_DATATYPE_OBJECTTYPE_STRING = 12, <br/>OH_AI_DATATYPE_OBJECTTYPE_LIST = 13, <br/>OH_AI_DATATYPE_OBJECTTYPE_TUPLE = 14,<br/>OH_AI_DATATYPE_OBJECTTYPE_TENSOR = 17, <br/>OH_AI_DATATYPE_NUMBERTYPE_BEGIN = 29,<br/> OH_AI_DATATYPE_NUMBERTYPE_BOOL = 30,<br/> OH_AI_DATATYPE_NUMBERTYPE_INT8 = 32,<br/>OH_AI_DATATYPE_NUMBERTYPE_INT16 = 33, <br/>OH_AI_DATATYPE_NUMBERTYPE_INT32 = 34, <br/>OH_AI_DATATYPE_NUMBERTYPE_INT64 = 35, <br/>OH_AI_DATATYPE_NUMBERTYPE_UINT8 = 37,<br/>OH_AI_DATATYPE_NUMBERTYPE_UINT16 = 38, <br/>OH_AI_DATATYPE_NUMBERTYPE_UINT32 = 39,<br/> OH_AI_DATATYPE_NUMBERTYPE_UINT64 = 40, <br/>OH_AI_DATATYPE_NUMBERTYPE_FLOAT16 = 42,<br/>OH_AI_DATATYPE_NUMBERTYPE_FLOAT32 = 43, <br/>OH_AI_DATATYPE_NUMBERTYPE_FLOAT64 = 44, <br/>OH_AI_DATATYPE_NUMBERTYPE_END = 46,<br/> OH_AI_DataTypeInvalid = INT32_MAX<br/>} | MSTensor保存的数据支持的类型。           |
| [OH_AI_Format](#oh_ai_format-1) {<br/>OH_AI_FORMAT_NCHW = 0,<br/> OH_AI_FORMAT_NHWC = 1, <br/>OH_AI_FORMAT_NHWC4 = 2, <br/>OH_AI_FORMAT_HWKC = 3,<br/>OH_AI_FORMAT_HWCK = 4, <br/>OH_AI_FORMAT_KCHW = 5, <br/>OH_AI_FORMAT_CKHW = 6,<br/> OH_AI_FORMAT_KHWC = 7,<br/>OH_AI_FORMAT_CHWK = 8,<br/> OH_AI_FORMAT_HW = 9, <br/>OH_AI_FORMAT_HW4 = 10,<br/> OH_AI_FORMAT_NC = 11,<br/>OH_AI_FORMAT_NC4 = 12, <br/>OH_AI_FORMAT_NC4HW4 = 13, <br/>OH_AI_FORMAT_NCDHW = 15,<br/> OH_AI_FORMAT_NWC = 16,<br/>OH_AI_FORMAT_NCW = 17<br/>} | MSTensor保存的数据支持的排列格式。       |
| [OH_AI_CompCode](#oh_ai_compcode) { <br/>OH_AI_COMPCODE_CORE = 0x00000000u, <br/>OH_AI_COMPCODE_LITE = 0xF0000000u<br/> } | Minspore不同组件的代码。                 |
| [OH_AI_Status](#oh_ai_status-1) {<br/>OH_AI_STATUS_SUCCESS = 0, OH_AI_STATUS_CORE_FAILED = OH_AI_COMPCODE_CORE \| 0x1, OH_AI_STATUS_LITE_ERROR = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -1), OH_AI_STATUS_LITE_NULLPTR = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -2),<br/>OH_AI_STATUS_LITE_PARAM_INVALID = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -3), OH_AI_STATUS_LITE_NO_CHANGE = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -4), OH_AI_STATUS_LITE_SUCCESS_EXIT = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -5), OH_AI_STATUS_LITE_MEMORY_FAILED = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -6),<br/>OH_AI_STATUS_LITE_NOT_SUPPORT = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -7), OH_AI_STATUS_LITE_THREADPOOL_ERROR = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -8), OH_AI_STATUS_LITE_UNINITIALIZED_OBJ = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -9), OH_AI_STATUS_LITE_OUT_OF_TENSOR_RANGE = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -100),<br/>OH_AI_STATUS_LITE_INPUT_TENSOR_ERROR, OH_AI_STATUS_LITE_REENTRANT_ERROR = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -102), OH_AI_STATUS_LITE_GRAPH_FILE_ERROR = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -200), OH_AI_STATUS_LITE_NOT_FIND_OP = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -300),<br/>OH_AI_STATUS_LITE_INVALID_OP_NAME = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -301), OH_AI_STATUS_LITE_INVALID_OP_ATTR = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -302), OH_AI_STATUS_LITE_OP_EXECUTE_FAILURE, OH_AI_STATUS_LITE_FORMAT_ERROR = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -400),<br/>OH_AI_STATUS_LITE_INFER_ERROR = OH_AI_COMPCODE_LITE \| (0x0FFFFFFF &amp; -500), OH_AI_STATUS_LITE_INFER_INVALID, OH_AI_STATUS_LITE_INPUT_PARAM_INVALID<br/>} | Minspore的状态码。                       |
| [OH_AI_ModelType](#oh_ai_modeltype-1) { <br/>OH_AI_MODELTYPE_MINDIR = 0, <br/>OH_AI_MODELTYPE_INVALID = 0xFFFFFFFF <br/>} | 模型文件的类型。                         |
| [OH_AI_DeviceType](#oh_ai_devicetype-1) {<br/>OH_AI_DEVICETYPE_CPU = 0, <br/>OH_AI_DEVICETYPE_GPU, <br/>OH_AI_DEVICETYPE_KIRIN_NPU, <br/>OH_AI_DEVICETYPE_NNRT = 60,<br/>OH_AI_DEVICETYPE_INVALID = 100<br/>} | 设备类型信息,包含了目前支持的设备类型。 |
| [OH_AI_NNRTDeviceType](#oh_ai_nnrtdevicetype-1) { <br/>OH_AI_NNRTDEVICE_OTHERS = 0, <br/>OH_AI_NNRTDEVICE_CPU = 1, <br/>OH_AI_NNRTDEVICE_GPU = 2, <br/>OH_AI_NNRTDEVICE_ACCELERATOR = 3<br/> } | NNRT管理的硬件设备类型。                 |
| [OH_AI_PerformanceMode](#oh_ai_performancemode-1) {<br/>OH_AI_PERFORMANCE_NONE = 0, <br/>OH_AI_PERFORMANCE_LOW = 1, <br/>OH_AI_PERFORMANCE_MEDIUM = 2,<br/> OH_AI_PERFORMANCE_HIGH = 3,<br/>OH_AI_PERFORMANCE_EXTREME = 4<br/>} | NNRT硬件的工作性能模式。                 |
| [OH_AI_Priority](#oh_ai_priority-1) { <br/>OH_AI_PRIORITY_NONE = 0, <br/>OH_AI_PRIORITY_LOW = 1, <br/>OH_AI_PRIORITY_MEDIUM = 2, <br/>OH_AI_PRIORITY_HIGH = 3 <br/>} | NNRT推理任务优先级。                     |
G
ge-yafang 已提交
83 84 85 86


### 函数

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
| 名称                                                         | 描述                                                         |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| [OH_AI_ContextCreate](#oh_ai_contextcreate) ()               | 创建一个上下文的对象。                                       |
| [OH_AI_ContextDestroy](#oh_ai_contextdestroy) ([OH_AI_ContextHandle](#oh_ai_contexthandle) \*context) | 释放上下文对象。                                             |
| [OH_AI_ContextSetThreadNum](#oh_ai_contextsetthreadnum) ([OH_AI_ContextHandle](#oh_ai_contexthandle) context, int32_t thread_num) | 设置运行时的线程数量。                                       |
| [OH_AI_ContextGetThreadNum](#oh_ai_contextgetthreadnum) (const [OH_AI_ContextHandle](#oh_ai_contexthandle) context) | 获取线程数量。                                               |
| [OH_AI_ContextSetThreadAffinityMode](#oh_ai_contextsetthreadaffinitymode) ([OH_AI_ContextHandle](#oh_ai_contexthandle) context, int mode) | 设置运行时线程绑定CPU核心的策略,按照CPU物理核频率分为大、中、小三种类型的核心,并且仅需绑大核或者绑中核,不需要绑小核。 |
| [OH_AI_ContextGetThreadAffinityMode](#oh_ai_contextgetthreadaffinitymode) (const [OH_AI_ContextHandle](#oh_ai_contexthandle) context) | 获取运行时线程绑定CPU核心的策略。                            |
| [OH_AI_ContextSetThreadAffinityCoreList](#oh_ai_contextsetthreadaffinitycorelist) ([OH_AI_ContextHandle](#oh_ai_contexthandle) context, const int32_t \*core_list, size_t core_num) | 设置运行时线程绑定CPU核心的列表。                            |
| [OH_AI_ContextGetThreadAffinityCoreList](#oh_ai_contextgetthreadaffinitycorelist) (const [OH_AI_ContextHandle](#oh_ai_contexthandle) context, size_t \*core_num) | 获取CPU绑核列表。                                            |
| [OH_AI_ContextSetEnableParallel](#oh_ai_contextsetenableparallel) ([OH_AI_ContextHandle](#oh_ai_contexthandle) context, bool is_parallel) | 设置运行时是否支持并行。                                     |
| [OH_AI_ContextGetEnableParallel](#oh_ai_contextgetenableparallel) (const [OH_AI_ContextHandle](#oh_ai_contexthandle) context) | 获取是否支持算子间并行。                                     |
| [OH_AI_ContextAddDeviceInfo](#oh_ai_contextadddeviceinfo) ([OH_AI_ContextHandle](#oh_ai_contexthandle) context, [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 添加运行设备信息。                                           |
| [OH_AI_DeviceInfoCreate](#oh_ai_deviceinfocreate) ([OH_AI_DeviceType](#oh_ai_devicetype) device_type) | 创建一个设备信息对象。                                       |
| [OH_AI_DeviceInfoDestroy](#oh_ai_deviceinfodestroy) ([OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) \*device_info) | 释放设备信息实例。                                           |
| [OH_AI_DeviceInfoSetProvider](#oh_ai_deviceinfosetprovider) ([OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info, const char \*provider) | 设置供应商的名称。                                           |
| [OH_AI_DeviceInfoGetProvider](#oh_ai_deviceinfogetprovider) (const [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 获取生产商的名称。                                           |
| [OH_AI_DeviceInfoSetProviderDevice](#oh_ai_deviceinfosetproviderdevice) ([OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info, const char \*device) | 设置生产商设备的名称。                                       |
| [OH_AI_DeviceInfoGetProviderDevice](#oh_ai_deviceinfogetproviderdevice) (const [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 获取生产商设备的名称。                                       |
| [OH_AI_DeviceInfoGetDeviceType](#oh_ai_deviceinfogetdevicetype) (const [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 获取设备的类型。                                             |
| [OH_AI_DeviceInfoSetEnableFP16](#oh_ai_deviceinfosetenablefp16) ([OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info, bool is_fp16) | 设置是否开启float16推理模式,仅CPU/GPU设备可用。             |
| [OH_AI_DeviceInfoGetEnableFP16](#oh_ai_deviceinfogetenablefp16) (const [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 获取是否开启float16推理模式, 仅CPU/GPU设备可用。             |
| [OH_AI_DeviceInfoSetFrequency](#oh_ai_deviceinfosetfrequency) ([OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info, int frequency) | 设置NPU的频率,仅NPU设备可用。                               |
| [OH_AI_DeviceInfoGetFrequency](#oh_ai_deviceinfogetfrequency) (const [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 获取NPU的频率类型,仅NPU设备可用。                           |
| [OH_AI_GetAllNNRTDeviceDescs](#oh_ai_getallnnrtdevicedescs) (size_t \*num) | 获取系统中所有NNRT硬件设备的描述信息。                       |
| [OH_AI_DestroyAllNNRTDeviceDescs](#oh_ai_destroyallnnrtdevicedescs) ([NNRTDeviceDesc](#nnrtdevicedesc) \*\*desc) | 销毁从[OH_AI_GetAllNNRTDeviceDescs](#oh_ai_getallnnrtdevicedescs)获取的NNRT描写信息实例数组。 |
| [OH_AI_GetDeviceIdFromNNRTDeviceDesc](#oh_ai_getdeviceidfromnnrtdevicedesc) (const [NNRTDeviceDesc](#nnrtdevicedesc) \*desc) | 从特定的NNRT设备描述信息实例获取NNRT设备ID。注意,此ID只对NNRT有效。 |
| [OH_AI_GetNameFromNNRTDeviceDesc](#oh_ai_getnamefromnnrtdevicedesc) (const [NNRTDeviceDesc](#nnrtdevicedesc) \*desc) | 从特定的NNRT设备描述信息实例获取NNRT设备名称。               |
| [OH_AI_GetTypeFromNNRTDeviceDesc](#oh_ai_gettypefromnnrtdevicedesc) (const [NNRTDeviceDesc](#nnrtdevicedesc) \*desc) | 从特定的NNRT设备描述信息实例获取NNRT设备类型。               |
| [OH_AI_CreateNNRTDeviceInfoByName](#oh_ai_creatennrtdeviceinfobyname) (const char \*name) | 查找指定名称的NNRT设备,根据找到的第一个设备信息,创建NNRT设备信息。 |
| [OH_AI_CreateNNRTDeviceInfoByType](#oh_ai_creatennrtdeviceinfobytype) ([OH_AI_NNRTDeviceType](#oh_ai_nnrtdevicetype) type) | 查找指定类型的NNRT设备,根据找到的第一个设备信息,创建NNRT设备信息。 |
| [OH_AI_DeviceInfoSetDeviceId](#oh_ai_deviceinfosetdeviceid) ([OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info, size_t device_id) | 设置NNRT设备ID,仅NNRT设备可用。                             |
| [OH_AI_DeviceInfoGetDeviceId](#oh_ai_deviceinfogetdeviceid) (const [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 获取NNRT设备ID,仅NNRT设备可用。                             |
| [OH_AI_DeviceInfoSetPerformanceMode](#oh_ai_deviceinfosetperformancemode) ([OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info, [OH_AI_PerformanceMode](#oh_ai_performancemode) mode) | 设置NNRT性能模式,仅NNRT设备可用。                           |
| [OH_AI_DeviceInfoGetPerformanceMode](#oh_ai_deviceinfogetperformancemode) (const [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 获取NNRT性能模式,仅NNRT设备可用。                           |
| [OH_AI_DeviceInfoSetPriority](#oh_ai_deviceinfosetpriority) ([OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info, [OH_AI_Priority](#oh_ai_priority) priority) | 设置NNRT任务优先级,仅NNRT设备可用。                         |
| [OH_AI_DeviceInfoGetPriority](#oh_ai_deviceinfogetpriority) (const [OH_AI_DeviceInfoHandle](#oh_ai_deviceinfohandle) device_info) | 获取NNRT任务优先级,仅NNRT设备可用。                         |
| [OH_AI_ModelCreate](#oh_ai_modelcreate) ()                   | 创建一个模型对象。                                           |
| [OH_AI_ModelDestroy](#oh_ai_modeldestroy) ([OH_AI_ModelHandle](#oh_ai_modelhandle) \*model) | 释放一个模型对象。                                           |
| [OH_AI_ModelBuild](#oh_ai_modelbuild) ([OH_AI_ModelHandle](#oh_ai_modelhandle) model, const void \*model_data, size_t data_size, [OH_AI_ModelType](#oh_ai_modeltype) model_type, const [OH_AI_ContextHandle](#oh_ai_contexthandle) model_context) | 从内存缓冲区加载并编译MindSpore模型。                        |
| [OH_AI_ModelBuildFromFile](#oh_ai_modelbuildfromfile) ([OH_AI_ModelHandle](#oh_ai_modelhandle) model, const char \*model_path, [OH_AI_ModelType](#oh_ai_modeltype) model_type, const [OH_AI_ContextHandle](#oh_ai_contexthandle) model_context) | 通过模型文件加载并编译MindSpore模型。                        |
| [OH_AI_ModelResize](#oh_ai_modelresize) ([OH_AI_ModelHandle](#oh_ai_modelhandle) model, const [OH_AI_TensorHandleArray](_o_h___a_i___tensor_handle_array.md) inputs, [OH_AI_ShapeInfo](_o_h___a_i___shape_info.md) \*shape_infos, size_t shape_info_num) | 调整已编译模型的输入形状。                                   |
| [OH_AI_ModelPredict](#oh_ai_modelpredict) ([OH_AI_ModelHandle](#oh_ai_modelhandle) model, const [OH_AI_TensorHandleArray](_o_h___a_i___tensor_handle_array.md) inputs, [OH_AI_TensorHandleArray](_o_h___a_i___tensor_handle_array.md) \*outputs, const [OH_AI_KernelCallBack](#oh_ai_kernelcallback) before, const [OH_AI_KernelCallBack](#oh_ai_kernelcallback) after) | 执行模型推理。                                               |
| [OH_AI_ModelGetInputs](#oh_ai_modelgetinputs) (const [OH_AI_ModelHandle](#oh_ai_modelhandle) model) | 获取模型的输入张量数组结构体。                               |
| [OH_AI_ModelGetOutputs](#oh_ai_modelgetoutputs) (const [OH_AI_ModelHandle](#oh_ai_modelhandle) model) | 获取模型的输出张量数组结构体。                               |
| [OH_AI_ModelGetInputByTensorName](#oh_ai_modelgetinputbytensorname) (const [OH_AI_ModelHandle](#oh_ai_modelhandle) model, const char \*tensor_name) | 通过张量名获取模型的输入张量。                               |
| [OH_AI_ModelGetOutputByTensorName](#oh_ai_modelgetoutputbytensorname) (const [OH_AI_ModelHandle](#oh_ai_modelhandle) model, const char \*tensor_name) | 通过张量名获取模型的输出张量。                               |
| [OH_AI_TensorCreate](#oh_ai_tensorcreate) (const char \*name, [OH_AI_DataType](#oh_ai_datatype) type, const int64_t \*shape, size_t shape_num, const void \*data, size_t data_len) | 创建一个张量对象。                                           |
| [OH_AI_TensorDestroy](#oh_ai_tensordestroy) ([OH_AI_TensorHandle](#oh_ai_tensorhandle) \*tensor) | 释放张量对象。                                               |
| [OH_AI_TensorClone](#oh_ai_tensorclone) ([OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor) | 深拷贝一个张量。                                             |
| [OH_AI_TensorSetName](#oh_ai_tensorsetname) ([OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor, const char \*name) | 设置张量的名称。                                             |
| [OH_AI_TensorGetName](#oh_ai_tensorgetname) (const [OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor) | 获取张量的名称。                                             |
| [OH_AI_TensorSetDataType](#oh_ai_tensorsetdatatype) ([OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor, [OH_AI_DataType](#oh_ai_datatype) type) | 设置张量的数据类型。                                         |
| [OH_AI_TensorGetDataType](#oh_ai_tensorgetdatatype) (const [OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor) | 获取张量类型。                                               |
| [OH_AI_TensorSetShape](#oh_ai_tensorsetshape) ([OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor, const int64_t \*shape, size_t shape_num) | 设置张量的形状。                                             |
| [OH_AI_TensorGetShape](#oh_ai_tensorgetshape) (const [OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor, size_t \*shape_num) | 获取张量的形状。                                             |
| [OH_AI_TensorSetFormat](#oh_ai_tensorsetformat) ([OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor, [OH_AI_Format](#oh_ai_format) format) | 设置张量数据的排列方式。                                     |
| [OH_AI_TensorGetFormat](#oh_ai_tensorgetformat) (const [OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor) | 获取张量数据的排列方式。                                     |
| [OH_AI_TensorSetData](#oh_ai_tensorsetdata) ([OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor, void \*data) | 设置张量的数据。                                             |
| [OH_AI_TensorGetData](#oh_ai_tensorgetdata) (const [OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor) | 获取张量数据的指针。                                         |
| [OH_AI_TensorGetMutableData](#oh_ai_tensorgetmutabledata) (const [OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor) | 获取可变的张量数据指针。如果数据为空则会开辟内存。           |
| [OH_AI_TensorGetElementNum](#oh_ai_tensorgetelementnum) (const [OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor) | 获取张量元素数量。                                           |
| [OH_AI_TensorGetDataSize](#oh_ai_tensorgetdatasize) (const [OH_AI_TensorHandle](#oh_ai_tensorhandle) tensor) | 获取张量中的数据的字节数大小。                               |


## 宏定义说明
G
ge-yafang 已提交
153 154 155 156 157 158 159 160 161 162 163


### OH_AI_MAX_SHAPE_NUM


```
#define OH_AI_MAX_SHAPE_NUM   32
```

**描述:**

164
张量维度的最大值。
G
ge-yafang 已提交
165 166


167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
## 类型定义说明


### NNRTDeviceDesc


```
typedef struct NNRTDeviceDesc NNRTDeviceDesc
```

**描述:**

NNRT设备信息描述,包含设备ID,设备名称等信息。

**起始版本:**

10
G
ge-yafang 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292


### OH_AI_CallBackParam


```
typedef struct OH_AI_CallBackParam OH_AI_CallBackParam
```

**描述:**

回调函数中传入的算子信息。


### OH_AI_ContextHandle


```
typedef void* OH_AI_ContextHandle
```

**描述:**

Mindspore的上下文信息的指针,该指针会指向Context。


### OH_AI_DataType


```
typedef enum OH_AI_DataType OH_AI_DataType
```

**描述:**

MSTensor保存的数据支持的类型。


### OH_AI_DeviceInfoHandle


```
typedef void* OH_AI_DeviceInfoHandle
```

**描述:**

Mindspore的运行设备信息的指针。


### OH_AI_DeviceType


```
typedef enum OH_AI_DeviceType OH_AI_DeviceType
```

**描述:**

设备类型信息,包含了目前支持的设备类型。


### OH_AI_Format


```
typedef enum OH_AI_Format OH_AI_Format
```

**描述:**

MSTensor保存的数据支持的排列格式。


### OH_AI_KernelCallBack


```
typedef bool(* OH_AI_KernelCallBack) (const OH_AI_TensorHandleArray inputs, const OH_AI_TensorHandleArray outputs, const OH_AI_CallBackParam kernel_Info)
```

**描述:**

回调函数指针。

该函数指针是用于设置[OH_AI_ModelPredict](#oh_ai_modelpredict)函数参数中的两个回调函数。 该指针指向的函数需要包含三个参数,其中inputs和outputs对应了算子的输入和输出张量,kernel_Info表示当前算子的信息。 可以通过回调函数监控算子执行的情况,例如统计算子的执行时间,校验算子的正确性等等。


### OH_AI_ModelHandle


```
typedef void* OH_AI_ModelHandle
```

**描述:**

指向模型对象的指针。


### OH_AI_ModelType


```
typedef enum OH_AI_ModelType OH_AI_ModelType
```

**描述:**

293
模型文件的类型。
G
ge-yafang 已提交
294 295


296
### OH_AI_NNRTDeviceType
G
ge-yafang 已提交
297 298 299


```
300
typedef enum OH_AI_NNRTDeviceType OH_AI_NNRTDeviceType
G
ge-yafang 已提交
301 302 303 304
```

**描述:**

305
NNRT管理的硬件设备类型。
G
ge-yafang 已提交
306

307
**起始版本:**
G
ge-yafang 已提交
308

309
10
G
ge-yafang 已提交
310 311


312
### OH_AI_PerformanceMode
G
ge-yafang 已提交
313 314 315


```
316
typedef enum OH_AI_PerformanceMode OH_AI_PerformanceMode
G
ge-yafang 已提交
317 318 319 320
```

**描述:**

321
NNRT硬件的工作性能模式。
G
ge-yafang 已提交
322

323
**起始版本:**
G
ge-yafang 已提交
324

325
10
G
ge-yafang 已提交
326 327


328
### OH_AI_Priority
G
ge-yafang 已提交
329 330 331


```
332
typedef enum OH_AI_Priority OH_AI_Priority
G
ge-yafang 已提交
333 334 335 336
```

**描述:**

337
NNRT推理任务优先级。
G
ge-yafang 已提交
338

339
**起始版本:**
G
ge-yafang 已提交
340

341
10
G
ge-yafang 已提交
342 343 344 345 346 347


### OH_AI_Status


```
348
typedef enum OH_AI_Status OH_AI_Status
G
ge-yafang 已提交
349 350 351 352 353 354 355
```

**描述:**

Minspore的状态码。


356
### OH_AI_TensorHandle
G
ge-yafang 已提交
357 358 359


```
360
typedef void* OH_AI_TensorHandle
G
ge-yafang 已提交
361 362 363 364
```

**描述:**

365
指向张量对象句柄。
G
ge-yafang 已提交
366 367


368
### OH_AI_TensorHandleArray
G
ge-yafang 已提交
369 370 371


```
372
typedef struct OH_AI_TensorHandleArray OH_AI_TensorHandleArray
G
ge-yafang 已提交
373 374 375 376
```

**描述:**

377
张量数组结构体,用于存储张量数组指针和张量数组长度。
G
ge-yafang 已提交
378 379


380
## 枚举类型说明
G
ge-yafang 已提交
381 382


383
### OH_AI_CompCode
G
ge-yafang 已提交
384 385 386


```
387
enum OH_AI_CompCode
G
ge-yafang 已提交
388 389 390 391
```

**描述:**

392
Minspore不同组件的代码。
G
ge-yafang 已提交
393

394 395 396 397
| 枚举值              | 描述                  |
| ------------------- | --------------------- |
| OH_AI_COMPCODE_CORE | Minspore Core的代码。 |
| OH_AI_COMPCODE_LITE | Minspore Lite的代码。 |
G
ge-yafang 已提交
398 399


400
### OH_AI_DataType
G
ge-yafang 已提交
401 402 403


```
404
enum OH_AI_DataType
G
ge-yafang 已提交
405 406 407 408
```

**描述:**

409
MSTensor保存的数据支持的类型。
G
ge-yafang 已提交
410

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
| 枚举值                            | 描述                   |
| --------------------------------- | ---------------------- |
| OH_AI_DATATYPE_UNKNOWN            | 未知的数据类型。       |
| OH_AI_DATATYPE_OBJECTTYPE_STRING  | String数据类型。       |
| OH_AI_DATATYPE_OBJECTTYPE_LIST    | List数据类型。         |
| OH_AI_DATATYPE_OBJECTTYPE_TUPLE   | Tuple数据类型。        |
| OH_AI_DATATYPE_OBJECTTYPE_TENSOR  | TensorList数据类型。   |
| OH_AI_DATATYPE_NUMBERTYPE_BEGIN   | Number类型的起始。     |
| OH_AI_DATATYPE_NUMBERTYPE_BOOL    | Bool数据类型。         |
| OH_AI_DATATYPE_NUMBERTYPE_INT8    | Int8数据类型。         |
| OH_AI_DATATYPE_NUMBERTYPE_INT16   | 表示Int16数据类型。    |
| OH_AI_DATATYPE_NUMBERTYPE_INT32   | 表示Int32数据类型。    |
| OH_AI_DATATYPE_NUMBERTYPE_INT64   | 表示Int64数据类型。    |
| OH_AI_DATATYPE_NUMBERTYPE_UINT8   | 表示UInt8数据类型。    |
| OH_AI_DATATYPE_NUMBERTYPE_UINT16  | 表示UInt16数据类型。   |
| OH_AI_DATATYPE_NUMBERTYPE_UINT32  | 表示UInt32数据类型。   |
| OH_AI_DATATYPE_NUMBERTYPE_UINT64  | 表示UInt64数据类型。   |
| OH_AI_DATATYPE_NUMBERTYPE_FLOAT16 | 表示Float16数据类型。  |
| OH_AI_DATATYPE_NUMBERTYPE_FLOAT32 | 表示Float32数据类型。  |
| OH_AI_DATATYPE_NUMBERTYPE_FLOAT64 | 表示Float64数据类型。  |
| OH_AI_DATATYPE_NUMBERTYPE_END     | 表示Number类型的结尾。 |
| OH_AI_DataTypeInvalid             | 表示无效的数据类型。   |
G
ge-yafang 已提交
433 434


435
### OH_AI_DeviceType
G
ge-yafang 已提交
436 437 438


```
439
enum OH_AI_DeviceType
G
ge-yafang 已提交
440 441 442 443
```

**描述:**

444
设备类型信息,包含了目前支持的设备类型。
G
ge-yafang 已提交
445

446 447 448 449 450 451 452
| 枚举值                     | 描述                                    |
| -------------------------- | --------------------------------------- |
| OH_AI_DEVICETYPE_CPU       | 设备类型是CPU。                         |
| OH_AI_DEVICETYPE_GPU       | 设备类型是GPU。预留选项, 暂不支持。    |
| OH_AI_DEVICETYPE_KIRIN_NPU | 设备类型是麒麟NPU。预留选项,暂不支持。 |
| OH_AI_DEVICETYPE_NNRT      | 设备类型是NNRt。OHOS设备范围是[60,80)。 |
| OH_AI_DEVICETYPE_INVALID   | 设备类型无效。                          |
G
ge-yafang 已提交
453 454


455
### OH_AI_Format
G
ge-yafang 已提交
456 457 458


```
459
enum OH_AI_Format
G
ge-yafang 已提交
460 461 462 463
```

**描述:**

464
MSTensor保存的数据支持的排列格式。
G
ge-yafang 已提交
465

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
| 枚举值              | 描述             |
| ------------------- | ---------------- |
| OH_AI_FORMAT_NCHW   | 表示NCHW排列。   |
| OH_AI_FORMAT_NHWC   | 表示NHWC排列。   |
| OH_AI_FORMAT_NHWC4  | 表示NHWC4排列。  |
| OH_AI_FORMAT_HWKC   | 表示HWKC排列。   |
| OH_AI_FORMAT_HWCK   | 表示HWCK排列。   |
| OH_AI_FORMAT_KCHW   | 表示KCHW排列。   |
| OH_AI_FORMAT_CKHW   | 表示CKHW排列。   |
| OH_AI_FORMAT_KHWC   | 表示KHWC排列。   |
| OH_AI_FORMAT_CHWK   | 表示CHWK排列。   |
| OH_AI_FORMAT_HW     | 表示HW排列。     |
| OH_AI_FORMAT_HW4    | 表示HW4排列。    |
| OH_AI_FORMAT_NC     | 表示NC排列。     |
| OH_AI_FORMAT_NC4    | 表示NC4排列。    |
| OH_AI_FORMAT_NC4HW4 | 表示NC4HW4排列。 |
| OH_AI_FORMAT_NCDHW  | 表示NCDHW排列。  |
| OH_AI_FORMAT_NWC    | 表示NWC排列。    |
| OH_AI_FORMAT_NCW    | 表示NCW排列。    |
G
ge-yafang 已提交
485 486


487
### OH_AI_ModelType
G
ge-yafang 已提交
488 489 490


```
491
enum OH_AI_ModelType
G
ge-yafang 已提交
492 493 494 495
```

**描述:**

496
模型文件的类型。
G
ge-yafang 已提交
497

498 499 500 501
| 枚举值                  | 描述               |
| ----------------------- | ------------------ |
| OH_AI_MODELTYPE_MINDIR  | 模型类型是MindIR。 |
| OH_AI_MODELTYPE_INVALID | 模型类型无效。     |
G
ge-yafang 已提交
502 503


504
### OH_AI_NNRTDeviceType
G
ge-yafang 已提交
505 506 507


```
508
enum OH_AI_NNRTDeviceType
G
ge-yafang 已提交
509 510 511 512
```

**描述:**

513
NNRT管理的硬件设备类型。
G
ge-yafang 已提交
514

515
**起始版本**
G
ge-yafang 已提交
516

517
10
G
ge-yafang 已提交
518

519 520 521 522 523 524
| 枚举值                       | 描述                                |
| ---------------------------- | ----------------------------------- |
| OH_AI_NNRTDEVICE_OTHERS      | 设备类型不属于以下3种,则属于其它。 |
| OH_AI_NNRTDEVICE_CPU         | CPU设备。                           |
| OH_AI_NNRTDEVICE_GPU         | GPU设备。                           |
| OH_AI_NNRTDEVICE_ACCELERATOR | 特定的加速设备。                    |
G
ge-yafang 已提交
525 526


527
### OH_AI_PerformanceMode
G
ge-yafang 已提交
528 529 530


```
531
enum OH_AI_PerformanceMode
G
ge-yafang 已提交
532 533 534 535
```

**描述:**

536
NNRT硬件的工作性能模式。
G
ge-yafang 已提交
537

538
**起始版本**
G
ge-yafang 已提交
539

540
10
G
ge-yafang 已提交
541

542 543 544 545 546 547 548
| 枚举值                    | 描述                |
| ------------------------- | ------------------- |
| OH_AI_PERFORMANCE_NONE    | 无特殊设置。        |
| OH_AI_PERFORMANCE_LOW     | 低功耗模式。        |
| OH_AI_PERFORMANCE_MEDIUM  | 功耗-性能均衡模式。 |
| OH_AI_PERFORMANCE_HIGH    | 高性能模式。        |
| OH_AI_PERFORMANCE_EXTREME | 极致性能模式。      |
G
ge-yafang 已提交
549 550


551
### OH_AI_Priority
G
ge-yafang 已提交
552 553 554


```
555
enum OH_AI_Priority
G
ge-yafang 已提交
556 557 558 559
```

**描述:**

560
NNRT推理任务优先级。
G
ge-yafang 已提交
561

562
**起始版本**
G
ge-yafang 已提交
563

564
10
G
ge-yafang 已提交
565

566 567 568 569 570 571
| 枚举值                | 描述           |
| --------------------- | -------------- |
| OH_AI_PRIORITY_NONE   | 无优先级偏好。 |
| OH_AI_PRIORITY_LOW    | 低优先级任务。 |
| OH_AI_PRIORITY_MEDIUM | 中优先级任务。 |
| OH_AI_PRIORITY_HIGH   | 高优先级。     |
G
ge-yafang 已提交
572 573


574
### OH_AI_Status
G
ge-yafang 已提交
575 576 577


```
578
enum OH_AI_Status
G
ge-yafang 已提交
579 580 581 582
```

**描述:**

583
Minspore的状态码。
G
ge-yafang 已提交
584

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
| 枚举值                                | 描述                                      |
| ------------------------------------- | ----------------------------------------- |
| OH_AI_STATUS_SUCCESS                  | 通用的成功状态码。                        |
| OH_AI_STATUS_CORE_FAILED              | Mindspore Core 失败状态码。               |
| OH_AI_STATUS_LITE_ERROR               | Mindspore Lite 异常状态码。               |
| OH_AI_STATUS_LITE_NULLPTR             | Mindspore Lite 空指针状态码。             |
| OH_AI_STATUS_LITE_PARAM_INVALID       | Mindspore Lite 参数异常状态码。           |
| OH_AI_STATUS_LITE_NO_CHANGE           | Mindspore Lite 未改变状态码。             |
| OH_AI_STATUS_LITE_SUCCESS_EXIT        | Mindspore Lite 没有错误但是退出的状态码。 |
| OH_AI_STATUS_LITE_MEMORY_FAILED       | Mindspore Lite 内存分配失败的状态码。     |
| OH_AI_STATUS_LITE_NOT_SUPPORT         | Mindspore Lite 功能未支持的状态码。       |
| OH_AI_STATUS_LITE_THREADPOOL_ERROR    | Mindspore Lite 线程池异常状态码。         |
| OH_AI_STATUS_LITE_UNINITIALIZED_OBJ   | Mindspore Lite 未初始化状态码。           |
| OH_AI_STATUS_LITE_OUT_OF_TENSOR_RANGE | Mindspore Lite 张量溢出错误的状态码。     |
| OH_AI_STATUS_LITE_INPUT_TENSOR_ERROR  | Mindspore Lite 输入张量异常的状态码。     |
| OH_AI_STATUS_LITE_REENTRANT_ERROR     | Mindspore Lite 重入异常的状态码。         |
| OH_AI_STATUS_LITE_GRAPH_FILE_ERROR    | Mindspore Lite 文件异常状态码。           |
| OH_AI_STATUS_LITE_NOT_FIND_OP         | Mindspore Lite 未找到算子的状态码。       |
| OH_AI_STATUS_LITE_INVALID_OP_NAME     | Mindspore Lite 无效算子状态码。           |
| OH_AI_STATUS_LITE_INVALID_OP_ATTR     | Mindspore Lite 无效算子超参数状态码。     |
| OH_AI_STATUS_LITE_OP_EXECUTE_FAILURE  | Mindspore Lite 算子执行失败的状态码。     |
| OH_AI_STATUS_LITE_FORMAT_ERROR        | Mindspore Lite 张量格式异常状态码。       |
| OH_AI_STATUS_LITE_INFER_ERROR         | Mindspore Lite 形状推理异常状态码。       |
| OH_AI_STATUS_LITE_INFER_INVALID       | Mindspore Lite 无效的形状推理的状态码。   |
| OH_AI_STATUS_LITE_INPUT_PARAM_INVALID | Mindspore Lite 用户输入的参数无效状态码。 |
G
ge-yafang 已提交
610 611