From f996ff13a2f692c82b275ad94cc72c00f3a54da5 Mon Sep 17 00:00:00 2001 From: gsq7474741 Date: Fri, 19 Nov 2021 10:49:12 +0800 Subject: [PATCH 1/9] add doc of zeropad2d --- docs/api/paddle/nn/ZeroPad2D_cn.rst | 40 +++++++++++++++++++++++++++++ docs/api/paddle/zeropad2d_cn.rst | 36 ++++++++++++++++++++++++++ 2 files changed, 76 insertions(+) create mode 100644 docs/api/paddle/nn/ZeroPad2D_cn.rst create mode 100644 docs/api/paddle/zeropad2d_cn.rst diff --git a/docs/api/paddle/nn/ZeroPad2D_cn.rst b/docs/api/paddle/nn/ZeroPad2D_cn.rst new file mode 100644 index 00000000000..76df33640f1 --- /dev/null +++ b/docs/api/paddle/nn/ZeroPad2D_cn.rst @@ -0,0 +1,40 @@ +.. _cn_api_nn_ZeroPad2D: + +ZeroPad2D +------------------------------- +.. py:class:: paddle.nn.ZeroPad2D(self, padding, data_format="NCHW", name=None) + +**ZeroPad2D** + +按照 padding 属性对输入进行零填充。 + +参数： + - **padding** (Tensor | List[int] | int]) - 填充大小。如果是int，则在所有待填充边界使用相同的填充， + 否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。 + - **data_format** (str) - 指定输入的format，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 + - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。 + +返回：无 + +**代码示例** + +.. 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] + data = paddle.arange(np.prod(input_shape), dtype="float32").reshape(input_shape) + 1 + + my_pad = nn.ZeroPad2D(padding=pad) + 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.]]]] + """ \ No newline at end of file diff --git a/docs/api/paddle/zeropad2d_cn.rst b/docs/api/paddle/zeropad2d_cn.rst new file mode 100644 index 00000000000..e4950e2c65d --- /dev/null +++ b/docs/api/paddle/zeropad2d_cn.rst @@ -0,0 +1,36 @@ +.. _cn_api_tensor_zeropad2d: + +zeropad2d +------------------------------- +.. py:function:: paddle.zeropad2d(x, pad, data_format="NCHW", name=None) + +该OP返回一个按照 ``padding`` 属性对 ``x`` 进行零填充的Tensor，数据类型与 ``x`` 相同。 + +参数 +:::::::::: + - **x** (Tensor) - Tensor，format可以为 ``'NCHW'``, ``'NHWC'`` ，默认值为 ``'NCHW'``，数据类型支持float16, float32, float64, int32, int64。 + - **pad** (Tensor | List[int] | Tuple[int]) - 填充大小。pad的格式为[pad_left, pad_right, pad_top, pad_bottom]； + - **data_format** (str) - 指定 ``x`` 的format，可为 ``'NCHW'``, ``'NHWC'``, 默认值为 ``'NCHW'``。 + - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。 +返回 +:::::::::: + Tensor：对 ``x`` 进行 ``'pad'`` 的结果，数据类型和 ``x`` 相同。 + +代码示例 +:::::::::: + +.. code-block:: python + + import paddle + import numpy as np + + x_shape = (1, 1, 2, 3) + x = paddle.arange(np.prod(x_shape), dtype="float32").reshape(x_shape) + 1 + y = paddle.zeropad2d(x, [1, 2, 1, 1]) + + # [[[[0. 0. 0. 0. 0. 0.] + # [0. 1. 2. 3. 0. 0.] + # [0. 4. 5. 6. 0. 0.] + # [0. 0. 0. 0. 0. 0.]]]] + + From 89a287dc2fd7a40e112a312ae9e7f46079018aa1 Mon Sep 17 00:00:00 2001 From: gsq7474741 Date: Fri, 19 Nov 2021 11:00:35 +0800 Subject: [PATCH 2/9] add doc of zeropad2d v0.2 --- docs/api/paddle/nn/ZeroPad2D_cn.rst | 3 ++- docs/api/paddle/zeropad2d_cn.rst | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/paddle/nn/ZeroPad2D_cn.rst b/docs/api/paddle/nn/ZeroPad2D_cn.rst index 76df33640f1..2393802f698 100644 --- a/docs/api/paddle/nn/ZeroPad2D_cn.rst +++ b/docs/api/paddle/nn/ZeroPad2D_cn.rst @@ -37,4 +37,5 @@ ZeroPad2D # [0. 4. 5. 6.] # [0. 0. 0. 0.] # [0. 0. 0. 0.]]]] - """ \ No newline at end of file + + diff --git a/docs/api/paddle/zeropad2d_cn.rst b/docs/api/paddle/zeropad2d_cn.rst index e4950e2c65d..f88fb868cbd 100644 --- a/docs/api/paddle/zeropad2d_cn.rst +++ b/docs/api/paddle/zeropad2d_cn.rst @@ -12,6 +12,7 @@ zeropad2d - **pad** (Tensor | List[int] | Tuple[int]) - 填充大小。pad的格式为[pad_left, pad_right, pad_top, pad_bottom]； - **data_format** (str) - 指定 ``x`` 的format，可为 ``'NCHW'``, ``'NHWC'``, 默认值为 ``'NCHW'``。 - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。 + 返回 :::::::::: Tensor：对 ``x`` 进行 ``'pad'`` 的结果，数据类型和 ``x`` 相同。 From 5d1651775e0b91610f338f318d7cf9ac5ec9e6bd Mon Sep 17 00:00:00 2001 From: gsq7474741 Date: Mon, 22 Nov 2021 18:53:35 +0800 Subject: [PATCH 3/9] add doc of zeropad2d v0.2 --- docs/api/paddle/zeropad2d_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/zeropad2d_cn.rst b/docs/api/paddle/zeropad2d_cn.rst index f88fb868cbd..b73c9e4d43a 100644 --- a/docs/api/paddle/zeropad2d_cn.rst +++ b/docs/api/paddle/zeropad2d_cn.rst @@ -2,14 +2,14 @@ zeropad2d ------------------------------- -.. py:function:: paddle.zeropad2d(x, pad, data_format="NCHW", name=None) +.. py:function:: paddle.zeropad2d(x, padding, data_format="NCHW", name=None) 该OP返回一个按照 ``padding`` 属性对 ``x`` 进行零填充的Tensor，数据类型与 ``x`` 相同。 参数 :::::::::: - **x** (Tensor) - Tensor，format可以为 ``'NCHW'``, ``'NHWC'`` ，默认值为 ``'NCHW'``，数据类型支持float16, float32, float64, int32, int64。 - - **pad** (Tensor | List[int] | Tuple[int]) - 填充大小。pad的格式为[pad_left, pad_right, pad_top, pad_bottom]； + - **padding** (Tensor | List[int] | Tuple[int]) - 填充大小。pad的格式为[pad_left, pad_right, pad_top, pad_bottom]； - **data_format** (str) - 指定 ``x`` 的format，可为 ``'NCHW'``, ``'NHWC'``, 默认值为 ``'NCHW'``。 - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。 From 39b3446590a8c85c915066c315f68f79ff6a7279 Mon Sep 17 00:00:00 2001 From: gsq7474741 Date: Tue, 23 Nov 2021 17:34:28 +0800 Subject: [PATCH 4/9] add doc of zeropad2d v0.3 --- docs/api/paddle/{ => nn/functional}/zeropad2d_cn.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename docs/api/paddle/{ => nn/functional}/zeropad2d_cn.rst (86%) diff --git a/docs/api/paddle/zeropad2d_cn.rst b/docs/api/paddle/nn/functional/zeropad2d_cn.rst similarity index 86% rename from docs/api/paddle/zeropad2d_cn.rst rename to docs/api/paddle/nn/functional/zeropad2d_cn.rst index b73c9e4d43a..81336d91a78 100644 --- a/docs/api/paddle/zeropad2d_cn.rst +++ b/docs/api/paddle/nn/functional/zeropad2d_cn.rst @@ -1,8 +1,8 @@ -.. _cn_api_tensor_zeropad2d: +.. _cn_api_nn_functional_zeropad2d: zeropad2d ------------------------------- -.. py:function:: paddle.zeropad2d(x, padding, data_format="NCHW", name=None) +.. py:function:: paddle.nn.functional.zeropad2d(x, padding, data_format="NCHW", name=None) 该OP返回一个按照 ``padding`` 属性对 ``x`` 进行零填充的Tensor，数据类型与 ``x`` 相同。 @@ -27,7 +27,7 @@ zeropad2d x_shape = (1, 1, 2, 3) x = paddle.arange(np.prod(x_shape), dtype="float32").reshape(x_shape) + 1 - y = paddle.zeropad2d(x, [1, 2, 1, 1]) + y = paddle.nn.functional.zeropad2d(x, [1, 2, 1, 1]) # [[[[0. 0. 0. 0. 0. 0.] # [0. 1. 2. 3. 0. 0.] From f6b65b16746f7af58315e5889018a1faa97f2dda Mon Sep 17 00:00:00 2001 From: Chen Long <1300851984@qq.com> Date: Fri, 26 Nov 2021 09:08:15 +0800 Subject: [PATCH 5/9] Update ZeroPad2D_cn.rst --- docs/api/paddle/nn/ZeroPad2D_cn.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/nn/ZeroPad2D_cn.rst b/docs/api/paddle/nn/ZeroPad2D_cn.rst index 2393802f698..23bb8bc0124 100644 --- a/docs/api/paddle/nn/ZeroPad2D_cn.rst +++ b/docs/api/paddle/nn/ZeroPad2D_cn.rst @@ -8,7 +8,9 @@ ZeroPad2D 按照 padding 属性对输入进行零填充。 -参数： +参数 +::::::::: + - **padding** (Tensor | List[int] | int]) - 填充大小。如果是int，则在所有待填充边界使用相同的填充， 否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。 - **data_format** (str) - 指定输入的format，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 @@ -16,7 +18,8 @@ ZeroPad2D 返回：无 -**代码示例** +代码示例 +::::::::: .. code-block:: python From aff38e7a73a4d385cf11f012a9201aa18f5720e2 Mon Sep 17 00:00:00 2001 From: gsq7474741 Date: Fri, 26 Nov 2021 10:03:42 +0800 Subject: [PATCH 6/9] add doc of zeropad2d v0.4 --- docs/api/paddle/nn/Overview_cn.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api/paddle/nn/Overview_cn.rst b/docs/api/paddle/nn/Overview_cn.rst index c56093e1579..3ae0083d8c7 100644 --- a/docs/api/paddle/nn/Overview_cn.rst +++ b/docs/api/paddle/nn/Overview_cn.rst @@ -102,6 +102,7 @@ Padding层 " :ref:`paddle.nn.Pad1D ` ", "一维填充层" " :ref:`paddle.nn.Pad2D ` ", "二维填充层" " :ref:`paddle.nn.Pad3D ` ", "三维填充层" + " :ref:`paddle.nn.ZeroPad2D ` ", "二维零填充层" .. _activation_layers: @@ -344,6 +345,7 @@ Padding相关函数 " :ref:`paddle.nn.functional.pad ` ", "依照 pad 和 mode 属性对input进行填充" + " :ref:`paddle.nn.functional.zeropad2d <_cn_api_nn_functional_zeropad2d>` ", "依照 pad 对x进行零填充" .. _activation_functional: From 892d88db9b1162e202bc047de8c83f04fad31133 Mon Sep 17 00:00:00 2001 From: Chen Long <1300851984@qq.com> Date: Mon, 29 Nov 2021 09:21:10 +0800 Subject: [PATCH 7/9] Update Overview_cn.rst --- docs/api/paddle/nn/Overview_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/nn/Overview_cn.rst b/docs/api/paddle/nn/Overview_cn.rst index 3ae0083d8c7..8f1d385f6be 100644 --- a/docs/api/paddle/nn/Overview_cn.rst +++ b/docs/api/paddle/nn/Overview_cn.rst @@ -345,7 +345,7 @@ Padding相关函数 " :ref:`paddle.nn.functional.pad ` ", "依照 pad 和 mode 属性对input进行填充" - " :ref:`paddle.nn.functional.zeropad2d <_cn_api_nn_functional_zeropad2d>` ", "依照 pad 对x进行零填充" + " :ref:`paddle.nn.functional.zeropad2d ` ", "依照 pad 对x进行零填充" .. _activation_functional: From 8000a9a2c238173bfe771a541c412ea93067670d Mon Sep 17 00:00:00 2001 From: Chen Long <1300851984@qq.com> Date: Mon, 29 Nov 2021 09:22:22 +0800 Subject: [PATCH 8/9] Update ZeroPad2D_cn.rst --- docs/api/paddle/nn/ZeroPad2D_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/nn/ZeroPad2D_cn.rst b/docs/api/paddle/nn/ZeroPad2D_cn.rst index 23bb8bc0124..54f8e1c84a0 100644 --- a/docs/api/paddle/nn/ZeroPad2D_cn.rst +++ b/docs/api/paddle/nn/ZeroPad2D_cn.rst @@ -2,7 +2,7 @@ ZeroPad2D ------------------------------- -.. py:class:: paddle.nn.ZeroPad2D(self, padding, data_format="NCHW", name=None) +.. py:class:: paddle.nn.ZeroPad2D(padding, data_format="NCHW", name=None) **ZeroPad2D** From 891deb083a43d218d36999fd419d7abd8cb9f938 Mon Sep 17 00:00:00 2001 From: gsq7474741 Date: Mon, 29 Nov 2021 10:13:26 +0800 Subject: [PATCH 9/9] add doc of zeropad2d v0.5 --- docs/api/paddle/nn/ZeroPad2D_cn.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/api/paddle/nn/ZeroPad2D_cn.rst b/docs/api/paddle/nn/ZeroPad2D_cn.rst index 23bb8bc0124..834fcc05f37 100644 --- a/docs/api/paddle/nn/ZeroPad2D_cn.rst +++ b/docs/api/paddle/nn/ZeroPad2D_cn.rst @@ -18,6 +18,12 @@ ZeroPad2D 返回：无 +形状 +::::::::: + + - x(Tensor): ZeroPadD层的输入，要求形状为4-D，dtype为 ``'float32'`` 或 ``'float64'`` + - output(Tensor): 输出，形状为4-D，dtype与 ``'input'`` 相同 + 代码示例 :::::::::