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

liyongchao911 · 2022-08-11T08:39:35Z

文档参数部分，对于默认参数加上可选，optional标识，与其他文档保持一致
示例代码部分可以将numpy.prod改成paddle.prod, 并删除import numpy as np

PADDLEPADDLE_PR=45068

…evelop

SigureMo · 2022-08-11T08:51:48Z

docs/api/paddle/multiplex_cn.rst

 COPY-FROM: paddle.multiplex:code-example1
+=======
+COPY-FROM: paddle.multiplex:code-example1
+>>>>>>> 946e985763dcc3ae0f029147b8141c3af4fd9d9a


这里处理冲突出问题啦～

SigureMo · 2022-08-11T08:52:47Z

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'``。


Suggested change

- **mode** (str, 可选) - padding的四种模式，分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。

- **mode** (str，可选) - padding的四种模式，分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。

这里是中文逗号～

SigureMo · 2022-08-11T08:54:04Z

docs/api/paddle/nn/Pad1D_cn.rst

@@ -31,11 +31,11 @@ Pad1D

    import paddle
    import paddle.nn as nn
-    import numpy as np
+


示例代码直接 COPY-FROM 吧，如果 copy 失败了可以找我，我们一起解决呀～

SigureMo · 2022-08-11T13:56:59Z

docs/api/paddle/nn/Pad1D_cn.rst

-    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-FROM: paddle.nn.Pad1D

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

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

SigureMo · 2022-08-11T13:57:26Z

docs/api/paddle/nn/Pad1D_cn.rst

-  - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。
-  - **data_format** (str, 可选)  - 指定输入的format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``。
-  - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。
+  - **value** (float32， 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。


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

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

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

pre-commit run --files <file_name>

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

:math:`0.0`

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

SigureMo

辛苦先合并下上游修改～

SigureMo · 2022-08-11T17:30:20Z

docs/api/paddle/nn/Pad1D_cn.rst

@@ -13,12 +13,12 @@ Pad1D

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


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

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

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

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

SigureMo · 2022-08-11T17:33:11Z

docs/api/paddle/nn/Pad1D_cn.rst

-  - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。
-  - **data_format** (str, 可选)  - 指定输入的format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``。
-  - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。
+  - **value** (float32， 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。


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

SigureMo · 2022-08-11T17:39:03Z

docs/api/paddle/nn/Pad1D_cn.rst

-  - **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。


这里可以改成这个：

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 过来后改一下格式～

SigureMo · 2022-08-11T17:40:04Z

docs/api/paddle/nn/Pad1D_cn.rst

-  - **value** (float32, 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。
-  - **data_format** (str, 可选)  - 指定输入的format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``。
-  - **name** (str, 可选) - 该参数供开发人员打印调试信息时使用，具体用法请参见 :ref:`api_guide_Name` ，缺省值为None。
+  - **value** (float32， 可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为0.0。


:math:`0.0`

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

liyongchao911 · 2022-08-15T06:50:11Z

issue a new PR #5136 instead!

liyongchao911 added 5 commits April 26, 2022 11:21

align the code example with en docs using copy from function

78aeea7

updata copy from function local

1b9c397

Merge branch 'develop' of https://github.com/PaddlePaddle/docs into d…

f0969d5

…evelop

Merge branch 'develop' of https://github.com/PaddlePaddle/docs into d…

30bed2b

…evelop

update Pad1D/2D/3D class api

1a883ed

SigureMo requested changes Aug 11, 2022

View reviewed changes

liyongchao911 added 2 commits August 11, 2022 21:25

update to resolve the confict

89fdb03

update docs with COPY-FROM function for the code example

a12d04a

SigureMo requested changes Aug 11, 2022

View reviewed changes

liyongchao911 closed this Aug 15, 2022

paddle-bot bot added the status: not progressed label Aug 15, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

liyongchao911 commented Aug 11, 2022 •

edited

Loading

SigureMo Aug 11, 2022

SigureMo Aug 11, 2022

SigureMo Aug 11, 2022

liyongchao911 Aug 11, 2022

SigureMo Aug 11, 2022 •

edited

Loading

SigureMo Aug 11, 2022

SigureMo Aug 11, 2022 •

edited

Loading

SigureMo Aug 11, 2022

SigureMo Aug 11, 2022

SigureMo left a comment

SigureMo Aug 11, 2022

SigureMo Aug 11, 2022

SigureMo Aug 11, 2022

SigureMo Aug 11, 2022

liyongchao911 commented Aug 15, 2022 •

edited by Ligoml

Loading

	- mode (str, 可选) - padding的四种模式，分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。
	- mode (str，可选) - padding的四种模式，分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。

		@@ -13,12 +13,12 @@ Pad1D

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

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

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

Conversation

liyongchao911 commented Aug 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SigureMo Aug 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SigureMo Aug 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SigureMo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

liyongchao911 commented Aug 15, 2022 • edited by Ligoml Loading

liyongchao911 commented Aug 11, 2022 •

edited

Loading

SigureMo Aug 11, 2022 •

edited

Loading

SigureMo Aug 11, 2022 •

edited

Loading

liyongchao911 commented Aug 15, 2022 •

edited by Ligoml

Loading