aclnnAvgPool3d

支持的产品型号

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

接口原型

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

• aclnnStatus aclnnAvgPool3dGetWorkspaceSize(const aclTensor *self, const aclIntArray *kernelSize, const aclIntArray *stride, const aclIntArray *padding, bool ceilMode, bool countIncludePad, int64_t divisorOverride, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)

• aclnnStatus aclnnAvgPool3d(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

功能描述

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

$$D_{out}=\lfloor \frac{D_{in}+2*padding[0]-kernelSize[0]}{stride[0]}+1 \rfloor$$ $$H_{out}=\lfloor \frac{H_{in}+2*padding[1]-kernelSize[1]}{stride[1]}+1 \rfloor$$ $$W_{out}=\lfloor \frac{W_{in}+2*padding[2]-kernelSize[2]}{stride[2]}+1 \rfloor$$ $$out(N_i,C_i,d,h,w)=\frac{1}{kD*kH*kW}\sum_{k=0}^{kD-1}\sum_{m=0}^{kH-1}\sum_{n=0}^{kW-1}input(N_i,C_i,stride[0]*d+k,stride[1]*h+m,stride[2]*w+n)$$

aclnnAvgPool3dGetWorkspaceSize

• 参数说明：

  • self(const aclTensor*，计算输入): 公式中的$input$，Device侧的tensor，支持空tensor场景，数据类型支持FLOAT16、BFLOAT16和FLOAT。支持4维($C,D_{in},H_{in},W_{in}$)或5维($N,C,D_{in},H_{in},W_{in}$)。支持undefined。支持undefined为ND。
  • kernelSize(const aclIntArray*，计算输入): 公式中的$kernelSize$，Host侧的aclIntArray，长度为1($kD=kH=kW$)或3($kD, kH, kW$)，表示池化窗口大小。数据类型支持INT32和INT64。数值必须大于0且不小于输入对应维度的数值。
  • stride(const aclIntArray*，计算输入): 公式中的$stride$，Host侧的aclIntArray，长度为0($默认为kernelSize$)或1($sD=sH=sW$)或3($sD, sH, sW$)，表示池化操作的步长。数据类型支持INT32和INT64。数值必须大于0。
  • padding(const aclIntArray*，计算输入): 公式中的$padding$，Host侧的aclIntArray，长度为1($padD=padH=padW$)或3($padD, padH, padW$)，表示在输入的D、H、W方向上padding补0的层数。数据类型支持INT32和INT64。数值在[0, kernelSize/2]的范围内。
  • ceilMode(bool，计算输入): 数据类型支持BOOL。表示计算输出shape时，向下取整（False），否则向上取整。
  • countIncludePad(bool，计算输入): 数据类型支持BOOL。表示平均计算中包括零填充（True），否则不包括。
  • divisorOverride(int64_t，计算输入): 数据类型支持INT64。如果指定，它将用作平均计算中的除数，当值为0时，该属性不生效。
  • out(aclTensor*，计算输出): 输出的tensor，公式中的$out$。数据类型支持FLOAT16、BFLOAT16和FLOAT。支持4维($C,D_{out},H_{out},W_{out}$)或5维($N,C,D_{out},H_{out},W_{out}$)。支持undefined。支持undefined为ND。数据类型、undefined需要与self一致。
  • workspaceSize(uint64_t*，出参)：返回用户需要在Device侧申请的workspace大小。
  • executor(aclOpExecutor**，出参)：返回op执行器，包含了算子计算流程。

• 返回值：

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

aclnnAvgPool3d

• 参数说明：

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

• 返回值：

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

约束与限制

• 无

调用示例

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