diff --git a/doc/fluid/api_cn/nn_cn/functional_cn/avg_pool2d_cn.rst b/doc/fluid/api_cn/nn_cn/functional_cn/avg_pool2d_cn.rst index c215b8e5b95c1efec19f9770104f5fed2b44a2b0..1dc8152c791a9415e18c5fc58818ac8af0f88bb3 100644 --- a/doc/fluid/api_cn/nn_cn/functional_cn/avg_pool2d_cn.rst +++ b/doc/fluid/api_cn/nn_cn/functional_cn/avg_pool2d_cn.rst @@ -1,7 +1,10 @@ +.. _cn_api_nn_functional_avg_pool2d: + + avg_pool2d ------------------------------- -.. py:function:: paddle.nn.functional.avg_pool2d(x, kernel_size,stride=None,padding=0,ceil_mode=False,count_include_pad=True,divisor_override=None,data_format="NCHW",name=None)) +.. py:function:: paddle.nn.functional.avg_pool2d(x, kernel_size, stride=None, padding=0, ceil_mode=False, count_include_pad=True, divisor_override=None, data_format="NCHW", name=None) 该函数是一个二维平均池化函数, 其将构建一个二维平均池化层,根据输入参数 `kernel_size`, `stride`, `padding` 等参数对输入做平均池化操作。 @@ -25,7 +28,7 @@ avg_pool2d - **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` 计算输出形状的大小。 + - **ceil_mode** (bool):是否用ceil函数计算输出高度和宽度。如果是True,则使用 `ceil` 计算输出形状的大小。默认为None - **count_include_pad** (bool): 是否在平均池化模式忽略填充值,默认是 `True`. - **divisor_override** (int|float):如果指定,它将用作除数,否则根据`kernel_size`计算除数。 默认`None`. - **data_format** (str): 输入和输出的数据格式,可以是"NCHW"和"NHWC"。N是批尺寸,C是通道数,H是特征高度,W是特征宽度。默认值:"NCHW"