Skip to main content

aclmdlExecute

aclmdlLoadFromFileWithQ​

函数功能​

从文件加载离线模型数据（适配昇腾AI处理器的离线模型），模型的输入、输出数据都存放在队列中，同步接口。

系统完成模型加载后，返回的模型ID，作为后续操作时用于识别模型的标志。

约束说明​

  • 本接口只支持加载固定Shape输入的模型。
  • 模型加载、模型执行、模型卸载的操作必须在同一个Context下（关于Context的创建请参见aclrtCreateContext）。

函数原型​

aclError aclmdlLoadFromFileWithQ(const char *modelPath, uint32_t *modelId, const uint32_t *inputQ, size_t inputQNum, const uint32_t *outputQ, size_t outputQNum)

参数说明​

参数名输入/输出说明
modelPath输入离线模型文件路径的指针，路径中包含文件名。运行程序（APP）的用户需要对该存储路径有访问权限。 此处的离线模型文件是适配昇腾AI处理器的离线模型，即*.om文件。 （说明：关于如何获取om文件，请参见 《 ATC工具使用指南 》 。 对om模型文件大小有限制的场景下，如果使用ATC工具生成om文件时，将--external_weight参数设置为1（1表示将原始网络中的Const/Constant节点的权重保存在单独的文件中，且该文件保存在与om文件同级的weight目录下），那么在使用本接口加载om文件时，需将weight目录与om文件放在同级目录下，这时AscendCL会自行到weight目录下查找权重文件，否则可能会导致单独的权重文件加载不成功。）
modelId输出模型ID的指针。 系统成功加载模型后会返回的模型ID。
inputQ输入队列ID的指针，一个模型的输入对应一个队列ID。
inputQNum输入输入队列大小。
outputQ输入队列ID的指针，一个模型的输出对应一个队列ID。
outputQNum输入输出队列大小。

返回值说明​

返回0表示成功，返回其它值表示失败。

相关接口​

当前AscendCL还提供了aclmdlSetConfigOpt接口、aclmdlLoadWithConfig接口来实现模型加载，通过配置对象中的属性来区分，在加载模型时是从文件加载，还是从内存加载，以及内存是由系统内部管理，还是由用户管理。

父主题： 模型加载与执行

aclmdlLoadFromMemWithQ​

函数功能​

从内存加载离线模型数据（适配昇腾AI处理器的离线模型），模型的输入、输出数据都存放在队列中，同步接口。

系统完成模型加载后，返回的模型ID，作为后续操作时用于识别模型的标志。

约束说明​

  • 本接口只支持加载固定Shape输入的模型。
  • 模型加载、模型执行、模型卸载的操作必须在同一个Context下（关于Context的创建请参见aclrtCreateContext）。

函数原型​

aclError aclmdlLoadFromMemWithQ(const void *model, size_t modelSize, uint32_t *modelId, const uint32_t *inputQ, size_t inputQNum, const uint32_t *outputQ, size_t outputQNum)

参数说明​

参数名输入/输出说明
model输入存放模型数据的内存地址指针。
modelSize输入内存中的模型数据长度，单位Byte。
modelId输出模型ID的指针。 系统成功加载模型后会返回的模型ID。
inputQ输入队列ID的指针，一个模型的输入对应一个队列ID。
inputQNum输入输入队列大小。
outputQ输入队列ID的指针，一个模型的输出对应一个队列ID。
outputQNum输入输出队列大小。

返回值说明​

返回0表示成功，返回其它值表示失败。

相关接口​

当前AscendCL还提供了aclmdlSetConfigOpt接口、aclmdlLoadWithConfig接口来实现模型加载，通过配置对象中的属性来区分，在加载模型时是从文件加载，还是从内存加载，以及内存是由系统内部管理，还是由用户管理。

父主题： 模型加载与执行

aclmdlExecute​

函数功能​

执行模型推理，直到返回推理结果，同步接口。

