Skip to content
Merged
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
23 changes: 20 additions & 3 deletions docs/api/paddle/amp/GradScaler_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ GradScaler



GradScaler 用于动态图模式下的"自动混合精度"的训练。它控制 loss 的缩放比例,有助于避免浮点数溢出的问题。这个类具有 ``scale()``、 ``unscale_()``、 ``step()``、 ``update()``、 ``minimize()`` 和参数的 ``get()/set()`` 等方法
GradScaler 用于动态图模式下的"自动混合精度"的训练。它控制 loss 的缩放比例,有助于避免浮点数溢出的问题。这个类具有 ``scale()``、 ``unscale_()``、 ``minimize()``、 ``step()``、 ``update()`` 和参数的 ``get()/set()`` 共十九个方法

``scale()`` 用于让 loss 乘上一个缩放的比例。
``unscale_()`` 用于让 loss 除去一个缩放的比例。
Expand Down Expand Up @@ -96,10 +96,14 @@ step(optimizer)

COPY-FROM: paddle.amp.GradScaler.step

update()
update(new_scale=None)
'''''''''

更新缩放比例。
更新 loss scaling 比例。

**参数**

- **new_scale** (float,可选) - 新的 loss scaling 因子。如果提供,loss scaling 因子将直接设置为 ``new_scale`` 并重置内部步数计数。默认值为 None。

**代码示例**

Expand Down Expand Up @@ -301,3 +305,16 @@ load_state_dict(state_dict)
**代码示例**

COPY-FROM: paddle.amp.GradScaler.load_state_dict

get_scale()
'''''''''

返回当前的缩放因子,类型为 Python float。如果 loss scaling 未启用,则返回 0.0。

**返回**

float,当前 loss scaling 因子,如果禁用则返回 0.0。

**代码示例**

COPY-FROM: paddle.amp.GradScaler.get_scale
15 changes: 15 additions & 0 deletions docs/api/paddle/clamp__cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
.. _cn_api_paddle_clamp_:

clamp\_
-------------------------------

.. py:function:: paddle.clamp_(x, min=None, max=None, name=None)

``clip_`` 的别名,请参考 :ref:`cn_api_paddle_clip_`。

.. note::
别名支持:参数名 ``input`` 可替代 ``x``,如 ``clamp_(input=tensor_x)`` 等价于 ``clamp_(x=tensor_x)``。

更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

.. _3.1.3 原位(Inplace)操作和非原位操作的区别: https://www.paddlepaddle.org.cn/documentation/docs/zh/develop/guides/beginner/tensor_cn.html#id3
29 changes: 29 additions & 0 deletions docs/api/paddle/clamp_max_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _cn_api_paddle_clamp_max:

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

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

将输入中的所有元素裁剪到区间 [min=None, max] 内。

该接口是 ``paddle.clip`` 的封装,仅设置上界。

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

- **input** (Tensor) - 输入的 Tensor。
- **max** (float|Tensor) - 裁剪的最大值。

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

返回
::::::::::::
输出 Tensor,与 ``input`` 维度相同。

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

COPY-FROM: paddle.clamp_max
6 changes: 3 additions & 3 deletions docs/api/paddle/cross_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ cross
.. py:function:: paddle.cross(x, y, axis=9, name=None)


计算 Tensor ``x`` 和 ``y`` 在 ``axis`` 维度上的向量积(叉积)。
计算两个 Tensor 在 ``axis`` 维度上的向量积(叉积)。

``x`` 和 ``y`` 必须有相同的形状,且指定的 ``axis`` 的长度必须为 3。如果未指定 ``axis``,默认选取第一个长度为 3 的 ``axis``
输入 Tensor 必须有相同的形状,且指定维度的长度必须为 3。如果未指定 ``axis``,默认选取第一个长度为 3 的维度

参数
:::::::::
- **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,可选) - 沿着此维度进行向量积操作。默认值为 9,表示选取第一个长度为 3 的维度。别名 ``dim``
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

返回
Expand Down
28 changes: 28 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,28 @@
.. _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``,表示当前设备。

返回
:::::::::

无。

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

.. code-block:: pycon

