Skip to content

Commit 785620c

Browse files
update PixelShuffle api (#5192)
* update PixelShuffle api * udpate format issue * update format issue * udpate format issue * copy-from RReLU Co-authored-by: Ligoml <[email protected]>
1 parent a9d33f7 commit 785620c

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

docs/api/paddle/nn/PReLU_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ PReLU 激活层(PReLU Activation Operator)。计算公式如下:
1616

1717
参数
1818
::::::::::
19-
- num_parameters (int,可选) - 可训练`weight`数量,支持 2 种输入:1 - 输入中的所有元素使用同一个`weight`值;输入的通道数 - 在同一个通道中的元素使用同一个`weight`值。默认为 1。
20-
- init (float,可选) - `weight`的初始值。默认为 0.25。
21-
- weight_attr (ParamAttr,可选) - 指定权重参数属性的对象。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_ParamAttr` 。
22-
- data_format (str,可选) – 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值:"NCHW"。
19+
- **num_parameters** (int,可选) - 可训练`weight`数量,支持 2 种输入:1 - 输入中的所有元素使用同一个`weight`值;输入的通道数 - 在同一个通道中的元素使用同一个`weight`值。默认为 1。
20+
- **init** (float,可选) - `weight`的初始值。默认为 0.25。
21+
- **weight_attr** (ParamAttr,可选) - 指定权重参数属性的对象。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_ParamAttr` 。
22+
- **data_format** (str,可选) – 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值:"NCHW"。
2323
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2424

2525
形状:

docs/api/paddle/nn/PixelShuffle_cn.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ PixelShuffle
44
-------------------------------
55

66
.. py:function:: paddle.nn.PixelShuffle(upscale_factor, data_format="NCHW", name=None)
7-
该算子将一个形为[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 <https://arxiv.org/abs/1609.05158v2>`_ 。
7+
该算子将一个形为 :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 <https://arxiv.org/abs/1609.05158v2>`_ 。
88

99
.. code-block:: text
1010
@@ -14,8 +14,8 @@ PixelShuffle
1414
1515
参数
1616
:::::::::
17-
- **upscale_factor** (int)增大空间分辨率的增大因子
18-
- **data_format** (str,可选)数据格式,可选:"NCHW"或"NHWC",默认:"NCHW"
17+
- **upscale_factor** (int) - 增大空间分辨率的增大因子
18+
- **data_format** (str,可选) - 数据格式,可选:"NCHW"或"NHWC",默认:"NCHW"
1919
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2020

2121
形状

docs/api/paddle/nn/RReLU_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ RReLU 激活层,应用随机纠正线性单元对神经元激活,参考论
4949
代码示例
5050
:::::::::
5151

52-
COPY-FROM: paddle.nn.RRelu
52+
COPY-FROM: paddle.nn.RReLU

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ pixel_shuffle
55
-------------------------------
66

77
.. py:function:: paddle.nn.functional.pixel_shuffle(x, upscale_factor, data_format="NCHW", name=None)
8-
该算子将一个形为[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 <https://arxiv.org/abs/1609.05158v2>`_ 。
8+
将一个形为 :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 <https://arxiv.org/abs/1609.05158v2>`_ 。
99

1010
.. note::
1111
详细请参考对应的 `Class` 请参考::ref:`cn_api_nn_PixelShuffle` 。
1212

1313
参数
1414
:::::::::
15-
- **x** (Tensor)当前算子的输入,其是一个形状为 `[N, C, H, W]` 的 4-D Tensor。其中 `N` 是 batch size, `C` 是通道数,`H` 是输入特征的高度,`W` 是输入特征的宽度。其数据类型为 float32 或者 float64。
16-
- **upscale_factor** (int)增大空间分辨率的增大因子
17-
- **data_format** (str,可选)数据格式,可选:"NCHW"或"NHWC",默认:"NCHW"
15+
- **x** (Tensor) - 当前算子的输入,其是一个形状为 `[N, C, H, W]` 的 4-D Tensor。其中 `N` 是 batch size, `C` 是通道数,`H` 是输入特征的高度,`W` 是输入特征的宽度。其数据类型为 float32 或者 float64。
16+
- **upscale_factor** (int) - 增大空间分辨率的增大因子
17+
- **data_format** (str,可选) - 数据格式,可选:"NCHW"或"NHWC",默认:"NCHW"
1818
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
1919

2020
返回

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ prelu 激活层(PRelu Activation Operator)。计算公式如下:
1515

1616
参数
1717
::::::::::
18-
- x (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
19-
- weight (Tensor) - 可训练参数,数据类型同``x`` 一致,形状支持 2 种:[1] 或者 [in],其中`in`为输入的通道数。
20-
- data_format (str,可选) – 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值:"NCHW"。
18+
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
19+
- **weight** (Tensor) - 可训练参数,数据类型同``x`` 一致,形状支持 2 种:[1] 或者 [in],其中`in`为输入的通道数。
20+
- **data_format** (str,可选) – 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值:"NCHW"。
2121
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2222

2323
返回

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ relu6 激活层
1515

1616
参数
1717
::::::::::
18-
- x (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
18+
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
1919
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2020

2121
返回

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ relu 激活层(Rectified Linear Unit)。计算公式如下:
1616

1717
参数
1818
::::::::::
19-
- x (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
19+
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
2020
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2121

2222
返回

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ selu 激活层
2121
::::::::::::
2222

2323
::::::::::
24-
- x (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
25-
- scale (float,可选) - selu 激活计算公式中的 scale 值,必须大于 1.0。默认值为 1.0507009873554804934193349852946。
26-
- alpha (float,可选) - selu 激活计算公式中的 alpha 值,必须大于等于零。默认值为 1.6732632423543772848170429916717。
24+
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
25+
- **scale** (float,可选) - selu 激活计算公式中的 scale 值,必须大于 1.0。默认值为 1.0507009873554804934193349852946。
26+
- **alpha** (float,可选) - selu 激活计算公式中的 alpha 值,必须大于等于零。默认值为 1.6732632423543772848170429916717。
2727
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2828

2929
返回

0 commit comments

Comments
 (0)