Skip to content

fix nn.Pad1D/2D/3D class issue #5126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 7 commits into from
Closed

fix nn.Pad1D/2D/3D class issue #5126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
78aeea7
align the code example with en docs using copy from function
liyongchao911 Apr 26, 2022
1b9c397
updata copy from function local
liyongchao911 Apr 29, 2022
f0969d5
Merge branch 'develop' of https://github.com/PaddlePaddle/docs into d…
liyongchao911 May 1, 2022
30bed2b
Merge branch 'develop' of https://github.com/PaddlePaddle/docs into d…
liyongchao911 May 6, 2022
1a883ed
update Pad1D/2D/3D class api
liyongchao911 Aug 11, 2022
89fdb03
update to resolve the confict
liyongchao911 Aug 11, 2022
a12d04a
update docs with COPY-FROM function for the code example
liyongchao911 Aug 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api/paddle/multiplex_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,6 @@ Tensor, 进行Multiplex运算后的输出Tensor。
代码示例
::::::::::::


COPY-FROM: paddle.multiplex:code-example1

23 changes: 5 additions & 18 deletions docs/api/paddle/nn/Pad1D_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Pad1D

- **padding** (Tensor | List[int] | int) - 填充大小。如果是int，则在所有待填充边界使用相同的填充，
否则填充的格式为[pad_left, pad_right]。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

list[int] 统一小写吧，英文一起改下

中文的话，同一个参数不需要折行，折行会在中间加空格。

这里的 如果是int 中间不应该没有空格，是不是没有合并上游修改，现在最新的 develop 是这样的：

image

COPY-FROM 我也在那个 PR 里加了，所以重新合并下上游吧

- **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。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

改为中文逗号后后面不需要加空格

Copy link
Member

@SigureMo SigureMo Aug 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

注意本地需要用 pre-commit 来处理下代码风格的问题，比如这里中英文（数字）之间要有空格

如果本地是大小写不敏感的文件系统，安装 pre-commit 后无法成功 commit，可以尝试逐个文件进行修复。

pre-commit run --files <file_name>

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里应该直接写 float，float32 不是 Python 原生的数据类型

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

:math:`0.0`

这里的数字默认值可以这样写～

- **data_format** (str， 可选) - 指定输入的format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``。
- **name** (str， 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里可以改成这个：

docs/docs/templates/common_docs.py

Line 42 in 6dc68c9

name (str，可选) - 具体用法请参见 :ref:`api_guide_Name` ，一般无需设置，默认值为 None。

英文可同步修改为：

docs/docs/templates/common_docs.py

Line 9 in 6dc68c9

name (str, optional): For details, please refer to :ref:`api_guide_Name`. Generally, no setting is required. Default: None.

可能需要注意 copy 过来后改一下格式～


返回
::::::::::::
Expand All @@ -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
Copy link
Member

@SigureMo SigureMo Aug 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里格式不太对 
COPY-FROM: paddle.nn.Pad1D

在确定唯一的情况下，不建议加一个 :name: 属性哒，英文那面也删一下

看下面的 review 消息，直接 merge 上游修改即可，因为这些上游改过了，当然英文那面也是不需要加 :name: 的

26 changes: 5 additions & 21 deletions docs/api/paddle/nn/Pad2D_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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。

返回
::::::::::::
Expand All @@ -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
26 changes: 5 additions & 21 deletions docs/api/paddle/nn/Pad3D_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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。

返回
::::::::::::
Expand All @@ -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