Skip to content
46 changes: 43 additions & 3 deletions docs/api/paddle/Tensor__upper_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -339,9 +339,26 @@ is_cuda
d.is_cuda


numpy()
is_cpu
:::::::::

如果 Tensor 存储在 CPU 上,则为 True,否则为 False。

**代码示例**

.. code-block:: python

import paddle
d = torch.Tensor([1, 2, 3])
d.is_cpu


numpy(force=True)
:::::::::

参数:
- **force** (bool, 可选) - 此参数用于 pytorch 兼容,无实际作用,默认为 True。

返回:将 Tensor 转为 numpy 返回

返回类型:numpy\.ndarray
Expand Down Expand Up @@ -1242,8 +1259,16 @@ cuda(device_id=None, blocking=False)

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

本 API 支持两种调用方式:

1. **Paddle 风格**: ``paddle.Tensor.cuda(self, device_id=None, blocking=True)``
使用 blocking 参数。

2. **PyTorch 风格**: ``paddle.Tensor.cuda(self, device, non_blocking=False)``
使用 non_blocking 参数。device 参数为 str 类型时,默认使用此签名。

参数:
- **device_id** (int, 可选) - 目标 GPU 的设备 Id默认为 None,此时为当前 Tensor 的设备 Id,如果当前 Tensor 不在 GPU 上,则为 0。
- **device_id** (int, str, paddle.core.Place, 可选) - Tensor 移动的目标设备。若为 int,则为目标 GPU 的设备 Id默认为 None,此时为当前 Tensor 的设备 Id,如果当前 Tensor 不在 GPU 上,则为 0。别名 ``device``
- **blocking** (bool, 可选) - 如果为 False 并且当前 Tensor 处于固定内存上,将会发生主机到设备端的异步拷贝。否则,会发生同步拷贝。默认为 False。

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

本 API 支持两种调用方式:

1. **Paddle 风格**: ``paddle.Tensor.fill_diagonal_(x, value, offset=0, wrap=False)``
使用位置参数 offset。

2. **PyTorch 风格**: ``paddle.Tensor.fill_diagonal_(x, fill_value, wrap=False)``
不使用位置参数 offset。

参数:
- **x** (Tensor) - 需要修改对角线元素值的原始 Tensor。
- **value** (float) - 以输入 value 值修改原始 Tensor 对角线元素。
- **value** (float) - 以输入 value 值修改原始 Tensor 对角线元素。别名 ``fill_value``。
- **offset** (int,可选) - 所选取对角线相对原始主对角线位置的偏移量,正向右上方偏移,负向左下方偏移,默认为 0。
- **wrap** (bool,可选) - 对于 2 维 Tensor,height>width 时是否循环填充,默认为 False。
- **name** (str,可选) - 具体用法请参见 :ref:`api_guide_Name`,一般无需设置,默认值为 None。
Expand Down Expand Up @@ -2259,6 +2292,13 @@ neg(name=None)

请参考 :ref:`cn_api_paddle_neg`

nelement()
:::::::::

返回:Tensor 内元素的数量

返回类型:int

nonzero(as_tuple=False)
:::::::::

Expand Down
14 changes: 14 additions & 0 deletions docs/api/paddle/autograd/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ paddle.autograd 目录下包含飞桨框架支持的自动微分相关的 API

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

.. _about_autograd:

Expand Down Expand Up @@ -35,3 +36,16 @@ paddle.autograd 目录下包含飞桨框架支持的自动微分相关的 API
" :ref:`PyLayer <cn_api_paddle_autograd_PyLayer>` ", "通过创建 ``PyLayer`` 子类的方式实现 Python 端自定义算子"
" :ref:`Function <cn_api_paddle_autograd_Function>` ", "``PyLayer`` 的别名"
" :ref:`PyLayerContext <cn_api_paddle_autograd_PyLayerContext>` ", "``PyLayerContext`` 对象能够辅助 :ref:`cn_api_paddle_autograd_PyLayer` 实现某些功能"


.. _about_autograd_function:

自动微分相关别名 API
::::::::::::::::::::

.. csv-table::
:header: "类或 API 名称", "类或 API 功能"
:widths: 10, 30

" :ref:`FunctionCtx <cn_api_paddle_autograd_function_FunctionCtx>` ", "``paddle.autograd.PyLayerContext`` 的别名"
" :ref:`once_differentiable <cn_api_paddle_autograd_function_once_differentiable>` ", "``paddle.autograd.py_layer.once_differentiable`` 的别名"
13 changes: 13 additions & 0 deletions docs/api/paddle/autograd/PyLayerContext_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,19 @@ PyLayerContext
COPY-FROM: paddle.autograd.PyLayerContext


