Skip to content

update paddle.nn.Pad1D/2D/3D cn docs #5136

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

Merged
merged 7 commits into from
Aug 23, 2022
Merged

update paddle.nn.Pad1D/2D/3D cn docs #5136

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
3061b83
update paddle.nn.Pad1D/2D/3D cn docs
liyongchao911 Aug 15, 2022
b2ff037
update Pad1D/2D/3D cn docs
liyongchao911 Aug 15, 2022
68b1879
update pad docs format issue
liyongchao911 Aug 15, 2022
81224e1
update format issue
liyongchao911 Aug 17, 2022
85aeaa7
fix format issue
liyongchao911 Aug 17, 2022
77f6b75
fix format issue
liyongchao911 Aug 17, 2022
798415a
update format issue
liyongchao911 Aug 23, 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
12 changes: 6 additions & 6 deletions docs/api/paddle/nn/NLLLoss_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ NLLLoss

参数
:::::::::
- **weight** (Tensor，可选): - 手动指定每个类别的权重。其默认为 `None`。如果提供该参数的话，长度必须为 `num_classes`。数据类型为 float32 或 float64。
- **ignore_index** (int64，可选): - 指定一个忽略的标签值，此标签值不参与计算。默认值为-100。数据类型为 int64。
- **reduction** (str，可选): - 指定应用于输出结果的计算方式，可选值有：`none`, `mean`, `sum`。默认为 `mean`，计算 `mini-batch` loss 均值。设置为 `sum` 时，计算 `mini-batch` loss 的总和。设置为 `none` 时，则返回 loss Tensor。数据类型为 string。
- **weight** (Tensor，可选) - 手动指定每个类别的权重。其默认为 `None`。如果提供该参数的话，长度必须为 `num_classes`。数据类型为 float32 或 float64。
- **ignore_index** (int64，可选) - 指定一个忽略的标签值，此标签值不参与计算。默认值为-100。数据类型为 int64。
- **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：`none`, `mean`, `sum`。默认为 `mean`，计算 `mini-batch` loss 均值。设置为 `sum` 时，计算 `mini-batch` loss 的总和。设置为 `none` 时，则返回 loss Tensor。数据类型为 string。
- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

形状
:::::::::
- **input** (Tensor): - 输入 `Tensor`，其形状为 :math:`[N, C]`，其中 `C` 为类别数。但是对于多维度的情形下，它的形状为 :math:`[N, C, d_1, d_2, ..., d_K]`。数据类型为 float32 或 float64。
- **label** (Tensor): - 输入 `input` 对应的标签值。其形状为 :math:`[N,]` 或者 :math:`[N, d_1, d_2, ..., d_K]`，数据类型为 int64。
- **output** (Tensor): - 输入 `input` 和 `label` 间的 `negative log likelihood loss` 损失。如果 `reduction` 为 `'none'`，则输出 Loss 形状为 `[N, *]`。如果 `reduction` 为 `'sum'` 或者 `'mean'`，则输出 Loss 形状为 `'[1]'` 。
- **input** (Tensor) - 输入 `Tensor`，其形状为 :math:`[N, C]`，其中 `C` 为类别数。但是对于多维度的情形下，它的形状为 :math:`[N, C, d_1, d_2, ..., d_K]`。数据类型为 float32 或 float64。
- **label** (Tensor) - 输入 `input` 对应的标签值。其形状为 :math:`[N,]` 或者 :math:`[N, d_1, d_2, ..., d_K]`，数据类型为 int64。
- **output** (Tensor) - 输入 `input` 和 `label` 间的 `negative log likelihood loss` 损失。如果 `reduction` 为 `'none'`，则输出 Loss 形状为 `[N, *]`。如果 `reduction` 为 `'sum'` 或者 `'mean'`，则输出 Loss 形状为 `'[1]'` 。

代码示例
:::::::::
Expand Down
19 changes: 10 additions & 9 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 @@ -4,20 +4,21 @@ Pad1D
-------------------------------
.. py:class:: paddle.nn.Pad1D(padding, mode="constant", value=0.0, data_format="NCL", name=None)

**Pad1D**

按照 padding、mode 和 value 属性对输入进行填充。

参数
::::::::::::

