Skip to main content

aclmdlSetAIPPByInputIndex

aclmdlSetInputAIPP​

函数功能​

动态AIPP场景下，根据指定的动态AIPP输入的输入index，设置模型推理时的AIPP参数值，同步接口。

动态AIPP支持的几种操作的计算方式及其计算顺序如下：抠图->色域转换->缩放（当前版本不支持缩放）->减均值/归一化->padding。

约束说明​

  • 经过动态AIPP处理后的图像的宽、高必须与原始模型中输入Shape中的宽、高保持一致。

  • 多Batch场景下，根据每个Batch的配置计算出动态AIPP后输出图片的宽、高，经过动态AIPP后每个Batch的输出图片宽、高必须是一致的。计算输出图片宽、高的计算公式如表1所示。

  • 抠图或者缩放或者padding之后，对图片宽、高的校验规则如下，其中，aippOutputW、aippOutputH分别表示AIPP输出图片的宽、高，其它参数是aclmdlSetAIPPSrcImageSize、aclmdlSetAIPPScfParams、aclmdlSetAIPPCropParams、aclmdlSetAIPPPaddingParams接口的入参：

    表1 输出图片宽、高计算公式

    抠图缩放补边（padding）动态AIPP输出图片的宽、高
    否否否aippOutputW=srcImageSizeW，aippOutputH=srcImageSizeH
    是否否aippOutputW=cropSizeW，aippOutputH=cropSizeH
    是是否aippOutputW=scfOutputSizeW，aippOutputH=scfOutputSizeH
    是否是aippOutputW=cropSizeW + paddingSizeLeft + paddingSizeRight，aippOutputH=cropSizeH + paddingSizeTop + paddingSizeBottom
    否否是aippOutputW=srcImageSizeW + paddingSizeLeft + paddingSizeRight，aippOutputH=srcImageSizeH + paddingSizeTop + paddingSizeBottom
    否是是aippOutputW=scfOutputSizeW + paddingSizeLeft + paddingSizeRight，aippOutputH=scfOutputSizeH + paddingSizeTop + paddingSizeBottom
    否是否aippOutputW=scfOutputSizeW，aippOutputH=scfOutputSizeH
    是是是aippOutputW=scfOutputSizeW + paddingSizeLeft + paddingSizeRight，aippOutputH=scfOutputSizeH + paddingSizeTop + paddingSizeBottom

函数原型​

aclError aclmdlSetInputAIPP(uint32_t modelId, aclmdlDataset *dataset, size_t index, const aclmdlAIPP *aippParmsSet)

参数说明​

参数名输入/输出说明
modelId输入模型的ID。 调用aclmdlLoadFromFile接口/aclmdlLoadFromMem接口/aclmdlLoadFromFileWithMem接口/aclmdlLoadFromMemWithMem接口加载模型成功后，会返回模型ID。
dataset输入模型推理的输入数据的指针。 使用aclmdlDataset类型的数据描述模型推理时的输入数据，输入的内存地址、内存大小用aclDataBuffer类型的数据来描述。
index输入标识动态AIPP输入的输入index。 多个动态AIPP输入的场景下，用户可调用aclmdlGetAippType接口获取指定模型输入所关联的动态AIPP输入的输入index。 为保证向前兼容，如果明确只有一个动态AIPP输入，可调用aclmdlGetInputIndexByName接口获取，输入名称固定为ACL_DYNAMIC_AIPP_NAME。
aippParmsSet输入动态AIPP参数对象的指针。 提前调用aclmdlCreateAIPP接口创建aclmdlAIPP类型的数据。

返回值说明​

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

参考资源​

接口调用流程及示例，参见模型动态AIPP推理。

父主题： 模型加载与执行

aclmdlGetFirstAippInfo​

函数功能​

获取模型AIPP（包括静态AIPP和动态AIPP）的配置信息。

