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
1 change: 1 addition & 0 deletions docs/api/paddle/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ tensor 数学操作原位(inplace)版本
" :ref:`paddle.put_along_axis_ <cn_api_paddle_put_along_axis_>` ", "Inplace 版本的 put_along_axis API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.cauchy_ <cn_api_paddle_cauchy_>` ", "直接修改输入 x,将所有元素替换为从柯西分布中随机采样的数值"
" :ref:`paddle.ceil_ <cn_api_paddle_ceil_>` ", "Inplace 版本的 ceil API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.clamp_ <cn_api_paddle_clamp_>` ", "Inplace 版本的 clamp API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.clip_ <cn_api_paddle_clip_>` ", "Inplace 版本的 clip API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.copysign_ <cn_api_paddle_copysign_>` ", "Inplace 版本的 copysign API,对输入 x 采用 Inplace 策略"
" :ref:`paddle.cumprod_ <cn_api_paddle_cumprod_>` ", "Inplace 版本的 cumprod API,对输入 x 采用 Inplace 策略"
Expand Down
31 changes: 31 additions & 0 deletions docs/api/paddle/clamp_max_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _cn_api_paddle_clamp_max:

clamp_max
-------------------------------

.. py:function:: paddle.clamp_max(input, max=None, *, out=None)

该 API 将输入中的所有元素进行裁剪,使得输出元素不大于给定的最大值,具体公式如下:

.. math::

Out = MIN(x, max)

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

- **input** (Tensor) - 输入的 Tensor,数据类型为:float16、float32、float64、int32、int64。
- **max** (float|int|Tensor,可选) - 裁剪的最大值,输入中大于该值的元素将由该元素代替。数据类型可以是 float32 或形状为 [] 的 0-D Tensor,默认值为 None。

关键字参数
::::::::::::
- **out** (Tensor,可选) - 输出 Tensor。默认值为 None。

返回
::::::::::::
输出 Tensor,与 ``input`` 维度相同。当 ``input`` 数据类型为 int32 或 int64 且 ``max`` 为 float 类型时,输出 Tensor 的数据类型为 float32,否则与输入 ``input`` 的数据类型相同。

代码示例
::::::::::::

COPY-FROM: paddle.clamp_max
1 change: 1 addition & 0 deletions docs/api/paddle/compat/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ PyTorch 兼容函数
" :ref:`slogdet <cn_api_paddle_compat_slogdet>` ", "slogdet 函数"
" :ref:`sort <cn_api_paddle_compat_sort>` ", "同时返回 values 及 indices 的排序"
" :ref:`split <cn_api_paddle_compat_split>` ", "允许非整除块大小输入的 Tensor 轴向切分"
" :ref:`logical_and_ <cn_api_paddle_compat_logical_and_>` ", "Inplace 版本的逻辑与运算,保留输入 Tensor 数据类型"


.. _about_compat_nn:
Expand Down
23 changes: 23 additions & 0 deletions docs/api/paddle/compat/nn/_pair_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. _cn_api_paddle_compat_nn__pair:

_pair
-------------------------------

.. py:function:: paddle.compat.nn._pair(x)

用于将输入转换为包含 2 个元素的元组。当输入为单个整数时,返回包含两个相同整数的元组;当输入为列表或元组时,转换为元组并返回。

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

- **x** (int|list|tuple) - 输入值,可以是整数、包含 2 个元素的列表或元组。

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

tuple:包含 2 个元素的元组。

代码示例
::::::::::::

COPY-FROM: paddle.compat.nn._pair
8 changes: 6 additions & 2 deletions 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=-1, name=None, *, out=None)


计算 Tensor ``x`` 和 ``y`` 在 ``axis`` 维度上的向量积(叉积)。
Expand All @@ -14,9 +14,13 @@ cross
:::::::::
- **x** (Tensor) - 第一个输入 Tensor,数据类型为:float16、float32、float64、int32、int64、complex64、complex128。别名 ``input``。
- **y** (Tensor) - 第二个输入 Tensor,数据类型为:float16、float32、float64、int32、int64、complex64、complex128。别名 ``other``。
- **axis** (int,可选) - 沿着此维进行向量积操作。别名 ``dim``。默认值是 9,意思是选取第一个长度为 3 的 ``axis`` 。
- **axis** (int,可选) - 沿着此维进行向量积操作。别名 ``dim``。默认值是 -1,意思是选取第一个长度为 3 的 ``axis`` 。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

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