属性
::::::::::::
saved_tensors
'''''''''

获取被 ``save_for_backward`` 暂存的 ``Tensor`` 。此属性是方法 ``saved_tensor()`` 的别名。


**返回**

如果调用 ``save_for_backward`` 暂存了一些 ``Tensor``,则返回这些 ``Tensor``,否则,返回 None。


方法
::::::::::::
save_for_backward(*tensors)
Expand Down
8 changes: 8 additions & 0 deletions docs/api/paddle/autograd/function/FunctionCtx_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_autograd_function_FunctionCtx:

FunctionCtx
-------------------------------

.. py:class:: paddle.autograd.function.FunctionCtx

``paddle.autograd.PyLayerContext`` 的别名,请参考 :ref:`cn_api_paddle_autograd_PyLayerContext`。
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_autograd_function_once_differentiable:

once_differentiable
-------------------------------

.. py:function:: paddle.autograd.function.once_differentiable

``paddle.autograd.py_layer.once_differentiable`` 的别名。
8 changes: 6 additions & 2 deletions docs/api/paddle/optimizer/Optimizer_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ COPY-FROM: paddle.optimizer.Optimizer

方法
::::::::::::
step()
step(closure=None)
'''''''''

.. note::
Expand All @@ -38,9 +38,13 @@ step()

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

**参数**

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

**返回**

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


**代码示例**
Expand Down
2 changes: 2 additions & 0 deletions docs/api/paddle/random/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@ paddle.random 目录下包含飞桨框架随机数相关 API。具体如下:
:header: "API 名称", "API 功能"

" :ref:`paddle.random.initial_seed <cn_api_paddle_random_initial_seed>` ", "获取随机数初始种子值"
" :ref:`paddle.random.get_rng_state <cn_api_paddle_random_get_rng_state>` ", "``paddle.device.cpu.get_rng_state`` 的别名"
" :ref:`paddle.random.set_rng_state <cn_api_paddle_random_set_rng_state>` ", "``paddle.device.cpu.set_rng_state`` 的别名"
12 changes: 12 additions & 0 deletions docs/api/paddle/random/get_rng_state_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.. _cn_api_paddle_random_get_rng_state:

get_rng_state
-------------------------------

.. py:function:: paddle.random.get_rng_state()

``paddle.device.cpu.get_rng_state`` 的别名,请参考 :ref:`cn_api_paddle_get_rng_state`。

返回
:::::::::
Tensor:CPU 随机数生成器的初始种子值。
17 changes: 17 additions & 0 deletions docs/api/paddle/random/set_rng_state_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _cn_api_paddle_random_set_rng_state:

set_rng_state
-------------------------------

.. py:function:: paddle.random.set_rng_state(new_state)

``paddle.device.cpu.set_rng_state`` 的别名,请参考 :ref:`cn_api_paddle_set_rng_state`。

参数
:::::::::
- **new_state** (Tensor) - 要设置的 CPU 随机数生成器的初始种子值。通过 ``get_rng_state()`` 获得。


返回
:::::::::
28 changes: 26 additions & 2 deletions docs/api/paddle/utils/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ paddle.utils 目录下包含飞桨框架工具类的 API。具体如下:

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



Expand Down Expand Up @@ -43,6 +44,29 @@ paddle.utils 目录下包含飞桨框架工具类的 API。具体如下:
" :ref:`switch <cn_api_paddle_utils_unique_name_switch>` ", "切换命名空间"
" :ref:`Profiler <cn_api_paddle_profiler_Profiler>` ", "通用性能分析器"
" :ref:`require_version <cn_api_paddle_utils_require_version>` ", "用于检查已安装的飞桨版本是否介于[min_version, max_version]之间"
" :ref:`to_dlpack <cn_api_paddle_utils_dlpack_to_dlpack>` ", "用于将 Tensor 对象转换为 DLPack"
" :ref:`from_dlpack <cn_api_paddle_utils_dlpack_from_dlpack>` ", "用于从 DLPack 中解码出 Tensor 对象"
" :ref:`to_dlpack <cn_api_paddle_to_dlpack>` ", "用于将 Tensor 对象转换为 DLPack"
" :ref:`from_dlpack <cn_api_paddle_from_dlpack>` ", "用于从 DLPack 中解码出 Tensor 对象"
" :ref:`try_import <cn_api_paddle_utils_try_import>` ", "用于尝试导入一个模块并且在失败时提供自定义错误信息"


.. _about_alias:

别名相关 API
::::::::::::::::::::

.. csv-table::
:header: "API 名称", "API 功能"
:widths: 12, 30

