From d3de28dc4c6696776f949af00dbb721a0a8096aa Mon Sep 17 00:00:00 2001 From: chrnunzhe Date: Fri, 8 Aug 2025 06:14:52 +0000 Subject: [PATCH] [XPU] update paddle.device.xpu doc for new Stream Event api --- docs/api/paddle/device/Overview_cn.rst | 2 ++ docs/api/paddle/device/xpu/Event_cn.rst | 21 +++++++++++++++++++++ docs/api/paddle/device/xpu/Stream_cn.rst | 24 ++++++++++++++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 docs/api/paddle/device/xpu/Event_cn.rst create mode 100644 docs/api/paddle/device/xpu/Stream_cn.rst diff --git a/docs/api/paddle/device/Overview_cn.rst b/docs/api/paddle/device/Overview_cn.rst index 653a6309b4f..2807177a593 100644 --- a/docs/api/paddle/device/Overview_cn.rst +++ b/docs/api/paddle/device/Overview_cn.rst @@ -126,6 +126,8 @@ XPU 相关 :header: "API 名称", "API 功能" :widths: 10, 30 + " :ref:`Stream ` ", "XPU ``StreamBase`` 的设备流包装器,该 API 未来计划废弃,不推荐使用" + " :ref:`Event ` ", "XPU ``EventBase`` 的设备事件包装器,该 API 未来计划废弃,不推荐使用" " :ref:`device_count ` ", "返回值是 int,表示当前程序可用的 XPU 数量" " :ref:`empty_cache ` ", "用于释放显存分配器中空闲的显存" " :ref:`max_memory_allocated ` ", "返回给定设备上分配给 Tensor 的显存峰值统计" diff --git a/docs/api/paddle/device/xpu/Event_cn.rst b/docs/api/paddle/device/xpu/Event_cn.rst new file mode 100644 index 00000000000..c8065662094 --- /dev/null +++ b/docs/api/paddle/device/xpu/Event_cn.rst @@ -0,0 +1,21 @@ +.. _cn_api_paddle_device_xpu_Event: + +Event +------------------------------- + +.. py:class:: paddle.device.xpu.Event() + +XPU event 的句柄。 + +返回 +:::::::::::: +None + +代码示例 +:::::::::::: + +COPY-FROM: paddle.device.xpu.Event + + +.. warning:: + 该 API 未来计划废弃,不推荐使用。 diff --git a/docs/api/paddle/device/xpu/Stream_cn.rst b/docs/api/paddle/device/xpu/Stream_cn.rst new file mode 100644 index 00000000000..a7afa314245 --- /dev/null +++ b/docs/api/paddle/device/xpu/Stream_cn.rst @@ -0,0 +1,24 @@ +.. _cn_api_paddle_device_xpu_Stream: + +Stream +------------------------------- + +.. py:class:: paddle.device.xpu.Stream(device=None) + +XPU stream 的句柄。 + +参数 +:::::::::::: + + - **device** (paddle.XPUPlace()|int|None,可选) - 希望分配 stream 的设备。如果是 None 或者负数,则设备为当前的设备。如果是正数,则必须小于设备的个数。默认值为 None。 + + +代码示例 +:::::::::::: + +COPY-FROM: paddle.device.xpu.Stream + + + +.. warning:: + 该 API 未来计划废弃,不推荐使用。