返回
:::::::::
计算后的 Tensor,数据类型与输入 ``x`` 相同。
Expand Down
29 changes: 29 additions & 0 deletions docs/api/paddle/device/set_default_device_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _cn_api_paddle_device_set_default_device:

set_default_device
-------------------------------

.. py:function:: paddle.device.set_default_device(device=None)

Paddle 支持在各种类型的设备上运行,包括 CPU、GPU、XPU、NPU 和 IPU。
该函数可以设置 OP 运行的全局设备。

参数
:::::::::

- **device** (str|Place|paddle.device|int|None,可选) - 此参数确定特定的运行设备。可以是 ``cpu``、``gpu``、``xpu``、``npu``、``gpu:x``、``xpu:x``、``npu:x`` 和 ``ipu``,
其中 ``x`` 是 GPU、XPU 或 NPU 的索引。也可以是 ``paddle.device`` 对象或 int 类型的设备索引。如果为 ``None``,则重置为 CPU。
默认值为 None。

返回
:::::::::

无。

代码示例
:::::::::

.. code-block:: pycon

>>> import paddle
>>> paddle.device.set_default_device("cpu")
25 changes: 25 additions & 0 deletions docs/api/paddle/expand_copy_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.. _cn_api_paddle_expand_copy:

expand_copy
-------------------------------

.. py:function:: paddle.expand_copy(x, shape, name=None)

根据 ``shape`` 指定的形状扩展 ``x``,扩展后返回一个新的 Tensor,不会修改原 Tensor。

这是 :ref:`cn_api_paddle_expand` 的非原位版本。

参数
:::::::::::
- **x** (Tensor) - 输入的 Tensor,数据类型为:bool、float16、float32、float64、int32、int64、uint8、uint16、complex64 或 complex128。别名 ``input``。
- **shape** (tuple|list|Tensor) - 给定输入 ``x`` 扩展后的形状。若 shape 为 list 或 tuple,其中的元素值应全为整数或 0-D 或 1-D Tensor(数据类型为 int32)。别名 ``size``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
:::::::::::
Tensor,数据类型与 ``x`` 相同。

代码示例
:::::::::::

COPY-FROM: paddle.expand_copy
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
8 changes: 6 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,14 @@ 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
5 changes: 3 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,14 @@
det
-------------------------------

.. py:function:: paddle.linalg.det(x)
.. py:function:: paddle.linalg.det(x, *, out=None)
计算批量矩阵的行列式值。

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

- **x** (Tensor):输入一个或批量矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64。别名 ``input``。
- **x** (Tensor):输入一个或批量矩阵。``x`` 的形状应为 ``[*, M, M]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32、float64。别名 ``input``、 ``A``。
- **out** (Tensor,可选):指定输出的存储结果的 Tensor,如果提供,返回值将是 ``out`` 本身。默认值为 ``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** (tuple[Tensor, Tensor],可选) - 输出 Tensor 元组,若不为 ``None``,计算结果将保存在该 Tensor 元组中,默认值为 ``None``。

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

Expand Down
18 changes: 13 additions & 5 deletions 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, *, out=None)


计算一个或一批矩阵的正交三角分解,也称 QR 分解(暂不支持反向)。
Expand All @@ -19,15 +19,23 @@ qr
参数
::::::::::::

