Skip to content

Commit b141690

Browse files
[API Compatibility] CN doc (#7896)
1 parent c165e6f commit b141690

22 files changed

Lines changed: 245 additions & 7 deletions

docs/api/paddle/Tensor__upper_cn.rst

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -339,9 +339,26 @@ is_cuda
339339
d.is_cuda
340340
341341
342-
numpy()
342+
is_cpu
343343
:::::::::
344344

345+
如果 Tensor 存储在 CPU 上,则为 True,否则为 False。
346+
347+
**代码示例**
348+
349+
.. code-block:: python
350+
351+
import paddle
352+
d = torch.Tensor([1, 2, 3])
353+
d.is_cpu
354+
355+
356+
numpy(force=True)
357+
:::::::::
358+
359+
参数:
360+
- **force** (bool, 可选) - 此参数用于 pytorch 兼容,无实际作用,默认为 True。
361+
345362
返回:将 Tensor 转为 numpy 返回
346363

347364
返回类型:numpy\.ndarray
@@ -1309,8 +1326,16 @@ cuda(device_id=None, blocking=False)
13091326

13101327
如果当前 Tensor 已经在 GPU 上,且 device_id 为 None,则不会发生任何拷贝。
13111328

1329+
本 API 支持两种调用方式:
1330+
1331+
1. **Paddle 风格**: ``paddle.Tensor.cuda(self, device_id=None, blocking=True)``
1332+
使用 blocking 参数。
1333+
1334+
2. **PyTorch 风格**: ``paddle.Tensor.cuda(self, device, non_blocking=False)``
1335+
使用 non_blocking 参数。device 参数为 str 类型时,默认使用此签名。
1336+
13121337
参数:
1313-
- **device_id** (int, 可选) - 目标 GPU 的设备 Id默认为 None,此时为当前 Tensor 的设备 Id,如果当前 Tensor 不在 GPU 上,则为 0。
1338+
- **device_id** (int, str, paddle.core.Place, 可选) - Tensor 移动的目标设备。若为 int,则为目标 GPU 的设备 Id默认为 None,此时为当前 Tensor 的设备 Id,如果当前 Tensor 不在 GPU 上,则为 0。别名 ``device``
13141339
- **blocking** (bool, 可选) - 如果为 False 并且当前 Tensor 处于固定内存上,将会发生主机到设备端的异步拷贝。否则,会发生同步拷贝。默认为 False。
13151340

13161341
返回:拷贝到 GPU 上的 Tensor
@@ -1613,9 +1638,17 @@ fill_diagonal_(x, value, offset=0, wrap=False, name=None)
16131638
输入 Tensor x 维度至少是 2 维,当维度大于 2 维时要求所有维度值相等。
16141639
当维度等于 2 维时,两个维度可以不等,且此时 wrap 选项生效,详见 wrap 参数说明。
16151640

1641+
本 API 支持两种调用方式:
1642+
1643+
1. **Paddle 风格**: ``paddle.Tensor.fill_diagonal_(x, value, offset=0, wrap=False)``
1644+
使用位置参数 offset。
1645+
1646+
2. **PyTorch 风格**: ``paddle.Tensor.fill_diagonal_(x, fill_value, wrap=False)``
1647+
不使用位置参数 offset。
1648+
16161649
参数:
16171650
- **x** (Tensor) - 需要修改对角线元素值的原始 Tensor。
1618-
- **value** (float) - 以输入 value 值修改原始 Tensor 对角线元素。
1651+
- **value** (float) - 以输入 value 值修改原始 Tensor 对角线元素。别名 ``fill_value``。
16191652
- **offset** (int,可选) - 所选取对角线相对原始主对角线位置的偏移量,正向右上方偏移,负向左下方偏移,默认为 0。
16201653
- **wrap** (bool,可选) - 对于 2 维 Tensor,height>width 时是否循环填充,默认为 False。
16211654
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
@@ -2340,6 +2373,13 @@ neg(name=None)
23402373

23412374
请参考 :ref:`cn_api_paddle_neg`
23422375

2376+
nelement()
2377+
:::::::::
2378+
2379+
返回:Tensor 内元素的数量
2380+
2381+
返回类型:int
2382+
23432383
nonzero(as_tuple=False)
23442384
:::::::::
23452385

docs/api/paddle/autograd/Overview_cn.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ paddle.autograd 目录下包含飞桨框架支持的自动微分相关的 API
77

88
- :ref:`自动微分相关 API <about_autograd>`
99
- :ref:`自动微分相关辅助类 <about_autograd_class>`
10+
- :ref:`自动微分相关别名 API <about_autograd_function>`
1011

1112
.. _about_autograd:
1213

@@ -35,3 +36,16 @@ paddle.autograd 目录下包含飞桨框架支持的自动微分相关的 API
3536
" :ref:`PyLayer <cn_api_paddle_autograd_PyLayer>` ", "通过创建 ``PyLayer`` 子类的方式实现 Python 端自定义算子"
3637
" :ref:`Function <cn_api_paddle_autograd_Function>` ", "``PyLayer`` 的别名"
3738
" :ref:`PyLayerContext <cn_api_paddle_autograd_PyLayerContext>` ", "``PyLayerContext`` 对象能够辅助 :ref:`cn_api_paddle_autograd_PyLayer` 实现某些功能"
39+
40+
41+
.. _about_autograd_function:
42+
43+
自动微分相关别名 API
44+
::::::::::::::::::::
45+
46+
.. csv-table::
47+
:header: "类或 API 名称", "类或 API 功能"
48+
:widths: 10, 30
49+
50+
" :ref:`FunctionCtx <cn_api_paddle_autograd_function_FunctionCtx>` ", "``paddle.autograd.PyLayerContext`` 的别名"
51+
" :ref:`once_differentiable <cn_api_paddle_autograd_function_once_differentiable>` ", "``paddle.autograd.py_layer.once_differentiable`` 的别名"

docs/api/paddle/autograd/PyLayerContext_cn.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,19 @@ PyLayerContext
1414
COPY-FROM: paddle.autograd.PyLayerContext
1515

1616

17+
属性
18+
::::::::::::
19+
saved_tensors
20+
'''''''''
21+
22+
获取被 ``save_for_backward`` 暂存的 ``Tensor`` 。此属性是方法 ``saved_tensor()`` 的别名。
23+
24+
25+
**返回**
26+
27+
如果调用 ``save_for_backward`` 暂存了一些 ``Tensor``,则返回这些 ``Tensor``,否则,返回 None。
28+
29+
1730
方法
1831
::::::::::::
1932
save_for_backward(*tensors)
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _cn_api_paddle_autograd_function_FunctionCtx:
2+
3+
FunctionCtx
4+
-------------------------------
5+
6+
.. py:class:: paddle.autograd.function.FunctionCtx
7+
8+
``paddle.autograd.PyLayerContext`` 的别名,请参考 :ref:`cn_api_paddle_autograd_PyLayerContext`。
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. _cn_api_paddle_autograd_function_once_differentiable:
2+
3+
once_differentiable
4+
-------------------------------
5+
6+
.. py:function:: paddle.autograd.function.once_differentiable
7+
8+
``paddle.autograd.py_layer.once_differentiable`` 的别名。

docs/api/paddle/optimizer/Optimizer_cn.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ COPY-FROM: paddle.optimizer.Optimizer
2929

3030
方法
3131
::::::::::::
32-
step()
32+
step(closure=None)
3333
'''''''''
3434

3535
.. note::
@@ -38,9 +38,13 @@ step()
3838

3939
执行一次优化器并进行参数更新。
4040

41+
**参数**
42+
43+
- **closure** (Callable[[], Tensor], 可选) - 用于评估模型并返回损失的闭包函数。闭包函数应接受 0 个参数并返回 Tensor。适用于需要多次评估损失的优化过程。默认值为 None。
44+
4145
**返回**
4246

43-
47+
Tensor 或 None。若传入 closure 参数则返回其输出的损失,否则返回 None
4448

4549

4650
**代码示例**

docs/api/paddle/random/Overview_cn.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@ paddle.random 目录下包含飞桨框架随机数相关 API。具体如下:
1010
:header: "API 名称", "API 功能"
1111

1212
" :ref:`paddle.random.initial_seed <cn_api_paddle_random_initial_seed>` ", "获取随机数初始种子值"
13+
" :ref:`paddle.random.get_rng_state <cn_api_paddle_random_get_rng_state>` ", "``paddle.device.cpu.get_rng_state`` 的别名"
14+
" :ref:`paddle.random.set_rng_state <cn_api_paddle_random_set_rng_state>` ", "``paddle.device.cpu.set_rng_state`` 的别名"
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _cn_api_paddle_random_get_rng_state:
2+
3+
get_rng_state
4+
-------------------------------
5+
6+
.. py:function:: paddle.random.get_rng_state()
7+
8+
``paddle.device.cpu.get_rng_state`` 的别名,请参考 :ref:`cn_api_paddle_get_rng_state`。
9+
10+
返回
11+
:::::::::
12+
Tensor:CPU 随机数生成器的初始种子值。
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.. _cn_api_paddle_random_set_rng_state:
2+
3+
set_rng_state
4+
-------------------------------
5+
6+
.. py:function:: paddle.random.set_rng_state(new_state)
7+
8+
``paddle.device.cpu.set_rng_state`` 的别名,请参考 :ref:`cn_api_paddle_set_rng_state`。
9+
10+
参数
11+
:::::::::
12+
- **new_state** (Tensor) - 要设置的 CPU 随机数生成器的初始种子值。通过 ``get_rng_state()`` 获得。
13+
14+
15+
返回
16+
:::::::::
17+

docs/api/paddle/utils/Overview_cn.rst

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ paddle.utils 目录下包含飞桨框架工具类的 API。具体如下:
77

88
- :ref:`自定义 OP 相关 API <about_cpp_extension>`
99
- :ref:`工具类相关 API <about_utils>`
10+
- :ref:`别名相关 API <about_alias>`
1011

1112

1213

@@ -43,6 +44,29 @@ paddle.utils 目录下包含飞桨框架工具类的 API。具体如下:
4344
" :ref:`switch <cn_api_paddle_utils_unique_name_switch>` ", "切换命名空间"
4445
" :ref:`Profiler <cn_api_paddle_profiler_Profiler>` ", "通用性能分析器"
4546
" :ref:`require_version <cn_api_paddle_utils_require_version>` ", "用于检查已安装的飞桨版本是否介于[min_version, max_version]之间"
46-
" :ref:`to_dlpack <cn_api_paddle_utils_dlpack_to_dlpack>` ", "用于将 Tensor 对象转换为 DLPack"
47-
" :ref:`from_dlpack <cn_api_paddle_utils_dlpack_from_dlpack>` ", "用于从 DLPack 中解码出 Tensor 对象"
47+
" :ref:`to_dlpack <cn_api_paddle_to_dlpack>` ", "用于将 Tensor 对象转换为 DLPack"
48+
" :ref:`from_dlpack <cn_api_paddle_from_dlpack>` ", "用于从 DLPack 中解码出 Tensor 对象"
4849
" :ref:`try_import <cn_api_paddle_utils_try_import>` ", "用于尝试导入一个模块并且在失败时提供自定义错误信息"
50+
51+
52+
.. _about_alias:
53+
54+
别名相关 API
55+
::::::::::::::::::::
56+
57+
.. csv-table::
58+
:header: "API 名称", "API 功能"
59+
:widths: 12, 30
60+
61+
" :ref:`default_collate <cn_api_paddle_utils_data_default_collate>` ", "``paddle.io.dataloader.collate.default_collate_fn`` 的别名"
62+
" :ref:`get_worker_info <cn_api_paddle_utils_data_get_worker_info>` ", "``paddle.io.get_worker_info`` 的别名"
63+
" :ref:`ChainDataset <cn_api_paddle_utils_data_ChainDataset>` ", "``paddle.io.ChainDataset`` 的别名"
64+
" :ref:`ConcatDataset <cn_api_paddle_utils_data_ConcatDataset>` ", "``paddle.io.ConcatDataset`` 的别名"
65+
" :ref:`Dataset <cn_api_paddle_utils_data_Dataset>` ", "``paddle.io.Dataset`` 的别名"
66+
" :ref:`IterableDataset <cn_api_paddle_utils_data_IterableDataset>` ", "``paddle.io.IterableDataset`` 的别名"
67+
" :ref:`Subset <cn_api_paddle_utils_data_Subset>` ", "``paddle.io.Subset`` 的别名"
68+
" :ref:`random_split <cn_api_paddle_utils_data_random_split>` ", "``paddle.io.random_split`` 的别名"
69+
" :ref:`BatchSampler <cn_api_paddle_utils_data_BatchSampler>` ", "``paddle.io.BatchSampler`` 的别名"
70+
" :ref:`RandomSampler <cn_api_paddle_utils_data_RandomSampler>` ", "``paddle.io.RandomSampler`` 的别名"
71+
" :ref:`Sampler <cn_api_paddle_utils_data_Sampler>` ", "``paddle.io.Sampler`` 的别名"
72+
" :ref:`SequentialSampler <cn_api_paddle_utils_data_SequentialSampler>` ", "``paddle.io.SequenceSampler`` 的别名"

0 commit comments

Comments
 (0)