aclmdlGetInputDims
aclmdlGetInputSizeByIndex
函数功能
根据模型描述信息获取指定输入的大小,单位为Byte。同步接口。
约束说明
如果模型输入的Shape是动态的、且维度的取值为-1(表示此维度可以使用>=1的任意取值),则通过本接口获取的大小为0,用户需根据实际数据占用的内存大小来申请内存。
函数原型
size_t aclmdlGetInputSizeByIndex(aclmdlDesc *modelDesc, size_t index)
参数说明
| 参数名 | 输入/输出 | 说明 |
|---|---|---|
| modelDesc | 输入 | aclmdlDesc类型的指针。 需提前调用aclmdlCreateDesc接口创建aclmdlDesc类型的数据。 |
| index | 输入 | 指定获取第几个输入的大小,index值从0开始。 |
返回值说明
针对动态Batch、动态分辨率(宽高)的场景,返回最大档位对应的输入的大小;静态场景下,返回指定输入的大小。单位是Byte。
父主题: aclmdlDesc
aclmdlGetOutputSizeByIndex
函数功能
根据模型描述信息获取指定输出的大小,单位为Byte。同步接口。
约束说明
如果通过本接口获取的大小为0,有可能是由于输出Shape的范围不确定,当前支持以下两种处理方式:
-
方式一:系统内部自行申请对应index的输出内存,节省内存,但内存数据使用结束后,需由用户释放内存,同时,系统内部申请内存时涉及内存拷贝,可能涉及性能损耗。
调用aclCreateDataBuffer接口创建存放对应index输出数据的aclDataBuffer类型时,可在data参数处传入nullptr,表示创建一个空的aclDataBuffer类型,然后在模型执行过程中,系统内部自行计算并申请该index输出的内存。
-
方式二:用户预估输出内存大小,并申请内存,由用户自行管理内存,但内存大小可能不够或超出,不够时系统会校验报错,超出时会浪费内存。
用户需先根据实际情况预估一块较大的输出内存,在模型执行过程中,系统会校验用户指定的输出内存大小是否符合要求,如果不符合要求,系统会返回报错,并在报错信息中提示具体需要多大的输出内存。您可以通过以下两种方式查看报错:
- 获取应用类日志,查看ERROR级别的报错,如何获取日志请参见《日志参考》。
- 在应用程序中调用aclGetRecentErrMsg接口获取报错。
函数原型
size_t aclmdlGetOutputSizeByIndex(aclmdlDesc *modelDesc, size_t index)
参数说明
| 参数名 | 输入/输出 | 说明 |
|---|---|---|
| modelDesc | 输入 | aclmdlDesc类型的指针。 需提前调用aclmdlCreateDesc接口创建aclmdlDesc类型的数据。 |
| index | 输入 | 指定获取第几个输出的大小,index值从0开始。 |
返回值说明
针对动态Batch、动态分辨率(宽高)的场景,返回最大档位对应的输出的大小;静态场景下,返回指定输出的大小。单位是Byte。
父主题: aclmdlDesc
aclmdlGetInputDims
函数功能
根据模型描述信息获取模型的输入tensor的维度信息。同步接口。
如果模型中含有静态AIPP配置信息,您可以根据实际需要选择aclmdlGetInputDims接口或aclmdlGetInputDimsV2接口查询维度信息,两者的区别在于:
- 通过aclmdlGetInputDims接口获取的维度信息,各维度的值与输入图像的各维度的值保持一致,详细规则如表1所示。
- 通过aclmdlGetInputDimsV2接口获取的维度信息,H维度的值 = 输入图像的H维度值*系数,不同图片格式下C维度的值不同,详细规则如aclmdlGetInputDimsV2接口处的表1所示,且各维度值相乘的结果值与通过aclmdlGetInputSizeByIndex接口获取的值保持一致。
函数原型
aclError aclmdlGetInputDims(const aclmdlDesc *modelDesc, size_t index, aclmdlIODims *dims)
参数说明
| 参数名 | 输入/输出 | 说明 |
|---|---|---|
| modelDesc | 输入 | aclmdlDesc类型的指针。 需提前调用aclmdlCreateDesc接口创建aclmdlDesc类型的数据。 |
| index | 输入 | 指定获取第几个输入的Dims,index值从0开始。 |
| dims | 输出 | 输入维度信息的指针。 针对动态Batch、动态分辨率(宽高)的场景,输入tensor的dims中batch size或宽高为-1,表示其动态可变。例如,输入tensor的format为NCHW,在动态Batch场景下,动态可变的输入tensor的dims为[-1,3,224,224];在动态分辨率场景下,动态可变的输入tensor的dims为[1,3,-1,-1]。举例中的斜体部分以实际情况为准。 若tensor的name长度大于127,则在输出的dims.name时,AscendCL会将tensor的name转换为“acl_modelId_${id}input${index}${随机字符串} ”格式(如果转换后的tensor的name与模型中已有的tensor的name冲突,则会在转换后的name尾部增加“${随机字符串} ”,否则不会增加随机字符串),并在转换后的name与原name之间建立映射关系,用户可调用aclmdlGetTensorRealName接口,传入转换后的name,获取原name(若向接口传入原name,则获取的还是原name);若tensor的name长度小于或等于127,则在输出的dims.name时,按tensor的name输出。 |
表1 静态AIPP场景下的维度定义规则
| 图像格式 | Format参考格式 | 维度定义规则 |
|---|---|---|
| YUV420SP_U8 | NHWC | n,h,w,c |
| XRGB8888_U8 | NHWC | n,h,w,c |
| RGB888_U8 | NHWC | n,h,w,c |
| YUV400_U8 | NHWC | n,h,w,c |
| ARGB8888_U8 | NHWC | n,h,w,c |
| YUYV_U8 | NHWC | n,h,w,c |
| YUV422SP_U8 | NHWC | n,h,w,c |
| AYUV444_U8 | NHWC | n,h,w,c |
返回值说明
返回0表示成功,返回非0表示失败。
父主题: aclmdlDesc
aclmdlGetInputDimsV2
函数功能
根据模型描述信息获取模型的输入tensor的维度信息。同步接口。
如果模型中含有静态AIPP配置信息,您可以根据实际需要选择aclmdlGetInputDims接口或aclmdlGetInputDimsV2接口查询维度信息,两者的区别在于:
- 通过aclmdlGetInputDims接口获取的维度信息,各维度的值与输入图像的各维度的值保持一致,详细规则如表1所示。
- 通过aclmdlGetInputDimsV2接口获取的维度信息,H维度的值 = 输入图像的H维度值*系数,不同图片格式下C维度的值不同,详细规则如aclmdlGetInputDimsV2接口处的表1所示,且各维度值相乘的结果值与通过aclmdlGetInputSizeByIndex接口获取的值保持一致。
函数原型
aclError aclmdlGetInputDimsV2(const aclmdlDesc *modelDesc, size_t index, aclmdlIODims *dims)
参数说明
| 参数名 | 输入/输出 | 说明 |
|---|---|---|
| modelDesc | 输入 | aclmdlDesc类型的指针。 需提前调用aclmdlCreateDesc接口创建aclmdlDesc类型的数据。 |
| index | 输入 | 指定获取第几个输入的Dims,index值从0开始。 |
| dims | 输出 | 输入维度信息的指针。 针对动态Batch、动态分辨率(宽高)的场景,输入tensor的dims中batch size或宽高为-1,表示其动态可变。例如,输入tensor的format为NCHW,在动态Batch场景下,动态可变的输入tensor的dims为[-1,3,224,224];在动态分辨率场景下,动态可变的输入tensor的dims为[1,3,-1,-1]。举例中的斜体部分以实际情况为准。 若tensor的name长度大于127,则在输出的dims.name时,AscendCL会将tensor的name转换为“acl_modelId_${id}input${index}${随机字符串} ”格式(如果转换后的tensor的name与模型中已有的tensor的name冲突,则会在转换后的name尾部增加“${随机字符串} ”,否则不会增加随机字符串),并在转换后的name与原name之间建立映射关系,用户可调用aclmdlGetTensorRealName接口,传入转换后的name,获取原name(若向接口传入原name,则获取的还是原name);若tensor的name长度小于或等于127,则在输出的dims.name时,按tensor的name输出。 针对静态AIPP场景,本接口针对不同格式的图像,对应NHWC的Format格式,当前接口中明确各个维度的定义规则,如表1所示。 |
表1 静态AIPP场景下的维度定义规则
| 图像格式 | Format参考格式 | 维度定义规则 |
|---|---|---|
| YUV420SP_U8 | NHWC | n,h*1.5,w,1 |
| XRGB8888_U8 | NHWC | n,h,w,4 |
| RGB888_U8 | NHWC | n,h,w,3 |
| YUV400_U8 | NHWC | n,h,w,1 |
| ARGB8888_U8 | NHWC | n,h,w,4 |
| YUYV_U8 | NHWC | n,h,w,2 |
| YUV422SP_U8 | NHWC | n,h*2,w,1 |
| AYUV444_U8 | NHWC | n,h,w,4 |
返回值说明
返回0表示成功,返回非0表示失败。
父主题: aclmdlDesc
aclmdlGetOutputDims
函数功能
根据模型描述信息获取指定的模型输出tensor的维度信息。同步接口。
固定Shape场景下,通过该接口获取指定的模型输出tensor的维度信息。
动态Shape(动态Batch或动态分辨率)场景下,通过该接口获取最大档的维度信息。
函数原型
aclError aclmdlGetOutputDims(const aclmdlDesc *modelDesc, size_t index, aclmdlIODims *dims)
参数说明
| 参数名 | 输入/输出 | 说明 |
|---|---|---|
| modelDesc | 输入 | aclmdlDesc类型的指针。 需提前调用aclmdlCreateDesc接口创建aclmdlDesc类型的数据。 |
| index | 输入 | 指定获取第几个输出的Dims,index值从0开始。 |
| dims | 输出 | 输出维度信息的指针。 若tensor的name长度大于127,则在输出的dims.name时,系统会将tensor的name转换为“acl_modelId_${id}output${index} ${随机字符串} ”格式(如果转换后的tensor的name与模型中已有的tensor的name冲突,则会在转换后的name尾部增加“${随机字符串} ”,否则不会增加随机字符串),并在转换后的name与原name之间建立映射关系,用户可调用aclmdlGetTensorRealName接口,传入转换后的name,获取原name(若向接口传入原name,则获取的还是原name);若tensor的name长度小于或等于127,则在输出的dims.name时,按tensor的name输出。 |
返回值说明
返回0表示成功,返回非0表示失败。
父主题: aclmdlDesc
aclmdlGetInputNameByIndex
函数功能
根据模型描述信息获取模型中指定输入的输入名称。同步接口。
函数原型
const char *aclmdlGetInputNameByIndex(const aclmdlDesc *modelDesc, size_t index)
参数说明
| 参数名 | 输入/输出 | 说明 |
|---|---|---|
| modelDesc | 输入 | aclmdlDesc类型的指针。 需提前调用aclmdlCreateDesc接口创建aclmdlDesc类型的数据。 |
| index | 输入 | 指定获取第几个输入的名称,index值从0开始。 |
返回值说明
返回指定输入的输入名称。
父主题: aclmdlDesc
在线提单