[API Compatibility] Add some device related API by fxyfxy777 · Pull Request #7467 · PaddlePaddle/docs

fxyfxy777 · 2025-09-24T06:38:33Z

" :ref:paddle.get_default_device <cn_api_paddle_get_default_device> ", "获取当前默认设备信息"
" :ref:paddle.get_device_module <cn_api_paddle_get_device_module> ", "获取指定设备对应的模块"
" :ref:current_stream <cn_api_paddle_cuda_current_stream> ", "获取当前 CUDA 流"
" :ref:get_device_properties <cn_api_paddle_cuda_get_device_properties> ", "获取 CUDA 设备属性"
" :ref:get_rng_state <cn_api_paddle_cuda_get_rng_state> ", "获取随机数生成器状态"
" :ref:is_available <cn_api_paddle_cuda_is_available> ", "检查 CUDA 是否可用"
" :ref:is_current_stream_capturing <cn_api_paddle_cuda_is_current_stream_capturing> ", "检查当前流是否处于捕获状态"

" :ref:`manual_seed_all <cn_api_paddle_cuda_manual_seed_all>` ", "设置全局随机种子"

" :ref:`set_rng_state <cn_api_paddle_cuda_set_rng_state>` ", "设置随机数生成器状态"
" :ref:`synchronize <cn_api_paddle_cuda_synchronize>` ", "同步 CUDA 设备"
" :ref:`get_device_properties <cn_api_paddle_device_get_device_properties>` ", "获取设备属性信息"
" :ref:`is_available <cn_api_paddle_device_is_available>` ", "检查设备是否可用"
" :ref:`get_rng_state <cn_api_paddle_device_cuda_get_rng_state>` ", "获取随机数生成器状态"
" :ref:`manual_seed_all <cn_api_paddle_device_cuda_manual_seed_all>` ", "设置全局随机种子"
" :ref:`set_rng_state <cn_api_paddle_device_cuda_set_rng_state>` ", "设置随机数生成器状态"

" :ref:is_current_stream_capturing <cn_api_paddle_device_is_current_stream_capturing> ", "检查当前流是否处于捕获状态"

paddle-bot · 2025-09-24T06:38:39Z

感谢你贡献飞桨文档，文档预览构建中，Docs-New 跑完后即可预览，预览链接：http://preview-pr-7467.paddle-docs-preview.paddlepaddle.org.cn/documentation/docs/zh/api/index_cn.html
预览工具的更多说明，请参考：飞桨文档预览工具

github-actions · 2025-11-03T12:41:07Z

📚 本次 PR 文档预览链接（点击展开）

ℹ️ 预览提醒请等待 `Docs-NEW` 流水线运行完成后再点击预览链接，否则可能会看到旧版本内容或遇到链接无法访问的情况。

docs/api/paddle/Overview_cn.rst: 点击预览
docs/api/paddle/cuda/Overview_cn.rst: 点击预览
docs/api/paddle/cuda/current_stream_cn.rst: 点击预览
docs/api/paddle/cuda/get_device_properties_cn.rst: 点击预览
docs/api/paddle/cuda/get_rng_state_cn.rst: 点击预览
docs/api/paddle/cuda/is_available_cn.rst: 点击预览
docs/api/paddle/cuda/manual_seed_all_cn.rst: 点击预览
docs/api/paddle/cuda/set_rng_state_cn.rst: 点击预览
docs/api/paddle/cuda/synchronize_cn.rst: 点击预览
docs/api/paddle/device/Overview_cn.rst: 点击预览
docs/api/paddle/device/get_device_properties_cn.rst: 点击预览
docs/api/paddle/device/get_rng_state_cn.rst: 点击预览
docs/api/paddle/device/is_available_cn.rst: 点击预览
docs/api/paddle/device/is_current_stream_capturing_cn.rst: 点击预览
docs/api/paddle/device/reset_peak_memory_stats_cn.rst: 点击预览
docs/api/paddle/device/set_rng_state_cn.rst: 点击预览
docs/api/paddle/get_default_device_cn.rst: 点击预览
docs/api/paddle/get_device_module_cn.rst: 点击预览

y

sunzhongkai588 · 2025-11-06T06:55:58Z

+current_stream
+


