Skip to content

Commit 7aa8519

Browse files
Manfredssclaudemattheliu
authored
[API Compatibility] Update and add cn docs for aligned 19 apis -part (#7893)
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Mattheliu <leonliuzx@outlook.com>
1 parent 8b9cba2 commit 7aa8519

32 files changed

Lines changed: 179 additions & 57 deletions

docs/api/paddle/Overview_cn.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -469,6 +469,7 @@ tensor 线性代数相关
469469
" :ref:`paddle.histogram_bin_edges <cn_api_paddle_histogram_bin_edges>` ", "返回计算 input 的直方图时所使用的 bins 的边界值 bin_edges"
470470
" :ref:`paddle.histogram <cn_api_paddle_histogram>` ", "计算输入 Tensor 的直方图"
471471
" :ref:`paddle.histogramdd <cn_api_paddle_histogramdd>` ", "计算输入多维 Tensor 的直方图"
472+
" :ref:`paddle.inverse <cn_api_paddle_inverse>` ", "计算方阵的逆矩阵"
472473
" :ref:`paddle.matmul <cn_api_paddle_matmul>` ", "计算两个 Tensor 的乘积,遵循完整的广播规则"
473474
" :ref:`paddle.mv <cn_api_paddle_mv>` ", "计算矩阵 x 和向量 vec 的乘积"
474475
" :ref:`paddle.rank <cn_api_paddle_rank>` ", "计算输入 Tensor 的维度(秩)"
@@ -613,6 +614,7 @@ framework 相关
613614
:header: "API 名称", "API 功能"
614615
:widths: 10, 30
615616

617+
" :ref:`paddle._assert <cn_api_paddle__assert>` ", "对 Python assert 的封装,支持符号追踪"
616618
" :ref:`paddle.CPUPlace <cn_api_paddle_CPUPlace>` ", "一个设备描述符,指定 CPUPlace 则 Tensor 将被自动分配在该设备上,并且模型将会运行在该设备上"
617619
" :ref:`paddle.CUDAPinnedPlace <cn_api_paddle_CUDAPinnedPlace>` ", "一个设备描述符,它所指代的页锁定内存由 CUDA 函数 cudaHostAlloc() 在主机内存上分配,主机的操作系统将不会对这块内存进行分页和交换操作,可以通过直接内存访问技术访问,加速主机和 GPU 之间的数据拷贝"
618620
" :ref:`paddle.CUDAPlace <cn_api_paddle_CUDAPlace>` ", "一个设备描述符,表示一个分配或将要分配 Tensor 的 GPU 设备"

docs/api/paddle/Tensor__upper_cn.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4020,7 +4020,7 @@ new_full(size, fill_value, \*, dtype=None, device=None, requires_grad=False, pin
40204020
- **out** (Tensor,可选) - 用于保存输出结果的 Tensor,默认值为 None。
40214021
- **device** (PlaceLike|None,可选) - 期望创建 Tensor 所在的设备。若为 None,则与 ``self`` 保持一致。
40224022
- **requires_grad** (bool,可选) - 是否需要为返回的 Tensor 记录梯度信息。默认值为 False。
4023-
- **pin_memory** (bool,可选) - 若为 True,返回的 CPU Tensor 将分配在锁页内存中。仅对 CPU Tensor 生效。默认值为 False。
4023+
- **pin_memory** (bool,可选) - 若为 True,返回的 Tensor 将分配在锁页内存中。默认值为 False。
40244024

40254025
返回:
40264026
- **Tensor**,其形状为 ``shape``,元素值为 ``fill_value``,数据类型为 ``dtype``(若未指定,则与 ``self`` 一致)。
@@ -4044,7 +4044,7 @@ new_ones(size, \*, dtype=None, device=None, requires_grad=False, pin_memory=Fals
40444044
- **out** (Tensor,可选) - 用于保存输出结果的 Tensor,默认值为 None。
40454045
- **device** (PlaceLike|None,可选) - 期望创建 Tensor 所在的设备。若为 None,则与 ``self`` 保持一致。
40464046
- **requires_grad** (bool,可选) - 是否需要为返回的 Tensor 记录梯度信息。默认值为 False。
4047-
- **pin_memory** (bool,可选) - 若为 True,返回的 CPU Tensor 将分配在锁页内存中。仅对 CPU Tensor 生效。默认值为 False。
4047+
- **pin_memory** (bool,可选) - 若为 True,返回的 Tensor 将分配在锁页内存中。默认值为 False。
40484048

40494049
返回:
40504050
- **Tensor**,其形状为 ``shape``,元素值为 ``1``,数据类型为 ``dtype``(若未指定,则与 ``self`` 一致)。
@@ -4068,7 +4068,7 @@ new_zeros(size, \*, dtype=None, device=None, requires_grad=False, pin_memory=Fal
40684068
- **out** (Tensor,可选) - 用于保存输出结果的 Tensor,默认值为 None。
40694069
- **device** (PlaceLike|None,可选) - 期望创建 Tensor 所在的设备。若为 None,则与 ``self`` 保持一致。
40704070
- **requires_grad** (bool,可选) - 是否需要为返回的 Tensor 记录梯度信息。默认值为 False。
4071-
- **pin_memory** (bool,可选) - 若为 True,返回的 CPU Tensor 将分配在锁页内存中。仅对 CPU Tensor 生效。默认值为 False。
4071+
- **pin_memory** (bool,可选) - 若为 True,返回的 Tensor 将分配在锁页内存中。默认值为 False。
40724072

40734073
返回:
40744074
- **Tensor**,其形状为 ``shape``,元素值为 ``0``,数据类型为 ``dtype``(若未指定,则与 ``self`` 一致)。
@@ -4092,7 +4092,7 @@ new_empty(size, \*, dtype=None, device=None, requires_grad=False, pin_memory=Fal
40924092
- **out** (Tensor,可选) - 用于保存输出结果的 Tensor,默认值为 None。
40934093
- **device** (PlaceLike|None,可选) - 期望创建 Tensor 所在的设备。若为 None,则与 ``self`` 保持一致。
40944094
- **requires_grad** (bool,可选) - 是否需要为返回的 Tensor 记录梯度信息。默认值为 False。
4095-
- **pin_memory** (bool,可选) - 若为 True,返回的 CPU Tensor 将分配在锁页内存中。仅对 CPU Tensor 生效。默认值为 False。
4095+
- **pin_memory** (bool,可选) - 若为 True,返回的 Tensor 将分配在锁页内存中。默认值为 False。
40964096

40974097
返回:
40984098
- **Tensor**,其形状为 ``shape``,元素值为 ``0``(一般情况下为 ``0``,但也有可能为随机值),数据类型为 ``dtype``(若未指定,则与 ``self`` 一致)。

docs/api/paddle/_assert_cn.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _cn_api_paddle__assert:
2+
3+
_assert
4+
-------------------------------
5+
6+
.. py:function:: paddle._assert(condition, message="")
7+
8+
对 Python assert 的封装,支持符号追踪。
9+
10+
在动态图模式下,该函数的行为与 Python 的 assert 语句一致。在静态图模式下,当 condition 是 Tensor 时,会在计算图中创建一个 Assert 算子。
11+
12+
参数
13+
::::::::::::
14+
- **condition** (bool|Tensor) - 断言的条件。如果是 Tensor,必须是布尔标量(numel=1)。
15+
- **message** (str,可选) - 断言失败时显示的错误信息。默认值为 ""。
16+
17+
代码示例
18+
::::::::::::
19+
20+
.. code-block:: pycon
21+
22+
>>> import paddle
23+
>>> # Non-tensor condition
24+
>>> paddle._assert(1 == 1, "This should pass")
25+
26+
>>> # Tensor condition
27+
>>> x = paddle.to_tensor([True])
28+
>>> paddle._assert(x, "Tensor assertion")

docs/api/paddle/allclose_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ allclose
1515
参数
1616
::::::::::::
1717

18-
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float16、float32、float64。
19-
- **y** (Tensor) - 输入的 ``Tensor``,数据类型为:float16、float32、float64。
18+
- **x** (Tensor) - 输入的 ``Tensor``,数据类型为:float16、float32、float64。别名 ``input``。
19+
- **y** (Tensor) - 输入的 ``Tensor``,数据类型为:float16、float32、float64。别名 ``other``。
2020
- **rtol** (float,可选) - 相对容忍误差,默认值为 1e-5。
2121
- **atol** (float,可选) - 绝对容忍误差,默认值为 1e-8。
2222
- **equal_nan** (bool,可选) - 如果设置为 True,则两个 NaN 数值将被视为相等,默认值为 False。

docs/api/paddle/amp/GradScaler_cn.rst

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,21 @@ GradScaler 用于动态图模式下的"自动混合精度"的训练。它控制
1717

1818
通常,GradScaler 和 ``paddle.amp.auto_cast`` 一起使用,来实现动态图模式下的"自动混合精度"。
1919

20+
本 API 支持三种调用方式:
21+
22+
1. ``GradScaler(enable=True, init_loss_scaling=2.0**16, incr_ratio=2.0, decr_ratio=0.5, incr_every_n_steps=2000, decr_every_n_nan_or_inf=1, use_dynamic_loss_scaling=True)``
23+
24+
2. ``GradScaler(device, init_scale=2.0**16, growth_factor=2.0, backoff_factor=0.5, growth_interval=2000, enabled=True)``
25+
26+
3. ``GradScaler(init_scale=2.0**16, growth_factor=2.0, backoff_factor=0.5, growth_interval=2000, enabled=True)``
2027

2128
参数
2229
:::::::::
23-
- **enable** (bool,可选) - 是否使用 loss scaling。默认值为 True。
24-
- **init_loss_scaling** (float,可选) - 初始 loss scaling 因子。默认值为 65536.0。
25-
- **incr_ratio** (float,可选) - 增大 loss scaling 时使用的乘数。默认值为 2.0。
26-
- **decr_ratio** (float,可选) - 减小 loss scaling 时使用的小于 1 的乘数。默认值为 0.5。
27-
- **incr_every_n_steps** (int,可选) - 连续 n 个 steps 的梯度都是有限值时,增加 loss scaling。默认值为 2000。
30+
- **enable** (bool,可选) - 是否使用 loss scaling。默认值为 True。别名 ``enabled``。
31+
- **init_loss_scaling** (float,可选) - 初始 loss scaling 因子。默认值为 65536.0。别名 ``init_scale``。
32+
- **incr_ratio** (float,可选) - 增大 loss scaling 时使用的乘数。默认值为 2.0。别名 ``growth_factor``。
33+
- **decr_ratio** (float,可选) - 减小 loss scaling 时使用的小于 1 的乘数。默认值为 0.5。别名 ``backoff_factor``。
34+
- **incr_every_n_steps** (int,可选) - 连续 n 个 steps 的梯度都是有限值时,增加 loss scaling。默认值为 2000。别名 ``growth_interval``。
2835
- **decr_every_n_nan_or_inf** (int,可选) - 累计出现 n 个 steps 的梯度为 nan 或者 inf 时,减小 loss scaling。默认值为 1。
2936
- **use_dynamic_loss_scaling** (bool,可选) - 是否使用动态的 loss scaling。如果不使用,则使用固定的 loss scaling;如果使用,则会动态更新 loss scaling。默认值为 True。
3037

docs/api/paddle/arange_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ arange
2222
- **out** (Tensor,可选) - 用于存储结果的 Tensor。若指定,将直接写入该 Tensor,默认值为 None。
2323
- **device** (PlaceLike|None,可选) - 期望创建 Tensor 所在的设备。默认值为 None,表示使用当前全局设备(可通过 ``paddle.device.set_device`` 设置)。
2424
- **requires_grad** (bool,可选) - 是否需要为返回的 Tensor 记录梯度信息。默认值为 False。
25-
- **pin_memory** (bool,可选) - 若为 True,返回的 CPU Tensor 将分配在锁页内存中。仅对 CPU Tensor 生效。默认值为 False。
25+
- **pin_memory** (bool,可选) - 若为 True,返回的 Tensor 将分配在锁页内存中。默认值为 False。
2626
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
2727

2828
返回

docs/api/paddle/deg2rad_cn.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
deg2rad
44
-------------------------------
55

6-
.. py:function:: paddle.deg2rad(x, name=None)
6+
.. py:function:: paddle.deg2rad(x, name=None, *, out=None)
77
88
将元素从度转换为弧度
99

@@ -17,6 +17,10 @@ deg2rad
1717
- **x** (Tensor) - 输入的 Tensor,数据类型为:int32、int64、float32、float64。
1818
- **name** (str,可选) - 操作的名称(可选,默认值为 None)。更多信息请参见 :ref:`api_guide_Name`。
1919

20+
关键字参数
21+
:::::::::
22+
- **out** (Tensor,可选) - 输出 Tensor,若不为 ``None``,计算结果将保存在该 Tensor 中,默认值为 ``None``。
23+
2024
返回
2125
:::::::::
2226

docs/api/paddle/empty_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ empty
3232
- **out** (Tensor,可选) - 用于存储结果的 Tensor。若指定,将直接写入该 Tensor,默认值为 None。
3333
- **device** (PlaceLike|None,可选) - 期望创建 Tensor 所在的设备。默认值为 None,表示使用当前全局设备(可通过 ``paddle.device.set_device`` 设置)。
3434
- **requires_grad** (bool,可选) - 是否需要为返回的 Tensor 记录梯度信息。默认值为 False。
35-
- **pin_memory** (bool,可选) - 若为 True,返回的 CPU Tensor 将分配在锁页内存中。仅对 CPU Tensor 生效。默认值为 False。
35+
- **pin_memory** (bool,可选) - 若为 True,返回的 Tensor 将分配在锁页内存中。默认值为 False。
3636

3737
返回
3838
::::::::::::

docs/api/paddle/empty_like_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ empty_like
2222
::::::::::::
2323
- **device** (PlaceLike|None,可选) - 期望创建 Tensor 所在的设备。若为 None,则与 ``x`` 保持一致。
2424
- **requires_grad** (bool,可选) - 是否需要为返回的 Tensor 记录梯度信息。默认值为 False。
25-
- **pin_memory** (bool,可选) - 若为 True,返回的 CPU Tensor 将分配在锁页内存中。仅对 CPU Tensor 生效。默认值为 False。
25+
- **pin_memory** (bool,可选) - 若为 True,返回的 Tensor 将分配在锁页内存中。默认值为 False。
2626

2727
返回
2828
::::::::::::

docs/api/paddle/eye_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ eye
2424
- **device** (PlaceLike|None,可选) - 指定返回 Tensor 所在的设备。默认值为 None,表示使用当前全局设备(可通过 ``paddle.device.set_device`` 设置)。
2525
对于 CPU Tensor,设备为 CPU;对于 CUDA Tensor,设备为当前 CUDA 设备。默认值为 None。
2626
- **requires_grad** (bool,可选) - 是否在返回的 Tensor 上记录 autograd 的操作。默认值为 False。
27-
- **pin_memory** (bool,可选) - 若设置为 True,则返回的 Tensor 将分配在锁页内存中。仅对 CPU Tensor 生效。默认值为 False。
27+
- **pin_memory** (bool,可选) - 若设置为 True,则返回的 Tensor 将分配在锁页内存中。默认值为 False。
2828

2929
返回
3030
::::::::::::

0 commit comments

Comments
 (0)