[XPU] add paddle.device.xpu doc #7363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

onecatcn merged 1 commit into PaddlePaddle:develop from cqulilujia:device

Aug 5, 2025

Contributor

cqulilujia commented Jul 18, 2025

为PR PaddlePaddle/Paddle#73189
添加paddle.device.xpu系列接口中文文档
包括：

device_count
empty_cache
max_memory_allocated
max_memory_reserved
reset_max_memory_allocated
reset_max_memory_reserved
memory_allocated
memory_reserved
memory_total
memory_used
set_debug_level
synchronize

paddle-bot bot commented Jul 18, 2025

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

paddle-bot bot added the XPU label

CLAassistant commented Jul 18, 2025 •

edited

Loading

All committers have signed the CLA.

cqulilujia force-pushed the device branch from af3bfa4 to de5e68e Compare

July 18, 2025 07:53

cqulilujia mentioned this pull request

[XPU] support python memory api in XPU PaddlePaddle/Paddle#73189

Merged

cqulilujia force-pushed the device branch 2 times, most recently from 944e679 to 12d2e2d Compare

July 31, 2025 08:42

iosmers commented Aug 1, 2025

LGTM 这个PR希望能够尽快合入

PaddlePaddle locked and limited conversation to collaborators

PaddlePaddle unlocked this conversation

cqulilujia force-pushed the device branch from 12d2e2d to d84d121 Compare

August 1, 2025 05:43

sunzhongkai588 approved these changes

View reviewed changes

docs/api/paddle/device/xpu/max_memory_allocated_cn.rst Outdated

Comment on lines 13 to 16

+              参数
+              ::::::::
+              **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。
          
            参数
          
            ::::::::
          
                - **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

参考固定的格式，且要有缩进

docs/api/paddle/device/xpu/max_memory_reserved_cn.rst Outdated

Comment on lines 10 to 13

+              参数
+              ::::::::
+              **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。
          
            参数
          
            ::::::::
          
                - **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

docs/api/paddle/device/xpu/memory_allocated_cn.rst Outdated

Comment on lines 13 to 16

+              参数
+              ::::::::
+              **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。
          
            参数
          
            ::::::::
          
                - **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

docs/api/paddle/device/xpu/memory_reserved_cn.rst Outdated

Comment on lines 10 to 13

+              参数
+              ::::::::
+              **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。
          
            参数
          
            ::::::::
          
                - **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

docs/api/paddle/device/xpu/memory_total_cn.rst Outdated

Comment on lines 10 to 13

+              参数
+              ::::::::
+              **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。
          
            参数
          
            ::::::::
          
                - **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

docs/api/paddle/device/xpu/memory_used_cn.rst Outdated

Comment on lines 13 to 16

+              参数
+              ::::::::
+              **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。
          
            参数
          
            ::::::::
          
                - **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

docs/api/paddle/device/xpu/reset_max_memory_allocated_cn.rst Outdated

Comment on lines 10 to 13

+              参数
+              ::::::::
+              **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。
          
            参数
          
            ::::::::
          
                - **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

docs/api/paddle/device/xpu/reset_max_memory_reserved_cn.rst Outdated

Comment on lines 10 to 13

+              参数
+              ::::::::
+              **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。
          
            参数
          
            ::::::::
          
                - **device** (paddle.XPUPlace|int|str，可选) - 设备、设备 ID 或形如 ``xpu:x`` 的设备名称。如果 ``device`` 为 None，则 ``device`` 为当前的设备。默认值为 None。

docs/api/paddle/device/xpu/set_debug_level_cn.rst Outdated

Comment on lines 10 to 13

+              参数
+              ::::::::
+              **level** (int) -  Debug 等级。0x1 ( trace )，打印算子调用信息。0x10 ( checksum )，打印张量校验和。0x100 ( dump )，将张量保存为 npy 格式的文件。0x1000 ( profiling )，记录每个算子的执行时间。

Collaborator

sunzhongkai588 Aug 4, 2025

Suggested change

      
            参数
          
            ::::::::
          
            **level** (int) -  Debug 等级。0x1 ( trace )，打印算子调用信息。0x10 ( checksum )，打印张量校验和。0x100 ( dump )，将张量保存为 npy 格式的文件。0x1000 ( profiling )，记录每个算子的执行时间。
          
            参数
          
            ::::::::
          
                - **level** (int) -  Debug 等级。0x1 ( trace )，打印算子调用信息。0x10 ( checksum )，打印张量校验和。0x100 ( dump )，将张量保存为 npy 格式的文件。0x1000 ( profiling )，记录每个算子的执行时间。

Contributor Author

cqulilujia Aug 4, 2025

Done


          [XPU] add paddle.device.xpu.*** doc

50c652b

cqulilujia force-pushed the device branch from 5b59381 to 50c652b Compare

August 4, 2025 07:39

yongqiangma approved these changes

View reviewed changes

Contributor

yongqiangma left a comment

LGTM

onecatcn merged commit db2b9e3 into PaddlePaddle:develop

2 checks passed

LittleHeroZZZX pushed a commit to LittleHeroZZZX/Paddle-docs that referenced this pull request


          [XPU] add paddle.device.xpu.*** doc (PaddlePaddle#7363)

4c1e226

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

XPU