From f6786779afb3b194d21efa4e413acd9442a65d10 Mon Sep 17 00:00:00 2001 From: yaohaolin Date: Fri, 7 Nov 2025 17:31:51 +0800 Subject: [PATCH] fix docs error --- ...tasystem.hetero_client.HeteroClient.dev_publish.rst | 7 +++---- ...system.hetero_client.HeteroClient.dev_subscribe.rst | 10 +++++----- .../api/python/datasystem.kv_client.SetParam.rst | 2 +- 3 files changed, 9 insertions(+), 10 deletions(-) diff --git a/docs/source_zh_cn/development-guide/api/python/datasystem.hetero_client.HeteroClient.dev_publish.rst b/docs/source_zh_cn/development-guide/api/python/datasystem.hetero_client.HeteroClient.dev_publish.rst index 23df39b..7a5f536 100644 --- a/docs/source_zh_cn/development-guide/api/python/datasystem.hetero_client.HeteroClient.dev_publish.rst +++ b/docs/source_zh_cn/development-guide/api/python/datasystem.hetero_client.HeteroClient.dev_publish.rst @@ -3,11 +3,10 @@ datasystem.hetero_client.HeteroClient.dev_publish .. py:method:: datasystem.hetero_client.HeteroClient.dev_publish(keys, data_blob_list) - 将 device 上的内存发布为数据系统的异构对象。发布后的异构对象可通过 dev_subscribe 获取。 + 将 device 上的内存发布为数据系统的异构对象。发布后的异构对象可通过 dev_subscribe 获取。通过 dev_subscribe 获取数据成功后，数据系统会自动删除此异构对象，不再管理此对象对应的 device 内存。 - dev_publish 和 dev_subscribe 需配套使用。dev_publish 和 dev_subscribe 传入的 Device 内存地址不能归属于同一张 NPU 卡。 - - 通过 dev_subscribe 获取数据成功后，数据系统会自动删除此异构对象，不再管理此对象对应的 device 内存。 + .. note:: + dev_publish 和 dev_subscribe 需配套使用。 参数： - **keys** (list) - device 的异构对象的 key diff --git a/docs/source_zh_cn/development-guide/api/python/datasystem.hetero_client.HeteroClient.dev_subscribe.rst b/docs/source_zh_cn/development-guide/api/python/datasystem.hetero_client.HeteroClient.dev_subscribe.rst index e555a8f..7ece9a7 100644 --- a/docs/source_zh_cn/development-guide/api/python/datasystem.hetero_client.HeteroClient.dev_subscribe.rst +++ b/docs/source_zh_cn/development-guide/api/python/datasystem.hetero_client.HeteroClient.dev_subscribe.rst @@ -4,14 +4,14 @@ datasystem.hetero_client.HeteroClient.dev_subscribe .. py:method:: datasystem.hetero_client.HeteroClient.dev_subscribe(keys, data_blob_list) 订阅发布到数据系统的异构对象，并接收数据写入 data_blob_list。数据通过 device to device 通道直接传输。 + + 通过 dev_subscribe 获取数据成功后，数据系统会自动删除此异构对象，不再管理此对象对应的 device 内存。在执行 dev_subscribe 过程中，执行了 dev_publish 的进程不能退出，否则 dev_subscribe 会失败。 - dev_publish 和 dev_subscribe 需配套使用。dev_publish 和 dev_subscribe 传入的 Device 内存地址不能归属于同一张 NPU 卡。 - - 通过 dev_subscribe 获取数据成功后，数据系统会自动删除此异构对象，不再管理此对象对应的 device 内存。 - - 在执行 dev_subscribe 过程中，执行了 dev_publish 的进程不能退出，否则 dev_subscribe 会失败。 dev_subscribe单Key的订阅超时时间为20s，多key为60s。 + .. note:: + dev_publish 和 dev_subscribe 需配套使用。 + 参数： - **keys** (list) - device 的异构对象的 key - **data_blob_list** (list) - :class:`datasystem.hetero_client.DeviceBlobList` 列表。 diff --git a/docs/source_zh_cn/development-guide/api/python/datasystem.kv_client.SetParam.rst b/docs/source_zh_cn/development-guide/api/python/datasystem.kv_client.SetParam.rst index 9123ede..a7e43d5 100644 --- a/docs/source_zh_cn/development-guide/api/python/datasystem.kv_client.SetParam.rst +++ b/docs/source_zh_cn/development-guide/api/python/datasystem.kv_client.SetParam.rst @@ -3,7 +3,7 @@ datasystem.kv_client.SetParam .. py:class:: datasystem.kv_client.SetParam - :func:`datasystem.hetero_client.HeteroClient.mset_d2h` 以及 `datasystem.hetero_client.HeteroClient.async_mset_d2h` 方法的入参，用于指定随机读的键名称、偏移量以及大小。 + :func:`datasystem.hetero_client.HeteroClient.mset_d2h` 以及 :func:`datasystem.hetero_client.HeteroClient.async_mset_d2h` 方法的入参，用于指定随机读的键名称、偏移量以及大小。 :ivar WriteMode write_mode: key的可靠性配置。 :ivar int ttl_seconds: key的存活时间, (以秒为单位)。 -- Gitee