- **x** (Tensor):输入进行正交三角分解的一个或一批方阵,类型为 Tensor。 ``x`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。
- **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]`` 。
- **x** (Tensor):输入进行正交三角分解的一个或一批方阵,类型为 Tensor。 ``x`` 的形状应为 ``[*, M, N]``,其中 ``*`` 为零或更大的批次维度,数据类型支持 float32, float64。别名 ``input``, ``A``。
- **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:`R`,其形状为 ``[*, K, N]``。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
- **out** (Tensor|tuple,可选) - 指定输出的张量。
当 ``mode = "r"`` 时,为一个 Tensor 用于存储 R;
否则为一个 ``(Q, R)`` 张量元组,默认值为 None。

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

- Tensor Q,正交三角分解的 Q 正交矩阵,需注意如果 ``mode = "reduced"``,则不返回 Q 矩阵,只返回 R 矩阵。
- Tensor R,正交三角分解的 R 上三角矩阵。
- 如果 ``mode = "r"``,返回 Tensor R,即缩减的上三角矩阵。
- 否则返回 ``QrRetType(Q, R)`` 具名元组:
- Tensor Q,正交三角分解的 Q 正交矩阵。
- Tensor R,正交三角分解的 R 上三角矩阵。

代码示例
::::::::::
Expand Down
26 changes: 26 additions & 0 deletions docs/api/paddle/logdet_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.. _cn_api_paddle_logdet:

logdet
-------------------------------

.. py:function:: paddle.logdet(input, name=None)

计算一个或一批方阵的行列式的自然对数。

如果行列式值为正数,则返回行列式的自然对数;如果行列式值为负数或零,则返回 ``NaN``。

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

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

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

Tensor,输出矩阵的行列式的自然对数值。

代码示例
::::::::::::

COPY-FROM: paddle.logdet
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,可选) - 是否在不更改变量的内存地址的情况下,直接修改变量的值,默认值为 False。
- **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,可选) - 是否在不更改变量的内存地址的情况下,直接修改变量的值,默认值为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
3 changes: 2 additions & 1 deletion docs/api/paddle/nn/functional/gumbel_softmax_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

gumbel_softmax
-------------------------------
.. py:function:: paddle.nn.functional.gumbel_softmax(x, temperature = 1.0, hard = False, axis = -1, name = None)
.. py:function:: paddle.nn.functional.gumbel_softmax(x, temperature = 1.0, hard = False, axis = -1, name = None, eps = None)

实现了按 Gumbel-Softmax 分布进行采样的功能,通过 hard 可选择是否离散化。记 temperature 为 ``t``,涉及到的等式如下:

Expand Down Expand Up @@ -32,6 +32,7 @@ gumbel_softmax
- **hard** (bool,可选) - 如果是 True,返回离散的 one-hot 向量。如果是 False,返回软样本。默认值:False。
- **axis** (int,可选) - 按照维度 axis 计算 softmax。默认值:-1。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
- **eps** (float,可选) - 此参数已被废弃,不产生任何作用。默认值为 None。

返回
::::::::::
Expand Down
9 changes: 7 additions & 2 deletions docs/api/paddle/nn/functional/instance_norm_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,19 @@
instance_norm
-------------------------------

.. py:class:: paddle.nn.functional.instance_norm(x, running_mean=None, running_var=None, weight=None, bias=None, use_input_stats=True, momentum=0.9, eps=1e-05, data_format='NCHW', name=None)
.. py:function:: paddle.nn.functional.instance_norm(x, running_mean=None, running_var=None, weight=None, bias=None, use_input_stats=True, momentum=0.9, eps=1e-05, data_format='NCHW', name=None)

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

推荐使用 :ref:`cn_api_paddle_nn_InstanceNorm1D`,:ref:`cn_api_paddle_nn_InstanceNorm2D`,:ref:`cn_api_paddle_nn_InstanceNorm3D`,由内部调用此方法。

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

- **x** (Tensor) - 输入,数据类型为 float32, float64。
- **x** (Tensor) - 输入,数据类型为 float32, float64。别名 ``input``。
- **running_mean** (Tensor,可选) - 均值的 Tensor。过时(已被删除,无法使用)
- **running_var** (Tensor,可选) - 方差的 Tensor。过时(已被删除,无法使用)
- **weight** (Tensor,可选) - 权重的 Tensor。默认值:None. 如果 weight 为 None 则 weight 被初始化为全 1 的 Tensor.
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/nn/functional/prelu_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ prelu 激活层(PRelu Activation Operator)。计算公式如下:

参数
::::::::::
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float32、float64。别名 ``input``。
- **weight** (Tensor) - 可训练参数,数据类型同``x`` 一致,形状支持:[]、[1] 或者 [in],其中 ``in`` 为输入的通道数。
- **data_format** (str,可选) – 指定输入的数据格式,输出的数据格式将与输入保持一致,可以是 "NC", "NCL", "NCHW", "NCDHW", "NLC", "NHWC" 或者 "NDHWC"。默认值:"NCHW"。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down
Loading