- **padding** (Tensor | List[int] | int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充，
否则填充的格式为[pad_left, pad_right]。
- **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'``。
- **padding** (Tensor|list[int]|int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充，否则填充的格式为[pad_left, pad_right]。
- **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``，默认值为 ``'constant'``。

- ``'constant'`` 表示填充常数 ``value``；
- ``'reflect'`` 表示填充以输入边界值为轴的映射；
- ``'replicate'`` 表示填充输入边界值；
- ``'circular'`` 为循环填充输入。

- **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。
- **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCL'`` 或者 ``'NLC'`` ，默认值为 ``'NCL'``。
- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

返回
Expand Down
19 changes: 10 additions & 9 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 @@ -4,20 +4,21 @@ Pad2D
-------------------------------
.. py:class:: paddle.nn.Pad2D(padding, mode="constant", value=0.0, data_format="NCHW", name=None)

**Pad2D**

按照 padding、mode 和 value 属性对输入进行填充。

参数
::::::::::::

- **padding** (Tensor | List[int] | int]) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充，
否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。
- **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'``。
- **padding** (Tensor|list[int]|int]) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充，否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。
- **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``，默认值为 ``'constant'``。

- ``'constant'`` 表示填充常数 ``value``；
- ``'reflect'`` 表示填充以输入边界值为轴的映射；
- ``'replicate'`` 表示填充输入边界值；
- ``'circular'`` 为循环填充输入。

- **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。
- **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。
- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

返回
Expand Down
19 changes: 10 additions & 9 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 @@ -4,20 +4,21 @@ Pad3D
-------------------------------
.. py:class:: paddle.nn.Pad3D(padding, mode="constant", value=0.0, data_format="NCDHW", name=None)

**Pad3D**

按照 padding、mode 和 value 属性对输入进行填充。

参数
::::::::::::

- **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'``。
``'constant'`` 表示填充常数 ``value``； ``'reflect'`` 表示填充以输入边界值为轴的映射；``'replicate'`` 表示
填充输入边界值；``'circular'`` 为循环填充输入。默认值为 ``'constant'`` 。
- **value** (float32) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。
- **data_format** (str) - 指定输入的 format，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``。
- **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'``，默认值为 ``'constant'``。

- ``'constant'`` 表示填充常数 ``value``；
- ``'reflect'`` 表示填充以输入边界值为轴的映射；
- ``'replicate'`` 表示填充输入边界值；
- ``'circular'`` 为循环填充输入。

- **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。
- **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``。
- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

返回
Expand Down
10 changes: 5 additions & 5 deletions docs/api/paddle/nn/functional/nll_loss_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ nll_loss

参数
:::::::::
- **input** (Tensor): - 输入 `Tensor`，其形状为 :math:`[N, C]`，其中 `C` 为类别数。但是对于多维度的情形下，它的形状为 :math:`[N, C, d_1, d_2, ..., d_K]`。数据类型为 float32 或 float64。
- **label** (Tensor): - 输入 x 对应的标签值。其形状为 :math:`[N,]` 或者 :math:`[N, d_1, d_2, ..., d_K]`，数据类型为 int64。
- **weight** (Tensor，可选): - 手动指定每个类别的权重。其默认为 `None`。如果提供该参数的话，长度必须为 `num_classes`。数据类型为 float32 或 float64。
- **ignore_index** (int64，可选): - 指定一个忽略的标签值，此标签值不参与计算。默认值为-100。数据类型为 int64。
- **reduction** (str，可选): - 指定应用于输出结果的计算方式，可选值有：`none`, `mean`, `sum`。默认为 `mean`，计算 `mini-batch` loss 均值。设置为 `sum` 时，计算 `mini-batch` loss 的总和。设置为 `none` 时，则返回 loss Tensor。数据类型为 string。
- **input** (Tensor) - 输入 `Tensor`，其形状为 :math:`[N, C]`，其中 `C` 为类别数。但是对于多维度的情形下，它的形状为 :math:`[N, C, d_1, d_2, ..., d_K]`。数据类型为 float32 或 float64。
- **label** (Tensor) - 输入 x 对应的标签值。其形状为 :math:`[N,]` 或者 :math:`[N, d_1, d_2, ..., d_K]`，数据类型为 int64。
- **weight** (Tensor，可选) - 手动指定每个类别的权重。其默认为 `None`。如果提供该参数的话，长度必须为 `num_classes`。数据类型为 float32 或 float64。
- **ignore_index** (int，可选) - 指定一个忽略的标签值，此标签值不参与计算。默认值为-100。数据类型为 int64。
- **reduction** (str，可选) - 指定应用于输出结果的计算方式，可选值有：`none`, `mean`, `sum`。默认为 `mean`，计算 `mini-batch` loss 均值。设置为 `sum` 时，计算 `mini-batch` loss 的总和。设置为 `none` 时，则返回 loss Tensor。数据类型为 string。
- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。

