Skip to content

Commit a090fdd

Browse files
committed
[API compatibility]update doc of GroupNorm
1 parent a5c5f28 commit a090fdd

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/api/paddle/nn/GroupNorm_cn.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
GroupNorm
44
-------------------------------
55

6-
.. py:class:: paddle.nn.GroupNorm(num_groups, num_channels, epsilon=1e-05, weight_attr=None, bias_attr=None, data_format='NCHW', name=None)
6+
.. py:class:: paddle.nn.GroupNorm(num_groups, num_channels, epsilon=1e-05, affine=True, device=None, dtype=None, weight_attr=None, bias_attr=None, data_format='NCHW', name=None)
77
88
**Group Normalization 层**
99

@@ -15,10 +15,21 @@ GroupNorm
1515
- **num_groups** (int) - 从通道中分离出来的 ``group`` 的数目。
1616
- **num_channels** (int) - 输入的通道数。
1717
- **epsilon** (float,可选) - 为防止方差除零,增加一个很小的值。默认值:1e-05。
18+
``别名: eps``
19+
- **affine** (bool,可选) - 该模块是否具有可学习的仿射参数(weight 和 bias)。如果设置为 False,将不会创建可学习的参数,无论 weight_attr 和 bias_attr 如何设置。默认值:True。
20+
``注意: 此参数必须以关键字参数的形式传入``
21+
- **device** (PlaceLike,可选) - 计算发生的设备。默认值:None。
22+
``注意: 此参数必须以关键字参数的形式传入``
23+
- **dtype** (DTypeLike,可选) - 权重和偏置的数据类型。默认值:None。
24+
``注意: 此参数必须以关键字参数的形式传入``
1825
- **weight_attr** (ParamAttr|bool,可选) - 指定权重参数属性的对象。如果为 False,表示参数不学习。默认值为 None,表示使用默认的权重参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
26+
``注意: 此参数必须以关键字参数的形式传入``
1927
- **bias_attr** (ParamAttr|bool,可选) - 指定偏置参数属性的对象。如果为 False,表示参数不学习。默认值为 None,表示使用默认的偏置参数属性。具体用法请参见 :ref:`cn_api_paddle_ParamAttr` 。
28+
``注意: 此参数必须以关键字参数的形式传入``
2029
- **data_format** (string,可选) - 支持 “NCL”,“NCHW”,“NCDHW”,“NLC”,“NHWC”,“NDHWC” 格式。默认值:“NCHW”。
30+
``注意: 此参数必须以关键字参数的形式传入``
2131
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
32+
``注意: 此参数必须以关键字参数的形式传入``
2233

2334
形状
2435
::::::::::::

0 commit comments

Comments
 (0)