约束说明​

  • 若由于业务需求，必须在多线程中使用同一个modelId，则用户线程间需加锁，保证刷新输入输出内存、保证执行是连续操作，例如：

    // 线程A的接口调用顺序：
    lock(handle1) -> aclrtMemcpy刷新输入输出内存 -> alcmdlExecute执行推理 -> unlock(handle1)

    // 线程B的接口调用顺序：
    lock(handle1) -> aclrtMemcpy刷新输入输出内存 -> alcmdlExecute执行推理 -> unlock(handle1)

  • 模型加载、模型执行、模型卸载的操作必须在同一个Context下（关于Context的创建请参见aclrtCreateContext）。

  • 存放模型输入/输出数据的Device内存，可以使用以下接口申请：aclrtMalloc、或aclrtMallocHost、或aclrtMallocCached接口、或acldvppMalloc接口、或hi_mpi_dvpp_malloc接口。

    其中：

    • aclrtMallocHost接口支持在RC模式下申请Device内存。
    • acldvppMalloc接口和hi_mpi_dvpp_malloc接口是媒体数据处理功能专用的内存申请接口，一般从性能角度，为了减少拷贝，媒体数据处理的输出作为模型推理的输入，实现内存复用。
    • 由于硬件对内存有对齐和补齐要求，若用户使用这些接口申请大块内存并自行划分、管理内存时，需满足对应接口的对齐和补齐约束，请参见内存二次分配管理。

函数原型​

aclError aclmdlExecute(uint32_t modelId, const aclmdlDataset *input, aclmdlDataset *output)

参数说明​

参数名输入/输出说明
modelId输入指定需要执行推理的模型的ID。 调用aclmdlLoadFromFile接口/aclmdlLoadFromMem接口/aclmdlLoadFromFileWithMem接口/aclmdlLoadFromMemWithMem接口加载模型成功后，会返回模型ID。
input输入模型推理的输入数据的指针。
output输出模型推理的输出数据的指针。

返回值说明​

返回0表示成功，返回其它值表示失败。

参考资源​

接口调用流程及示例代码，参见模型执行。

父主题： 模型加载与执行

aclmdlExecuteAsync​

函数功能​

执行模型推理，异步接口。

约束说明​

  • 对同一个modelId的模型，不能调用aclmdlExecuteAsync接口执行多Stream并发场景下的模型推理。错误示例如下，该示例中，两次aclmdlExecuteAsync接口多Stream并发执行，导致报错：

    //......
    aclmdlExecuteAsync(modelId1, input, output, stream1);
    aclmdlExecuteAsync(modelId1, input, output, stream2);
    aclrtSynchronizeStream(stream1);
    aclrtSynchronizeStream(stream2);
    //......

  • 若由于业务需求，必须在多线程中使用同一个modelId，则用户线程间需加锁，保证刷新输入输出内存、保证执行是连续操作，例如：

    // 线程A的接口调用顺序：
    lock(handle1) -> aclrtMemcpyAsync(stream1)刷新输入输出内存 -> aclmdlExecuteAsync(modelId1,stream1)执行推理 -> unlock(handle1)

    // 线程B的接口调用顺序：
    lock(handle1) -> aclrtMemcpyAsync(stream1)刷新输入输出内存 -> aclmdlExecuteAsync(modelId1,stream1)执行推理 -> unlock(handle1)

  • 模型加载、模型执行、模型卸载的操作必须在同一个Context下（关于Context的创建请参见aclrtCreateContext）。

  • 存放模型输入/输出数据的内存，可以使用以下接口申请：aclrtMalloc、或aclrtMallocHost、或aclrtMallocCached接口、或acldvppMalloc接口、或hi_mpi_dvpp_malloc接口。

    其中，acldvppMalloc接口和hi_mpi_dvpp_malloc接口是媒体数据处理功能专用的内存申请接口，一般从性能角度，为了减少拷贝，媒体数据处理的输出作为模型推理的输入，实现内存复用。

    由于硬件对内存有对齐和补齐要求，若用户使用这些接口申请大块内存并自行划分、管理内存时，需满足对应接口的对齐和补齐约束，请参见内存二次分配管理。

