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
7 changes: 7 additions & 0 deletions docs/api/paddle/cuda/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,10 @@ PyTorch 兼容函数
" :ref:`memory_allocated <cn_api_paddle_cuda_memory_allocated>` ", "返回当前设备上分配的内存总量"
" :ref:`memory_reserved <cn_api_paddle_cuda_memory_reserved>` ", "返回当前设备上由缓存分配器管理的内存总量"
" :ref:`set_device <cn_api_paddle_cuda_set_device>` ", "设置当前设备"
" :ref:`Stream <cn_api_paddle_cuda_Stream>` ", "CUDA 流类"
" :ref:`get_stream_from_external <cn_api_paddle_cuda_get_stream_from_external>` ", "从外部流创建 Paddle 流"
" :ref:`device <cn_api_paddle_cuda_device>` ", "临时选择设备使用"
" :ref:`manual_seed <cn_api_paddle_cuda_manual_seed>` ", "设置设备随机种子"
" :ref:`max_memory_allocated <cn_api_paddle_cuda_max_memory_allocated>` ", "获取最大内存分配量"
" :ref:`reset_peak_memory_stats <cn_api_paddle_cuda_reset_peak_memory_stats>` ", "重置峰值内存统计"
" :ref:`get_device_capability <_cn_api_paddle_cuda_get_device_capability>` ", "返回指定设备的计算能力"
17 changes: 17 additions & 0 deletions docs/api/paddle/cuda/Stream_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _cn_api_paddle_cuda_Stream:

Stream
------

.. py:class:: paddle.cuda.Stream(device=None, priority=0, blocking=False)

CUDA 流类,用于管理异步操作。

参数
::::::::::::
- **device** (int|paddle.Place|str|int|None) - 设备 ID 或设备对象
- **priority** (int, 可选) - 流的优先级,默认为 0; 可以是 1 或-1(高优先级)或 0 或 2(低优先级)。默认情况下,流具有优先级 2。

代码示例
::::::::::::
COPY-FROM: paddle.cuda.Stream
17 changes: 17 additions & 0 deletions docs/api/paddle/cuda/device_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _cn_api_paddle_cuda_device:

device
------

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

获取或设置当前 CUDA 设备。本函数与 paddle.device.device 功能一致

参数
::::::::::::
- **device** (int|str|paddle.Place|None) - 设备、设备的 id 或设备的字符串名称,如 npu:x',从中获取设备的属性。 如果设备为 None,则该设备为当前设备,默认值:None。


代码示例
::::::::::::
COPY-FROM: paddle.cuda.device
20 changes: 20 additions & 0 deletions docs/api/paddle/cuda/get_device_capability_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. _cn_api_paddle_cuda_get_device_capability:

get_device_capability
---------------------

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

获取设备计算能力。

参数
::::::::::::
- **device** (int|str|paddle.Place|None) - 设备、设备的 id 或设备的字符串名称,如 npu:x',从中获取设备的属性。如果设备为“无”,则该设备为当前设备,认值:无。

返回
::::::::::::
tuple: (主版本号, 次版本号)

代码示例
::::::::::::
COPY-FROM: paddle.cuda.get_device_capability
22 changes: 22 additions & 0 deletions docs/api/paddle/cuda/get_stream_from_external_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _cn_api_paddle_cuda_get_stream_from_external:

get_stream_from_external
------------------------

.. py:function:: paddle.cuda.get_stream_from_external(data_ptr, device=None)

从外部创建的 CUDA 流创建 Paddle 流对象。
本函数与 paddle.device.get_stream_from_external 功能一致

参数
::::::::::::
- **data_ptr** (int) - 外部 CUDA 流的指针值
- **device** (int, 可选) - 设备 ID,默认为 None

返回
::::::::::::
paddle.cuda.Stream: 包装后的 Paddle 流对象

代码示例
::::::::::::
COPY-FROM: paddle.cuda.get_stream_from_external
16 changes: 16 additions & 0 deletions docs/api/paddle/cuda/manual_seed_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _cn_api_paddle_cuda_manual_seed:

