From 78aeea796d231a3fa078f9fa6dabfd12dff2ef57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Dliyongchao911?= <11_258@163.com> Date: Tue, 26 Apr 2022 11:21:28 +0800 Subject: [PATCH 1/4] align the code example with en docs using copy from function --- docs/api/paddle/multiplex_cn.rst | 13 +------------ docs/api/paddle/put_along_axis_cn.rst | 13 +------------ docs/api/paddle/reshape_cn.rst | 25 +------------------------ docs/api/paddle/take_along_axis_cn.rst | 11 +---------- 4 files changed, 4 insertions(+), 58 deletions(-) diff --git a/docs/api/paddle/multiplex_cn.rst b/docs/api/paddle/multiplex_cn.rst index 8753d0d9b6c..c11f61a4e37 100644 --- a/docs/api/paddle/multiplex_cn.rst +++ b/docs/api/paddle/multiplex_cn.rst @@ -47,15 +47,4 @@ Tensor, 进行Multiplex运算后的输出Tensor。 代码示例 :::::::::::: -.. code-block:: python - - import paddle - import numpy as np - img1 = np.array([[1, 2], [3, 4]]).astype(np.float32) - img2 = np.array([[5, 6], [7, 8]]).astype(np.float32) - inputs = [paddle.to_tensor(img1), paddle.to_tensor(img2)] - index = paddle.to_tensor(np.array([[1], [0]]).astype(np.int32)) - res = paddle.multiplex(inputs, index) - print(res) - # [[5. , 6.], - # [3. , 4.]] +COPY-FROM: : diff --git a/docs/api/paddle/put_along_axis_cn.rst b/docs/api/paddle/put_along_axis_cn.rst index f2b4b68eec9..e19956d24de 100644 --- a/docs/api/paddle/put_along_axis_cn.rst +++ b/docs/api/paddle/put_along_axis_cn.rst @@ -23,15 +23,4 @@ put_along_axis 代码示例 ::::::::: -.. code-block:: python - - import paddle - - x = paddle.to_tensor([[10, 30, 20], [60, 40, 50]]) - index = paddle.to_tensor([[0]]) - value = 99 - axis = 0 - result = paddle.put_along_axis(x, index, value, axis) - print(result) - # [[99, 99, 99], - # [60, 40, 50]] \ No newline at end of file +COPY-FROM: : \ No newline at end of file diff --git a/docs/api/paddle/reshape_cn.rst b/docs/api/paddle/reshape_cn.rst index ba5dd4cf6ef..29f1648838f 100644 --- a/docs/api/paddle/reshape_cn.rst +++ b/docs/api/paddle/reshape_cn.rst @@ -43,30 +43,7 @@ reshape 代码示例 :::::::::::: -.. code-block:: python - - import numpy as np - import paddle - - x = paddle.rand([2, 4, 6], dtype="float32") - positive_four = paddle.full([1], 4, "int32") - - out = paddle.reshape(x, [-1, 0, 3, 2]) - print(out) - # the shape is [2,4,3,2]. - - out = paddle.reshape(x, shape=[positive_four, 12]) - print(out) - # the shape of out_2 is [4, 12]. - - shape_tensor = paddle.to_tensor(np.array([8, 6]).astype("int32")) - out = paddle.reshape(x, shape=shape_tensor) - print(out) - # the shape is [8, 6]. - # 在动态图模式下，输出out与输入x共享数据 - x[0, 0, 0] = 10. - print(out[0, 0]) - # the value is [10.] +COPY-FROM: : diff --git a/docs/api/paddle/take_along_axis_cn.rst b/docs/api/paddle/take_along_axis_cn.rst index 3b22ee0a6cd..75809e73f4b 100644 --- a/docs/api/paddle/take_along_axis_cn.rst +++ b/docs/api/paddle/take_along_axis_cn.rst @@ -21,13 +21,4 @@ take_along_axis 代码示例 ::::::::: -.. code-block:: python - - import paddle - - x = paddle.to_tensor([[1, 2, 3], [4, 5, 6], [7, 8, 9]]) - index = paddle.to_tensor([[0]]) - axis = 0 - result = paddle.take_along_axis(x, index, axis) - print(result) - # [[1, 2, 3]] \ No newline at end of file +COPY-FROM: : \ No newline at end of file From 1a883ed0c460c3140a521ead055f191d327477f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Dliyongchao911?= <11_258@163.com> Date: Thu, 11 Aug 2022 16:34:51 +0800 Subject: [PATCH 2/4] update Pad1D/2D/3D class api --- docs/api/paddle/nn/Pad1D_cn.rst | 10 +++++----- docs/api/paddle/nn/Pad2D_cn.rst | 8 ++++---- docs/api/paddle/nn/Pad3D_cn.rst | 8 ++++---- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/api/paddle/nn/Pad1D_cn.rst b/docs/api/paddle/nn/Pad1D_cn.rst index e33ceb97f08..669def634b9 100644 --- a/docs/api/paddle/nn/Pad1D_cn.rst +++ b/docs/api/paddle/nn/Pad1D_cn.rst @@ -13,11 +13,11 @@ 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'``。 + - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 + - **data_format** (str, 可选) - 指定输入的format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``。 - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。 返回 @@ -31,11 +31,11 @@ Pad1D 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 + data = paddle.arange(paddle.prod(paddle.to_tensor(input_shape)), dtype="float32").reshape(input_shape) + 1 my_pad = nn.Pad1D(padding=pad, mode=mode) result = my_pad(data) print(result) diff --git a/docs/api/paddle/nn/Pad2D_cn.rst b/docs/api/paddle/nn/Pad2D_cn.rst index 6084de999f7..5ca830de213 100644 --- a/docs/api/paddle/nn/Pad2D_cn.rst +++ b/docs/api/paddle/nn/Pad2D_cn.rst @@ -13,11 +13,11 @@ 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'``。 + - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 + - **data_format** (str, 可选) - 指定输入的format，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。 返回 @@ -35,7 +35,7 @@ Pad2D 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 + data = paddle.arange(paddle.prod(paddle.to_tensor(input_shape))), dtype="float32").reshape(input_shape) + 1 my_pad = nn.Pad2D(padding=pad, mode=mode) result = my_pad(data) print(result) diff --git a/docs/api/paddle/nn/Pad3D_cn.rst b/docs/api/paddle/nn/Pad3D_cn.rst index 4531abcaa7e..57f87e671d4 100644 --- a/docs/api/paddle/nn/Pad3D_cn.rst +++ b/docs/api/paddle/nn/Pad3D_cn.rst @@ -13,11 +13,11 @@ 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'``。 + - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。 + - **data_format** (str, 可选) - 指定输入的format，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``。 - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。 返回 @@ -35,7 +35,7 @@ Pad3D 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 + data = paddle.arange(paddle.prod(paddle.to_tensor(input_shape))), dtype="float32").reshape(input_shape) + 1 my_pad = nn.Pad3D(padding=pad, mode=mode) result = my_pad(data) print(result) From 89fdb03dad48c685674f41161a6272d1d83b57c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Dliyongchao911?= <11_258@163.com> Date: Thu, 11 Aug 2022 21:25:21 +0800 Subject: [PATCH 3/4] update to resolve the confict --- docs/api/paddle/multiplex_cn.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/api/paddle/multiplex_cn.rst b/docs/api/paddle/multiplex_cn.rst index 973f75358f1..d46ad47a75e 100644 --- a/docs/api/paddle/multiplex_cn.rst +++ b/docs/api/paddle/multiplex_cn.rst @@ -47,8 +47,6 @@ Tensor, 进行Multiplex运算后的输出Tensor。 代码示例 :::::::::::: -<<<<<<< HEAD -COPY-FROM: paddle.multiplex:code-example1 -======= + COPY-FROM: paddle.multiplex:code-example1 ->>>>>>> 946e985763dcc3ae0f029147b8141c3af4fd9d9a + From a12d04a27d6ec7fb1aaeb8e51db4228aa3ed3ca1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Dliyongchao911?= <11_258@163.com> Date: Thu, 11 Aug 2022 21:48:00 +0800 Subject: [PATCH 4/4] update docs with COPY-FROM function for the code example --- docs/api/paddle/nn/Pad1D_cn.rst | 23 +++++------------------ docs/api/paddle/nn/Pad2D_cn.rst | 26 +++++--------------------- docs/api/paddle/nn/Pad3D_cn.rst | 26 +++++--------------------- docs/api/paddle/put_along_axis_cn.rst | 4 ---- docs/api/paddle/reshape_cn.rst | 4 ---- docs/api/paddle/take_along_axis_cn.rst | 4 ---- 6 files changed, 15 insertions(+), 72 deletions(-) diff --git a/docs/api/paddle/nn/Pad1D_cn.rst b/docs/api/paddle/nn/Pad1D_cn.rst index 669def634b9..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 - - input_shape = (1, 2, 3) - pad = [1, 2] - mode = "constant" - data = paddle.arange(paddle.prod(paddle.to_tensor(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 5ca830de213..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(paddle.prod(paddle.to_tensor(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 57f87e671d4..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(paddle.prod(paddle.to_tensor(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 diff --git a/docs/api/paddle/put_along_axis_cn.rst b/docs/api/paddle/put_along_axis_cn.rst index 98f646fecaf..251be3e3f7a 100644 --- a/docs/api/paddle/put_along_axis_cn.rst +++ b/docs/api/paddle/put_along_axis_cn.rst @@ -23,8 +23,4 @@ put_along_axis 代码示例 ::::::::: -<<<<<<< HEAD COPY-FROM: paddle.put_along_axis:code-example1 -======= -COPY-FROM: paddle.put_along_axis:code-example1 ->>>>>>> 946e985763dcc3ae0f029147b8141c3af4fd9d9a diff --git a/docs/api/paddle/reshape_cn.rst b/docs/api/paddle/reshape_cn.rst index 853910841ac..ab9c7a8fced 100644 --- a/docs/api/paddle/reshape_cn.rst +++ b/docs/api/paddle/reshape_cn.rst @@ -43,11 +43,7 @@ reshape 代码示例 :::::::::::: -<<<<<<< HEAD COPY-FROM: paddle.reshape:code-example1 -======= -COPY-FROM: paddle.reshape:code-example1 ->>>>>>> 946e985763dcc3ae0f029147b8141c3af4fd9d9a diff --git a/docs/api/paddle/take_along_axis_cn.rst b/docs/api/paddle/take_along_axis_cn.rst index 000ab39a131..2196679cc4b 100644 --- a/docs/api/paddle/take_along_axis_cn.rst +++ b/docs/api/paddle/take_along_axis_cn.rst @@ -21,8 +21,4 @@ take_along_axis 代码示例 ::::::::: -<<<<<<< HEAD COPY-FROM: paddle.take_along_axis:code-example1 -======= -COPY-FROM: paddle.take_along_axis:code-example1 ->>>>>>> 946e985763dcc3ae0f029147b8141c3af4fd9d9a