" :ref:`default_collate <cn_api_paddle_utils_data_default_collate>` ", "``paddle.io.dataloader.collate.default_collate_fn`` 的别名"
" :ref:`get_worker_info <cn_api_paddle_utils_data_get_worker_info>` ", "``paddle.io.get_worker_info`` 的别名"
" :ref:`ChainDataset <cn_api_paddle_utils_data_ChainDataset>` ", "``paddle.io.ChainDataset`` 的别名"
" :ref:`ConcatDataset <cn_api_paddle_utils_data_ConcatDataset>` ", "``paddle.io.ConcatDataset`` 的别名"
" :ref:`Dataset <cn_api_paddle_utils_data_Dataset>` ", "``paddle.io.Dataset`` 的别名"
" :ref:`IterableDataset <cn_api_paddle_utils_data_IterableDataset>` ", "``paddle.io.IterableDataset`` 的别名"
" :ref:`Subset <cn_api_paddle_utils_data_Subset>` ", "``paddle.io.Subset`` 的别名"
" :ref:`random_split <cn_api_paddle_utils_data_random_split>` ", "``paddle.io.random_split`` 的别名"
" :ref:`BatchSampler <cn_api_paddle_utils_data_BatchSampler>` ", "``paddle.io.BatchSampler`` 的别名"
" :ref:`RandomSampler <cn_api_paddle_utils_data_RandomSampler>` ", "``paddle.io.RandomSampler`` 的别名"
" :ref:`Sampler <cn_api_paddle_utils_data_Sampler>` ", "``paddle.io.Sampler`` 的别名"
" :ref:`SequentialSampler <cn_api_paddle_utils_data_SequentialSampler>` ", "``paddle.io.SequenceSampler`` 的别名"
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/BatchSampler_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_BatchSampler:

BatchSampler
-------------------------------

.. py:class:: paddle.utils.data.BatchSampler

``paddle.io.BatchSampler`` 的别名,请参考 :ref:`cn_api_paddle_io_BatchSampler`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/ChainDataset_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_ChainDataset:

ChainDataset
-------------------------------

.. py:class:: paddle.utils.data.ChainDataset

``paddle.io.ChainDataset`` 的别名,请参考 :ref:`cn_api_paddle_io_ChainDataset`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/ConcatDataset_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_ConcatDataset:

ConcatDataset
-------------------------------

.. py:class:: paddle.utils.data.ConcatDataset

``paddle.io.ConcatDataset`` 的别名,请参考 :ref:`cn_api_paddle_io_ConcatDataset`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/Dataset_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_Dataset:

Dataset
-------------------------------

.. py:class:: paddle.utils.data.Dataset

``paddle.io.Dataset`` 的别名,请参考 :ref:`cn_api_paddle_io_Dataset`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/IterableDataset_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_IterableDataset:

IterableDataset
-------------------------------

.. py:class:: paddle.utils.data.IterableDataset

``paddle.io.IterableDataset`` 的别名,请参考 :ref:`cn_api_paddle_io_IterableDataset`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/RandomSampler_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_RandomSampler:

RandomSampler
-------------------------------

.. py:class:: paddle.utils.data.RandomSampler

``paddle.io.RandomSampler`` 的别名,请参考 :ref:`cn_api_paddle_io_RandomSampler`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/Sampler_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_Sampler:

Sampler
-------------------------------

.. py:class:: paddle.utils.data.Sampler

``paddle.io.Sampler`` 的别名,请参考 :ref:`cn_api_paddle_io_Sampler`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/SequentialSampler_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_SequentialSampler:

SequentialSampler
-------------------------------

.. py:class:: paddle.utils.data.SequentialSampler

``paddle.io.SequenceSampler`` 的别名,请参考 :ref:`cn_api_paddle_io_SequenceSampler`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/Subset_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_Subset:

Subset
-------------------------------

.. py:class:: paddle.utils.data.Subset

``paddle.io.Subset`` 的别名,请参考 :ref:`cn_api_paddle_io_Subset`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/default_collate_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_default_collate:

default_collate
-------------------------------

.. py:function:: paddle.utils.data.default_collate()

``paddle.io.dataloader.collate.default_collate_fn`` 的别名,请参考 :ref:`cn_api_paddle_io_DataLoader`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/get_worker_info_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_get_worker_info:

get_worker_info
-------------------------------

.. py:function:: paddle.utils.data.get_worker_info()

``paddle.io.get_worker_info`` 的别名,请参考 :ref:`cn_api_paddle_io_get_worker_info`。
8 changes: 8 additions & 0 deletions docs/api/paddle/utils/data/random_split_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
.. _cn_api_paddle_utils_data_random_split:

random_split
-------------------------------

.. py:function:: paddle.utils.data.random_split()

``paddle.io.random_split`` 的别名,请参考 :ref:`cn_api_paddle_io_random_split`。