Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# Paddle API Docs
docs/api/paddle @jzhang533 @sunzhongkai588 @mattheliu @Echo-Nie
docs/api/paddle @jzhang533 @sunzhongkai588 @mattheliu @Echo-Nie @zhwesky2010
1 change: 1 addition & 0 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,7 @@ tensor 元素操作相关(如:转置,reshape 等)
" :ref:`paddle.crop <cn_api_paddle_crop>` ", "根据偏移量(offsets)和形状(shape),裁剪输入(x)Tensor"
" :ref:`paddle.expand <cn_api_paddle_expand>` ", "根据 shape 指定的形状扩展 x ,扩展后, x 的形状和 shape 指定的形状一致"
" :ref:`paddle.expand_as <cn_api_paddle_expand_as>` ", "根据 y 的形状扩展 x ,扩展后, x 的形状和 y 的形状相同"
" :ref:`paddle.expand_copy <cn_api_paddle_expand_copy>` ", "根据 shape 指定的形状扩展 x ,扩展后返回一个新的 Tensor"
" :ref:`paddle.flatten <cn_api_paddle_flatten>` ", "根据给定的 start_axis 和 stop_axis 将连续的维度展平"
" :ref:`paddle.flip <cn_api_paddle_flip>` ", "沿指定轴反转 n 维 tensor"
" :ref:`paddle.ravel <cn_api_paddle_ravel>` ", "返回一个连续的展平的 tensor"
Expand Down
4 changes: 4 additions & 0 deletions docs/api/paddle/bernoulli__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,7 @@ Inplace 版本的 :ref:`cn_api_paddle_bernoulli` API,对输入 x 采用 Inplac
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

.. note::

参数名 ``input`` 可替代 ``x``,如 ``bernoulli_(input=tensor_x)`` 等价于 ``bernoulli_(x=tensor_x)``。
2 changes: 2 additions & 0 deletions docs/api/paddle/clip_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ clip

.. note::
别名支持: 参数名 ``input`` 可替代 ``x``,如 ``clip(input=tensor_x, min=0.3, max=0.7)`` 等价于 ``clip(x=tensor_x, min=0.3, max=0.7)``。
相关 API: 按最小值裁剪可使用 :ref:`cn_api_paddle_clamp_min`,按最大值裁剪可使用 :ref:`cn_api_paddle_clamp_max`。


参数
::::::::::::
Expand Down
3 changes: 2 additions & 1 deletion docs/api/paddle/compat/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,12 @@ PyTorch 兼容的 nn 模块
::::::::::::::::::::::::::::::

.. csv-table::
:header: "类名称", "类功能"
:header: "函数/类名称", "函数/类功能"
:widths: 10, 30

" :ref:`Linear <cn_api_paddle_compat_nn_Linear>` ", "PyTorch 对齐的 ``paddle.nn.Linear`` 兼容版本"
" :ref:`Unfold <cn_api_paddle_compat_nn_Unfold>` ", "允许 Tensor 输入的 ``paddle.nn.Unfold`` 兼容版本"
" :ref:`_pair <cn_api_paddle_compat_nn__pair>` ", "将输入转换为包含 2 个元素的元组"


.. _about_compat_nn_functional:
Expand Down
6 changes: 5 additions & 1 deletion docs/api/paddle/cross_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
cross
-------------------------------

.. py:function:: paddle.cross(x, y, axis=9, name=None)
.. py:function:: paddle.cross(x, y, axis=9, name=None, *, out=None)


