跳到主要内容

aclmdlSetExecConfigOpt

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表示成功，返回其它值表示失败。

父主题： 模型加载与执行

aclmdlExecuteAsyncV2​

函数功能​

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

Atlas 200/500 A2推理产品不支持该接口。

约束说明​

函数原型​

aclError aclmdlExecuteAsyncV2(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表示成功，返回其它值表示失败。

父主题： 模型加载与执行

aclmdlUnload​

函数功能​

系统完成模型推理后，可调用该接口卸载模型，释放资源，同步接口。

约束说明​

  • 在调用aclmdlUnload接口卸载指定模型时，需确保其它接口没有正在使用该模型。
  • 模型加载、模型执行、模型卸载的操作必须在同一个Context下（关于Context的创建请参见aclrtCreateContext）。

函数原型​

aclError aclmdlUnload(uint32_t modelId)

参数说明​

参数名输入/输出说明
modelId输入需卸载的模型的ID。

返回值说明​

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

参考资源​

接口调用流程，参见AscendCL接口调用流程。

父主题： 模型加载与执行

在线提单