From 628fa84f2bcb5f17b0e5c91b077f7320404c5562 Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Thu, 25 Aug 2022 19:07:09 +0800 Subject: [PATCH 1/5] update PixelShuffle api --- docs/api/paddle/nn/PixelShuffle_cn.rst | 4 ++-- docs/api/paddle/nn/functional/pixel_shuffle_cn.rst | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/paddle/nn/PixelShuffle_cn.rst b/docs/api/paddle/nn/PixelShuffle_cn.rst index e9b8052f94c..8ca80d3c84f 100644 --- a/docs/api/paddle/nn/PixelShuffle_cn.rst +++ b/docs/api/paddle/nn/PixelShuffle_cn.rst @@ -14,8 +14,8 @@ PixelShuffle 参数 ::::::::: - - **upscale_factor** （int)：增大空间分辨率的增大因子 - - **data_format** (str，可选)：数据格式，可选："NCHW"或"NHWC"，默认："NCHW" + - **upscale_factor** （int) - 增大空间分辨率的增大因子 + - **data_format** (str，可选) - 数据格式，可选："NCHW"或"NHWC"，默认："NCHW" - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状 diff --git a/docs/api/paddle/nn/functional/pixel_shuffle_cn.rst b/docs/api/paddle/nn/functional/pixel_shuffle_cn.rst index 3e6b21dca96..2c51768d8f7 100644 --- a/docs/api/paddle/nn/functional/pixel_shuffle_cn.rst +++ b/docs/api/paddle/nn/functional/pixel_shuffle_cn.rst @@ -5,16 +5,16 @@ pixel_shuffle ------------------------------- .. py:function:: paddle.nn.functional.pixel_shuffle(x, upscale_factor, data_format="NCHW", name=None) -该算子将一个形为[N, C, H, W]或是[N, H, W, C]的 Tensor 重新排列成形为 [N, C/r**2, H*r, W*r]或 [N, H*r, W*r, C/r**2] 的 Tensor。这样做有利于实现步长（stride）为 1/r 的高效 sub-pixel（亚像素）卷积。详见 Shi 等人在 2016 年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 +将一个形为[N, C, H, W]或是[N, H, W, C]的 Tensor 重新排列成形为 [N, C/r**2, H*r, W*r]或 [N, H*r, W*r, C/r**2] 的 Tensor。这样做有利于实现步长（stride）为 1/r 的高效 sub-pixel（亚像素）卷积。详见 Shi 等人在 2016 年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 .. note:: 详细请参考对应的 `Class` 请参考：:ref:`cn_api_nn_PixelShuffle` 。 参数 ::::::::: - - **x** (Tensor)：当前算子的输入，其是一个形状为 `[N, C, H, W]` 的 4-D Tensor。其中 `N` 是 batch size, `C` 是通道数，`H` 是输入特征的高度，`W` 是输入特征的宽度。其数据类型为 float32 或者 float64。 - - **upscale_factor** （int)：增大空间分辨率的增大因子 - - **data_format** (str，可选)：数据格式，可选："NCHW"或"NHWC"，默认："NCHW" + - **x** (Tensor) - 当前算子的输入，其是一个形状为 `[N, C, H, W]` 的 4-D Tensor。其中 `N` 是 batch size, `C` 是通道数，`H` 是输入特征的高度，`W` 是输入特征的宽度。其数据类型为 float32 或者 float64。 + - **upscale_factor** （int) - 增大空间分辨率的增大因子 + - **data_format** (str，可选) - 数据格式，可选："NCHW"或"NHWC"，默认："NCHW" - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 From 9b2842ba46a52d5d63509eb804a9d8db93a1007e Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Fri, 26 Aug 2022 14:46:28 +0800 Subject: [PATCH 2/5] udpate format issue --- docs/api/paddle/nn/PixelShuffle_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/nn/PixelShuffle_cn.rst b/docs/api/paddle/nn/PixelShuffle_cn.rst index 8ca80d3c84f..3689a0189f5 100644 --- a/docs/api/paddle/nn/PixelShuffle_cn.rst +++ b/docs/api/paddle/nn/PixelShuffle_cn.rst @@ -4,7 +4,7 @@ PixelShuffle ------------------------------- .. py:function:: paddle.nn.PixelShuffle(upscale_factor, data_format="NCHW", name=None) -该算子将一个形为[N, C, H, W]或是[N, H, W, C]的 Tensor 重新排列成形为 [N, C/r**2, H*r, W*r]或 [N, H*r, W*r, C/r**2] 的 Tensor。这样做有利于实现步长（stride）为 1/r 的高效 sub-pixel（亚像素）卷积。详见 Shi 等人在 2016 年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 +该算子将一个形为 :math:`[N, C, H, W]` 或是 :math:`[N, H, W, C]` 的 Tensor 重新排列成形为 :math:`[N, C/r**2, H*r, W*r]` 或 :math:`[N, H*r, W*r, C/r**2]` 的 Tensor。这样做有利于实现步长（stride）为 :math:`1/r` 的高效 sub-pixel（亚像素）卷积。详见 Shi 等人在 2016 年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 .. code-block:: text From ae559d634e70a8c08926f47156d6d26a0e07ccce Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Mon, 29 Aug 2022 15:25:58 +0800 Subject: [PATCH 3/5] update format issue --- docs/api/paddle/nn/PReLU_cn.rst | 8 ++++---- docs/api/paddle/nn/PixelShuffle_cn.rst | 2 +- docs/api/paddle/nn/functional/pixel_shuffle_cn.rst | 2 +- docs/api/paddle/nn/functional/prelu_cn.rst | 2 +- docs/api/paddle/nn/functional/relu6_cn.rst | 2 +- docs/api/paddle/nn/functional/relu_cn.rst | 2 +- docs/api/paddle/nn/functional/selu_cn.rst | 6 +++--- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api/paddle/nn/PReLU_cn.rst b/docs/api/paddle/nn/PReLU_cn.rst index 9cdc3a7096b..6516acfa5fe 100644 --- a/docs/api/paddle/nn/PReLU_cn.rst +++ b/docs/api/paddle/nn/PReLU_cn.rst @@ -16,10 +16,10 @@ PReLU 激活层（PReLU Activation Operator）。计算公式如下： 参数 :::::::::: - - num_parameters (int，可选) - 可训练`weight`数量，支持 2 种输入：1 - 输入中的所有元素使用同一个`weight`值；输入的通道数 - 在同一个通道中的元素使用同一个`weight`值。默认为 1。 - - init (float，可选) - `weight`的初始值。默认为 0.25。 - - weight_attr (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_ParamAttr` 。 - - data_format (str，可选) – 指定输入的数据格式，输出的数据格式将与输入保持一致，可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值："NCHW"。 + - **num_parameters** (int，可选) - 可训练`weight`数量，支持 2 种输入：1 - 输入中的所有元素使用同一个`weight`值；输入的通道数 - 在同一个通道中的元素使用同一个`weight`值。默认为 1。 + - **init** (float，可选) - `weight`的初始值。默认为 0.25。 + - **weight_attr** (ParamAttr，可选) - 指定权重参数属性的对象。默认值为 None，表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_ParamAttr` 。 + - **data_format** (str，可选) – 指定输入的数据格式，输出的数据格式将与输入保持一致，可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值："NCHW"。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 形状： diff --git a/docs/api/paddle/nn/PixelShuffle_cn.rst b/docs/api/paddle/nn/PixelShuffle_cn.rst index 3689a0189f5..b13e2117a09 100644 --- a/docs/api/paddle/nn/PixelShuffle_cn.rst +++ b/docs/api/paddle/nn/PixelShuffle_cn.rst @@ -4,7 +4,7 @@ PixelShuffle ------------------------------- .. py:function:: paddle.nn.PixelShuffle(upscale_factor, data_format="NCHW", name=None) -该算子将一个形为 :math:`[N, C, H, W]` 或是 :math:`[N, H, W, C]` 的 Tensor 重新排列成形为 :math:`[N, C/r**2, H*r, W*r]` 或 :math:`[N, H*r, W*r, C/r**2]` 的 Tensor。这样做有利于实现步长（stride）为 :math:`1/r` 的高效 sub-pixel（亚像素）卷积。详见 Shi 等人在 2016 年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 +该算子将一个形为 :math:`[N, C, H, W]` 或是 :math:`[N, H, W, C]` 的 Tensor 重新排列成形为 :math:`[N, C/r^2, H \times r, W \times r]` 或 :math:`[N, H \times r, W \times r, C/r^2]` 的 Tensor。这样做有利于实现步长（stride）为 :math:`1/r` 的高效 sub-pixel（亚像素）卷积。详见 Shi 等人在 2016 年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 .. code-block:: text diff --git a/docs/api/paddle/nn/functional/pixel_shuffle_cn.rst b/docs/api/paddle/nn/functional/pixel_shuffle_cn.rst index 2c51768d8f7..0131334ea3e 100644 --- a/docs/api/paddle/nn/functional/pixel_shuffle_cn.rst +++ b/docs/api/paddle/nn/functional/pixel_shuffle_cn.rst @@ -5,7 +5,7 @@ pixel_shuffle ------------------------------- .. py:function:: paddle.nn.functional.pixel_shuffle(x, upscale_factor, data_format="NCHW", name=None) -将一个形为[N, C, H, W]或是[N, H, W, C]的 Tensor 重新排列成形为 [N, C/r**2, H*r, W*r]或 [N, H*r, W*r, C/r**2] 的 Tensor。这样做有利于实现步长（stride）为 1/r 的高效 sub-pixel（亚像素）卷积。详见 Shi 等人在 2016 年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 +将一个形为 :math:`[N, C, H, W]` 或 :math:`[N, H, W, C]` 的 Tensor 重新排列成形为 :math:`[N, C/r^2, H \times r, W \times r]` 或 :math:`[N, H \times r, W \times r, C/r^2]` 的 Tensor。这样做有利于实现步长（stride）为 1/r 的高效 sub-pixel（亚像素）卷积。详见 Shi 等人在 2016 年发表的论文 `Real Time Single Image and Video Super Resolution Using an Efficient Sub Pixel Convolutional Neural Network `_ 。 .. note:: 详细请参考对应的 `Class` 请参考：:ref:`cn_api_nn_PixelShuffle` 。 diff --git a/docs/api/paddle/nn/functional/prelu_cn.rst b/docs/api/paddle/nn/functional/prelu_cn.rst index c9a63174b91..8bb2a2c2039 100644 --- a/docs/api/paddle/nn/functional/prelu_cn.rst +++ b/docs/api/paddle/nn/functional/prelu_cn.rst @@ -15,7 +15,7 @@ prelu 激活层（PRelu Activation Operator）。计算公式如下： 参数 :::::::::: - - x (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 - weight (Tensor) - 可训练参数，数据类型同``x`` 一致，形状支持 2 种：[1] 或者 [in]，其中`in`为输入的通道数。 - data_format (str，可选) – 指定输入的数据格式，输出的数据格式将与输入保持一致，可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值："NCHW"。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 diff --git a/docs/api/paddle/nn/functional/relu6_cn.rst b/docs/api/paddle/nn/functional/relu6_cn.rst index 9440906580b..0a014ef15f1 100644 --- a/docs/api/paddle/nn/functional/relu6_cn.rst +++ b/docs/api/paddle/nn/functional/relu6_cn.rst @@ -15,7 +15,7 @@ relu6 激活层 参数 :::::::::: - - x (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/relu_cn.rst b/docs/api/paddle/nn/functional/relu_cn.rst index 480f4d7bc1e..48e892189be 100644 --- a/docs/api/paddle/nn/functional/relu_cn.rst +++ b/docs/api/paddle/nn/functional/relu_cn.rst @@ -16,7 +16,7 @@ relu 激活层（Rectified Linear Unit）。计算公式如下： 参数 :::::::::: - - x (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 diff --git a/docs/api/paddle/nn/functional/selu_cn.rst b/docs/api/paddle/nn/functional/selu_cn.rst index 66c7e83e234..951d15f70e2 100644 --- a/docs/api/paddle/nn/functional/selu_cn.rst +++ b/docs/api/paddle/nn/functional/selu_cn.rst @@ -21,9 +21,9 @@ selu 激活层 :::::::::::: :::::::::: - - x (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 - - scale (float，可选) - selu 激活计算公式中的 scale 值，必须大于 1.0。默认值为 1.0507009873554804934193349852946。 - - alpha (float，可选) - selu 激活计算公式中的 alpha 值，必须大于等于零。默认值为 1.6732632423543772848170429916717。 + - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 + - **scale** (float，可选) - selu 激活计算公式中的 scale 值，必须大于 1.0。默认值为 1.0507009873554804934193349852946。 + - **alpha** (float，可选) - selu 激活计算公式中的 alpha 值，必须大于等于零。默认值为 1.6732632423543772848170429916717。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 From d571531e1e10d3218e82957e991e083f592b103a Mon Sep 17 00:00:00 2001 From: liyongchao911 <11_258@163.com> Date: Mon, 29 Aug 2022 15:56:45 +0800 Subject: [PATCH 4/5] udpate format issue --- docs/api/paddle/nn/functional/prelu_cn.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/paddle/nn/functional/prelu_cn.rst b/docs/api/paddle/nn/functional/prelu_cn.rst index 8bb2a2c2039..0d564582add 100644 --- a/docs/api/paddle/nn/functional/prelu_cn.rst +++ b/docs/api/paddle/nn/functional/prelu_cn.rst @@ -16,8 +16,8 @@ prelu 激活层（PRelu Activation Operator）。计算公式如下： 参数 :::::::::: - **x** (Tensor) - 输入的 ``Tensor``，数据类型为：float32、float64。 - - weight (Tensor) - 可训练参数，数据类型同``x`` 一致，形状支持 2 种：[1] 或者 [in]，其中`in`为输入的通道数。 - - data_format (str，可选) – 指定输入的数据格式，输出的数据格式将与输入保持一致，可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值："NCHW"。 + - **weight** (Tensor) - 可训练参数，数据类型同``x`` 一致，形状支持 2 种：[1] 或者 [in]，其中`in`为输入的通道数。 + - **data_format** (str，可选) – 指定输入的数据格式，输出的数据格式将与输入保持一致，可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值："NCHW"。 - **name** (str，可选) - 具体用法请参见 :ref:`api_guide_Name`，一般无需设置，默认值为 None。 返回 From cc17fdb4cdc1245fa0368ee780692588ffbef4bb Mon Sep 17 00:00:00 2001 From: Ligoml <39876205+Ligoml@users.noreply.github.com> Date: Mon, 29 Aug 2022 17:17:29 +0800 Subject: [PATCH 5/5] copy-from RReLU --- docs/api/paddle/nn/RReLU_cn.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/paddle/nn/RReLU_cn.rst b/docs/api/paddle/nn/RReLU_cn.rst index a19423575dc..ebad25c8b66 100644 --- a/docs/api/paddle/nn/RReLU_cn.rst +++ b/docs/api/paddle/nn/RReLU_cn.rst @@ -49,4 +49,4 @@ RReLU 激活层，应用随机纠正线性单元对神经元激活，参考论 代码示例 ::::::::: -COPY-FROM: paddle.nn.RRelu +COPY-FROM: paddle.nn.RReLU