Skip to content

Commit 0064278

Browse files
committed
[API compatibility]update doc of group_norm
1 parent 60beaad commit 0064278

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
group_norm
44
-------------------------------
55

6-
.. py:function:: paddle.nn.functional.group_norm(x, num_groups, epsilon=1e-05, weight=None, bias=None, data_format='NCHW', name=None)
6+
.. py:function:: paddle.nn.functional.group_norm(x, num_groups, weight=None, bias=None, epsilon=1e-05, data_format='NCHW', name=None)
7+
8+
.. note::
9+
别名支持: 参数名 ``input`` 可替代 ``x``,如 ``group_norm(input=tensor_x, ...)`` 等价于 ``group_norm(x=tensor_x, ...)`` 。
710

811
对输入 ``x`` 进行组归一化, 计算公式如下:
912

@@ -19,10 +22,11 @@ group_norm
1922
::::::::::::
2023

2124
- **x** (Tensor) - 输入 Tensor,形状为 [批大小,通道数,\*]。
25+
``别名: input``
2226
- **num_groups** (int) - 从通道中分离出来的 ``group`` 的数目。
23-
- **epsilon** (float,可选) - 为防止方差除零,增加一个很小的值。默认值:1e-05。
2427
- **weight** (Tensor,可选) - 权重的 Tensor,形状为 [通道数],默认为 None。
2528
- **bias** (Tensor,可选) - 偏置的 Tensor,形状为 [通道数],默认为 None。
29+
- **epsilon** (float,可选) - 为防止方差除零,增加一个很小的值。默认值:1e-05。
2630
- **data_format** (string,可选) - 支持 “NCL”,“NCHW”,“NCDHW”,“NLC”,“NHWC”,“NDHWC” 格式。默认值:“NCHW”。
2731
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2832

0 commit comments

Comments
 (0)