diff --git a/docs/api/paddle/multiplex_cn.rst b/docs/api/paddle/multiplex_cn.rst index 12dd976ec7c..d46ad47a75e 100644 --- a/docs/api/paddle/multiplex_cn.rst +++ b/docs/api/paddle/multiplex_cn.rst @@ -47,4 +47,6 @@ Tensor, 进行Multiplex运算后的输出Tensor。 代码示例 :::::::::::: + COPY-FROM: paddle.multiplex:code-example1 + diff --git a/docs/api/paddle/nn/Pad1D_cn.rst b/docs/api/paddle/nn/Pad1D_cn.rst index e33ceb97f08..a16bbf47a17 100644 --- a/docs/api/paddle/nn/Pad1D_cn.rst +++ b/docs/api/paddle/nn/Pad1D_cn.rst @@ -13,12 +13,12 @@ Pad1D - **padding** (Tensor | List[int] | int) - 填充大小。如果是int,则在所有待填充边界使用相同的填充, 否则填充的格式为[pad_left, pad_right]。 - - **mode** (str) - padding的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。 + - **mode** (str, 可选) - padding的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。 ``'constant'`` 表示填充常数 ``value`` ; ``'reflect'`` 表示填充以输入边界值为轴的映射;``'replicate'`` 表示 填充输入边界值; ``'circular'`` 为循环填充输入。默认值为 ``'constant'``。 - - **value** (float32) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 - - **data_format** (str) - 指定输入的format,可为 ``'NCL'`` 或者 ``'NLC'``,默认值为 ``'NCL'``。 - - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,缺省值为None。 + - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 + - **data_format** (str, 可选) - 指定输入的format,可为 ``'NCL'`` 或者 ``'NLC'``,默认值为 ``'NCL'``。 + - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,缺省值为None。 返回 :::::::::::: @@ -27,17 +27,4 @@ Pad1D 代码示例 :::::::::::: -.. code-block:: python - - import paddle - import paddle.nn as nn - import numpy as np - input_shape = (1, 2, 3) - pad = [1, 2] - mode = "constant" - data = paddle.arange(np.prod(input_shape), dtype="float32").reshape(input_shape) + 1 - my_pad = nn.Pad1D(padding=pad, mode=mode) - result = my_pad(data) - print(result) - # [[[0. 1. 2. 3. 0. 0.] - # [0. 4. 5. 6. 0. 0.]]] +COPY-FROM: Paddle.nn.layer.common.Pad1D(Layer):code-example1 diff --git a/docs/api/paddle/nn/Pad2D_cn.rst b/docs/api/paddle/nn/Pad2D_cn.rst index 6084de999f7..23097541d7a 100644 --- a/docs/api/paddle/nn/Pad2D_cn.rst +++ b/docs/api/paddle/nn/Pad2D_cn.rst @@ -13,12 +13,12 @@ Pad2D - **padding** (Tensor | List[int] | int]) - 填充大小。如果是int,则在所有待填充边界使用相同的填充, 否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。 - - **mode** (str) - padding的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。 + - **mode** (str, 可选) - padding的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。 ``'constant'`` 表示填充常数 ``value``; ``'reflect'`` 表示填充以输入边界值为轴的映射;``'replicate'`` 表示 填充输入边界值;``'circular'`` 为循环填充输入。默认值为 ``'constant'`` 。 - - **value** (float32) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 - - **data_format** (str) - 指定输入的format,可为 ``'NCHW'`` 或者 ``'NHWC'``,默认值为 ``'NCHW'``。 - - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,缺省值为None。 + - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 + - **data_format** (str, 可选) - 指定输入的format,可为 ``'NCHW'`` 或者 ``'NHWC'``,默认值为 ``'NCHW'``。 + - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,缺省值为None。 返回 :::::::::::: @@ -27,20 +27,4 @@ Pad2D 代码示例 :::::::::::: -.. code-block:: python - - import paddle - import paddle.nn as nn - import numpy as np - input_shape = (1, 1, 2, 3) - pad = [1, 0, 1, 2] - mode = "constant" - data = paddle.arange(np.prod(input_shape), dtype="float32").reshape(input_shape) + 1 - my_pad = nn.Pad2D(padding=pad, mode=mode) - result = my_pad(data) - print(result) - # [[[[0. 0. 0. 0.] - # [0. 1. 2. 3.] - # [0. 4. 5. 6.] - # [0. 0. 0. 0.] - # [0. 0. 0. 0.]]]] +COPY-FROM: Paddle.nn.layer.common.Pad2D(Layer):code-example1 diff --git a/docs/api/paddle/nn/Pad3D_cn.rst b/docs/api/paddle/nn/Pad3D_cn.rst index 4531abcaa7e..7711171c971 100644 --- a/docs/api/paddle/nn/Pad3D_cn.rst +++ b/docs/api/paddle/nn/Pad3D_cn.rst @@ -13,12 +13,12 @@ Pad3D - **padding** (Tensor | List[int] | int) - 填充大小。如果是int,则在所有待填充边界使用相同的填充, 否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。 - - **mode** (str) - padding的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。 + - **mode** (str, 可选) - padding的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。 ``'constant'`` 表示填充常数 ``value``; ``'reflect'`` 表示填充以输入边界值为轴的映射; ``'replicate'`` 表示 填充输入边界值; ``'circular'`` 为循环填充输入。默认值为 ``'constant'`` 。 - - **value** (float32) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 - - **data_format** (str) - 指定输入的format,可为 ``'NCDHW'`` 或者 ``'NDHWC'``,默认值为 ``'NCDHW'``。 - - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,缺省值为None。 + - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 + - **data_format** (str, 可选) - 指定输入的format,可为 ``'NCDHW'`` 或者 ``'NDHWC'``,默认值为 ``'NCDHW'``。 + - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用,具体用法请参见 :ref:`api_guide_Name` ,缺省值为None。 返回 :::::::::::: @@ -27,20 +27,4 @@ Pad3D 代码示例 :::::::::::: -.. code-block:: python - - import paddle - import paddle.nn as nn - import numpy as np - input_shape = (1, 1, 1, 2, 3) - pad = [1, 0, 1, 2, 0, 0] - mode = "constant" - data = paddle.arange(np.prod(input_shape), dtype="float32").reshape(input_shape) + 1 - my_pad = nn.Pad3D(padding=pad, mode=mode) - result = my_pad(data) - print(result) - # [[[[[0. 0. 0. 0.] - # [0. 1. 2. 3.] - # [0. 4. 5. 6.] - # [0. 0. 0. 0.] - # [0. 0. 0. 0.]]]]] +COPY-FROM: Paddle.nn.layer.common.Pad3D(Layer):code-example1