Skip to content
2 changes: 2 additions & 0 deletions docs/api/paddle/nn/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ Padding层
" :ref:`paddle.nn.Pad1D <cn_api_nn_Pad1D>` ", "一维填充层"
" :ref:`paddle.nn.Pad2D <cn_api_nn_Pad2D>` ", "二维填充层"
" :ref:`paddle.nn.Pad3D <cn_api_nn_Pad3D>` ", "三维填充层"
" :ref:`paddle.nn.ZeroPad2D <cn_api_nn_ZeroPad2D>` ", "二维零填充层"

.. _activation_layers:

Expand Down Expand Up @@ -344,6 +345,7 @@ Padding相关函数


" :ref:`paddle.nn.functional.pad <cn_api_nn_cn_pad>` ", "依照 pad 和 mode 属性对input进行填充"
" :ref:`paddle.nn.functional.zeropad2d <cn_api_nn_functional_zeropad2d>` ", "依照 pad 对x进行零填充"

.. _activation_functional:

Expand Down
50 changes: 50 additions & 0 deletions docs/api/paddle/nn/ZeroPad2D_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
.. _cn_api_nn_ZeroPad2D:

ZeroPad2D
-------------------------------
.. py:class:: paddle.nn.ZeroPad2D(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。

返回:无

形状
:::::::::

- x(Tensor): ZeroPadD层的输入,要求形状为4-D,dtype为 ``'float32'`` 或 ``'float64'``
- output(Tensor): 输出,形状为4-D,dtype与 ``'input'`` 相同

代码示例
:::::::::

.. 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.]]]]


37 changes: 37 additions & 0 deletions docs/api/paddle/nn/functional/zeropad2d_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. _cn_api_nn_functional_zeropad2d:

zeropad2d
-------------------------------
.. py:function:: paddle.nn.functional.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。
- **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。

返回
::::::::::
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.nn.functional.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.]]]]