Suggested change

current_stream

current_stream

-------------------------------

sunzhongkai588 · 2025-11-06T06:58:29Z

+    • None：获取当前设备上的默认计算流。
+    • int：设备索引，例如 0 表示 cuda:0。
+    • str：设备字符串，例如 'cuda:0' 或 'gpu:1'。
+    • CUDAPlace：Paddle 的 CUDAPlace 对象。
+    • CustomPlace：Paddle 的自定义设备 Place 对象。


参数不是只有 device 吗？其他的如果是参数的说明，就再加一层缩进。另外，不要用 • 用 -

sunzhongkai588 · 2025-11-07T09:03:39Z

+
+参数
+:::::::::
+    • device (int | str | CUDAPlace | CustomPlace | None, optional) – 指定需要同步的设备。


同样的问题，参数不是只有 device 吗？其他的如果是参数的说明，就再加一层缩进。另外，不要用 • 用 -

sunzhongkai588 · 2025-11-07T09:06:05Z

+- **new_state** (core.GeneratorState) - 要设置的 RNG 状态对象，通常从``get_rng_state()``获取
+- **device** (DeviceLike, 可选) - 要设置 RNG 状态的设备:
+
+  - 如果不指定，则使用当前默认设备(由``paddle.framework._current_expected_place_()``返回)


Suggested change

- 如果不指定，则使用当前默认设备(由``paddle.framework._current_expected_place_()``返回)

- 如果不指定，则使用当前默认设备(由 ``paddle.framework._current_expected_place_()`` 返回)

sunzhongkai588 · 2025-11-07T09:06:25Z

+
+参数
+:::::::::
+- **new_state** (core.GeneratorState) - 要设置的 RNG 状态对象，通常从``get_rng_state()``获取


Suggested change

- **new_state** (core.GeneratorState) - 要设置的 RNG 状态对象，通常从``get_rng_state()``获取

- **new_state** (core.GeneratorState) - 要设置的 RNG 状态对象，通常从 ``get_rng_state()`` 获取

sunzhongkai588 · 2025-11-07T09:06:38Z

+- **new_state** (core.GeneratorState) - 要设置的 RNG 状态对象，通常从``get_rng_state()``获取
+- **device** (DeviceLike, 可选) - 要设置 RNG 状态的设备:
+
+  - 如果不指定，则使用当前默认设备(由``paddle.framework._current_expected_place_()``返回)


Suggested change

- 如果不指定，则使用当前默认设备(由``paddle.framework._current_expected_place_()``返回)

- 如果不指定，则使用当前默认设备(由 ``paddle.framework._current_expected_place_()`` 返回)

sunzhongkai588 · 2025-11-07T09:07:04Z

+
+参数
+:::::::::
+- **new_state** (core.GeneratorState) - 要设置的 RNG 状态对象，通常从``get_rng_state()``获取


Suggested change

- **new_state** (core.GeneratorState) - 要设置的 RNG 状态对象，通常从``get_rng_state()``获取

- **new_state** (core.GeneratorState) - 要设置的 RNG 状态对象，通常从 ``get_rng_state()`` 获取

sunzhongkai588 · 2025-11-07T09:11:12Z

+
+异常
+:::::::::
+- RuntimeError: 如果设备类型是 CPU(Paddle 不暴露`paddle.cpu`模块)或找不到匹配的设备模块


Suggested change

- RuntimeError: 如果设备类型是 CPU(Paddle 不暴露`paddle.cpu`模块)或找不到匹配的设备模块

- RuntimeError: 如果设备类型是 CPU(Paddle 不暴露 ``paddle.cpu`` 模块)或找不到匹配的设备模块

Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>

sunzhongkai588

LGTM

fxyfxy777 added 3 commits September 24, 2025 11:16

add is_available ...

2566bee

Add device related API

dbff885

Remove unexpected indentation

00e0d26

zhwesky2010 changed the title ~~[Compat]Add some device related API~~ [[API Compatibility]] Add some device related API Sep 24, 2025

zhwesky2010 changed the title ~~[[API Compatibility]] Add some device related API~~ [API Compatibility] Add some device related API Sep 24, 2025

zhwesky2010 requested a review from sunzhongkai588 September 24, 2025 07:19