AIPP支持的几种操作的计算方式及其计算顺序如下：抠图->色域转换->缩放（当前版本不支持缩放）->减均值/归一化->padding。

约束说明​

如果使用本接口获取模型中动态AIPP的信息，只能获取aclAippInfo结构体中如下参数的值：srcFormat、srcDatatype、srcDimNum、shapeCount、outDims，其它参数值无效。

函数原型​

aclError aclmdlGetFirstAippInfo(uint32_t modelId, size_t index, aclAippInfo *aippInfo)

参数说明​

参数名输入/输出说明
modelId输入模型ID。 调用aclmdlLoadFromFile接口/aclmdlLoadFromMem接口/aclmdlLoadFromFileWithMem接口/aclmdlLoadFromMemWithMem接口加载模型成功后，会返回模型ID。
index输入模型中输入的index。
aippInfo输出获取指定输入上AIPP配置信息的指针。 详细说明及参数解释，请参考《ATC工具使用指南》。

返回值说明​

返回0表示成功，返回非0表示失败。

父主题： 模型加载与执行

aclmdlGetAippType​

函数功能​

获取指定模型的指定输入所支持的AIPP类型（动态AIPP或静态AIPP）及动态AIPP输入对应的index值。

函数原型​

aclError aclmdlGetAippType(uint32_t modelId, size_t index, aclmdlInputAippType *type, size_t *dynamicAttachedDataIndex)

参数说明​

参数名输入/输出说明
modelId输入指定模型的ID。 调用aclmdlLoadFromFile接口/aclmdlLoadFromMem接口/aclmdlLoadFromFileWithMem接口/aclmdlLoadFromMemWithMem接口加载模型成功后，会返回模型ID。
index输入模型中输入的index。
type输出指定模型输入的AIPP类型的指针。
dynamicAttachedDataIndex输出当type不为ACL_DATA_WITH_DYNAMIC_AIPP时，该值返回0xFFFFFFFF，表示无效。 当type为ACL_DATA_WITH_DYNAMIC_AIPP时，该值返回动态AIPP输入（用于配置动态AIPP参数）的index。

返回值说明​

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

参考资源​

接口调用示例，参见动态AIPP（多个动态AIPP输入）。

父主题： 模型加载与执行

aclmdlSetAIPPByInputIndex​

函数功能​

动态AIPP场景下，根据指定的模型输入的输入index，设置模型推理时的AIPP参数值，同步接口。

动态AIPP支持的几种操作的计算方式及其计算顺序如下：抠图->色域转换->缩放（当前版本不支持缩放）->减均值/归一化->padding。

约束说明​

  • 经过动态AIPP处理后的图像的宽、高必须与原始模型中输入Shape中的宽、高保持一致。

  • 多Batch场景下，根据每个Batch的配置计算出动态AIPP后输出图片的宽、高，经过动态AIPP后每个Batch的输出图片宽、高必须是一致的。计算输出图片宽、高的计算公式如表1所示。

  • 抠图或者缩放或者padding之后，对图片宽、高的校验规则如下，其中，aippOutputW、aippOutputH分别表示AIPP输出图片的宽、高，其它参数是aclmdlSetAIPPSrcImageSize、aclmdlSetAIPPScfParams、aclmdlSetAIPPCropParams、aclmdlSetAIPPPaddingParams接口的入参：

    表1 输出图片宽、高计算公式

    抠图缩放补边（padding）动态AIPP输出图片的宽、高
    否否否aippOutputW=srcImageSizeW，aippOutputH=srcImageSizeH
    是否否aippOutputW=cropSizeW，aippOutputH=cropSizeH
    是是否aippOutputW=scfOutputSizeW，aippOutputH=scfOutputSizeH
    是否是aippOutputW=cropSizeW + paddingSizeLeft + paddingSizeRight，aippOutputH=cropSizeH + paddingSizeTop + paddingSizeBottom
    否否是aippOutputW=srcImageSizeW + paddingSizeLeft + paddingSizeRight，aippOutputH=srcImageSizeH + paddingSizeTop + paddingSizeBottom
    否是是aippOutputW=scfOutputSizeW + paddingSizeLeft + paddingSizeRight，aippOutputH=scfOutputSizeH + paddingSizeTop + paddingSizeBottom
    否是否aippOutputW=scfOutputSizeW，aippOutputH=scfOutputSizeH
    是是是aippOutputW=scfOutputSizeW + paddingSizeLeft + paddingSizeRight，aippOutputH=scfOutputSizeH + paddingSizeTop + paddingSizeBottom