返回
Expand Down
31 changes: 16 additions & 15 deletions docs/api/paddle/nn/functional/pad_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,27 @@ pad
参数
::::::::::::

- **x** (Tensor) - Tensor，format 可以为 ``'NCL'``, ``'NLC'``, ``'NCHW'``, ``'NHWC'``, ``'NCDHW'``
或 ``'NDHWC'``，默认值为 ``'NCHW'``，数据类型支持 float16, float32, float64, int32, int64。
- **pad** (Tensor | List[int] | Tuple[int]) - 填充大小。如果 ``mode`` 为 ``'constant'``，并且 ``pad`` 的长度为 ``x`` 维度的 2 倍时，
则会根据 ``pad`` 和 ``value`` 对 ``x`` 从前面的维度向后依次补齐；否则：1。当输入维度为 3 时，pad 的格式为[pad_left, pad_right]；
2. 当输入维度为 4 时，pad 的格式为[pad_left, pad_right, pad_top, pad_bottom]；
3. 当输入维度为 5 时，pad 的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。
- **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。
``'constant'`` 表示填充常数 ``value``； ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射；``'replicate'`` 表示
填充 ``x`` 边界值；``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。默认值为 ``'constant'``。
- **value** (float32，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。
- **data_format** (str，可选) - 指定 ``x`` 的 format，可为 ``'NCL'``, ``'NLC'``, ``'NCHW'``, ``'NHWC'``, ``'NCDHW'``
或 ``'NDHWC'``，默认值为 ``'NCHW'``。
- **x** (Tensor) - Tensor，format 可以为 ``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'`` 或 ``'NDHWC'``，默认值为 ``'NCHW'``，数据类型支持 float16、float32、float64、int32、int64。
- **pad** (Tensor|list[int]|tuple[int]) - 填充大小。如果 ``mode`` 为 ``'constant'``，并且 ``pad`` 的长度为 ``x`` 维度的 2 倍时，则会根据 ``pad`` 和 ``value`` 对 ``x`` 从前面的维度向后依次补齐；否则：

- 当输入维度为 3 时，pad 的格式为[pad_left, pad_right]；
- 当输入维度为 4 时，pad 的格式为[pad_left, pad_right, pad_top, pad_bottom]；
- 当输入维度为 5 时，pad 的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。

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

- ``'constant'`` 表示填充常数 ``value``；
- ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射；
- ``'replicate'`` 表示填充 ``x`` 边界值；
- ``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。
Copy link
Member

@SigureMo SigureMo Aug 15, 2022

Choose a reason for hiding this comment

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

这里列表还是有问题，需要空行：

image

这里它将紧贴着的渲染成了 <dl>，可参考 https://zh-sphinx-doc.readthedocs.io/en/latest/rest.html#id18 ，这里有说「列表可以嵌套，但是需跟父列表使用空行分隔」，所以可能需要写成这样：

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

     - ``'constant'`` 表示填充常数 ``value``；
     - ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射；
     - ``'replicate'`` 表示填充 ``x`` 边界值；
     - ``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。
 
  - **value** (float32，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。

非常抱歉并不是很熟悉嵌套列表，所以之前有点误导


- **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。
- **data_format** (str，可选) - 指定 ``x`` 的数据格式，可为 ``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'`` 或 ``'NDHWC'``，默认值为 ``'NCHW'``。
- **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。
返回
::::::::::::
Tensor，对 ``x`` 进行 ``'pad'`` 的结果，数据类型和 ``x`` 相同。

返回类型



**示例**：

Expand Down