函数原型​

aclError aclmdlExecuteAsync(uint32_t modelId, const aclmdlDataset *input, aclmdlDataset *output, aclrtStream stream)

参数说明​

参数名输入/输出说明
modelId输入指定需要执行推理的模型的ID。 调用aclmdlLoadFromFile接口/aclmdlLoadFromMem接口/aclmdlLoadFromFileWithMem接口/aclmdlLoadFromMemWithMem接口加载模型成功后，会返回模型ID。
input输入模型推理的输入数据的指针。
output输出模型推理的输出数据的指针。
stream输入指定Stream。

返回值说明​

返回0表示成功，返回其它值表示失败。

参考资源​

接口调用流程及示例代码，参见异步模型推理。

父主题： 模型加载与执行

aclmdlSetExecConfigOpt​

函数功能​

设置模型执行的配置对象中的各属性的取值。

约束说明​

本接口需要配合其它接口一起使用，实现模型执行，接口调用顺序如下：

  1. 调用aclmdlCreateExecConfigHandle接口创建模型执行的配置对象。
  2. 多次调用aclmdlSetExecConfigOpt接口设置配置对象中每个属性的值。
  3. 调用aclmdlExecuteV2或aclmdlExecuteAsyncV2接口指定模型执行时需要的配置信息，并进行模型执行。
  4. 模型加载成功后，调用aclmdlDestroyExecConfigHandle接口销毁。

函数原型​

aclError aclmdlSetExecConfigOpt(aclmdlExecConfigHandle *handle, aclmdlExecConfigAttr attr, const void *attrValue, size_t valueSize)

参数说明​

参数名输入/输出说明
handle输出模型执行的配置对象的指针。需提前调用aclmdlCreateExecConfigHandle接口创建该对象。
attr输入指定需设置的属性。
attrValue输入指向属性值的指针，attr对应的属性取值。 如果属性值本身是指针，则传入该指针的地址。
valueSize输入attrValue部分的数据长度。 用户可使用C/C++标准库的函数sizeof(*attrValue)查询数据长度。

返回值说明​

返回0表示成功，返回其它值表示失败。

父主题： 模型加载与执行

aclmdlExecuteV2​

函数功能​

根据aclmdlSetExecConfigOpt接口所配置的属性，执行模型推理，直到返回推理结果。该接口是在aclmdlExecute接口基础上进行了增强，支持在执行模型推理时控制Stream任务的超时时间、Event任务的超时时间。

约束说明​

  • 本接口需要配合其它接口一起使用，实现模型执行，接口调用顺序如下：
    1. 调用aclmdlCreateExecConfigHandle接口创建模型执行的配置对象。
    2. 多次调用aclmdlSetExecConfigOpt接口设置配置对象中每个属性的值。
    3. 调用aclmdlExecuteV2接口指定模型执行时需要的配置信息，并进行模型执行。
    4. 模型加载成功后，调用aclmdlDestroyExecConfigHandle接口销毁。
  • 其他约束与aclmdlExecute一致。

函数原型​

aclError aclmdlExecuteV2(uint32_t modelId, const aclmdlDataset *input, aclmdlDataset *output, aclrtStream stream，const aclmdlExecConfigHandle* handle)

参数说明​

参数名输入/输出说明
modelId输入指定需要执行推理的模型的ID。 调用aclmdlLoadFromFile接口/aclmdlLoadFromMem接口/aclmdlLoadFromFileWithMem接口/aclmdlLoadFromMemWithMem接口加载模型成功后，会返回模型ID。
input输入模型推理的输入数据的指针。
output输出模型推理的输出数据的指针。
stream输入指定Stream。
handle输入模型执行的配置对象的指针。与aclmdlSetExecConfigOpt中的handle保持一致。

返回值说明​

返回0表示成功，返回其它值表示失败。

父主题： 模型加载与执行

在线提单