1# 使用MindSpore Lite进行模型推理 (C/C++)
2
3## 场景介绍
4
5MindSpore Lite是一款AI引擎，它提供了面向不同硬件设备AI模型推理的功能，目前已经在图像分类、目标识别、人脸识别、文字识别等应用中广泛使用。
6
7本文介绍使用MindSpore Lite推理引擎进行模型推理的通用开发流程。
8
9## 基本概念
10
11在进行开发前，请先了解以下概念。
12
13**张量**：它与数组和矩阵非常相似，是MindSpore Lite网络运算中的基本数据结构。
14
15**Float16推理模式**：  Float16又称半精度，它使用16比特表示一个数。Float16推理模式表示推理的时候用半精度进行推理。
16
17
18
19## 接口说明
20
21这里给出MindSpore Lite推理的通用开发流程中涉及的一些接口，具体请见下列表格。
22
23### Context 相关接口
24
25| 接口名称        | 描述        |
26| ------------------ | ----------------- |
27|OH_AI_ContextHandle OH_AI_ContextCreate()|创建一个上下文的对象。注意：此接口需跟OH_AI_ContextDestroy配套使用。|
28|void OH_AI_ContextSetThreadNum(OH_AI_ContextHandle context, int32_t thread_num)|设置运行时的线程数量。|
29| void OH_AI_ContextSetThreadAffinityMode(OH_AI_ContextHandle context, int mode)|设置运行时线程绑定CPU核心的策略，按照CPU物理核频率分为大、中、小三种类型的核心，并且仅需绑大核或者绑中核，不需要绑小核。
30|OH_AI_DeviceInfoHandle OH_AI_DeviceInfoCreate(OH_AI_DeviceType device_type)|创建一个运行时设备信息对象。|
31|void OH_AI_ContextDestroy(OH_AI_ContextHandle *context)|释放上下文对象。|
32|void OH_AI_DeviceInfoSetEnableFP16(OH_AI_DeviceInfoHandle device_info, bool is_fp16)|设置是否开启Float16推理模式，仅CPU/GPU设备可用。|
33|void OH_AI_ContextAddDeviceInfo(OH_AI_ContextHandle context, OH_AI_DeviceInfoHandle device_info)|添加运行时设备信息。|
34
35### Model 相关接口
36
37| 接口名称        | 描述        |
38| ------------------ | ----------------- |
39|OH_AI_ModelHandle OH_AI_ModelCreate()|创建一个模型对象。|
40|OH_AI_Status OH_AI_ModelBuildFromFile(OH_AI_ModelHandle model, const char *model_path,OH_AI_ModelType odel_type, const OH_AI_ContextHandle model_context)|通过模型文件加载并编译MindSpore模型。|
41|void OH_AI_ModelDestroy(OH_AI_ModelHandle *model)|释放一个模型对象。|
42
43### Tensor 相关接口
44
45| 接口名称        | 描述        |
46| ------------------ | ----------------- |
47|OH_AI_TensorHandleArray OH_AI_ModelGetInputs(const OH_AI_ModelHandle model)|获取模型的输入张量数组结构体。|
48|int64_t OH_AI_TensorGetElementNum(const OH_AI_TensorHandle tensor)|获取张量元素数量。|
49|const char *OH_AI_TensorGetName(const OH_AI_TensorHandle tensor)|获取张量的名称。|
50|OH_AI_DataType OH_AI_TensorGetDataType(const OH_AI_TensorHandle tensor)|获取张量数据类型。|
51|void *OH_AI_TensorGetMutableData(const OH_AI_TensorHandle tensor)|获取可变的张量数据指针。|
52
53## 开发步骤
54
55使用MindSpore Lite进行模型推理的开发流程如下图所示。
56
57**图 1** 使用MindSpore Lite进行模型推理的开发流程
58
59![how-to-use-mindspore-lite](figures/01.png)
60
61进入主要流程之前需要先引用相关的头文件，并编写函数生成随机的输入，具体如下：
62
63```c
64#include <stdlib.h>
65#include <stdio.h>
66#include "mindspore/model.h"
67
68//生成随机的输入
69int GenerateInputDataWithRandom(OH_AI_TensorHandleArray inputs) {
70  for (size_t i = 0; i < inputs.handle_num; ++i) {
71    float *input_data = (float *)OH_AI_TensorGetMutableData(inputs.handle_list[i]);
72    if (input_data == NULL) {
73      printf("MSTensorGetMutableData failed.\n");
74      return OH_AI_STATUS_LITE_ERROR;
75    }
76    int64_t num = OH_AI_TensorGetElementNum(inputs.handle_list[i]);
77    const int divisor = 10;
78    for (size_t j = 0; j < num; j++) {
79      input_data[j] = (float)(rand() % divisor) / divisor;  // 0--0.9f
80    }
81  }
82  return OH_AI_STATUS_SUCCESS;
83}
84```
85
86然后进入主要的开发步骤，具括包括模型的准备、读取、编译、推理和释放，具体开发过程及细节请见下文的开发步骤及示例。
87
881. 模型准备。
89
90    需要的模型可以直接下载，也可以通过模型转换工具获得。
91
92     - 下载模型的格式若为`.ms`，则可以直接使用。本文以mobilenetv2.ms为例。
93     - 如果是第三方框架的模型，比如 TensorFlow、TensorFlow Lite、Caffe、ONNX等，可以使用[模型转换工具](https://www.mindspore.cn/lite/docs/zh-CN/master/use/downloads.html#1-8-1)转换为`.ms`格式的模型文件。
94
952. 创建上下文，设置线程数、设备类型等参数。
96
97    以下介绍两种典型情形。
98
99    情形1：仅创建CPU推理上下文。
100
101    ```c
102    // 创建并配置上下文，设置运行时的线程数量为2，绑核策略为大核优先
103    OH_AI_ContextHandle context = OH_AI_ContextCreate();
104    if (context == NULL) {
105      printf("OH_AI_ContextCreate failed.\n");
106      return OH_AI_STATUS_LITE_ERROR;
107    }
108    const int thread_num = 2;
109    OH_AI_ContextSetThreadNum(context, thread_num);
110    OH_AI_ContextSetThreadAffinityMode(context, 1);
111    //设置运行设备为CPU，不使用Float16推理
112    OH_AI_DeviceInfoHandle cpu_device_info = OH_AI_DeviceInfoCreate(OH_AI_DEVICETYPE_CPU);
113    if (cpu_device_info == NULL) {
114      printf("OH_AI_DeviceInfoCreate failed.\n");
115      OH_AI_ContextDestroy(&context);
116      return OH_AI_STATUS_LITE_ERROR;
117    }
118    OH_AI_DeviceInfoSetEnableFP16(cpu_device_info, false);
119    OH_AI_ContextAddDeviceInfo(context, cpu_device_info);
120    ```
121
122    情形2：创建NNRT（Neural Network Runtime）和CPU异构推理上下文。
123
124    NNRT是面向AI领域的跨芯片推理计算运行时，一般来说，NNRT对接的加速硬件如NPU，推理能力较强，但支持的算子规格少；而通用CPU推理能力较弱，但支持算子规格更全面。MindSpore Lite支持配置NNRT硬件和CPU异构推理：优先将模型算子调度到NNRT推理，若某些算子NNRT不支持，将其调度到CPU进行推理。通过下面的操作即可配置NNRT/CPU异构推理。
125   <!--Del-->
126   > **说明：**
127   >
128   > NNRT/CPU异构推理，需要有实际的NNRT硬件接入，NNRT相关资料请参考：[OpenHarmony/ai_neural_network_runtime](https://gitee.com/openharmony/ai_neural_network_runtime)。
129   <!--DelEnd-->
130    ```c
131    // 创建并配置上下文，设置运行时的线程数量为2，绑核策略为大核优先
132    OH_AI_ContextHandle context = OH_AI_ContextCreate();
133    if (context == NULL) {
134      printf("OH_AI_ContextCreate failed.\n");
135      return OH_AI_STATUS_LITE_ERROR;
136    }
137    // 优先使用NNRT推理。
138    // 这里利用查找到的第一个ACCELERATORS类别的NNRT硬件，来创建nnrt设备信息，并设置硬件使用高性能模式推理。还可以通过如：OH_AI_GetAllNNRTDeviceDescs()接口获取当前环境中所有NNRT硬件的描述信息，按设备名、类型等信息查找，找到某一具体设备作为NNRT推理硬件。
139    OH_AI_DeviceInfoHandle nnrt_device_info = OH_AI_CreateNNRTDeviceInfoByType(OH_AI_NNRTDEVICE_ACCELERATOR);
140    if (nnrt_device_info == NULL) {
141      printf("OH_AI_DeviceInfoCreate failed.\n");
142      OH_AI_ContextDestroy(&context);
143      return OH_AI_STATUS_LITE_ERROR;
144    }
145    OH_AI_DeviceInfoSetPerformanceMode(nnrt_device_info, OH_AI_PERFORMANCE_HIGH);
146    OH_AI_ContextAddDeviceInfo(context, nnrt_device_info);
147
148    // 其次设置CPU推理。
149    OH_AI_DeviceInfoHandle cpu_device_info = OH_AI_DeviceInfoCreate(OH_AI_DEVICETYPE_CPU);
150    if (cpu_device_info == NULL) {
151      printf("OH_AI_DeviceInfoCreate failed.\n");
152      OH_AI_ContextDestroy(&context);
153      return OH_AI_STATUS_LITE_ERROR;
154    }
155    OH_AI_ContextAddDeviceInfo(context, cpu_device_info);
156    ```
157
158
159
1603. 创建、加载与编译模型。
161
162    调用OH_AI_ModelBuildFromFile加载并编译模型。
163
164    本例中传入OH_AI_ModelBuildFromFile的argv[1]参数是从控制台中输入的模型文件路径。
165
166    ```c
167    // 创建模型
168    OH_AI_ModelHandle model = OH_AI_ModelCreate();
169    if (model == NULL) {
170      printf("OH_AI_ModelCreate failed.\n");
171      OH_AI_ContextDestroy(&context);
172      return OH_AI_STATUS_LITE_ERROR;
173    }
174
175    // 加载与编译模型，模型的类型为OH_AI_MODELTYPE_MINDIR
176    int ret = OH_AI_ModelBuildFromFile(model, argv[1], OH_AI_MODELTYPE_MINDIR, context);
177    if (ret != OH_AI_STATUS_SUCCESS) {
178      printf("OH_AI_ModelBuildFromFile failed, ret: %d.\n", ret);
179      OH_AI_ModelDestroy(&model);
180      OH_AI_ContextDestroy(&context);
181      return ret;
182    }
183    ```
184
1854. 输入数据。
186
187    模型执行之前需要向输入的张量中填充数据。本例使用随机的数据对模型进行填充。
188
189    ```c
190    // 获得输入张量
191    OH_AI_TensorHandleArray inputs = OH_AI_ModelGetInputs(model);
192    if (inputs.handle_list == NULL) {
193      printf("OH_AI_ModelGetInputs failed, ret: %d.\n", ret);
194      OH_AI_ModelDestroy(&model);
195      OH_AI_ContextDestroy(&context);
196      return ret;
197    }
198    // 使用随机数据填充张量
199    ret = GenerateInputDataWithRandom(inputs);
200    if (ret != OH_AI_STATUS_SUCCESS) {
201      printf("GenerateInputDataWithRandom failed, ret: %d.\n", ret);
202      OH_AI_ModelDestroy(&model);
203      OH_AI_ContextDestroy(&context);
204      return ret;
205    }
206   ```
207
2085. 执行推理。
209
210    使用OH_AI_ModelPredict接口进行模型推理。
211
212    ```c
213    // 执行模型推理
214    OH_AI_TensorHandleArray outputs;
215    ret = OH_AI_ModelPredict(model, inputs, &outputs, NULL, NULL);
216    if (ret != OH_AI_STATUS_SUCCESS) {
217      printf("OH_AI_ModelPredict failed, ret: %d.\n", ret);
218      OH_AI_ModelDestroy(&model);
219      OH_AI_ContextDestroy(&context);
220      return ret;
221    }
222    ```
223
2246. 获取输出。
225
226    模型推理结束之后，可以通过输出张量得到推理结果。
227
228    ```c
229    // 获取模型的输出张量，并打印
230    for (size_t i = 0; i < outputs.handle_num; ++i) {
231      OH_AI_TensorHandle tensor = outputs.handle_list[i];
232      long long element_num = OH_AI_TensorGetElementNum(tensor);
233      printf("Tensor name: %s, tensor size is %zu ,elements num: %lld.\n", OH_AI_TensorGetName(tensor),
234            OH_AI_TensorGetDataSize(tensor), element_num);
235      const float *data = (const float *)OH_AI_TensorGetData(tensor);
236      printf("output data is:\n");
237      const int max_print_num = 50;
238      for (int j = 0; j < element_num && j <= max_print_num; ++j) {
239        printf("%f ", data[j]);
240      }
241      printf("\n");
242    }
243    ```
244
2457. 释放模型。
246
247    不再使用MindSpore Lite推理框架时，需要释放已经创建的模型。
248
249    ```c
250    // 释放模型和上下文
251    OH_AI_ModelDestroy(&model);
252    OH_AI_ContextDestroy(&context);
253    ```
254
255## 调测验证
256
2571. 编写CMakeLists.txt。
258
259    ```cmake
260    cmake_minimum_required(VERSION 3.14)
261    project(Demo)
262
263    add_executable(demo main.c)
264
265    target_link_libraries(
266            demo
267            mindspore_lite_ndk
268            pthread
269            dl
270    )
271    ```
272   - 使用ohos-sdk交叉编译，需要对CMake设置native工具链路径，即：`-DCMAKE_TOOLCHAIN_FILE="/xxx/native/build/cmake/ohos.toolchain.cmake"`。
273
274   - 工具链默认编译64位的程序，如果要编译32位，需要添加：`-DOHOS_ARCH="armeabi-v7a"`。
275
2762. 运行。
277
278    - 使用hdc_std连接设备，并将demo和mobilenetv2.ms推送到设备中的相同目录。
279    - 使用hdc_std shell进入设备，并进入demo所在的目录执行如下命令，即可得到结果。
280
281    ```shell
282    ./demo mobilenetv2.ms
283    ```
284
285    得到如下输出:
286
287    ```shell
288    # ./demo ./mobilenetv2.ms
289    Tensor name: Softmax-65, tensor size is 4004 ,elements num: 1001.
290    output data is:
291    0.000018 0.000012 0.000026 0.000194 0.000156 0.001501 0.000240 0.000825 0.000016 0.000006 0.000007 0.000004 0.000004 0.000004 0.000015 0.000099 0.000011 0.000013 0.000005 0.000023 0.000004 0.000008 0.000003 0.000003 0.000008 0.000014 0.000012 0.000006 0.000019 0.000006 0.000018 0.000024 0.000010 0.000002 0.000028 0.000372 0.000010 0.000017 0.000008 0.000004 0.000007 0.000010 0.000007 0.000012 0.000005 0.000015 0.000007 0.000040 0.000004 0.000085 0.000023
292    ```
293
294## 相关实例
295
296针对MindSpore Lite 的使用，有以下相关实例可供参考：
297
298- [简易MSLite教程](https://gitee.com/openharmony/third_party_mindspore/tree/OpenHarmony-3.2-Release/mindspore/lite/examples/quick_start_c)
299