manual_seed
-----------

.. py:function:: paddle.cuda.manual_seed(seed)

为当前设备置随机种子。与 paddle.device.manual_seed 功能一致。

参数
::::::::::::
- **seed** (int) - 随机种子值

代码示例
::::::::::::
COPY-FROM: paddle.cuda.manual_seed
24 changes: 24 additions & 0 deletions docs/api/paddle/cuda/max_memory_allocated_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. _cn_api_paddle_cuda_max_memory_allocated:

max_memory_allocated
--------------------

.. py:function:: paddle.cuda.max_memory_allocated(device=None)

返回给定设备上分配给 Tensor 的显存峰值统计。

.. note::
Paddle 中分配给 Tensor 的显存块大小会进行 256 字节对齐,因此可能大于 Tensor 实际需要的显存大小。例如,一个 shape 为[1]的 float32 类型 Tensor 会占用 256 字节的显存,即使存储一个 float32 类型数据实际只需要 4 字节。
与 paddle.device.max_memory_allocated 功能一致

参数
::::::::::::
- **device** (int|paddle.Place|str|None) - 设备、设备的 id 或设备的字符串名称,如 npu:x',从中获取设备的属性。 如果设备为 None,则该设备为当前设备,默认值:None。

返回
::::::::::::
int: 最大已分配内存量(字节)

代码示例
::::::::::::
COPY-FROM: paddle.cuda.max_memory_allocated
21 changes: 21 additions & 0 deletions docs/api/paddle/cuda/reset_peak_memory_stats_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _cn_api_paddle_cuda_reset_peak_memory_stats:

reset_peak_memory_stats
-----------------------

.. py:function:: paddle.cuda.reset_peak_memory_stats(device=None)

重置所有设备的峰值内存统计信息。
此方法重置程序执行期间为每个设备记录的峰值内存使用情况。
它将所有设备的峰值内存使用率设置为零。
与 paddle.device.reset_peak_memory_stats 功能一致

参数
::::::::::::
- **device** (int|paddle.Place|str|None) - 设备、设备的 id 或设备的字符串名称,如 npu:x',从中获取设备的属性。 如果设备为 None,则该设备为当前设备,默认值:None。

代码示例
::::::::::::
.. code-block:: python
>>> import paddle
>>> paddle.cuda.reset_peak_memory_stats(0)
6 changes: 5 additions & 1 deletion docs/api/paddle/device/Overview_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,22 @@ paddle.device 目录下包含 cuda 目录和 xpu 目录, cuda 目录中存放
" :ref:`get_available_device <cn_api_paddle_device_get_available_device>` ", "获得所有可用的设备"
" :ref:`get_cudnn_version <cn_api_paddle_device_get_cudnn_version>` ", "获得 cudnn 的版本"
" :ref:`get_device_properties <cn_api_paddle_device_get_device_properties>` ", "返回指定设备的属性"
" :ref:`get_device_capability <cn_api_paddle_device_get_device_capability>` ", "返回指定设备的计算能力"
" :ref:`max_memory_allocated <cn_api_paddle_device_max_memory_allocated>` ", "返回给定设备上分配给 Tensor 的内存峰值统计"
" :ref:`max_memory_reserved <cn_api_paddle_device_max_memory_reserved>` ", "返回给定设备上由内存分配器管理的内存峰值统计"
" :ref:`memory_allocated <cn_api_paddle_device_memory_allocated>` ", "返回给定设备上当前分配给 Tensor 的内存大小"
" :ref:`memory_reserved <cn_api_paddle_device_memory_reserved>` ", "返回给定设备上当前由内存分配器管理的内存大小"
" :ref:`reset_max_memory_allocated <cn_api_paddle_device_reset_max_memory_allocated>` ", "重置给定设备上分配给 Tensor 的内存峰值统计"
" :ref:`reset_max_memory_reserved <cn_api_paddle_device_reset_max_memory_reserved>` ", "重置给定设备上由内存分配器管理的内存峰值统计"
" :ref:`reset_peak_memory_stats <cn_api_paddle_device_reset_peak_memory_stats>` ", "重置峰值内存统计"
" :ref:`set_device <cn_api_paddle_device_set_device>` ", "指定 OP 运行的全局设备"
" :ref:`get_device <cn_api_paddle_device_get_device>` ", "获得 OP 运行的全局设备"
" :ref:`is_available <cn_api_paddle_device_is_available>` ", "检查设备是否可用"
" :ref:`get_rng_state <cn_api_paddle_device_get_rng_state>` ", "获取随机数生成器状态"
" :ref:`set_rng_state <cn_api_paddle_device_set_rng_state>` ", "设置随机数生成器状态"

