Skip to content

Commit 38f3abf

Browse files
update paddle.nn.Pad1D/2D/3D cn docs (PaddlePaddle#5136)
* update paddle.nn.Pad1D/2D/3D cn docs * update Pad1D/2D/3D cn docs * update pad docs format issue * update format issue * fix format issue * fix format issue * update format issue
1 parent a6143dd commit 38f3abf

File tree

6 files changed

+57
-53
lines changed

6 files changed

+57
-53
lines changed

docs/api/paddle/nn/NLLLoss_cn.rst

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

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

4646
代码示例
4747
:::::::::

docs/api/paddle/nn/Pad1D_cn.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@ Pad1D
44
-------------------------------
55
.. py:class:: paddle.nn.Pad1D(padding, mode="constant", value=0.0, data_format="NCL", name=None)
66
7-
**Pad1D**
8-
97
按照 padding、mode 和 value 属性对输入进行填充。
108

119
参数
1210
::::::::::::
1311

14-
- **padding** (Tensor | List[int] | int) - 填充大小。如果是 int,则在所有待填充边界使用相同的填充,
15-
否则填充的格式为[pad_left, pad_right]。
16-
- **mode** (str) - padding 的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。
17-
``'constant'`` 表示填充常数 ``value`` ; ``'reflect'`` 表示填充以输入边界值为轴的映射;``'replicate'`` 表示
18-
填充输入边界值;``'circular'`` 为循环填充输入。默认值为 ``'constant'``。
19-
- **value** (float32) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。
20-
- **data_format** (str) - 指定输入的 format,可为 ``'NCL'`` 或者 ``'NLC'``,默认值为 ``'NCL'``。
12+
- **padding** (Tensor|list[int]|int) - 填充大小。如果是 int,则在所有待填充边界使用相同的填充,否则填充的格式为[pad_left, pad_right]。
13+
- **mode** (str,可选) - padding 的四种模式,分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``,默认值为 ``'constant'``。
14+
15+
- ``'constant'`` 表示填充常数 ``value``;
16+
- ``'reflect'`` 表示填充以输入边界值为轴的映射;
17+
- ``'replicate'`` 表示填充输入边界值;
18+
- ``'circular'`` 为循环填充输入。
19+
20+
- **value** (float,可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。
21+
- **data_format** (str,可选) - 指定输入的数据格式,可为 ``'NCL'`` 或者 ``'NLC'`` ,默认值为 ``'NCL'``。
2122
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2223

2324
返回

docs/api/paddle/nn/Pad2D_cn.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@ Pad2D
44
-------------------------------
55
.. py:class:: paddle.nn.Pad2D(padding, mode="constant", value=0.0, data_format="NCHW", name=None)
66
7-
**Pad2D**
8-
97
按照 padding、mode 和 value 属性对输入进行填充。
108

119
参数
1210
::::::::::::
1311

14-
- **padding** (Tensor | List[int] | int]) - 填充大小。如果是 int,则在所有待填充边界使用相同的填充,
15-
否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。
16-
- **mode** (str) - padding 的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。
17-
``'constant'`` 表示填充常数 ``value``; ``'reflect'`` 表示填充以输入边界值为轴的映射;``'replicate'`` 表示
18-
填充输入边界值;``'circular'`` 为循环填充输入。默认值为 ``'constant'`` 。
19-
- **value** (float32) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。
20-
- **data_format** (str) - 指定输入的 format,可为 ``'NCHW'`` 或者 ``'NHWC'``,默认值为 ``'NCHW'``。
12+
- **padding** (Tensor|list[int]|int]) - 填充大小。如果是 int,则在所有待填充边界使用相同的填充,否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。
13+
- **mode** (str,可选) - padding 的四种模式,分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``,默认值为 ``'constant'``。
14+
15+
- ``'constant'`` 表示填充常数 ``value``;
16+
- ``'reflect'`` 表示填充以输入边界值为轴的映射;
17+
- ``'replicate'`` 表示填充输入边界值;
18+
- ``'circular'`` 为循环填充输入。
19+
20+
- **value** (float,可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。
21+
- **data_format** (str,可选) - 指定输入的数据格式,可为 ``'NCHW'`` 或者 ``'NHWC'``,默认值为 ``'NCHW'``。
2122
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2223

2324
返回

docs/api/paddle/nn/Pad3D_cn.rst

+10-9
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@ Pad3D
44
-------------------------------
55
.. py:class:: paddle.nn.Pad3D(padding, mode="constant", value=0.0, data_format="NCDHW", name=None)
66
7-
**Pad3D**
8-
97
按照 padding、mode 和 value 属性对输入进行填充。
108

119
参数
1210
::::::::::::
1311

14-
- **padding** (Tensor | List[int] | int) - 填充大小。如果是 int,则在所有待填充边界使用相同的填充,
15-
否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。
16-
- **mode** (str) - padding 的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。
17-
``'constant'`` 表示填充常数 ``value``; ``'reflect'`` 表示填充以输入边界值为轴的映射;``'replicate'`` 表示
18-
填充输入边界值;``'circular'`` 为循环填充输入。默认值为 ``'constant'`` 。
19-
- **value** (float32) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。
20-
- **data_format** (str) - 指定输入的 format,可为 ``'NCDHW'`` 或者 ``'NDHWC'``,默认值为 ``'NCDHW'``。
12+
- **padding** (Tensor|list[int]|int) - 填充大小。如果是 int,则在所有待填充边界使用相同的填充,否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。
13+
- **mode** (str,可选) - padding 的四种模式,分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``,默认值为 ``'constant'``。
14+
15+
- ``'constant'`` 表示填充常数 ``value``;
16+
- ``'reflect'`` 表示填充以输入边界值为轴的映射;
17+
- ``'replicate'`` 表示填充输入边界值;
18+
- ``'circular'`` 为循环填充输入。
19+
20+
- **value** (float,可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。
21+
- **data_format** (str,可选) - 指定输入的数据格式,可为 ``'NCDHW'`` 或者 ``'NDHWC'``,默认值为 ``'NCDHW'``。
2122
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2223

2324
返回

docs/api/paddle/nn/functional/nll_loss_cn.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ nll_loss
88

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

1818
返回

docs/api/paddle/nn/functional/pad_cn.rst

+16-15
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,27 @@ pad
1212
参数
1313
::::::::::::
1414

15-
- **x** (Tensor) - Tensor,format 可以为 ``'NCL'``, ``'NLC'``, ``'NCHW'``, ``'NHWC'``, ``'NCDHW'``
16-
或 ``'NDHWC'``,默认值为 ``'NCHW'``,数据类型支持 float16, float32, float64, int32, int64。
17-
- **pad** (Tensor | List[int] | Tuple[int]) - 填充大小。如果 ``mode`` 为 ``'constant'``,并且 ``pad`` 的长度为 ``x`` 维度的 2 倍时,
18-
则会根据 ``pad`` 和 ``value`` 对 ``x`` 从前面的维度向后依次补齐;否则:1。当输入维度为 3 时,pad 的格式为[pad_left, pad_right];
19-
2. 当输入维度为 4 时,pad 的格式为[pad_left, pad_right, pad_top, pad_bottom];
20-
3. 当输入维度为 5 时,pad 的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。
21-
- **mode** (str,可选) - padding 的四种模式,分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。
22-
``'constant'`` 表示填充常数 ``value``; ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射;``'replicate'`` 表示
23-
填充 ``x`` 边界值;``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。默认值为 ``'constant'``。
24-
- **value** (float32,可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。
25-
- **data_format** (str,可选) - 指定 ``x`` 的 format,可为 ``'NCL'``, ``'NLC'``, ``'NCHW'``, ``'NHWC'``, ``'NCDHW'``
26-
或 ``'NDHWC'``,默认值为 ``'NCHW'``。
15+
- **x** (Tensor) - Tensor,format 可以为 ``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'`` 或 ``'NDHWC'``,默认值为 ``'NCHW'``,数据类型支持 float16、float32、float64、int32、int64。
16+
- **pad** (Tensor|list[int]|tuple[int]) - 填充大小。如果 ``mode`` 为 ``'constant'``,并且 ``pad`` 的长度为 ``x`` 维度的 2 倍时,则会根据 ``pad`` 和 ``value`` 对 ``x`` 从前面的维度向后依次补齐;否则:
17+
18+
- 当输入维度为 3 时,pad 的格式为[pad_left, pad_right];
19+
- 当输入维度为 4 时,pad 的格式为[pad_left, pad_right, pad_top, pad_bottom];
20+
- 当输入维度为 5 时,pad 的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。
21+
22+
- **mode** (str,可选) - padding 的四种模式,分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``,
23+
24+
- ``'constant'`` 表示填充常数 ``value``;
25+
- ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射;
26+
- ``'replicate'`` 表示填充 ``x`` 边界值;
27+
- ``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。
28+
29+
- **value** (float,可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。
30+
- **data_format** (str,可选) - 指定 ``x`` 的数据格式,可为 ``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'`` 或 ``'NDHWC'``,默认值为 ``'NCHW'``。
2731
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2832
返回
2933
::::::::::::
3034
Tensor,对 ``x`` 进行 ``'pad'`` 的结果,数据类型和 ``x`` 相同。
3135

32-
返回类型
33-
34-
3536

3637
**示例**:
3738

0 commit comments

Comments
 (0)