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