" :ref:`device <_cn_api_paddle_device_device>` ", "临时使用设备"
" :ref:`get_device_name <cn_api_paddle_device_get_device_name>` ", "返回指定设备的名称"
" :ref:`manual_seed <_cn_api_paddle_device_manual_seed>` ", "设置当前设备的随机数种子"
.. _cn_device_compile:

编译环境检测
Expand Down
17 changes: 17 additions & 0 deletions docs/api/paddle/device/device_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _cn_api_paddle_device_device:

device
------

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

获取或设置当前 CUDA 设备。

参数
::::::::::::
- **device** (int|str|paddle.Place|None) - 设备、设备的 id 或设备的字符串名称,如 npu:x',从中获取设备的属性。 如果设备为 None,则该设备为当前设备,默认值:None。


代码示例
::::::::::::
COPY-FROM: paddle.device.device
20 changes: 20 additions & 0 deletions docs/api/paddle/device/get_device_capability_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. _cn_api_paddle_device_get_device_capability:

get_device_capability
---------------------

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

获取设备计算能力。

参数
::::::::::::
- **device** (int|str|paddle.Place|None) - 设备、设备的 id 或设备的字符串名称,如 npu:x',从中获取设备的属性。如果设备为“无”,则该设备为当前设备,认值:无。

返回
::::::::::::
tuple: (主版本号, 次版本号)

代码示例
::::::::::::
COPY-FROM: paddle.device.get_device_capability
20 changes: 20 additions & 0 deletions docs/api/paddle/device/get_device_name_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
.. _cn_api_paddle_device_get_device_name:

get_device_name
---------------

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

获取设备名称。

参数
::::::::::::
- **device** (int|paddle.CUDAPlace|None) - 设备、设备的 id 或设备的字符串名称,如 npu:x',从中获取设备的属性。 如果设备为 None,则该设备为当前设备,默认值:None。

返回
::::::::::::
str: 设备名称

代码示例
::::::::::::
COPY-FROM: paddle.device.get_device_name
16 changes: 16 additions & 0 deletions docs/api/paddle/device/manual_seed_cn.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
.. _cn_api_paddle_device_manual_seed:

manual_seed
-----------

.. py:function:: paddle.device.manual_seed(seed)

为当前设备设置随机种子。

参数
::::::::::::
- **seed** (int) - 随机种子值

代码示例
::::::::::::
COPY-FROM: paddle.device.manual_seed
2 changes: 1 addition & 1 deletion docs/api/paddle/device/reset_peak_memory_stats_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ reset_peak_memory_stats
::::::::::::
.. code-block:: python
>>> import paddle
>>> paddle.device.reset_max_memory_allocated(0)
>>> paddle.device.reset_peak_memory_stats(0)
2 changes: 0 additions & 2 deletions docs/api/paddle/get_default_device_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@ get_default_device

获取程序当前运行的全局设备信息。

返回一个表示当前设备的字符串,格式可能是:
返回一个表示当前设备的字符串,格式可能是:

- 'cpu'
- 'gpu:x' (CUDA 设备)
- 'xpu:x' (XPU 设备)
- 'npu:x' (NPU 设备)

如果全局设备未明确设置,将根据以下规则返回:
如果全局设备未明确设置,将根据以下规则返回:

- 当 CUDA 可用时返回 'gpu:x'
Expand Down