AvgPool2D

paddle.nn. AvgPool2D ( kernel_size, stride=None, padding=0, ceil_mode=False, exclusive=True, divisor_override=None, data_format='NCHW', name=None ) [源代码]

该接口用于构建 AvgPool2D 类的一个可调用对象,其将构建一个二维平均池化层,根据输入参数 kernel_size, stride, padding 等参数对输入做平均池化操作。

例如:

输入:

X 形状:\(\left ( N,C,H_{in},W_{in} \right )\)

属性:

kernel_size: \(ksize\) stride: \(stride\)

输出:

Out 形状:\(\left ( N,C,H_{out},W_{out} \right )\)

\[out(N_i, C_j, h, w) = \frac{1}{ksize[0] * ksize[1]} \sum_{m=0}^{ksize[0]-1} \sum_{n=0}^{ksize[1]-1} input(N_i, C_j, stride[0] \times h + m, stride[1] \times w + n)\]

参数

  • kernel_size (int|list|tuple): 池化核大小。如果它是一个元组或列表,它必须包含两个整数值, (pool_size_Height, pool_size_Width)。若为一个整数,则它的平方值将作为池化核大小,比如若pool_size=2, 则池化核大小为2x2。

  • stride (int|list|tuple):池化层的步长。如果它是一个元组或列表,它将包含两个整数,(pool_stride_Height, pool_stride_Width)。若为一个整数,则表示H和W维度上stride均为该值。默认值为kernel_size.

  • padding (string|int|list|tuple) 池化填充。如果它是一个字符串,可以是"VALID"或者"SAME",表示填充算法,计算细节可参考上述 pool_padding = "SAME"或 pool_padding = "VALID" 时的计算公式。如果它是一个元组或列表,它可以有3种格式:(1)包含2个整数值:[pad_height, pad_width];(2)包含4个整数值:[pad_height_top, pad_height_bottom, pad_width_left, pad_width_right];(3)包含4个二元组:当 data_format 为"NCHW"时为 [[0,0], [0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]],当 data_format 为"NHWC"时为[[0,0], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数,则表示H和W维度上均为该值。默认值:0。

  • ceil_mode (bool):是否用ceil函数计算输出高度和宽度。如果是True,则使用 ceil 计算输出形状的大小。默认为False。

  • exclusive (bool): 是否在平均池化模式忽略填充值,默认是 True.

  • divisor_override (int|float):如果指定,它将用作除数,否则根据`kernel_size`计算除数。 默认`None`.

  • data_format (str): 输入和输出的数据格式,可以是"NCHW"和"NHWC"。N是批尺寸,C是通道数,H是特征高度,W是特征宽度。默认值:"NCHW"

  • name (str):函数的名字,默认为None.

形状

  • x (Tensor): 默认形状为(批大小,通道数,高度,宽度),即NCHW格式的4-D Tensor。 其数据类型为float16, float32, float64, int32或int64。

  • output (Tensor): 默认形状为(批大小,通道数,输出特征高度,输出特征宽度),即NCHW格式的4-D Tensor。 其数据类型与输入相同。

返回

计算AvgPool2D的可调用对象

代码示例

import paddle
import paddle.nn as nn

# avg pool2d
input = paddle.uniform(shape=[1, 2, 32, 32], dtype='float32', min=-1, max=1)
AvgPool2D = nn.AvgPool2D(kernel_size=2,
                      stride=2, padding=0)
output = AvgPool2D(input)
# output.shape [1, 3, 16, 16]