Skip to content

Commit 2fb9864

Browse files
YqGe585YqGe585
committed
add paddle.device
1 parent 2474897 commit 2fb9864

10 files changed

+200
-0
lines changed

‎docs/api/paddle/device/Overview_cn.rst‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,20 @@ paddle.device 目录下包含 cuda 目录和 xpu 目录， cuda 目录中存放
2525
:header: "API 名称", "API 功能"
2626
:widths: 10, 30
2727

28+
" :ref:`device_count <cn_api_paddle_device_device_count>` ", "返回指定设备类型的可用设备数量"
29+
" :ref:`empty_cache <cn_api_paddle_device_empty_cache>` ", "释放当前设备上所有未占用的缓存内存"
2830
" :ref:`get_all_custom_device_type <cn_api_paddle_device_get_all_custom_device_type>` ", "获得所有可用的自定义设备类型"
2931
" :ref:`get_all_device_type <cn_api_paddle_device_get_all_device_type>` ", "获得所有可用的设备类型"
3032
" :ref:`get_available_custom_device <cn_api_paddle_device_get_available_custom_device>` ", "获得所有可用的自定义设备"
3133
" :ref:`get_available_device <cn_api_paddle_device_get_available_device>` ", "获得所有可用的设备"
3234
" :ref:`get_cudnn_version <cn_api_paddle_device_get_cudnn_version>` ", "获得 cudnn 的版本"
35+
" :ref:`get_device_properties <cn_api_paddle_device_get_device_properties>` ", "返回指定设备的属性"
36+
" :ref:`max_memory_allocated <cn_api_paddle_device_max_memory_allocated>` ", "返回给定设备上分配给 Tensor 的内存峰值统计"
37+
" :ref:`max_memory_reserved <cn_api_paddle_device_max_memory_reserved>` ", "返回给定设备上由内存分配器管理的内存峰值统计"
38+
" :ref:`memory_allocated <cn_api_paddle_device_memory_allocated>` ", "返回给定设备上当前分配给 Tensor 的内存大小"
39+
" :ref:`memory_reserved <cn_api_paddle_device_memory_reserved>` ", "返回给定设备上当前由内存分配器管理的内存大小"
40+
" :ref:`reset_max_memory_allocated <cn_api_paddle_device_reset_max_memory_allocated>` ", "重置给定设备上分配给 Tensor 的内存峰值统计"
41+
" :ref:`reset_max_memory_reserved <cn_api_paddle_device_reset_max_memory_reserved>` ", "重置给定设备上由内存分配器管理的内存峰值统计"
3342
" :ref:`set_device <cn_api_paddle_device_set_device>` ", "指定 OP 运行的全局设备"
3443
" :ref:`get_device <cn_api_paddle_device_get_device>` ", "获得 OP 运行的全局设备"
3544

‎docs/api/paddle/device/device_count_cn.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _cn_api_paddle_device_device_count:
2+
3+
device_count
4+
------------
5+
6+
.. py:function:: paddle.device.device_count(device=None)
7+
8+
返回指定设备类型的可用设备数量。
9+
10+
参数
11+
::::::::::::
12+
13+
- **device** (paddle.CUDAPlace|paddle.CustomPlace|paddle.XPUPlace|str|int，可选) - 设备、设备 ID 或形如 ``gpu:x``、``xpu:x`` 或自定义设备名称的设备字符串。如果为 None，则返回当前设备类型的可用设备数量。默认值为 None。
14+
15+
返回
16+
::::::::::::
17+
18+
int，指定设备类型的可用设备数量。
19+
20+
代码示例
21+
::::::::::::
22+
COPY-FROM: paddle.device.device_count

‎docs/api/paddle/device/empty_cache_cn.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _cn_api_paddle_device_empty_cache:
2+
3+
empty_cache
4+
-----------
5+
6+
.. py:function:: paddle.device.empty_cache()
7+
8+
释放当前设备上所有未占用的缓存内存。
9+
10+
代码示例
11+
::::::::::::
12+
COPY-FROM: paddle.device.empty_cache

‎docs/api/paddle/device/get_device_properties_cn.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _cn_api_paddle_device_get_device_properties:
2+
3+
get_device_properties
4+
---------------------
5+
6+
.. py:function:: paddle.device.get_device_properties(device=None)
7+
8+
返回指定设备的属性。
9+
10+
参数
11+
::::::::::::
12+
13+
- **device** (paddle.CUDAPlace|paddle.CustomPlace|paddle.XPUPlace|str|int，可选) - 设备、设备 ID 或形如 ``gpu:x``、``xpu:x`` 或自定义设备名称的设备字符串。如果为 None，则返回当前设备的属性。默认值为 None。
14+
15+
返回
16+
::::::::::::
17+
18+
String，指定设备的属性，包括设备名称、主要计算能力、次要计算能力、全局可用内存和设备上的多处理器数量。
19+
20+
代码示例
21+
::::::::::::
22+
COPY-FROM: paddle.device.get_device_properties

‎docs/api/paddle/device/max_memory_allocated_cn.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _cn_api_paddle_device_max_memory_allocated:
2+
3+
max_memory_allocated
4+
--------------------
5+
6+
.. py:function:: paddle.device.max_memory_allocated(device=None)
7+
8+
返回给定设备上分配给 Tensor 的内存峰值统计。
9+
10+
参数
11+
::::::::::::
12+
13+
- **device** (paddle.CUDAPlace|paddle.CustomPlace|paddle.XPUPlace|str|int，可选) - 设备、设备 ID 或形如 ``gpu:x``、``xpu:x`` 或自定义设备名称的设备字符串。如果为 None，则返回当前设备的统计信息。默认值为 None。
14+
15+
返回
16+
::::::::::::
17+
18+
int，给定设备上分配给 Tensor 的内存峰值统计，以字节为单位。
19+
20+
代码示例
21+
::::::::::::
22+
COPY-FROM: paddle.device.max_memory_allocated

