【Hackathon 10th Spring No.1】add param for MaxPool*D/max_pool*d (#7724)

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: jinyouzhi

docs/api/paddle/nn/AdaptiveAvgPool2D_cn.rst

@@ -25,7 +25,7 @@ AdaptiveAvgPool2D
 
 参数
 :::::::::
-    - **output_size** (int|list|tuple)：算子输出特征图的尺寸，如果其是 list 或 turple 类型的数值，必须包含两个元素，H 和 W。H 和 W 既可以是 int 类型值也可以是 None，None 表示与输入特征尺寸相同。
+    - **output_size** (int|list|tuple)：算子输出特征图的尺寸，如果其是 list 或 tuple 类型的数值，必须包含两个元素，H 和 W。H 和 W 既可以是 int 类型值也可以是 None，None 表示与输入特征尺寸相同。
     - **data_format** (str，可选)：输入和输出的数据格式，可以是"NCHW"和"NHWC"。N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度。默认值："NCHW"。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 

docs/api/paddle/nn/AdaptiveAvgPool3D_cn.rst

@@ -28,7 +28,7 @@ AdaptiveAvgPool3D
 
 参数
 :::::::::
-    - **output_size** (int|list|tuple)：算子输出特征图的尺寸，如果其是 list 或 turple 类型的数值，必须包含三个元素，D，H 和 W。D，H 和 W 既可以是 int 类型值也可以是 None，None 表示与输入特征尺寸相同。
+    - **output_size** (int|list|tuple)：算子输出特征图的尺寸，如果其是 list 或 tuple 类型的数值，必须包含三个元素，D，H 和 W。D，H 和 W 既可以是 int 类型值也可以是 None，None 表示与输入特征尺寸相同。
     - **data_format** (str，可选)：输入和输出的数据格式，可以是"NCDHW"和"NDHWC"。N 是批尺寸，C 是通道数，D 是特征长度，H 是特征高度，W 是特征宽度。默认值："NCDHW"。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 

docs/api/paddle/nn/AdaptiveMaxPool1D_cn.rst

@@ -22,12 +22,12 @@ AdaptiveMaxPool1D
 参数
 :::::::::
     - **output_size** (int|list|tuple)：算子输出特征图的长度，其数据类型为 int,list 或 tuple。
-    - **return_mask** (bool，可选)：如果设置为 True，则会与输出一起返回最大值的索引，默认为 False。
+    - **return_mask** (bool，可选)：如果设置为 True，则会与输出一起返回最大值的索引，默认为 False。别名 ``return_indices``。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
 形状
 :::::::::
-    - **x** (Tensor)：默认形状为（批大小，通道数，输出特征长度），即 NCL 格式的 3-D Tensor。其数据类型为 float32 或者 float64。
+    - **x** (Tensor)：默认形状为（批大小，通道数，输出特征长度），即 NCL 格式的 3-D Tensor。其数据类型为 float32 或者 float64。别名 ``input``。
     - **output** (Tensor)：默认形状为（批大小，通道数，输出特征长度），即 NCL 格式的 3-D Tensor。其数据类型与输入 x 相同。
 
 返回

docs/api/paddle/nn/AdaptiveMaxPool2D_cn.rst

@@ -27,17 +27,18 @@ AdaptiveMaxPool2D
 
     Output(i ,j) &= max(Input[hstart:hend, wstart:wend])
 
+
 参数
 :::::::::
 
     - **output_size** (int|list|tuple)：算子输出特征图的高和宽大小，其数据类型为 int,list 或 tuple。
-    - **return_mask** (bool，可选)：如果设置为 True，则会与输出一起返回最大值的索引，默认为 False。
+    - **return_mask** (bool，可选)：如果设置为 True，则会与输出一起返回最大值的索引，默认为 False。别名 ``return_indices``。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
 形状
 :::::::::
 
-    - **x** (Tensor)：默认形状为（批大小，通道数，输出特征长度，宽度），即 NCHW 格式的 4-D Tensor。其数据类型为 float32 或者 float64。
+    - **x** (Tensor)：默认形状为（批大小，通道数，输出特征长度，宽度），即 NCHW 格式的 4-D Tensor。其数据类型为 float32 或者 float64。别名 ``input``。
     - **output** (Tensor)：默认形状为（批大小，通道数，输出特征长度，宽度），即 NCHW 格式的 4-D Tensor。其数据类型与输入 x 相同。
 
 返回

docs/api/paddle/nn/AdaptiveMaxPool3D_cn.rst

@@ -25,15 +25,16 @@ AdaptiveMaxPool3D
 
     Output(i ,j, k) &= max(Input[dstart:dend, hstart:hend, wstart:wend])
 
+
 参数
 :::::::::
     - **output_size** (int|list|tuple)：算子输出特征图的高宽长大小，其数据类型为 int,list 或 tuple。
-    - **return_mask** (bool，可选)：如果设置为 True，则会与输出一起返回最大值的索引，默认为 False。
+    - **return_mask** (bool，可选)：如果设置为 True，则会与输出一起返回最大值的索引，默认为 False。别名 ``return_indices``。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
 形状
 :::::::::
-    - **x** (Tensor)：默认形状为（批大小，通道数，输出特征深度，高度，宽度），即 NCDHW 格式的 5-D Tensor。其数据类型为 float32 或者 float64。
+    - **x** (Tensor)：默认形状为（批大小，通道数，输出特征深度，高度，宽度），即 NCDHW 格式的 5-D Tensor。其数据类型为 float32 或者 float64。别名 ``input``。
     - **output** (Tensor)：默认形状为（批大小，通道数，输出特征深度，高度，宽度），即 NCDHW 格式的 5-D Tensor。其数据类型与输入 x 相同。
 
 返回

docs/api/paddle/nn/FractionalMaxPool2D_cn.rst

@@ -34,19 +34,24 @@ FractionalMaxPool2D
 由于池化操作的步长与核尺寸相同，同为此随机序列，最终得到池化输出为 `[2, 4, 1, 5, 3]` 。
 
 
+..  note::
+    别名支持: 参数名 ``input`` 可替代 ``x``，参数名 ``return_indices`` 可替代 ``return_mask``。
+
 参数
 :::::::::
 
     - **output_size** (int|list|tuple)：算子输出图的尺寸，其数据类型为 int 或 list，tuple。如果输出为 tuple 或者 list，则必须包含两个元素， `(H, W)` 。 `H` 和 `W` 可以是 `int` ，也可以是 `None` ，表示与输入保持一致。
     - **kernel_size** (int|list|tuple, 可选) - 池化核大小。如果它是一个元组或列表，它必须包含两个整数值，(pool_size_Height, pool_size_Width)。若为一个整数，则表示 H 和 W 维度上均为该值，比如若 pool_size=2，则池化核大小为 [2,2]。默认为 `None`，表示使用 `disjoint` (`non-overlapping`) 模式。
     - **random_u** (float)：分数阶池化操作的浮点随机数，取值范围为 `(0, 1)` 。默认为 `None` ，由框架随机生成，可以使用 `paddle.seed` 设置随机种子。
     - **return_mask** (bool，可选)：如果设置为 `True` ，则会与输出一起返回最大值的索引，默认为 `False`。
+      ``别名：return_indices``
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 `None`。
 
 形状
 :::::::::
 
     - **x** (Tensor)：默认形状为（批大小，通道数，输出特征长度，宽度），即 NCHW 格式的 4-D Tensor。其数据类型为 float16, bfloat16, float32, float64。
+      ``别名：input``
     - **output** (Tensor)：默认形状为（批大小，通道数，输出特征长度，宽度），即 NCHW 格式的 4-D Tensor。其数据类型与输入 x 相同。
 
 返回

docs/api/paddle/nn/FractionalMaxPool3D_cn.rst

@@ -40,12 +40,12 @@ FractionalMaxPool3D
     - **output_size** (int|list|tuple)：算子输出图的尺寸，其数据类型为 int 或 list，tuple。如果输出为 tuple 或者 list，则必须包含两个元素， `(H, W)` 。 `H` 和 `W` 可以是 `int` ，也可以是 `None` ，表示与输入保持一致。
     - **kernel_size** (int|list|tuple，可选) - 池化核大小。如果它是一个元组或列表，它必须包含三个整数值，(pool_size_Depth，pool_size_Height, pool_size_Width)。若为一个整数，则表示 D，H 和 W 维度上均为该值，比如若 pool_size=2，则池化核大小为[2,2,2]。默认为 `None`，表示使用 `disjoint` (`non-overlapping`) 模式。
     - **random_u** (float)：分数阶池化操作的浮点随机数，取值范围为 `(0, 1)` 。默认为 `None` ，由框架随机生成，可以使用 `paddle.seed` 设置随机种子。
-    - **return_mask** (bool，可选)：如果设置为 `True` ，则会与输出一起返回最大值的索引，默认为 `False`。
+    - **return_mask** (bool，可选)：如果设置为 `True` ，则会与输出一起返回最大值的索引，默认为 `False`。别名 ``return_indices``。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 `None`。
 
 形状
 :::::::::
-    - **x** (Tensor)：默认形状为（批大小，通道数，输出特征深度，高度，宽度），即 NCDHW 格式的 5-D Tensor。其数据类型为 float16, bfloat16, float32, float64。
+    - **x** (Tensor)：默认形状为（批大小，通道数，输出特征深度，高度，宽度），即 NCDHW 格式的 5-D Tensor。其数据类型为 float16, bfloat16, float32, float64。别名 ``input``。
     - **output** (Tensor)：默认形状为（批大小，通道数，输出特征深度，高度，宽度），即 NCDHW 格式的 5-D Tensor。其数据类型与输入 x 相同。
 
 返回

docs/api/paddle/nn/MaxPool1D_cn.rst

@@ -3,7 +3,7 @@
 MaxPool1D
 -------------------------------
 
-.. py:class:: paddle.nn.MaxPool1D(kernel_size, stride=None, padding=0, return_mask=False, ceil_mode=False, name=None)
+.. py:class:: paddle.nn.MaxPool1D(kernel_size, stride=None, padding=0, return_mask=False, ceil_mode=False, dilation=1, name=None)
 
 根据输入 `x` ， `kernel_size` 等参数对一个输入 Tensor 计算 1D 的最大值池化。输入和输出都是 3-D Tensor，默认是以 `NCL` 格式表示的，其中 `N` 是 batch size，`C` 是通道数，`L` 是输入特征的长度。
 
@@ -13,19 +13,22 @@ MaxPool1D
 
     Output(N_i, C_i, l) =  max(Input[N_i, C_i, stride \times l:stride \times l+k])
 
+
 参数
 :::::::::
     - **kernel_size** (int|list|tuple) - 池化核的尺寸大小。如果 kernel_size 为 list 或 tuple 类型，其必须包含一个整数，最终池化核的大小为该数值。
     - **stride** (int|list|tuple，可选) - 池化操作步长。如果 stride 为 list 或 tuple 类型，其必须包含一个整数，最终池化操作的步长为该数值。默认值为 None，这时会使用 kernel_size 作为 stride。
     - **padding** (str|int|list|tuple，可选) - 池化补零的方式。如果 padding 是一个字符串，则必须为 `SAME` 或者 `VALID`。如果是 tuple 或者 list 类型，若其长度为 1，则会在输入的两端都填充上长度为 padding[0] 的 0，若其长度为 2，则应是 `[pad_before, pad_after]` 形式。如果 padding 是一个非 0 整数，那么表示会在输入的两端都填充上同样长度的 0。如果 padding 是长度为 2 的序列组成的 list 或 tuple，则其中的每个元素表示在相应维度上的填充长度。注意：在 batch_size 维度和通道维度应该设置为 [0, 0] 或 (0, 0)。默认值为 0。
-    - **return_mask** (bool，可选) - 是否返回最大值的索引，默认为 False。
+    - **return_mask** (bool，可选) - 是否返回最大值的索引，默认为 False。别名 ``return_indices``。
+      ``别名：return_indices``
     - **ceil_mode** (bool，可选) - 是否用 ceil 函数计算输出的 height 和 width，如果设置为 False，则使用 floor 函数来计算，默认为 False。
+    - **dilation** (int|list|tuple，可选) - 空洞池化步长，如果 dilation 为 list 或 tuple 类型，其必须包含一个整数。默认值为 1。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
 
 形状
 :::::::::
-    - **x** (Tensor) ：默认形状为（批大小，通道数，长度），即 NCL 格式的 3-D Tensor。其数据类型为 float32 或 float64。
+    - **input** (Tensor) ：默认形状为（批大小，通道数，长度），即 NCL 格式的 3-D Tensor。其数据类型为 float32 或 float64。
     - **output** (Tensor) ：默认形状为（批大小，通道数，输出特征长度），即 NCL 格式的 3-D Tensor。其数据类型与输入 x 相同。
 
 返回

docs/api/paddle/nn/MaxPool2D_cn.rst

@@ -3,7 +3,7 @@
 MaxPool2D
 -------------------------------
 
-.. py:class:: paddle.nn.MaxPool2D(kernel_size, stride=None, padding=0, ceil_mode=False, return_mask=False, data_format="NCHW", name=None)
+.. py:class:: paddle.nn.MaxPool2D(kernel_size, stride=None, padding=0, return_mask=False, ceil_mode=False, dilation=1, data_format="NCHW", name=None)
 构建 `MaxPool2D` 类的一个可调用对象，其将构建一个二维最大池化层，根据输入参数 `kernel_size`, `stride`,
 `padding` 等参数对输入做最大池化操作。
 
@@ -27,16 +27,17 @@ MaxPool2D
     - **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 均为该值。默认值为 None，这时会使用 kernel_size 作为 stride。
     - **padding** (str|int|list|tuple，可选) - 池化填充。如果它是一个字符串，可以是"VALID"或者"SAME"，表示填充算法。如果它是一个元组或列表，它可以有 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。
+    - **return_mask** (bool，可选) - 是否返回最大索引和输出。默认为 False。别名 ``return_indices``。
     - **ceil_mode** (bool，可选) - 是否用 ceil 函数计算输出高度和宽度。如果是 True，则使用 `ceil` 计算输出形状的大小。
-    - **return_mask** (bool，可选) - 是否返回最大索引和输出。默认为 False。
+    - **dilation** (int|list|tuple，可选) - 空洞池化步长，如果 dilation 为 list 或 tuple 类型，其必须包含两个整数：[dilation_height, dilation_width]。若为一个整数，则表示 H 和 W 维度上均为该值。默认值：1。
     - **data_format** (str，可选) - 输入和输出的数据格式，可以是"NCHW"和"NHWC"。N 是批尺寸，C 是通道数，H 是特征高度，W 是特征宽度。默认值："NCHW"。
     - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
 
 
 
 形状
 :::::::::
-    - **x** (Tensor) ：默认形状为（批大小，通道数，高度，宽度），即 NCHW 格式的 4-D Tensor。其数据类型为 float16, float32, float64, int32 或 int64。
+    - **x** (Tensor) ：默认形状为（批大小，通道数，高度，宽度），即 NCHW 格式的 4-D Tensor。其数据类型为 float16, float32, float64, int32 或 int64。别名 ``input``。
     - **output** (Tensor) ：默认形状为（批大小，通道数，输出特征高度，输出特征宽度），即 NCHW 格式的 4-D Tensor。其数据类型与输入相同。