函数原型​

aclError aclmdlSetAIPPByInputIndex(uint32_t modelId, aclmdlDataset *dataset, size_t index, const aclmdlAIPP *aippParmsSet)

参数说明​

参数名输入/输出说明
modelId输入模型的ID。 调用aclmdlLoadFromFile接口/aclmdlLoadFromMem接口/aclmdlLoadFromFileWithMem接口/aclmdlLoadFromMemWithMem接口加载模型成功后，会返回模型ID。
dataset输入模型推理的输入数据的指针。 使用aclmdlDataset类型的数据描述模型推理时的输入数据，输入的内存地址、内存大小用aclDataBuffer类型的数据来描述。
index输入表示在第几个输入上设置动态AIPP参数。如果该输入没有关联动态AIPP输入，则返回报错。 可调用aclmdlGetAippType查询指定模型的指定输入是否有关联的动态AIPP输入，若有，则本接口的index参数值与aclmdlGetAippType接口的index参数值保持一致；若无，则无需设置动态AIPP参数。
aippParmsSet输入动态AIPP参数对象的指针。 提前调用aclmdlCreateAIPP接口创建aclmdlAIPP类型的数据。

返回值说明​

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

参考资源​

接口调用示例，参见动态AIPP（多个动态AIPP输入）。

父主题： 模型加载与执行

aclmdlSetInputDynamicDims​

函数功能​

如果模型输入的Shape是动态的、输入数据Format为ND格式（ND表示支持任意格式，N<=4），在模型执行前调用本接口设置模型推理时具体维度的值。

函数原型​

aclError aclmdlSetInputDynamicDims(uint32_t modelId, aclmdlDataset *dataset, size_t index, const aclmdlIODims *dims)

参数说明​

参数名输入/输出说明
modelId输入模型ID。 调用aclmdlLoadFromFile接口/aclmdlLoadFromMem接口/aclmdlLoadFromFileWithMem接口/aclmdlLoadFromMemWithMem接口加载模型成功后，会返回模型ID。
dataset输入&输出模型推理的输入数据的指针。 使用aclmdlDataset类型的数据描述模型推理时的输入数据，输入的内存地址、内存大小用aclDataBuffer类型的数据来描述。
index输入标识动态维度的输入index。 需调用aclmdlGetInputIndexByName接口获取，输入名称固定为ACL_DYNAMIC_TENSOR_NAME。
dims输入具体某一档上的所有维度信息的指针。 此处设置的动态维度的值只能是模型构建时设置的档位中的某一档。 如果不清楚模型构建时的动态维度档位，也可以调用aclmdlGetInputDynamicDims接口获取指定模型支持的动态维度档位数以及每一档中的值。 **例如：**使用ATC工具进行模型转换时，input_shape="data:1,1,40,-1;label:1,-1;mask:-1,-1" ，dynamic_dims="20,20,1,1; 40,40,2,2; 80,60,4,4"，若输入数据的真实维度为（1,1,40,20,1,20,1,1），则dims结构体信息的填充示例如下（name暂不使用）： dims.dimCount = 8 dims.dims[0] = 1 dims.dims[1] = 1 dims.dims[2] = 40 dims.dims[3] = 20 dims.dims[4] = 1 dims.dims[5] = 20 dims.dims[6] = 1 dims.dims[7] = 1