‎docs/api/paddle/device/max_memory_reserved_cn.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _cn_api_paddle_device_max_memory_reserved:
2+
3+
max_memory_reserved
4+
-------------------
5+
6+
.. py:function:: paddle.device.max_memory_reserved(device=None)
7+
8+
返回给定设备上由内存分配器管理的内存峰值统计。
9+
10+
参数
11+
::::::::::::
12+
13+
- **device** (paddle.CUDAPlace|paddle.CustomPlace|paddle.XPUPlace|str|int，可选) - 设备、设备 ID 或形如 ``gpu:x``、``xpu:x`` 或自定义设备名称的设备字符串。如果为 None，则返回当前设备的统计信息。默认值为 None。
14+
15+
返回
16+
::::::::::::
17+
18+
int，给定设备上由内存分配器管理的内存峰值统计，以字节为单位。
19+
20+
代码示例
21+
::::::::::::
22+
COPY-FROM: paddle.device.max_memory_reserved

‎docs/api/paddle/device/memory_allocated_cn.rst‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _cn_api_paddle_device_memory_allocated:
2+
3+
memory_allocated
4+
---------------
5+
6+
.. py:function:: paddle.device.memory_allocated(device=None)
7+
8+
返回给定设备上当前分配给 Tensor 的内存大小。
9+
10+
.. note::
11+
Paddle 中分配给 Tensor 的内存块大小会进行 256 字节对齐，因此可能大于 Tensor 实际需要的内存大小。例如，一个 shape 为[1]的 float32 类型 Tensor 会占用 256 字节的内存，即使存储一个 float32 类型数据实际只需要 4 字节。
12+
13+
参数
14+
::::::::::::
15+
16+
- **device** (paddle.CUDAPlace|paddle.CustomPlace|paddle.XPUPlace|str|int，可选) - 设备、设备 ID 或形如 ``gpu:x``、``xpu:x`` 或自定义设备名称的设备字符串。如果为 None，则返回当前设备的统计信息。默认值为 None。
17+
18+
返回
19+
::::::::::::
20+
21+
int，给定设备上当前分配给 Tensor 的内存大小，以字节为单位。
22+
23+
代码示例
24+
::::::::::::
25+
COPY-FROM: paddle.device.memory_allocated

‎docs/api/paddle/device/memory_reserved_cn.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _cn_api_paddle_device_memory_reserved:
2+
3+
memory_reserved
4+
---------------
5+
6+
.. py:function:: paddle.device.memory_reserved(device=None)
7+
8+
返回给定设备上当前由内存分配器管理的内存大小。
9+
10+
参数
11+
::::::::::::
12+
13+
- **device** (paddle.CUDAPlace|paddle.CustomPlace|paddle.XPUPlace|str|int，可选) - 设备、设备 ID 或形如 ``gpu:x``、``xpu:x`` 或自定义设备名称的设备字符串。如果为 None，则返回当前设备的统计信息。默认值为 None。
14+
15+
返回
16+
::::::::::::
17+
18+
int，给定设备上当前由内存分配器管理的内存大小，以字节为单位。
19+
20+
代码示例
21+
::::::::::::
22+
COPY-FROM: paddle.device.memory_reserved

‎docs/api/paddle/device/reset_max_memory_allocated_cn.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _cn_api_paddle_device_reset_max_memory_allocated:
2+
3+
reset_max_memory_allocated
4+
-------------------------
5+
6+
.. py:function:: paddle.device.reset_max_memory_allocated(device=None)
7+
8+
重置给定设备上分配给 Tensor 的内存峰值统计。
9+
10+
参数
11+
::::::::::::
12+
13+
- **device** (paddle.CUDAPlace|paddle.CustomPlace|paddle.XPUPlace|str|int，可选) - 设备、设备 ID 或形如 ``gpu:x``、``xpu:x`` 或自定义设备名称的设备字符串。如果为 None，则重置当前设备的统计信息。默认值为 None。
14+
15+
返回
16+
::::::::::::
17+
18+
None
19+
20+
代码示例
21+
::::::::::::
22+
COPY-FROM: paddle.device.reset_max_memory_allocated

‎docs/api/paddle/device/reset_max_memory_reserved_cn.rst‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _cn_api_paddle_device_reset_max_memory_reserved:
2+
3+
reset_max_memory_reserved
4+
-------------------------
5+
6+
.. py:function:: paddle.device.reset_max_memory_reserved(device=None)
7+
8+
重置给定设备上由内存分配器管理的内存峰值统计。
9+
10+
参数
11+
::::::::::::
12+
13+
- **device** (paddle.CUDAPlace|paddle.CustomPlace|paddle.XPUPlace|str|int，可选) - 设备、设备 ID 或形如 ``gpu:x``、``xpu:x`` 或自定义设备名称的设备字符串。如果为 None，则重置当前设备的统计信息。默认值为 None。
14+
15+
返回
16+
::::::::::::
17+
18+
None
19+
20+
代码示例
21+
::::::::::::
22+
COPY-FROM: paddle.device.reset_max_memory_reserved

0 commit comments

Comments
 (0)