aclnnMaxPool

产品支持情况

功能说明

• 算子功能： 对于dim=3 或4维的输入张量，进行最大池化（max pooling）操作。
• 计算公式：
  • 当ceilMode=False时，out tensor的shape中H和W维度推导公式：$$[H_{out}, W_{out}]=[\lfloor{\frac{H_{in}+ padding\_size_{Htop} + padding\_size_{Hbottom} - {dilation\_size \times(k_h - 1) - 1}}{s_h}}\rfloor + 1,\lfloor{\frac{W_{in}+ padding\_size_{Wleft} + padding\_size_{Wright} - {dilation\_size \times(k_w - 1) - 1}}{s_w}}\rfloor + 1]$$
  • 当ceilMode=True时，out tensor的shape中H和W维度推导公式：$$[H_{out}, W_{out}]=[\lceil{\frac{H_{in}+ padding\_size_{Htop} + padding\_size_{Hbottom} - {dilation\_size \times(k_h - 1) - 1}}{s_h}}\rceil + 1,\lceil{\frac{W_{in}+ padding\_size_{Wleft} + padding\_size_{Wright} - {dilation\_size \times(k_w - 1) - 1}}{s_w}}\rceil + 1]$$
    • 滑窗左上角起始位处在下或右侧pad填充位上或者界外（无法取到有效值）时，舍弃该滑窗结果，在上述推导公式基础上对应空间轴shape需减去1：$$\begin{cases} H_{out}=H_{out} - 1& \text{if } (H_{out}-1)*s_h>=H_{in}+padding\_size_{Htop} \\ W_{out}=W_{out} - 1& \text{if } (W_{out}-1)*s_w>=W_{in}+padding\_size_{Wleft} \\ \end{cases}\\$$

函数原型

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

• aclnnStatus aclnnMaxPoolGetWorkspaceSize(const aclTensor *self, const aclIntArray *kernelShape, const aclIntArray *strides, const int64_t autoPad, const aclIntArray *pads, const aclIntArray *dilations, const int64_t ceilMode, aclTensor *out, uint64_t *workspaceSize, aclOpExecutor **executor)
• aclnnStatus aclnnMaxPool(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, aclrtStream stream)

aclnnMaxPoolGetWorkspaceSize

• 参数说明：

  • self（aclTensor*，计算输入）：Device侧的aclTensor输入，对应公式中的H_in和W_in。维度需要是3D（维度分别代表C，H，W）或4D（维度分别代表N，C，H，W），N为Batchsize大小，C为Tensor通道大小，H为Tensor高度，W为Tensor宽度，不支持其他维度。支持undefined，undefined支持ND。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持FLOAT16。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
  • kernelShape（aclIntArray*，计算输入）：表示最大池化的窗口大小，对应公式中的k_h和k_w，长度为1或2，且数组元素必须都大于0。
  • strides（aclIntArray*，计算输入）：窗口移动的步长，对应公式中的s_h和s_w，数组长度为0、1或2，且数组元素必须都大于0。当数组长度为0时，strides取默认值为1。
  • autoPad（int64_t，计算输入）：指定padding的方式。其中0代表"NOTSET"，并且只支持数值0。
  • pads（aclIntArray*，计算输入）：沿着空间轴方向开始和结束的位置填充，对应公式中的padding_size。长度为0、1、2或4。当数组长度为0时，不进行填充。当数组长度为1时，H_top、H_bottom、W_left、W_right填充同一个值。当数组长度为2时，H_top、H_bottom分别填充数组第1个值，W_left、W_right分别填充数组第2个值。当数组长度为4时，按[H_top、W_left、H_bottom、W_right]位置关系进行填充。单个空间轴方向填充量之和需小于等于对应方向kernelShape。
  • dilations（aclIntArray*，计算输入）：沿着核空间轴方向的膨胀值，对应公式中的dilation_size，并且只支持数值为1的输入场景。长度为0、1、2或4。
  • ceilMode（int64_t，计算输入）：计算输出形状的取整模式，为0时，代表False，向下取整；非0值时，代表True，向上取整。
  • out（aclTensor*，计算输出）：数据类型和self一致。shape由上述公式推导出。数据格式和维度与输入self一致。
    • [object Object]Atlas 训练系列产品[object Object]：数据类型支持FLOAT16。
    • [object Object]Atlas A2 训练系列产品/Atlas 800I A2 推理产品/A200I A2 Box 异构组件[object Object]、[object Object]Atlas A3 训练系列产品/Atlas A3 推理系列产品[object Object]：数据类型支持FLOAT16、FLOAT32。
  • workspaceSize（uint64_t*，出参）：返回需要在Device侧申请的workspace大小。
  • executor（aclOpExecutor**，出参）：返回op执行器，包含了算子计算流程。

• 返回值：

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

  [object Object]

aclnnMaxPool

• 参数说明：

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

• 返回值：

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

调用示例

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