aclnnAvgPool2d

支持的产品型号

Atlas 推理系列产品。
Atlas 训练系列产品。
Atlas A2训练系列产品/Atlas 800I A2推理产品。

接口原型

每个算子分为undefined，必须先调用“aclnnAvgPool2dGetWorkspaceSize”接口获取计算所需workspace大小以及包含了算子计算流程的执行器，再调用“aclnnAvgPool2d”接口执行计算。

aclnnStatus aclnnAvgPool2dGetWorkspaceSize(const aclTensor *self, const aclIntArray *kernelSize, const aclIntArray *strides, const aclIntArray *paddings, const bool ceilMode, const bool countIncludePad, const int64_t divisorOverride, const int8_t cubeMathType, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
aclnnStatus aclnnAvgPool2d(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

算子功能：对输入Tensor进行窗口为 $kH * kW$ 、步长为 $sH * sW$ 的二维平均池化操作，其中 $k$ 为kernelSize，表示池化窗口的大小， $s$ 为stride，表示池化操作的步长。
计算公式：输入input( $N,C,H,W$ )、输出out( $N,C,H_{out},W_{out}$ )和池化步长( $strides$ )、池化窗口大小( $kH,kW$ )的关系是

H_{out}=\lfloor \frac{H_{in}+2*paddings[0]-kH}{strides[0]}+1 \rfloor

W_{out}=\lfloor \frac{W_{in}+2*paddings[1]-kW}{strides[1]}+1 \rfloor

out(N_i,C_i,h,w)=\frac{1}{kH*kW}\sum_{m=0}^{kH-1}\sum_{n=0}^{kW-1}input(N_i,C_i,strides[0]*h+m,strides[1]*w+n)

aclnnAvgPool2dGetWorkspaceSize

参数说明：
- self(const aclTensor*，计算输入)：公式中的 $input$ ，Device侧的tensor，不支持空tensor场景，数据类型支持FLOAT16、BFLOAT16和FLOAT。支持undefined。支持undefined为NCHW和NCL。
- kernelSize(const aclIntArray*，计算输入):Host侧的aclIntArray，长度为1( $kH=kW$ )或2( $kH, kW$ )，表示池化窗口大小。数据类型支持INT32和INT64。数值必须大于0。
- strides(const aclIntArray*，计算输入): 公式中的 $strides$ ，Host侧的aclIntArray，长度为1( $sH=sW$ )或2( $sH, sW$ )，表示池化操作的步长。数据类型支持INT32和INT64。数值必须大于0。
- paddings(const aclIntArray*，计算输入): 公式中的 $paddings$ ，Host侧的aclIntArray，长度为1( $padH=padW$ )或2( $padH, padW$ )，表示在输入的H、W方向上padding补0的层数。数据类型支持INT32和INT64。数值不能小于0。
- ceilMode(const bool，计算输入): 表示推导的输出out的shape是否向上取整。数据类型支持BOOL。
- countIncludePad(const bool，计算输入): 计算平均池化时是否包括padding填充的0。数据类型支持BOOL。
- countIncludePad(const bool，计算输入): 计算平均池化时是否包括padding填充的0。数据类型支持BOOL。
- divisorOverride(const int64_t，计算输入): 表示取平均的除数。数据类型支持INT64。divisorOverride配置为默认值0时表示功能不使能。
- cubeMathType(int8_t，计算输入): host侧的整型，判断Cube单元应该使用哪种计算逻辑进行运算，数据类型支持INT8。对于无特殊说明的数据类型，均保持原始输入数据类型计算。支持的枚举值如下：
  - 0:KEEP_DTYPE，保持输入的数据类型进行计算。当输入是FLOAT，Atlas 训练系列产品和Atlas 推理系列产品暂不支持，取0时会报错。
  - 1:ALLOW_FP32_DOWN_PRECISION，允许将输入数据降精度计算。当输入是FLOAT，Atlas 训练系列产品和Atlas 推理系列产品允许转换为FLOAT16计算。
  - 2:USE_FP16，允许转换为数据类型FLOAT16进行计算。当输入数据类型是FLOAT，转换为FLOAT16计算。
  - 3:USE_HF32，允许转换为数据类型HFLOAT32计算。当输入是FLOAT，Atlas 训练系列产品、Atlas 推理系列产品、Atlas A2训练系列产品/Atlas 800I A2推理产品暂不支持，取3时会报错。
- out(aclTensor*，计算输出): 输出的tensor，公式中的 $out$ 。数据类型支持FLOAT16、BFLOAT16和FLOAT。支持undefined。支持undefined为NCHW和NCL。数据类型、undefined需要与self一致。
- workSpaceSize(uint64_t*，出参)：返回需要在Device侧申请的workspace大小。
- executor(aclOpExecutor**，计算输出)：返回op执行器，包含了算子计算流程。
返回值：

aclnnStatus：返回状态码，具体参见undefined。

[object Object]

aclnnAvgPool2d

参数说明：
- workspace(void *, 入参)：在Device侧申请的workspace内存地址。
- workspaceSize(uint64_t, 入参)：在Device侧申请的workspace大小，由第一段接口aclnnAvgPool2dGetWorkspaceSize获取。
- executor(aclOpExecutor *, 入参)：op执行器，包含了算子计算流程。
- stream(aclrtStream, 入参)：指定执行任务的AscendCL Stream流。
返回值：

aclnnStatus：返回状态码，具体参见undefined。

约束与限制

对于Atlas 训练系列产品，Cube单元不支持FLOAT32计算。当输入为FLOAT32，可通过设置cubeMathType=1(ALLOW_FP32_DOWN_PRECISION)来允许接口内部cast到FLOAT16进行计算。
输入channel最大支持65535

调用示例

示例代码如下，仅供参考，具体编译和执行过程请参考undefined。

[object Object]