fxyfxy777 added 2 commits October 28, 2025 19:09

Merge branch 'develop' of github.com:PaddlePaddle/docs into cuda_apis

6d624de

Merge branch 'develop' of github.com:PaddlePaddle/docs into cuda_apis

a24df74

fxyfxy777 requested review from Echo-Nie, jzhang533, mattheliu and ooooo-create as code owners November 3, 2025 12:35

fxyfxy777 and others added 11 commits November 3, 2025 20:46

pre-commit

b5be53c

Merge branch 'develop' into cuda_apis

d8aef5b

fix error docs/api/paddle/device/Overview_cn.rst

38c3769

Merge branch 'cuda_apis' of github.com:fxyfxy777/docs into cuda_apis

8686cee

y

Merge branch 'develop' into cuda_apis

f85aaed

Merge branch 'develop' into cuda_apis

3ee3341

fix overvirw error

055fe3f

Merge branch 'develop' of github.com:PaddlePaddle/docs into cuda_apis

25bdb30

Merge branch 'cuda_apis' of github.com:fxyfxy777/docs into cuda_apis

6eb767c

fix error

cda9ced

Merge branch 'develop' into cuda_apis

0c94078

sunzhongkai588 reviewed Nov 7, 2025

View reviewed changes

fxyfxy777 and others added 4 commits November 10, 2025 10:29

fix pr error

da8483e

Merge branch 'cuda_apis' of github.com:fxyfxy777/docs into cuda_apis

5e5eca8

Merge branch 'develop' into cuda_apis

c81cdfd

Apply suggestion from @sunzhongkai588

7bdb45c

Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>

fxyfxy777 and others added 2 commits November 10, 2025 11:26

Apply suggestion from @sunzhongkai588

8f02a8b

Co-authored-by: zachary sun <70642955+sunzhongkai588@users.noreply.github.com>

fix reset_peak_memory_stats

080c9e6

sunzhongkai588 approved these changes Nov 10, 2025

View reviewed changes

sunzhongkai588 merged commit 297c096 into PaddlePaddle:develop Nov 10, 2025
5 checks passed

fxyfxy777 deleted the cuda_apis branch November 10, 2025 07:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[API Compatibility] Add some device related API#7467

[API Compatibility] Add some device related API#7467
sunzhongkai588 merged 22 commits into
PaddlePaddle:developfrom
fxyfxy777:cuda_apis

fxyfxy777 commented Sep 24, 2025

Uh oh!

paddle-bot Bot commented Sep 24, 2025

Uh oh!

github-actions Bot commented Nov 3, 2025 •

edited

Loading

Uh oh!

sunzhongkai588 Nov 6, 2025

Uh oh!

sunzhongkai588 Nov 6, 2025

Uh oh!

sunzhongkai588 Nov 7, 2025

Uh oh!

sunzhongkai588 Nov 7, 2025

Uh oh!

sunzhongkai588 Nov 7, 2025

Uh oh!

sunzhongkai588 Nov 7, 2025

Uh oh!

sunzhongkai588 Nov 7, 2025

Uh oh!

Uh oh!

Uh oh!

sunzhongkai588 Nov 7, 2025

Uh oh!

sunzhongkai588 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	- 如果不指定，则使用当前默认设备(由``paddle.framework._current_expected_place_()``返回)
	- 如果不指定，则使用当前默认设备(由 ``paddle.framework._current_expected_place_()`` 返回)

	- new_state (core.GeneratorState) - 要设置的 RNG 状态对象，通常从``get_rng_state()``获取
	- new_state (core.GeneratorState) - 要设置的 RNG 状态对象，通常从 ``get_rng_state()`` 获取

	- RuntimeError: 如果设备类型是 CPU(Paddle 不暴露`paddle.cpu`模块)或找不到匹配的设备模块
	- RuntimeError: 如果设备类型是 CPU(Paddle 不暴露 ``paddle.cpu`` 模块)或找不到匹配的设备模块

Conversation

fxyfxy777 commented Sep 24, 2025

Uh oh!

paddle-bot Bot commented Sep 24, 2025

Uh oh!

github-actions Bot commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sunzhongkai588 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Nov 3, 2025 •

edited

Loading