From a9298c89218ec62d7136fb5297521ed008f9f633 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E5=8D=81=E4=B8=80?= Date: Mon, 10 Nov 2025 16:48:04 +0800 Subject: [PATCH 1/5] change1 --- .../advanced_tutorials/yr_shutdown.md | 2 +- .../development_guide/scheduling/logical_resource.md | 4 ++-- .../examples/affinity.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/multi_language_function_programming_interface/advanced_tutorials/yr_shutdown.md b/docs/multi_language_function_programming_interface/advanced_tutorials/yr_shutdown.md index baeda9b..20ac45e 100644 --- a/docs/multi_language_function_programming_interface/advanced_tutorials/yr_shutdown.md +++ b/docs/multi_language_function_programming_interface/advanced_tutorials/yr_shutdown.md @@ -21,7 +21,7 @@ def __yr_shutdown__(self, gracePeriodSecond: int): :::{note} -您的自定义优化退出函数，签名必须与接口原型一致，否则将无法触发调用。 +您的自定义优雅退出函数，签名必须与接口原型一致，否则将无法触发调用。 ::: diff --git a/docs/multi_language_function_programming_interface/development_guide/scheduling/logical_resource.md b/docs/multi_language_function_programming_interface/development_guide/scheduling/logical_resource.md index 081a03f..a3a75c1 100644 --- a/docs/multi_language_function_programming_interface/development_guide/scheduling/logical_resource.md +++ b/docs/multi_language_function_programming_interface/development_guide/scheduling/logical_resource.md @@ -168,10 +168,10 @@ public class Main { `resource type` 可以配置为 `count`、 `HBM`、`latency`、`stream`，使用说明和约束如下。 - `count` 用于指定的卡的数量。该参数与其他参数互斥，即指定 `count` 将无法设置其他参数。 -- `HBM`、`latency`、`streams` 用于支持细粒度资源分配，三者需要同时配置。例如：`npu_resource = {"NPU/Ascend910/HBM":30000, "NPU/Ascend910/stream":2, "NPU/Ascend910/latency":50}`。 +- `HBM`、`latency`、`stream` 用于支持细粒度资源分配，三者需要同时配置。例如：`npu_resource = {"NPU/Ascend910/HBM":30000, "NPU/Ascend910/stream":2, "NPU/Ascend910/latency":50}`。 - `HBM` 指定该模型占用的显存量。 - `latency`：模型执行单次推理的时延（单位：ms）。 -- `streams`：模型内部 stream 数量，默认为 1，如果大于 1 则不会与其他进程共卡调度。 +- `stream`：模型内部 stream 数量，默认为 1，如果大于 1 则不会与其他进程共卡调度。 openYuanrong 通过自动设置 `ASCEND_RT_VISIBLE_DEVICES` 环境变量实现 NPU 隔离。使用 NPU 资源时，用户需要在函数中通过环境变量 `ASCEND_RT_VISIBLE_DEVICES` 获取为该实例分配的 NPU ID，参考[示例](../../examples/use_NPU_resource.md)。 diff --git a/docs/multi_language_function_programming_interface/examples/affinity.md b/docs/multi_language_function_programming_interface/examples/affinity.md index 50f4426..bcec81c 100644 --- a/docs/multi_language_function_programming_interface/examples/affinity.md +++ b/docs/multi_language_function_programming_interface/examples/affinity.md @@ -70,7 +70,7 @@ if __name__ == '__main__': 执行命令 `python resource-affinity.py` 运行程序。查看从节点上的函数日志文件 `{node_id}-user_func_std.log`，可见如下输出，表明两个实例都部署在标签为 `{"agent":"uat"}` 节点。 ```bash -025-07-18 17:12:33|56412d11-0000-4000-8000-005cef06b506|runtime-56412d11-0000-4000-8000-005cef06b506-c6d59c3a409e|INFO|Detector 0,NODE_ID:dggphis35945-2731346,LABELS:{"agent":"uat"} +2025-07-18 17:12:33|56412d11-0000-4000-8000-005cef06b506|runtime-56412d11-0000-4000-8000-005cef06b506-c6d59c3a409e|INFO|Detector 0,NODE_ID:dggphis35945-2731346,LABELS:{"agent":"uat"} 2025-07-18 17:12:33|04d8cf02-727f-4714-8000-000000000071|runtime-04d8cf02-727f-4714-8000-000000000071-000000d8f917|INFO|Detector 1,NODE_ID:dggphis35945-2731346,LABELS:{"agent":"uat"} ``` -- Gitee From 15e780cebff9615507d7bd1addf3e1b16e80ebd1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E5=8D=81=E4=B8=80?= Date: Tue, 11 Nov 2025 11:21:51 +0800 Subject: [PATCH 2/5] change1 --- api/python/yr/apis.py | 7 +++---- api/python/yr/config.py | 2 +- .../api/distributed_programming/zh_cn/Python/index.rst | 6 +++--- .../zh_cn/Python/yr.Config.code_dir.rst | 2 +- .../api/distributed_programming/zh_cn/Python/yr.Config.rst | 4 ++-- .../zh_cn/Python/yr.Config.rt_server_address.rst | 2 +- .../zh_cn/Python/yr.java_instance_class.rst | 2 +- .../zh_cn/Python/yr.kv_m_write_tx.rst | 2 +- .../zh_cn/Python/yr.kv_write_with_param.rst | 2 +- 9 files changed, 14 insertions(+), 15 deletions(-) diff --git a/api/python/yr/apis.py b/api/python/yr/apis.py index 396b9d6..8c8c619 100644 --- a/api/python/yr/apis.py +++ b/api/python/yr/apis.py @@ -724,8 +724,7 @@ def kv_write(key: str, value: bytes, existence: ExistenceOpt = ExistenceOpt.NONE @check_initialized def kv_write_with_param(key: str, value: bytes, set_param: SetParam) -> None: """ - Provides the Redis class's set storage interface, - which supports saving binary data to the data system. + Provide a storage interface that supports custom parameter configuration, enabling binary data to be written to the data system in a more flexible manner. Args: key (str): Sets a key for the data to be saved, which is used to identify the data. @@ -761,7 +760,7 @@ def kv_write_with_param(key: str, value: bytes, set_param: SetParam) -> None: @check_initialized def kv_m_write_tx(keys: List[str], values: List[bytes], m_set_param: MSetParam = MSetParam()) -> None: """ - It provides a Redis-like set storage interface, supporting the saving of a set of binary data to the data system. + Provide a Redis-like set storage interface that supports persisting a collection of binary data into the data system. Args: keys (List[str]): Set a set of keys for the saved data to identify the data. Use this key for querying data. @@ -1483,7 +1482,7 @@ def java_function(class_name: str, function_name: str, function_urn: str) -> Fun def java_instance_class(class_name: str, function_urn: str) -> InstanceCreator: """ - A proxy used to construct java classes and remotely invoke java classes. + A proxy used to construct Java classes and invoke them remotely. Args: class_name (str): The name of java. diff --git a/api/python/yr/config.py b/api/python/yr/config.py index 6c2dfdd..582adb4 100644 --- a/api/python/yr/config.py +++ b/api/python/yr/config.py @@ -87,7 +87,7 @@ class Config: invoke_timeout: int = 900 #: Run code in local, default is ``False``. local_mode: bool = False - #: Need set which init in runtime. + #: The code directory path that must be configured at runtime initialization. code_dir: str = "" #: Http client connection nums. #: default is ``100``, limit: [1,∞). diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/index.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/index.rst index 5e714b0..fe9ce66 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/index.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/index.rst @@ -229,7 +229,7 @@ Python * - :doc:`yr.java_function` - 用于构造 java 函数的代理，远程调用 java 函数。 * - :doc:`yr.java_instance_class` - - 用于构造 cpp 类的代理，远程调用 cpp 类。 + - 用于构造 Java 类，并远程调用 Java 类的代理。 函数组 API -------------- @@ -286,9 +286,9 @@ KV 缓存 API * - :doc:`yr.kv_write` - 提供类 Redis 的 set 存储接口，支持保存二进制数据到数据系统。 * - :doc:`yr.kv_write_with_param` - - 提供类 Redis 的 set 存储接口，支持保存二进制数据到数据系统。 + - 提供支持自定义参数配置的存储接口。用于以更灵活的方式将二进制数据写入数据系统。 * - :doc:`yr.kv_m_write_tx` - - 创建 ResourceGroup 后返回的句柄。 + - 提供一个类似 Redis 的集合存储接口，支持将一组二进制数据保存到数据系统。 * - :doc:`yr.kv_read` - 提供类 Redis 的 get 获取数据接口，支持同时获取多个数据。 * - :doc:`yr.kv_del` diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.code_dir.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.code_dir.rst index 4fe5321..ff0845b 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.code_dir.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.code_dir.rst @@ -7,4 +7,4 @@ yr.Config.code_dir :type: str :value: '' - 需要在运行时初始化的设置。 \ No newline at end of file + 需要在 runtime 初始化时设置的代码目录路径。 \ No newline at end of file diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.rst index ac6915e..c0eef10 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.rst @@ -18,7 +18,7 @@ yr.Config * - :ref:`certificate_file_path ` - 客户端证书文件路径。 * - :ref:`code_dir ` - - 需要在运行时初始化的设置。 + - 需要在 runtime 初始化时设置的代码目录路径。 * - :ref:`connection_nums ` - HTTP 客户端连接数。 * - :ref:`cpp_function_id ` @@ -66,7 +66,7 @@ yr.Config * - :ref:`rpc_timeout ` - RPC 超时时间（秒）。 * - :ref:`rt_server_address ` - - 运行时服务器，在驱动程序中保持默认值。 + - runtime 服务地址，在 driver 中保持默认值。 * - :ref:`runtime_id ` - 运行时 ID，在驱动程序中保持默认值。 * - :ref:`runtime_private_key_path ` diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.rt_server_address.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.rt_server_address.rst index a7df366..6640407 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.rt_server_address.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.Config.rt_server_address.rst @@ -7,4 +7,4 @@ yr.Config.rt_server_address :type: str :value: '' - 运行时服务器，在驱动程序中保持默认值。 \ No newline at end of file + runtime 服务地址，在 driver 中保持默认值。 \ No newline at end of file diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.java_instance_class.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.java_instance_class.rst index 01b89ff..e603e6a 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.java_instance_class.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.java_instance_class.rst @@ -3,7 +3,7 @@ yr.java_instance_class .. py:method:: java_instance_class(class_name: str, function_urn: str) -> InstanceCreator - 用于构造 Java 类并远程调用 Java 类的代理。 + 用于构造 Java 类，并远程调用 Java 类的代理。 参数： - **class_name** (str) – java 类名。 diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.kv_m_write_tx.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.kv_m_write_tx.rst index a77057f..df4dfe7 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.kv_m_write_tx.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.kv_m_write_tx.rst @@ -3,7 +3,7 @@ yr.kv_m_write_tx .. py:function:: yr.kv_m_write_tx(keys: ~typing.List[str], values: typing.List[bytes], m_set_param: yr.runtime.MSetParam = MSetParam(existence=, write_mode=, ttl_second=0, cache_type=)) -> None - 它提供了一个类似 redis 的集合存储接口，支持将一组二进制数据保存到数据系统。 + 提供一个类似 Redis 的集合存储接口，支持将一组二进制数据保存到数据系统。 参数: - **key** (List[str]) - 为保存的数据设置一组键来标识数据。使用此键查询数据时，不能为空。 diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.kv_write_with_param.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.kv_write_with_param.rst index dc880c9..2f4b939 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.kv_write_with_param.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.kv_write_with_param.rst @@ -3,7 +3,7 @@ yr.kv_write_with_param .. py:function:: kv_write_with_param(key: str, value: bytes, set_param: SetParam) -> None - 提供类 Redis 的 set 存储接口，支持保存二进制数据到数据系统。 + 提供支持自定义参数配置的存储接口。用于以更灵活的方式将二进制数据写入数据系统。 参数: - **key** (str) - 为保存的数据设置一个键，用于标识该数据。查询数据时使用该键进行查询，不能为空。 -- Gitee From 184bcea5888ecb23f123964108533170e28774d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E5=8D=81=E4=B8=80?= Date: Tue, 11 Nov 2025 16:01:19 +0800 Subject: [PATCH 3/5] change1 --- api/python/yr/apis.py | 3 ++- .../zh_cn/Python/yr.InvokeOptions.name.rst | 2 +- .../zh_cn/Python/yr.InvokeOptions.namespace.rst | 2 +- .../zh_cn/Python/yr.InvokeOptions.rst | 6 +++--- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/api/python/yr/apis.py b/api/python/yr/apis.py index 8c8c619..8245d47 100644 --- a/api/python/yr/apis.py +++ b/api/python/yr/apis.py @@ -724,7 +724,8 @@ def kv_write(key: str, value: bytes, existence: ExistenceOpt = ExistenceOpt.NONE @check_initialized def kv_write_with_param(key: str, value: bytes, set_param: SetParam) -> None: """ - Provide a storage interface that supports custom parameter configuration, enabling binary data to be written to the data system in a more flexible manner. + Provide a storage interface that supports custom parameter configuration, + enabling binary data to be written to the data system in a more flexible manner. Args: key (str): Sets a key for the data to be saved, which is used to identify the data. diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.name.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.name.rst index 9d2ac5c..fe53bd4 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.name.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.name.rst @@ -7,4 +7,4 @@ yr.InvokeOptions.name :type: str :value: '' - 用于指定实例的 ID。当指定了命名空间时，实例 ID 为命名空间-名称，否则为名称。 \ No newline at end of file + 用于指定实例的名称。当指定了命名空间时，实例 ID 为命名空间-名称，否则为名称。 \ No newline at end of file diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.namespace.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.namespace.rst index 1f03f6b..6d0b927 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.namespace.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.namespace.rst @@ -7,4 +7,4 @@ yr.InvokeOptions.namespace :type: str :value: "" - 用于指定实例的 ID。 \ No newline at end of file + 用于指定实例的命名空间。 \ No newline at end of file diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.rst index cf4c5d8..ae1146a 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.rst @@ -41,9 +41,9 @@ yr.InvokeOptions * - :ref:`min_instances ` - 指定无状态函数的最小实例数。 * - :ref:`name ` - - 用于指定实例的 ID。 + - 用于指定实例的名称。 * - :ref:`namespace ` - - 用于指定实例的 ID。 + - 用于指定实例的命名空间。 * - :ref:`need_order ` - 是否启用顺序保持。 * - :ref:`preferred_anti_other_labels ` @@ -76,7 +76,7 @@ yr.InvokeOptions - 实例启动时设置环境变量。 * - :ref:`alias_params ` - 在 FaaS 跨函数调用中，当通过指定的别名调用函数且该别名为规则别名时，此参数用于设置规则别名所依赖的 kv 参数。 - * - :ref:`runtime_envs ` + * - :ref:`runtime_env ` - 使用 conda、pip、working_dir 和 env_vars 配置 actor/task 的运行时环境。 **方法**： -- Gitee From d355db7cab8fba2f137f1df3963e1380e20de7bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E5=8D=81=E4=B8=80?= Date: Tue, 11 Nov 2025 17:00:19 +0800 Subject: [PATCH 4/5] change1 --- api/python/yr/apis.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/api/python/yr/apis.py b/api/python/yr/apis.py index 8245d47..e398d7b 100644 --- a/api/python/yr/apis.py +++ b/api/python/yr/apis.py @@ -761,7 +761,8 @@ def kv_write_with_param(key: str, value: bytes, set_param: SetParam) -> None: @check_initialized def kv_m_write_tx(keys: List[str], values: List[bytes], m_set_param: MSetParam = MSetParam()) -> None: """ - Provide a Redis-like set storage interface that supports persisting a collection of binary data into the data system. + Provide a Redis-like set storage interface that supports persisting + a collection of binary data into the data system. Args: keys (List[str]): Set a set of keys for the saved data to identify the data. Use this key for querying data. -- Gitee From fad598adfd55ac083e5b3d44b4e8073c8e15e4e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9B=B7=E5=8D=81=E4=B8=80?= Date: Tue, 11 Nov 2025 17:28:14 +0800 Subject: [PATCH 5/5] change1 --- .../api/distributed_programming/zh_cn/Python/yr.get.rst | 2 +- .../api/distributed_programming/zh_cn/Python/yr.put.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.get.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.get.rst index 16e6e73..40fc08d 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.get.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.get.rst @@ -1,7 +1,7 @@ yr.get ===================== -.. py:function:: yr.get(obj_refs: Union[ObjectRef, List], timeout: int = 300,\ +.. py:function:: yr.get(obj_refs: Union[ObjectRef, List], timeout: int = constants.DEFAULT_GET_TIMEOUT,\ allow_partial: bool = False) -> object 根据数据对象的键从数据系统中检索值。接口调用后会阻塞直到获取到对象的值或者超时。 diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.put.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.put.rst index 5f8bee7..2007571 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.put.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.put.rst @@ -11,7 +11,7 @@ yr.put 3. 如果传递给 put 的对象类型为 memoryview，bytearray 或 bytes，则其长度不能为 ``0``。 参数: - - **obj** (object) - 需要被远程调用的函数。 + - **obj** (object) - Python 对象，被序列化并保存到数据系统中。 - **create_param** (CreateParam()，可选) - 这是为数据系统创建对象时的参数。 返回: -- Gitee