--- title: 基于昇腾计算语言AscendCL开发AI推理应用-官方技术文章-昇腾社区 description: 本文介绍了昇腾计算语言AscendCL的基本概念，并以示例代码的形式介绍了如何基于AscendCL开发AI推理应用，最后配以实际的操作演示说明如何编译运行应用。 keywords: AscendCL,AI,基于昇腾计算,语言,开发,推理应用,官方技术文章,昇腾社区 url: https://www.hiascend.com/developer/techArticles/20230214-1?envFlag=1 section: (其他) --- # 基于昇腾计算语言AscendCL开发AI推理应用-官方技术文章-昇腾社区 URL: https://www.hiascend.com/developer/techArticles/20230214-1?envFlag=1 描述: 本文介绍了昇腾计算语言AscendCL的基本概念，并以示例代码的形式介绍了如何基于AscendCL开发AI推理应用，最后配以实际的操作演示说明如何编译运行应用。 关键词: AscendCL,AI,基于昇腾计算,语言,开发,推理应用,官方技术文章,昇腾社区 官方技术文章 [了解详情](https://www.hiascend.com/zh/developer/techArticles) 基于昇腾计算语言AscendCL开发AI推理应用 基于昇腾计算语言AscendCL开发AI推理应用 实战经验 发表于: 2023/02/14 # 01 初识AscendCL AscendCL（Ascend Computing Language，昇腾计算语言）是昇腾计算开放编程框架，是对底层昇腾计算服务接口的封装，它提供运行时资源（例如设备、内存等）管理、模型加载与执行、算子加载与执行、图片数据编解码/裁剪/缩放处理等API库，实现在昇腾CANN平台上进行深度学习推理计算、图形图像预处理、单算子加速计算等能力。简单来说，就是统一的API框架，实现对所有资源的调用。 # 02 如何基于AscendCL开发推理应用 首先，我们得先了解下，使用AscendCL时，经常会提到的“数据类型的操作接口” ，这是什么呢？为啥会存在？ 在C/C++中，对用户开放的数据类型通常以Struct结构体方式定义、以声明变量的方式使用，但这种方式一旦结构体要增加成员参数，用户的代码就涉及兼容性问题，不便于维护，因此AscendCL对用户开放的数据类型，均以接口的方式操作该数据类型，例如，调用某个数据类型的Create接口创建该数据类型、调用Get接口获取数据类型内参数值、调用Set接口设置数据类型内的参数值、调用Destroy接口销毁该数据类型，用户无需关注定义数据类型的结构体长什么样，这样即使后续数据类型需扩展，只需增加该数据类型的操作接口即可，也不会引起兼容性问题。 所以，总结下，“数据类型的操作接口”就是创建数据类型、Get/Set数据类型中的参数值、销毁数据类型的一系列接口，存在的最大好处就是减少兼容性问题。 接下来，进入我们今天的主题，怎么用AscendCL的接口开发网络模型推理场景下的应用。看完本文介绍的关键知识点，也可以到 “昇腾文档中心[1]”查阅详细的文档介绍。 # 03 AscendCL初始化与去初始化 使用AscendCL接口开发应用时，必须先初始化AscendCL ，否则可能会导致后续系统内部资源初始化出错，进而导致其它业务异常。在初始化时，还支持以下跟推理相关的配置项（例如，性能相关的采集信息配置），以json格式的配置文件传入AscendCL初始化接口。如果当前的默认配置已满足需求（例如，默认不开启性能相关的采集信息配置），无需修改，可向AscendCL初始化接口中传入NULL，或者可将配置文件配置为空json串（即配置文件中只有{}）。 有初始化就有去初始化，在完成了AscendCL的所有调用之后，或者进程退出之前，需调用AscendCL接口实现AscendCL去初始化。 ``` // 此处以伪代码的形式展示接口的调用流程 // 初始化 // 此处的..表示相对路径，相对可执行文件所在的目录，例如，编译出来的可执行文件存放在out目录下，此处的..就表示out目录的上一级目录 const char *aclConfigPath = "../src/acl.json"; aclError ret = aclInit(aclConfigPath); // ...... // 去初始化 ret = aclFinalize(); ``` # 04 运行管理资源申请与释放 运行管理资源包括Device、Context、Stream、Event等，此处重点介绍Device、Context、Stream，其基本概念如下图所示 。 您需要按顺序依次申请如下运行管理资源：Device、Context、Stream，确保可以使用这些资源执行运算、管理任务。所有数据处理都结束后，需要按顺序依次释放运行管理资源：Stream、Context、Device。 在申请运行管理资源时，Context、Stream支持隐式创建和显式创建两种申请方式。 ``` // 此处以伪代码的形式展示接口的调用流程，以显式创建Context和Stream为例 // 运行管理资源申请 // 1、指定运算的Device aclError ret = aclrtSetDevice(deviceId); // 2、显式创建一个Context，用于管理Stream对象 ret = aclrtCreateContext(context, deviceId); // 3、显式创建一个Stream，用于维护一些异步操作的执行顺序，确保按照应用程序中的代码调用顺序执行任务 ret = aclrtCreateStream(stream); //...... // 运行管理资源释放 // 1、销毁Stream ret = aclrtDestroyStream(stream); // 2、销毁Context ret = aclrtDestroyContext(context); // 3、释放Device资源 ret = aclrtResetDevice(deviceId); //...... ``` # 05 媒体数据处理 如果模型对输入图片的宽高要求与用户提供的源图不一致，AscendCL提供了媒体数据处理的接口，可实现抠图、缩放、格式转换、视频或图片的编解码等，将源图裁剪成符合模型的要求。后续期刊中会展开说明这个功能，本期着重介绍模型推理的部分，以输入图片满足模型的要求为例。 # 06 模型加载 模型推理场景下，必须要有适配昇腾AI处理器的离线模型（*.om文件），我们可以使用ATC（Ascend Tensor Compiler）来构建模型。如果模型推理涉及动态Batch、动态分辨率等特性，需在构建模型增加相关配置。关于如何使用ATC来构建模型，请参见“昇腾文档中心 [了解详情](https://www.hiascend.com/zh/document)”。 有了模型，就可以开始加载了，当前AscendCL支持以下几种方式加载模型： -  从*.om文件中加载模型数据，由AscendCL管理内存 -从*.om文件中加载模型数据，由用户自行管理内存 -从内存中加载模型数据，由AscendCL管理内存 -从内存中加载模型数据，由用户自行管理内存 由用户自行管理内存时，需关注工作内存、权值内存。工作内存用于存放模型执行过程中的临时数据，权值内存用于存放权值数据。这个时候，是不是有疑问了，我怎么知道工作内存、权值内存需要多大？不用担心，AscendCL不仅提供了加载模型的接口，同时也提供了“根据模型文件获取模型执行时所需的工作内存和权值内存大小”的接口，方便用户使用 。 ``` // 此处以伪代码的形式展示接口的调用流程，以“由用户管理内存”为例 // 1.根据om模型文件获取模型执行时所需的权值内存大小、工作内存大小。 aclError ret = aclmdlQuerySize(omModelPath, &modelWorkSize, &modelWeightSize); // 2.根据工作内存大小，申请Device上模型执行的工作内存。 ret = aclrtMalloc(&modelWorkPtr, modelWorkSize, ACL_MEM_MALLOC_HUGE_FIRST); // 3.根据权值内存的大小，申请Device上模型执行的权值内存。 ret = aclrtMalloc(&modelWeightPtr, modelWeightSize, ACL_MEM_MALLOC_HUGE_FIRST); // 4.以从om模型文件加载模型、由用户管理工作内存和权值内存为例 // 模型加载成功，返回标识模型的ID。 ret = aclmdlLoadFromFileWithMem(modelPath, &modelId, modelWorkPtr, modelWorkSize, modelWeightPtr, modelWeightSize); ``` # 07 模型执行 在调用AscendCL接口进行模型推理时，模型推理有输入、输出数据，输入、输出数据需要按照AscendCL规定的数据类型存放。相关数据类型如下： -  使用aclmdlDesc类型的数据描述模型基本信息（例如输入/输出的个数、名称、数据类型、Format、维度信息等）。 模型加载成功后，用户可根据模型的ID，调用该数据类型下的操作接口获取该模型的描述信息，进而从模型的描述信息中获取模型输入/输出的个数、内存大小、维度信息、Format、数据类型等信息。 -使用aclDataBuffer类型的数据来描述每个输入/输出的内存地址、内存大小。 调用aclDataBuffer类型下的操作接口获取内存地址、内存大小等，便于向内存中存放输入数据、获取输出数据。 -使用aclmdlDataset类型的数据描述模型的输入/输出数据。 模型可能存在多个输入、多个输出，调用aclmdlDataset类型的操作接口添加多个aclDataBuffer类型的数据。 ``` // 此处以伪代码的形式展示如何准备模型的输入、输出数据结构 // 1.根据加载成功的模型的ID，获取该模型的描述信息 aclmdlDesc *modelDesc = aclmdlCreateDesc(); aclError ret = aclmdlGetDesc(modelDesc, modelId); // 2.准备模型推理的输入数据结构 // (1)申请输入内存 // 当前示例代码中的模型只有一个输入，所以index为0，如果模型有多个输入，则需要先调用aclmdlGetNumInputs接口获取模型输入的数量 void *modelInputBuffer = nullptr; size_t modelInputSize = aclmdlGetInputSizeByIndex(modelDesc, 0); ret = aclrtMalloc(&modelInputBuffer, modelInputSize,ACL_MEM_MALLOC_NORMAL_ONLY); // (2)准备模型的输入数据结构 // 创建aclmdlDataset类型的数据，描述模型推理的输入 aclmdlDataset *input = aclmdlCreateDataset(); aclDataBuffer *inputData = aclCreateDataBuffer(modelInputBuffer, modelInputSize); ret = aclmdlAddDatasetBuffer(input, inputData); // 3.准备模型推理的输出数据结构 // (1)创建aclmdlDataset类型的数据output，描述模型推理的输出 aclmdlDataset *output = aclmdlCreateDataset(); // (2)获取模型的输出个数. size_t outputSize = aclmdlGetNumOutputs(modelDesc); // (3)循环为每个输出申请内存，并将每个输出添加到aclmdlDataset类型的数据中 for (size_t i = 0; i < outputSize; ++i) { size_t buffer_size = aclmdlGetOutputSizeByIndex(modelDesc, i); void *outputBuffer = nullptr; ret = aclrtMalloc(&outputBuffer, buffer_size, ACL_MEM_MALLOC_NORMAL_ONLY); aclDataBuffer *outputData = aclCreateDataBuffer(outputBuffer, buffer_size); ret = aclmdlAddDatasetBuffer(output, outputData); } ``` 准备好模型执行所需的输入和输出数据类型、且存放好模型执行的输入数据后，可以执行模型推理了，如果模型的输入涉及动态Batch、动态分辨率等特性，则在模型执行前，还需要调用AscendCL接口告诉模型本次执行时需要用的Batch数、分辨率等。 当前AscendCL支持同步模型执行、异步模型执行两种方式，这里说的同步、异步是站在调用者和执行者的角度。 -  若调用模型执行的接口后需等待推理完成再返回，则表示模型执行是同步的。当用户调用同步模型执行接口后，可直接从该接口的输出参数中获取模型执行的结果数据，如果需要推理的输入数据量很大，同步模型执行时，需要等所有数据都处理完成后，才能获取推理的结果数据。 -  若调用模型执行的接口后不等待推理完成完成再返回，则表示模型执行是异步的。当用户调用异步模型执行接口时，需指定Stream（ Stream用于维护一些异步操作的执行顺序，确保按照应用程序中的代码调用顺序在Device上执行），另外，还需调用aclrtSynchronizeStream接口阻塞程序运行，直到指定Stream中的所有任务都完成，才可以获取推理的结果数据。如果需要推理的输入数据量很大，异步模型执行时，AscendCL提供了Callback机制，触发回调函数，在指定时间内一旦有推理的结果数据，就获取出来，达到分批获取推理结果数据的目的，提高效率。 ``` // 此处以伪代码的形式展示同步模型执行的过程 // 1. 由用户自行编码，将模型所需的输入数据读入内存 // 如果模型推理之前先进行媒体数据处理，则此处可以将媒体数据处理后的输出内容作为模型推理的输入内存， // ...... // 2. 执行模型推理 // modelId表示模型ID，在模型加载成功后，会返回标识模型的ID // input、output分别表示模型推理的输入、输出数据，在准备模型推理的输入、输出数据结构时已定义 aclError ret = aclmdlExecute(modelId, input, output) // 3. 处理模型推理的输出数据 for (size_t i = 0; i < aclmdlGetDatasetNumBuffers(output); ++i) { //获取每个输出的内存地址和内存大小 aclDataBuffer* dataBuffer = aclmdlGetDatasetBuffer(output, i); void* data = aclGetDataBufferAddr(dataBuffer); size_t len = aclGetDataBufferSizeV2(dataBuffer); //获取到输出数据后，由用户自行编码，处理输出数据 //...... } // 4.销毁模型输入、输出数据结构 // 释放输入资源，包括数据结构和内存 (void)aclDestroyDataBuffer(dataBuffer); (void)aclmdlDestroyDataset(mdlDataset); // 5.释放内存资源，防止内存泄露 // ...... ``` 推理结束后，如果需要获取并进一步处理推理结果数据，则由用户自行编码实现。最后，别忘了，我们还要销毁aclmdlDataset、aclDataBuffer等数据类型，释放相关内存，防止内存泄露。 # 08 模型卸载 在模型推理结束后，还需要通过aclmdlUnload接口卸载模型，并销毁aclmdlDesc类型的模型描述信息、释放模型运行的工作内存和权值内存。 ``` // 此处以伪代码的形式展示模型卸载的过程 // 1. 卸载模型 aclError ret = aclmdlUnload(modelId); // 2. 释放模型描述信息 (void)aclmdlDestroyDesc(modelDesc); // 3. 释放模型运行的工作内存和权值内存 (void)aclrtFree(modelWorkPtr); (void)aclrtFree(modelWeightPtr); ``` 以上就是基于AscendCL开发基础推理应用的相关知识点，您也可以在“昇腾社区在线课程 [了解详情](https://www.hiascend.com/zh/edu/courses)”板块学习视频课程，学习过程中的任何疑问，都可以在“昇腾论坛 [了解详情](https://www.hiascend.com/forum)”互动交流！ # 09 编译及运行应用 此处我们以一个“基于Caffe ResNet-50网络实现图片分类”的应用为例，来说明编译运行应用的基本步骤以及运行应用后如何查看图片所属分类。编译运行应用依赖CANN软件，因此您需要先根据对应版本的安装指南安装CANN软件。 您可以参考视频3分钟体验下编译运行：https://v.qq.com/x/page/w3271yntt45.html [了解详情](https://v.qq.com/x/page/w3271yntt45.html) 体验完了，是不是意犹未尽，想自己操作一把呢，来吧！您可以从昇腾CANN样例仓 [了解详情](https://gitee.com/ascend/samples/)获取该样例以及详细的使用说明。 # 10 更多介绍 [1]昇腾文档中心：https://www.hiascend.com/zh/document [了解详情](https://www.hiascend.com/zh/document) [2]昇腾社区在线课程：https://www.hiascend.com/zh/edu/courses [了解详情](https://www.hiascend.com/zh/edu/courses) [3]昇腾论坛：https://www.hiascend.com/forum [了解详情](https://www.hiascend.com/forum) 本页内容