Skip to content

Commit cbb2929

Browse files
[API compatibility] Update paddle.nn.functional.gelu, paddle.layer_norm docs (#7443)
* feat(C API Sink) * feat(C API Sink) * feat(C API Sink) * feat(gelu, layer_norm) * Update docs/api/paddle/nn/functional/layer_norm_cn.rst Co-authored-by: zachary sun <[email protected]> * Update docs/api/paddle/nn/functional/layer_norm_cn.rst Co-authored-by: zachary sun <[email protected]> * Update docs/api/paddle/nn/functional/gelu_cn.rst * Update docs/api/paddle/nn/functional/gelu_cn.rst --------- Co-authored-by: zachary sun <[email protected]>
1 parent 23bbc3f commit cbb2929

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

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

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,15 @@ gelu 激活层(GELU Activation Operator)
2121
2222
其中,:math:`x` 为输入的 Tensor。
2323

24+
.. note::
25+
别名支持: 参数名 ``input`` 可替代 ``x``。
26+
2427
参数
2528
::::::::::::
2629
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
27-
- **approximate** (bool,可选) - 是否使用近似计算,默认值为 False,表示不使用近似计算。
30+
别名: ``input``。
31+
- **approximate** (str | bool,可选) - 是否使用近似计算,默认值为 False,表示不使用近似计算。
32+
当 ``approximate`` 为 ``none`` 时等价于 False;为 ``tanh`` 时等价于 True;为其他字符串时会报错。
2833
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2934

3035
返回

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,20 @@ layer_norm
99

1010
详情见 :ref:`cn_api_paddle_nn_LayerNorm` 。
1111

12+
.. note::
13+
别名支持: 参数名 ``input`` 可替代 ``x``, ``eps`` 可替代 ``epsilon``。
14+
15+
1216
参数
1317
::::::::::::
1418

1519
- **x** (int) - 输入,数据类型为 bfloat16 、 float16 、 float32 或 float64。
20+
别名: ``input``
1621
- **normalized_shape** (int|list|tuple) - 期望的输入是 :math:`[*, normalized_shape[0], normalized_shape[1], ..., normalized_shape[-1]]`,如果是一个整数,会作用在最后一个维度。
1722
- **weight** (Tensor,可选) - 权重的 Tensor,默认为 None。
1823
- **bias** (Tensor,可选) - 偏置的 Tensor,默认为 None。
1924
- **epsilon** (float,可选) - 为了数值稳定加在分母上的值。默认值:1e-05。
25+
别名: ``eps``
2026
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2127

2228

0 commit comments

Comments
 (0)