计算 Tensor ``x`` 和 ``y`` 在 ``axis`` 维度上的向量积(叉积)。
Expand All @@ -17,6 +17,10 @@ cross
- **axis** (int,可选) - 沿着此维进行向量积操作。别名 ``dim``。默认值是 9,意思是选取第一个长度为 3 的 ``axis`` 。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
:::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
:::::::::
计算后的 Tensor,数据类型与输入 ``x`` 相同。
Expand Down
1 change: 1 addition & 0 deletions docs/api/paddle/device/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ paddle.device 目录下包含 cuda 目录和 xpu 目录, cuda 目录中存放
" :ref:`reset_max_memory_reserved <cn_api_paddle_device_reset_max_memory_reserved>` ", "重置给定设备上由内存分配器管理的内存峰值统计"
" :ref:`reset_peak_memory_stats <cn_api_paddle_device_reset_peak_memory_stats>` ", "重置峰值内存统计"
" :ref:`set_device <cn_api_paddle_device_set_device>` ", "指定 OP 运行的全局设备"
" :ref:`set_default_device <cn_api_paddle_device_set_default_device>` ", "设置默认设备"
" :ref:`get_device <cn_api_paddle_device_get_device>` ", "获得 OP 运行的全局设备"
" :ref:`is_available <cn_api_paddle_device_is_available>` ", "检查设备是否可用"
" :ref:`get_rng_state <cn_api_paddle_device_get_rng_state>` ", "获取随机数生成器状态"
Expand Down
8 changes: 6 additions & 2 deletions docs/api/paddle/hstack_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,20 @@
hstack
-------------------------------

.. py:function:: paddle.hstack(x, name=None)
.. py:function:: paddle.hstack(x, name=None, *, out=None)

沿水平轴堆叠输入 ``x`` 中的所有张量。所有张量必须具有相同的数据类型。

参数
::::::::::::

- **x** (list[Tensor]|tuple[Tensor]) - 输入 ``x`` 可以是张量的 list 或 tuple, ``x`` 中张量的数据类型必须相同。支持的数据类型: ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 、 ``int64`` 或 ``bfloat16`` 。
- **x** (list[Tensor]|tuple[Tensor]) - 输入 ``x`` 可以是张量的 list 或 tuple, ``x`` 中张量的数据类型必须相同。支持的数据类型: ``float16`` 、 ``float32`` 、 ``float64`` 、 ``int32`` 、 ``int64`` 或 ``bfloat16`` 。别名 ``tensors``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::
Tensor,与输入数据类型相同的堆叠张量。
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/imag_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ imag
参数
::::::::::::

- **x** (Tensor) - 输入的 Tensor,其数据类型可以为 complex64 或 complex128。
- **x** (Tensor) - 输入的 Tensor,其数据类型可以为 complex64 或 complex128。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
9 changes: 7 additions & 2 deletions docs/api/paddle/linalg/cholesky_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
cholesky
-------------------------------

.. py:function:: paddle.linalg.cholesky(x, upper=False, name=None)
.. py:function:: paddle.linalg.cholesky(x, upper=False, name=None, *, out=None)



Expand All @@ -15,10 +15,15 @@ cholesky
参数
::::::::::::

- **x** (Tensor)- 输入变量为多维 Tensor,它的维度应该为 ``[*, M, M]``,其中*为零或更大的批次尺寸,并且最里面的两个维度上的矩阵都应为对称的正定矩阵,支持数据类型为 float32、float64。
- **x** (Tensor)- 输入变量为多维 Tensor,它的维度应该为 ``[*, M, M]``,其中*为零或更大的批次尺寸,并且最里面的两个维度上的矩阵都应为对称的正定矩阵,支持数据类型为 float32、float64。别名 ``input``。
- **upper** (bool)- 指示是否返回上三角矩阵或下三角矩阵。默认值:False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::

- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::
Tensor,与 ``x`` 具有相同形状和数据类型。它代表了 Cholesky 分解生成的三角矩阵。
Expand Down
11 changes: 9 additions & 2 deletions docs/api/paddle/linalg/det_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@
det
-------------------------------

.. py:function:: paddle.linalg.det(x)
.. py:function:: paddle.linalg.det(x, name=None, *, out=None)

计算批量矩阵的行列式值。

参数
::::::::::::

- **x** (Tensor):输入一个或批量矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64。
- **x** (Tensor):输入一个或批量矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::

- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::
Expand Down
8 changes: 6 additions & 2 deletions docs/api/paddle/linalg/eigh_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,20 @@
eigh
-------------------------------

.. py:function:: paddle.linalg.eigh(x, UPLO='L', name=None)
.. py:function:: paddle.linalg.eigh(x, UPLO='L', name=None, *, out=None)
计算厄米特矩阵或者实数对称矩阵的特征值和特征向量。

参数
::::::::::::

- **x** (Tensor):输入一个或一批厄米特矩阵或者实数对称矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64、complex64、complex128。
- **x** (Tensor):输入一个或一批厄米特矩阵或者实数对称矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64、complex64、complex128。别名 ``input``。
- **UPLO** (str,可选):表示计算上三角或者下三角矩阵,默认值为 'L',表示计算下三角矩阵的特征值和特征向量,'U'表示计算上三角矩阵的特征值和特征向量。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::
- **out** (Tensor|tuple,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。

返回
::::::::::::

Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/inv_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ inv

参数
:::::::::
- **x** (Tensor) – 输入 Tensor,最后两维的大小必须相等。如果输入 Tensor 的维数大于 2,则被视为 2-D 矩阵的批次(batch)。支持的数据类型:float32,float64。
- **x** (Tensor) – 输入 Tensor,最后两维的大小必须相等。如果输入 Tensor 的维数大于 2,则被视为 2-D 矩阵的批次(batch)。支持的数据类型:float32,float64。别名 ``input``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/linalg/pinv_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ pinv

参数
:::::::::
- **x** (Tensor):输入变量,类型为 Tensor,数据类型为 float32、float64、complex64、complex12,形状为(M, N)或(B, M, N)。
- **x** (Tensor):输入变量,类型为 Tensor,数据类型为 float32、float64、complex64、complex12,形状为(M, N)或(B, M, N)。别名 ``input``。
- **rcond** (float64,可选):奇异值(特征值)被截断的阈值,奇异值(特征值)小于 rcond * 最大奇异值时会被置为 0,默认值为 1e-15。
- **hermitian** (bool,可选):是否为 ``hermitian`` 矩阵或者实对称矩阵,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
7 changes: 6 additions & 1 deletion docs/api/paddle/linalg/qr_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
qr
-------------------------------

.. py:function:: paddle.linalg.qr(x, mode="reduced", name=None)
.. py:function:: paddle.linalg.qr(x, mode="reduced", name=None, *, some=None, out=None)


计算一个或一批矩阵的正交三角分解,也称 QR 分解(暂不支持反向)。
Expand All @@ -23,6 +23,11 @@ qr
- **mode** (str,可选):控制正交三角分解的行为,默认是 ``reduced``,假设 ``x`` 形状应为 ``[*, M, N]`` 和 ``K = min(M, N)``:如果 ``mode = "reduced"``,则 :math:`Q` 形状为 ``[*, M, K]`` 和 :math:`R` 形状为 ``[*, K, N]``;如果 ``mode = "complete"``,则 :math:`Q` 形状为 ``[*, M, M]`` 和 :math:`R` 形状为 ``[*, M, N]``;如果 ``mode = "r"``,则不返回 :math:`Q`,只返回 :math:`R` 且形状为 ``[*, K, N]`` 。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

关键字参数
::::::::::::
- **some** (bool,可选) - 控制正交三角分解的行为。当 ``some=True`` 时等价于 ``mode="reduced"``,当 ``some=False`` 时等价于 ``mode="complete"``。默认值为 None,此时使用 ``mode`` 参数控制行为。
- **out** (tuple[Tensor, Tensor],可选) - 指定输出的 Q 和 R 矩阵的元组。如果提供了 ``out``,结果将写入该元组中。当 ``mode="r"`` 时不可用。默认值为 None。

返回
::::::::::::

Expand Down
4 changes: 4 additions & 0 deletions docs/api/paddle/logical_and__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,7 @@ Inplace 版本的 :ref:`cn_api_paddle_logical_and` API,对输入 x 采用 Inpl
更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3

.. note::

别名支持:参数名 ``other`` 可替代 ``y``,如 ``logical_and_(other=tensor_y)`` 等价于 ``logical_and_(y=tensor_y)``。
3 changes: 2 additions & 1 deletion docs/api/paddle/nn/ELU_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

ELU
-------------------------------
.. py:class:: paddle.nn.ELU(alpha=1.0, name=None)
.. py:class:: paddle.nn.ELU(alpha=1.0, inplace=False, name=None)

ELU 激活层(ELU Activation Operator)

Expand All @@ -23,6 +23,7 @@ ELU 激活层(ELU Activation Operator)
参数
::::::::::
- **alpha** (float,可选) - ELU 的 alpha 值,默认值为 1.0。
- **inplace** (bool,可选) - 是否使用 inplace 操作,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

形状
Expand Down
4 changes: 2 additions & 2 deletions docs/api/paddle/nn/Flatten_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Flatten
参数
::::::::::::

- **start_axis** (int,可选) - 展开的起始维度,默认值为 1。
- **stop_axis** (int,可选) - 展开的结束维度,默认值为-1。
- **start_axis** (int,可选) - 展开的起始维度,默认值为 1。别名 ``start_dim``。
- **stop_axis** (int,可选) - 展开的结束维度,默认值为-1。别名 ``end_dim``。

返回
::::::::::::
Expand Down
3 changes: 3 additions & 0 deletions docs/api/paddle/nn/InstanceNorm3D_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ InstanceNorm3D

构建 ``InstanceNorm3D`` 类的一个可调用对象,具体用法参照 ``代码示例``。可以处理 5D 的 Tensor,实现了实例归一化层(Instance Normalization Layer)的功能。更多详情请参考:Instance Normalization: The Missing Ingredient for Fast Stylization 。

.. note::
``InstanceNorm3d`` 可作为 ``InstanceNorm3D`` 的别名使用。

数据布局:NCDHW [batch, in_channels, D, in_height, in_width]

``input`` 是 mini-batch 的输入。
Expand Down
17 changes: 17 additions & 0 deletions docs/api/paddle/nn/Layer_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -526,3 +526,20 @@ bfloat16(excluded_layers=None)
**代码示例**

COPY-FROM: paddle.nn.Layer.bfloat16

to_empty(*, device=None, recurse=True)
'''''''''

将 parameters 和 buffers 按照指定的 device 重新分配为空 Tensor,不保留原值。

**参数**

- **device** (PlaceLike|None,可选) - 指定的设备位置。默认为 None(不改变设备)。
- **recurse** (bool,可选) - 是否递归应用到子层。默认值:True。

**返回**
Layer (返回网络层), self (返回自身)

**代码示例**

COPY-FROM: paddle.nn.Layer.to_empty
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/LogSoftmax_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ LogSoftmax 激活层,计算公式如下:

参数
:::::::::
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴。``axis`` 的有效范围是[-D, D),D 是输入 Tensor 的维度,``axis`` 为负值时与 :math:`axis + D` 等价。默认值为-1。
- **axis** (int,可选) - 指定对输入 Tensor 进行运算的轴。``axis`` 的有效范围是[-D, D),D 是输入 Tensor 的维度,``axis`` 为负值时与 :math:`axis + D` 等价。默认值为-1。别名 ``dim``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

形状
Expand Down
2 changes: 2 additions & 0 deletions docs/api/paddle/nn/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -449,6 +449,8 @@ Normalization 方法
" :ref:`paddle.nn.functional.weight_norm <cn_api_paddle_nn_utils_weight_norm>` ", "对传入的 layer 中的权重参数进行归一化"
" :ref:`paddle.nn.functional.spectral_norm <cn_api_paddle_nn_utils_spectral_norm>` ", "对传入的 layer 中的权重参数进行谱归一化"
" :ref:`paddle.nn.functional.group_norm <cn_api_paddle_nn_functional_group_norm>` ", "Group Normalization 函数"
" :ref:`paddle.nn.functional.instance_norm <cn_api_paddle_nn_functional_instance_norm>` ", "Instance Normalization 函数"
" :ref:`paddle.nn.functional.rms_norm <cn_api_paddle_nn_functional_rms_norm>` ", "RMS Normalization 函数"

.. _linear_functional:

Expand Down
11 changes: 8 additions & 3 deletions docs/api/paddle/nn/functional/batch_norm_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,22 @@ batch_norm

详情见 :ref:`cn_api_paddle_nn_BatchNorm1D` 。

.. note::
此 API 有两种调用方式:
1. ``paddle.nn.functional.batch_norm(x, running_mean, running_var, weight=None, bias=None, training=False, momentum=0.9, epsilon=1e-05, data_format='NCHW', use_global_stats=None, name=None)`` (Paddle 风格)
2. ``paddle.nn.functional.batch_norm(input, running_mean, running_var, weight=None, bias=None, training=False, momentum=0.1, eps=1e-05)`` (PyTorch 风格)

参数
::::::::::::

- **x** (int) - 输入,数据类型为 float32, float64。
- **x** (Tensor) - 输入,数据类型为 float32, float64。别名 ``input``
- **running_mean** (Tensor) - 均值的 Tensor。
- **running_var** (Tensor) - 方差的 Tensor。
- **weight** (Tensor,可选) - 权重的 Tensor,默认为 None。
- **bias** (Tensor,可选) - 偏置的 Tensor,默认为 None。
- **training** (bool,可选) – 当该值为 True 时,表示为训练模式(train mode),即使用批数据计算并在训练期间跟踪全局均值和方差。为 False 时,表示使用推理模式(inference mode),即使用训练期间计算出的全局均值及方差计算。默认值为 False。
- **momentum** (float,可选) - 此值用于计算 ``moving_mean`` 和 ``moving_var``。默认值:0.9。更新公式如上所示
- **epsilon** (float,可选) - 为了数值稳定加在分母上的值。默认值:1e-05。
- **momentum** (float,可选) - 此值用于计算 ``moving_mean`` 和 ``moving_var``。默认值:0.9。在 PyTorch 风格签名中,momentum 值会自动转换(momentum = 1.0 - momentum)
- **epsilon** (float,可选) - 为了数值稳定加在分母上的值。默认值:1e-05。别名 ``eps``。
- **data_format** (str,可选) - 指定输入数据格式。数据格式可以为 ``"NC"``、``"NCL"``、``"NCHW"`` 或者 ``"NCDHW"``,其中 N 是批大小,C 是通道数,D 是特征深度,H 是特征高度,W 是特征宽度,L 是特征长度。默认值为 ``"NCHW"``。
- **use_global_stats** (bool|None,可选) - 指示是否使用全局均值和方差。若设置为 False,则使用一个 mini-batch 的统计数据。若设置为 True 时,将使用全局统计数据。若设置为 None,则会在测试阶段使用全局统计数据,在训练阶段使用一个 mini-batch 的统计数据。默认值为 None。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
5 changes: 3 additions & 2 deletions docs/api/paddle/nn/functional/elu_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
elu
-------------------------------

.. py:function:: paddle.nn.functional.elu(x, alpha=1.0, name=None)
.. py:function:: paddle.nn.functional.elu(x, alpha=1.0, inplace=False, name=None)

elu 激活层(ELU Activation Operator)

Expand All @@ -23,8 +23,9 @@ elu 激活层(ELU Activation Operator)

参数
::::::::::
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。别名 ``input``。
- **alpha** (float,可选) - elu 的 alpha 值,默认值为 1.0。
- **inplace** (bool, 可选) - 是否使用 inplace 操作。默认值:False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
Loading