返回值说明​

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

参考资源​

接口调用流程及示例，参见模型动态Shape输入推理。

父主题： 模型加载与执行

aclmdlCreateAndGetOpDesc​

函数功能​

获取指定算子的描述信息，包括算子名、输入tensor描述、输出tensor描述，如果查询不到指定算子，则返回报错。该接口不支持动态Shape场景。同步接口。

约束说明​

使用场景****举例：执行整网模型推理时，如果产生AI Core报错，可以调用本接口获取报错算子的描述信息，再做进一步错误排查。

推荐的接口调用顺序如下：

  1. 定义并实现异常回调函数fn(aclrtExceptionInfoCallback类型)，回调函数原型请参见aclrtSetExceptionInfoCallback 。

    实现回调函数的关键步骤如下：

    1. 在异常回调函数fn内调用aclrtGetDeviceIdFromExceptionInfo、aclrtGetStreamIdFromExceptionInfo、aclrtGetTaskIdFromExceptionInfo接口分别获取Device ID、Stream ID、Task ID。

    2. 在异常回调函数fn内调用aclmdlCreateAndGetOpDesc接口获取算子的描述信息。

    3. 在异常回调函数fn内调用aclGetTensorDescByIndex接口获取指定算子输入/输出的tensor描述。

    4. 在异常回调函数fn内如下接口获取tensor描述中的数据，进行进一步分析。

      例如，调用aclGetTensorDescAddress接口获取tensor数据的内存地址（用户可从该内存地址中获取tensor数据）、调用aclGetTensorDescType接口获取tensor描述中的数据类型、调用aclGetTensorDescFormat接口获取tensor描述中的Format、调用aclGetTensorDescNumDims接口获取tensor描述中的Shape维度个数、调用aclGetTensorDescDimV2接口获取Shape中指定维度的大小。

  2. 调用aclrtSetExceptionInfoCallback接口设置异常回调函数。

  3. 执行模型推理。

    如果存在AI Core报错，则触发回调函数fn，获取算子的信息，进行进一步分析。

函数原型​

aclError aclmdlCreateAndGetOpDesc(uint32_t deviceId, uint32_t streamId, uint32_t taskId, char *opName, size_t opNameLen, aclTensorDesc **inputDesc, size_t *numInputs, aclTensorDesc **outputDesc, size_t *numOutputs)

参数说明​

参数名输入/输出说明
deviceId输入Device ID。 调用aclrtGetDeviceIdFromExceptionInfo接口获取异常信息中的Device ID，作为本接口的输入。
streamId输入Stream ID。 调用aclrtGetStreamIdFromExceptionInfo接口获取异常信息中的Stream ID，作为本接口的输入。
taskId输入Task ID。 调用aclrtGetTaskIdFromExceptionInfo接口获取异常信息中的Task ID，作为本接口的输入。
opName输出算子名称字符串的指针。
opNameLen输入算子名称字符串长度。 若用户指定的长度比实际算子名称的长度短，则返回报错。
inputDesc输出算子所有输入的tensor描述的指针，指向一块连续内存的首地址。
numInputs输出输入个数的指针。
outputDesc输出算子所有输出的tensor描述的指针，指向一块连续内存的首地址。
numOutputs输出输出个数的指针。

返回值说明​

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

参考资源​

接口调用示例，参见AI Core异常信息获取。

父主题： 模型加载与执行

aclmdlInitDump​

函数功能​

Dump初始化。同步接口。

约束说明​

函数原型​

aclError aclmdlInitDump()

参数说明​

无

返回值说明​

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

相关接口​

AscendCL还提供了aclInit接口，在AscendCL初始化阶段，通过*.json文件传入Dump配置信息，运行应用后获取Dump数据的方式。该种方式，一个进程内，只能调用一次aclInit接口，如果要修改Dump配置信息，需修改*.json文件中的配置。

父主题： 模型加载与执行

在线提单