>>> import paddle
>>> paddle.device.set_default_device("cpu")
30 changes: 30 additions & 0 deletions docs/api/paddle/expand_copy_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
.. _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` 的非原位版本,始终返回新的 Tensor 而非视图。

.. note::
该接口有两个签名:
1. ``paddle.expand_copy(x, shape, name=None)`` (Paddle 风格):根据广播语义返回扩展后的新 Tensor。
2. ``paddle.expand_copy(input, *size)`` (PyTorch 风格):通过可变长 size 参数返回扩展后的新 Tensor。

参数
:::::::::::
- **x** (Tensor) - 输入的 Tensor。别名 ``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
2 changes: 1 addition & 1 deletion docs/api/paddle/histc_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ histc

计算 Tensor 的直方图。

元素被分配到 min 和 max 之间的等宽区间中。如果 min 和 max 都为零,则使用数据的最小值和最大值。
元素被分配到 min 和 max 之间的等宽区间中(包含边界)。如果 min 和 max 都为零,则使用数据的最小值和最大值。

参数
:::::::::
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`` 、 ``int8`` 、 ``int32`` 、 ``int64`` 或 ``bfloat16`` 。别名 ``tensors``
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。

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

返回
::::::::::::
Tensor,与输入数据类型相同的堆叠张量。
Expand Down
15 changes: 8 additions & 7 deletions docs/api/paddle/linalg/cholesky_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,23 @@
cholesky
-------------------------------

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



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

计算一个对称正定矩阵或一批对称正定矩阵的 Cholesky 分解。如果 ``upper`` 是 ``True``,
则分解形式为 :math:`A = U ^ {T} U`,返回的矩阵 U 是上三角矩阵。
否则,分解形式为 :math:`A = LL ^ {T}`,并返回矩阵 :math:`L` 是下三角矩阵。
则分解形式为 :math:`A = U^{T}U`,返回的矩阵 U 是上三角矩阵。
否则,分解形式为 :math:`A = LL^{T}`,并返回矩阵 :math:`L` 是下三角矩阵。

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

- **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
14 changes: 10 additions & 4 deletions docs/api/paddle/linalg/det_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,24 @@
det
-------------------------------

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

计算一个或批量方阵的行列式值。

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

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

关键字参数
::::::::::::
- **out** (Tensor,可选) - 指定输出的存储结果的 Tensor,如果提供,返回值将是 ``out`` 本身。默认值为 ``None``。

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

Tensor,输出矩阵的行列式值 Shape 为 ``[*]`` 。
Tensor,输出方阵的行列式值。Shape 为 ``[*]`` 。

代码示例
::::::::::
Expand Down
14 changes: 10 additions & 4 deletions docs/api/paddle/linalg/eigh_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,27 @@
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``。

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

- Tensor out_value,输出矩阵的特征值,输出顺序按照从小到大进行排序。Shape 为 ``[*, M]`` 。
- Tensor out_vector,输出矩阵的特征向量,与特征值一一对应,Shape 为 ``[*, M, M]`` 。
包含两项的元组:

- **out_value** (Tensor):输出矩阵的特征值,输出顺序按照从小到大进行排序。Shape 为 ``[*, N]``,数据类型为 float32 和 float64。
- **out_vector** (Tensor):输出矩阵的特征向量,与特征值一一对应,Shape 为 ``[*, N, N]``,数据类型为 float32、float64、complex64 和 complex128。

代码示例
::::::::::
Expand Down
28 changes: 22 additions & 6 deletions docs/api/paddle/linalg/qr_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,14 @@
qr
-------------------------------

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

.. note::

本 API 支持两种签名方式:

1. ``paddle.linalg.qr(x, mode='reduced', name=None, *, out=None)``(Paddle 风格):通过 ``mode`` 字符串参数控制 QR 分解。
2. ``paddle.linalg.qr(input, some=True, *, out=None)``(PyTorch 风格):通过 ``some`` 布尔参数控制 QR 分解。

计算一个或一批矩阵的正交三角分解,也称 QR 分解(暂不支持反向)。

Expand All @@ -15,19 +21,29 @@ qr

其中,:math:`Q` 是正交矩阵,:math:`R` 是上三角矩阵。


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

- **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、complex64、complex128。别名 ``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
27 changes: 27 additions & 0 deletions docs/api/paddle/logdet_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _cn_api_paddle_logdet:

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

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

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

对于行列式为负数的矩阵,返回 ``nan``。
对于行列式为零的矩阵,返回 ``-inf``。

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

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

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

Tensor:输出矩阵的行列式的自然对数值,Shape 为 ``[*]``。

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

COPY-FROM: paddle.logdet
6 changes: 5 additions & 1 deletion docs/api/paddle/masked_fill__cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@
masked_fill\_
-------------------------------

.. py:function:: paddle.masked_fill_(x)
.. py:function:: paddle.masked_fill_(x, mask, value, name=None)

Inplace 版本的 :ref:`cn_api_paddle_masked_fill` API,对输入 x 采用 Inplace 策略。

.. note::
别名支持:参数名 ``input`` 可替代 ``x``,如 ``masked_fill_(input=tensor_x, mask=tensor_mask, value=val)`` 等价于 ``masked_fill_(x=tensor_x, mask=tensor_mask, value=val)``。

更多关于 inplace 操作的介绍请参考 `3.1.3 原位(Inplace)操作和非原位操作的区别`_ 了解详情。

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