diff --git a/doc/fluid/api_cn/nn_cn/functional_cn/max_pool3d_cn.rst b/doc/fluid/api_cn/nn_cn/functional_cn/max_pool3d_cn.rst index e3434b2e5a48fd1128b7e09acb08c5ad0f52fa0e..f13a155bb280b151ec11a9668fee65a3d1680b92 100644 --- a/doc/fluid/api_cn/nn_cn/functional_cn/max_pool3d_cn.rst +++ b/doc/fluid/api_cn/nn_cn/functional_cn/max_pool3d_cn.rst @@ -1,7 +1,9 @@ +.. _cn_api_nn_functional_max_pool3d: + max_pool3d ------------------------------- -.. py:function:: paddle.nn.functinoal.max_pool3d(x, kernel_size,stride=None,padding=0,ceil_mode=False,return_indices=False,data_format="NCDHW",name=None)) +.. py:function:: paddle.nn.functinoal.max_pool3d(x, kernel_size, stride=None, padding=0, ceil_mode=False, return_indices=False, data_format="NCDHW", name=None)) 该函数是一个三维最大池化函数,根据输入参数 `kernel_size`, `stride`, `padding` 等参数对输入 `x` 做最大池化操作。 @@ -27,7 +29,7 @@ max_pool3d - **kernel_size** (int|list|tuple): 池化核大小。如果它是一个元组或列表,它必须包含三个整数值, (pool_size_Depth,pool_size_Height, pool_size_Width)。若为一个整数,则表示D,H和W维度上均为该值,比如若pool_size=2, 则池化核大小为[2,2,2]。 - **stride** (int|list|tuple):池化层的步长。如果它是一个元组或列表,它将包含三个整数,(pool_stride_Depth,pool_stride_Height, pool_stride_Width)。若为一个整数,则表示D, H和W维度上stride均为该值。默认值为kernel_size. - **padding** (string|int|list|tuple) 池化填充。如果它是一个字符串,可以是"VALID"或者"SAME",表示填充算法。如果它是一个元组或列表,它可以有3种格式:(1)包含3个整数值:[pad_depth, pad_height, pad_width];(2)包含6个整数值:[pad_depth_front, pad_depth_back, pad_height_top, pad_height_bottom, pad_width_left, pad_width_right];(3)包含5个二元组:当 data_format 为"NCDHW"时为[[0,0], [0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right]],当 data_format 为"NDHWC"时为[[0,0], [pad_depth_front, pad_depth_back], [pad_height_top, pad_height_bottom], [pad_width_left, pad_width_right], [0,0]]。若为一个整数,则表示D、H和W维度上均为该值。默认值:0 - - **ceil_mode** (bool):是否用ceil函数计算输出高度和宽度。如果是True,则使用 `ceil` 计算输出形状的大小。 + - **ceil_mode** (bool):是否用ceil函数计算输出高度和宽度。如果是True,则使用 `ceil` 计算输出形状的大小。默认为False - **return_indices** (bool):是否返回最大索引和输出。默认为False. - **data_format** (str): 输入和输出的数据格式,可以是"NCDHW"和"NDHWC"。N是批尺寸,C是通道数,D是特征深度,H是特征高度,W是特征宽度。默认值:"NDCHW"。 - **name** (str):函数的名字,默认为None.