From 3061b83a29a366680c52ea766f0734201b39e81a Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Mon, 15 Aug 2022 14:46:21 +0800 Subject: [PATCH 1/7] update paddle.nn.Pad1D/2D/3D cn docs --- docs/api/paddle/nn/Pad1D_cn.rst | 8 ++++---- docs/api/paddle/nn/Pad2D_cn.rst | 8 ++++---- docs/api/paddle/nn/Pad3D_cn.rst | 8 ++++---- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api/paddle/nn/Pad1D_cn.rst b/docs/api/paddle/nn/Pad1D_cn.rst index fc6d0d952c3..285d0606f9e 100644 --- a/docs/api/paddle/nn/Pad1D_cn.rst +++ b/docs/api/paddle/nn/Pad1D_cn.rst @@ -11,13 +11,13 @@ Pad1D 参数 :::::::::::: - - **padding** (Tensor | List[int] | int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充， + - **padding** (Tensor|list[int]|int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充， 否则填充的格式为[pad_left, pad_right]。 - - **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'``。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。 + - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/Pad2D_cn.rst b/docs/api/paddle/nn/Pad2D_cn.rst index 0aad0e3acb6..fc88a0f2a4f 100644 --- a/docs/api/paddle/nn/Pad2D_cn.rst +++ b/docs/api/paddle/nn/Pad2D_cn.rst @@ -11,13 +11,13 @@ Pad2D 参数 :::::::::::: - - **padding** (Tensor | List[int] | int]) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充， + - **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'``。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。 + - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/Pad3D_cn.rst b/docs/api/paddle/nn/Pad3D_cn.rst index 2dc4cee8b1b..02d30514e0a 100644 --- a/docs/api/paddle/nn/Pad3D_cn.rst +++ b/docs/api/paddle/nn/Pad3D_cn.rst @@ -11,13 +11,13 @@ Pad3D 参数 :::::::::::: - - **padding** (Tensor | List[int] | int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充， + - **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'``。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。 + - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 From b2ff037e073c70e15f197b0bc57ff5299c5a0946 Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Mon, 15 Aug 2022 16:33:20 +0800 Subject: [PATCH 2/7] update Pad1D/2D/3D cn docs --- docs/api/paddle/nn/Pad1D_cn.rst | 13 ++++++------ docs/api/paddle/nn/Pad2D_cn.rst | 11 ++++++----- docs/api/paddle/nn/Pad3D_cn.rst | 11 ++++++----- docs/api/paddle/nn/functional/pad_cn.rst | 25 +++++++++++------------- 4 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/api/paddle/nn/Pad1D_cn.rst b/docs/api/paddle/nn/Pad1D_cn.rst index 285d0606f9e..1aec9ac9e4e 100644 --- a/docs/api/paddle/nn/Pad1D_cn.rst +++ b/docs/api/paddle/nn/Pad1D_cn.rst @@ -11,13 +11,14 @@ Pad1D 参数 :::::::::::: - - **padding** (Tensor|list[int]|int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充， - 否则填充的格式为[pad_left, pad_right]。 + - **padding** (Tensor|list[int]|int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充，否则填充的格式为[pad_left, pad_right]。 - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。 - ``'constant'`` 表示填充常数 ``value`` ； ``'reflect'`` 表示填充以输入边界值为轴的映射；``'replicate'`` 表示 - 填充输入边界值；``'circular'`` 为循环填充输入。默认值为 ``'constant'``。 - - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。 - - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``。 + - ``'constant'`` 表示填充常数 ``value``； + - ``'reflect'`` 表示填充以输入边界值为轴的映射； + - ``'replicate'`` 表示填充输入边界值； + - ``'circular'`` 为循环填充输入。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 + - **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCL'`` 或者 ``'NLC'``，默认值为 ``'NCL'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/Pad2D_cn.rst b/docs/api/paddle/nn/Pad2D_cn.rst index fc88a0f2a4f..24a49c17fe3 100644 --- a/docs/api/paddle/nn/Pad2D_cn.rst +++ b/docs/api/paddle/nn/Pad2D_cn.rst @@ -11,12 +11,13 @@ Pad2D 参数 :::::::::::: - - **padding** (Tensor|list[int]|int]) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充， - 否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。 + - **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** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。 + - ``'constant'`` 表示填充常数 ``value``； + - ``'reflect'`` 表示填充以输入边界值为轴的映射； + - ``'replicate'`` 表示填充输入边界值； + - ``'circular'`` 为循环填充输入。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/Pad3D_cn.rst b/docs/api/paddle/nn/Pad3D_cn.rst index 02d30514e0a..3db92b672dd 100644 --- a/docs/api/paddle/nn/Pad3D_cn.rst +++ b/docs/api/paddle/nn/Pad3D_cn.rst @@ -11,12 +11,13 @@ Pad3D 参数 :::::::::::: - - **padding** (Tensor|list[int]|int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充， - 否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom, pad_front, pad_back]。 + - **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** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 0.0。 + - ``'constant'`` 表示填充常数 ``value``； + - ``'reflect'`` 表示填充以输入边界值为轴的映射； + - ``'replicate'`` 表示填充输入边界值； + - ``'circular'`` 为循环填充输入。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/pad_cn.rst b/docs/api/paddle/nn/functional/pad_cn.rst index 616fbb36320..e996f00803c 100644 --- a/docs/api/paddle/nn/functional/pad_cn.rst +++ b/docs/api/paddle/nn/functional/pad_cn.rst @@ -12,26 +12,23 @@ 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]。 + - **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'``。 + - ``'constant'`` 表示填充常数 ``value``； + - ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射； + - ``'replicate'`` 表示填充 ``x`` 边界值； + - ``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。默认值为 ``'constant'``。 + - **value** (float32，可选) - 以 ``'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`` 相同。 -返回类型 - - **示例**： From 68b18795cad65ef972c5bcdb9ace7ab40b4534ca Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Mon, 15 Aug 2022 19:18:55 +0800 Subject: [PATCH 3/7] update pad docs format issue --- docs/api/paddle/nn/Pad1D_cn.rst | 10 +++++----- docs/api/paddle/nn/Pad2D_cn.rst | 10 +++++----- docs/api/paddle/nn/Pad3D_cn.rst | 10 +++++----- docs/api/paddle/nn/functional/pad_cn.rst | 18 +++++++++--------- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/api/paddle/nn/Pad1D_cn.rst b/docs/api/paddle/nn/Pad1D_cn.rst index 1aec9ac9e4e..02c34dcda38 100644 --- a/docs/api/paddle/nn/Pad1D_cn.rst +++ b/docs/api/paddle/nn/Pad1D_cn.rst @@ -12,11 +12,11 @@ Pad1D :::::::::::: - **padding** (Tensor|list[int]|int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充，否则填充的格式为[pad_left, pad_right]。 - - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``, ``'reflect'``, ``'replicate'`` 和 ``'circular'``。 - - ``'constant'`` 表示填充常数 ``value``； - - ``'reflect'`` 表示填充以输入边界值为轴的映射； - - ``'replicate'`` 表示填充输入边界值； - - ``'circular'`` 为循环填充输入。 + - **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。 diff --git a/docs/api/paddle/nn/Pad2D_cn.rst b/docs/api/paddle/nn/Pad2D_cn.rst index 24a49c17fe3..cf803d7a379 100644 --- a/docs/api/paddle/nn/Pad2D_cn.rst +++ b/docs/api/paddle/nn/Pad2D_cn.rst @@ -12,11 +12,11 @@ Pad2D :::::::::::: - **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'`` 为循环填充输入。 + - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、 ``'reflect'``、 ``'replicate'`` 和 ``'circular'``，默认值为 ``'constant'``。 + - ``'constant'`` 表示填充常数 ``value``； + - ``'reflect'`` 表示填充以输入边界值为轴的映射； + - ``'replicate'`` 表示填充输入边界值； + - ``'circular'`` 为循环填充输入。 - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/Pad3D_cn.rst b/docs/api/paddle/nn/Pad3D_cn.rst index 3db92b672dd..27237813ce1 100644 --- a/docs/api/paddle/nn/Pad3D_cn.rst +++ b/docs/api/paddle/nn/Pad3D_cn.rst @@ -12,11 +12,11 @@ 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'``。 - - ``'constant'`` 表示填充常数 ``value``； - - ``'reflect'`` 表示填充以输入边界值为轴的映射； - - ``'replicate'`` 表示填充输入边界值； - - ``'circular'`` 为循环填充输入。 + - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、 ``'reflect'``、 ``'replicate'`` 和 ``'circular'``，默认值为 ``'constant'``。 + - ``'constant'`` 表示填充常数 ``value``； + - ``'reflect'`` 表示填充以输入边界值为轴的映射； + - ``'replicate'`` 表示填充输入边界值； + - ``'circular'`` 为循环填充输入。 - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/pad_cn.rst b/docs/api/paddle/nn/functional/pad_cn.rst index e996f00803c..c4214eb7a3b 100644 --- a/docs/api/paddle/nn/functional/pad_cn.rst +++ b/docs/api/paddle/nn/functional/pad_cn.rst @@ -12,16 +12,16 @@ pad 参数 :::::::::::: - - **x** (Tensor) - Tensor，format 可以为 ``'NCL'``, ``'NLC'``, ``'NCHW'``, ``'NHWC'``, ``'NCDHW'``或 ``'NDHWC'``，默认值为 ``'NCHW'``，数据类型支持 float16, float32, float64, int32, int64。 + - **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'``。 + - 当输入维度为 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'``。 + - ``'constant'`` 表示填充常数 ``value``； + - ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射； + - ``'replicate'`` 表示填充 ``x`` 边界值； + - ``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。 - **value** (float32，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - **data_format** (str，可选) - 指定 ``x`` 的数据格式，可为 ``'NCL'``, ``'NLC'``, ``'NCHW'``, ``'NHWC'``, ``'NCDHW'``或 ``'NDHWC'``，默认值为 ``'NCHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 From 81224e1e0ee1c67eec3b8f90e6e8b6244fe4d38b Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Wed, 17 Aug 2022 11:32:35 +0800 Subject: [PATCH 4/7] update format issue --- docs/api/paddle/nn/Pad1D_cn.rst | 6 ++++-- docs/api/paddle/nn/Pad2D_cn.rst | 6 ++++-- docs/api/paddle/nn/Pad3D_cn.rst | 6 ++++-- docs/api/paddle/nn/functional/pad_cn.rst | 12 ++++++++---- 4 files changed, 20 insertions(+), 10 deletions(-) diff --git a/docs/api/paddle/nn/Pad1D_cn.rst b/docs/api/paddle/nn/Pad1D_cn.rst index 02c34dcda38..621a1fcd33d 100644 --- a/docs/api/paddle/nn/Pad1D_cn.rst +++ b/docs/api/paddle/nn/Pad1D_cn.rst @@ -12,13 +12,15 @@ Pad1D :::::::::::: - **padding** (Tensor|list[int]|int) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充，否则填充的格式为[pad_left, pad_right]。 - - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、 ``'reflect'``、 ``'replicate'`` 和 ``'circular'``，默认值为 ``'constant'``。 + - **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'``。 + - **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCL'``或者 ``'NLC'``，默认值为 ``'NCL'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/Pad2D_cn.rst b/docs/api/paddle/nn/Pad2D_cn.rst index cf803d7a379..f332f0fa0a5 100644 --- a/docs/api/paddle/nn/Pad2D_cn.rst +++ b/docs/api/paddle/nn/Pad2D_cn.rst @@ -12,13 +12,15 @@ Pad2D :::::::::::: - **padding** (Tensor|list[int]|int]) - 填充大小。如果是 int，则在所有待填充边界使用相同的填充，否则填充的格式为[pad_left, pad_right, pad_top, pad_bottom]。 - - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、 ``'reflect'``、 ``'replicate'`` 和 ``'circular'``，默认值为 ``'constant'``。 + - **mode** (str，可选) - padding 的四种模式，分别为``'constant'``、``'reflect'``、``'replicate'``和``'circular'``，默认值为 ``'constant'``。 + - ``'constant'`` 表示填充常数 ``value``； - ``'reflect'`` 表示填充以输入边界值为轴的映射； - ``'replicate'`` 表示填充输入边界值； - ``'circular'`` 为循环填充输入。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 + - **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/Pad3D_cn.rst b/docs/api/paddle/nn/Pad3D_cn.rst index 27237813ce1..d5cf60914be 100644 --- a/docs/api/paddle/nn/Pad3D_cn.rst +++ b/docs/api/paddle/nn/Pad3D_cn.rst @@ -12,13 +12,15 @@ 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'``，默认值为 ``'constant'``。 + - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``，默认值为 ``'constant'``。 + - ``'constant'`` 表示填充常数 ``value``； - ``'reflect'`` 表示填充以输入边界值为轴的映射； - ``'replicate'`` 表示填充输入边界值； - ``'circular'`` 为循环填充输入。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - - **data_format** (str，可选) - 指定输入的 format，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``。 + - **data_format** (str，可选) - 指定输入的数据格式，可为``'NCDHW'``或者``'NDHWC'``，默认值为``'NCDHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/pad_cn.rst b/docs/api/paddle/nn/functional/pad_cn.rst index c4214eb7a3b..3f058c99d72 100644 --- a/docs/api/paddle/nn/functional/pad_cn.rst +++ b/docs/api/paddle/nn/functional/pad_cn.rst @@ -12,18 +12,22 @@ pad 参数 :::::::::::: - - **x** (Tensor) - Tensor，format 可以为 ``'NCL'``、 ``'NLC'``、 ``'NCHW'``、 ``'NHWC'``、 ``'NCDHW'``或 ``'NDHWC'``，默认值为 ``'NCHW'``，数据类型支持 float16, float32, float64, int32, int64。 + - **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'``。 + + - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和``'circular'``， + - ``'constant'`` 表示填充常数 ``value``； - ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射； - ``'replicate'`` 表示填充 ``x`` 边界值； - ``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。 - - **value** (float32，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - - **data_format** (str，可选) - 指定 ``x`` 的数据格式，可为 ``'NCL'``, ``'NLC'``, ``'NCHW'``, ``'NHWC'``, ``'NCDHW'``或 ``'NDHWC'``，默认值为 ``'NCHW'``。 + + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 + - **data_format** (str，可选) - 指定 ``x`` 的数据格式，可为``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'``或``'NDHWC'``，默认值为``'NCHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 :::::::::::: From 85aeaa727369ce98c43a7ff5f87dbca6303168b3 Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Wed, 17 Aug 2022 16:54:23 +0800 Subject: [PATCH 5/7] fix format issue --- docs/api/paddle/nn/Pad1D_cn.rst | 8 +++----- docs/api/paddle/nn/Pad2D_cn.rst | 6 ++---- docs/api/paddle/nn/Pad3D_cn.rst | 6 ++---- docs/api/paddle/nn/functional/pad_cn.rst | 6 +++--- 4 files changed, 10 insertions(+), 16 deletions(-) diff --git a/docs/api/paddle/nn/Pad1D_cn.rst b/docs/api/paddle/nn/Pad1D_cn.rst index 621a1fcd33d..ff3ea09a1fb 100644 --- a/docs/api/paddle/nn/Pad1D_cn.rst +++ b/docs/api/paddle/nn/Pad1D_cn.rst @@ -4,23 +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'``。 + - **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'``。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。 + - **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCL'`` 或者 ``'NLC'`` ，默认值为 ``'NCL'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/Pad2D_cn.rst b/docs/api/paddle/nn/Pad2D_cn.rst index f332f0fa0a5..992f85c4ba1 100644 --- a/docs/api/paddle/nn/Pad2D_cn.rst +++ b/docs/api/paddle/nn/Pad2D_cn.rst @@ -4,22 +4,20 @@ 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'``。 + - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``，默认值为 ``'constant'``。 - ``'constant'`` 表示填充常数 ``value``； - ``'reflect'`` 表示填充以输入边界值为轴的映射； - ``'replicate'`` 表示填充输入边界值； - ``'circular'`` 为循环填充输入。 - - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。 - **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCHW'`` 或者 ``'NHWC'``，默认值为 ``'NCHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/Pad3D_cn.rst b/docs/api/paddle/nn/Pad3D_cn.rst index d5cf60914be..b8e6453445f 100644 --- a/docs/api/paddle/nn/Pad3D_cn.rst +++ b/docs/api/paddle/nn/Pad3D_cn.rst @@ -4,8 +4,6 @@ Pad3D ------------------------------- .. py:class:: paddle.nn.Pad3D(padding, mode="constant", value=0.0, data_format="NCDHW", name=None) -**Pad3D** - 按照 padding、mode 和 value 属性对输入进行填充。 参数 @@ -19,8 +17,8 @@ Pad3D - ``'replicate'`` 表示填充输入边界值； - ``'circular'`` 为循环填充输入。 - - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - - **data_format** (str，可选) - 指定输入的数据格式，可为``'NCDHW'``或者``'NDHWC'``，默认值为``'NCDHW'``。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。 + - **data_format** (str，可选) - 指定输入的数据格式，可为 ``'NCDHW'`` 或者 ``'NDHWC'``，默认值为 ``'NCDHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/pad_cn.rst b/docs/api/paddle/nn/functional/pad_cn.rst index 3f058c99d72..c49c54d7b97 100644 --- a/docs/api/paddle/nn/functional/pad_cn.rst +++ b/docs/api/paddle/nn/functional/pad_cn.rst @@ -12,7 +12,7 @@ pad 参数 :::::::::::: - - **x** (Tensor) - Tensor，format 可以为 ``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'``或 ``'NDHWC'``，默认值为 ``'NCHW'``，数据类型支持float16、float32、float64、int32、int64。 + - **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]； @@ -26,8 +26,8 @@ pad - ``'replicate'`` 表示填充 ``x`` 边界值； - ``'circular'`` 为循环填充 ``x``。具体结果可见以下示例。 - - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为:math:`0.0`。 - - **data_format** (str，可选) - 指定 ``x`` 的数据格式，可为``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'``或``'NDHWC'``，默认值为``'NCHW'``。 + - **value** (float，可选) - 以 ``'constant'`` 模式填充区域时填充的值。默认值为 :math:`0.0`。 + - **data_format** (str，可选) - 指定 ``x`` 的数据格式，可为 ``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'`` 或 ``'NDHWC'``，默认值为 ``'NCHW'``。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 :::::::::::: From 77f6b752d9604a028fa861b3b4e1ee663af69c7d Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Wed, 17 Aug 2022 20:39:40 +0800 Subject: [PATCH 6/7] fix format issue --- docs/api/paddle/nn/functional/pad_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/nn/functional/pad_cn.rst b/docs/api/paddle/nn/functional/pad_cn.rst index c49c54d7b97..cb9b3a87250 100644 --- a/docs/api/paddle/nn/functional/pad_cn.rst +++ b/docs/api/paddle/nn/functional/pad_cn.rst @@ -12,14 +12,14 @@ pad 参数 :::::::::::: - - **x** (Tensor) - Tensor，format 可以为 ``'NCL'``、``'NLC'``、``'NCHW'``、``'NHWC'``、``'NCDHW'`` 或 ``'NDHWC'``，默认值为 ``'NCHW'``，数据类型支持float16、float32、float64、int32、int64。 + - **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'``， + - **mode** (str，可选) - padding 的四种模式，分别为 ``'constant'``、``'reflect'``、``'replicate'`` 和 ``'circular'``， - ``'constant'`` 表示填充常数 ``value``； - ``'reflect'`` 表示填充以 ``x`` 边界值为轴的映射； From 798415aab15f5500aa04a716a1b0744dd0cd8dc0 Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Tue, 23 Aug 2022 08:14:04 +0800 Subject: [PATCH 7/7] update format issue --- docs/api/paddle/nn/NLLLoss_cn.rst | 12 ++++++------ docs/api/paddle/nn/functional/nll_loss_cn.rst | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/api/paddle/nn/NLLLoss_cn.rst b/docs/api/paddle/nn/NLLLoss_cn.rst index b68b672c071..0b83647e2fb 100644 --- a/docs/api/paddle/nn/NLLLoss_cn.rst +++ b/docs/api/paddle/nn/NLLLoss_cn.rst @@ -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]'` 。 代码示例 ::::::::: diff --git a/docs/api/paddle/nn/functional/nll_loss_cn.rst b/docs/api/paddle/nn/functional/nll_loss_cn.rst index 14d5cd1c1fc..3973aae5f35 100644 --- a/docs/api/paddle/nn/functional/nll_loss_cn.rst +++ b/docs/api/paddle/nn/functional/nll_loss_cn.rst @@ -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。 返回