Skip to content

Commit 0be209b

Browse files
committed
[API compatibility]update doc of group_norm
1 parent a5c5f28 commit 0be209b

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

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

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
group_norm
44
-------------------------------
55

6+
.. caution::
7+
8+
本接口根据输入参数的不同,包含两种不同的参数。
9+
10+
下面列举的两种参数输入方式 **互斥**,混用非公共的参数输入方法将会导致报错,请谨慎使用。
11+
12+
=====
13+
614
.. py:function:: paddle.nn.functional.group_norm(x, num_groups, epsilon=1e-05, weight=None, bias=None, data_format='NCHW', name=None)
715
816
对输入 ``x`` 进行组归一化, 计算公式如下:
@@ -35,3 +43,21 @@ group_norm
3543
::::::::::::
3644

3745
COPY-FROM: paddle.nn.functional.group_norm
46+
47+
=====
48+
49+
.. py:function:: paddle.nn.functional.group_norm(input, num_groups, weight=None, bias=None, eps=1e-05)
50+
51+
PyTorch 兼容的 ``group_norm``,对输入 ``x`` 进行组归一化,与上一种接口形式的计算公式一致,仅参数 ``epsilon`` 更换为 ``eps``。
52+
53+
参数
54+
::::::::::::
55+
- **input** (Tensor) - 输入 Tensor,支持的数据类型包括 int32、int64、float32、float64、int16、uint8、float16(GPU)以及 bfloat16(GPU) 。
56+
- **num_groups** (int) - 从通道中分离出来的 ``group`` 的数目。
57+
- **weight** (Tensor,可选) - 权重的 Tensor,形状为 [通道数],默认为 None。
58+
- **bias** (Tensor,可选) - 偏置的 Tensor,形状为 [通道数],默认为 None。
59+
- **eps** (float,可选) - 为防止方差除零,增加一个很小的值。默认值:1e-05。
60+
61+
返回
62+
::::::::::::
63+
``Tensor``,输出形状与 ``x`` 一致。

0 commit comments

Comments
 (0)