diff --git a/api/python/yr/apis.py b/api/python/yr/apis.py index 396b9d66f70c0160eadfdc74a7a6d42a788d3d0c..e398d7bbe9fb2a78e4b95ab20aec60632ce18a04 100644 --- a/api/python/yr/apis.py +++ b/api/python/yr/apis.py @@ -724,8 +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: """ - 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 +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: """ - 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 +1484,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 6c2dfddced3b73b0cac3e2867fcfdfebacff28e7..582adb45300db78b3352e5f68b52bfb472deda10 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/advanced_tutorials/yr_shutdown.md b/docs/multi_language_function_programming_interface/advanced_tutorials/yr_shutdown.md index baeda9bab913efb8b74cb5f8e8d5302bbf5e0a32..20ac45e0c8a675296a3bb90a44d1097307641a91 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/api/distributed_programming/zh_cn/Python/index.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/index.rst index 5e714b0f19aef1d2a3dbac8c1418ec3a30d247cb..fe9ce66495f2d2671fc733fd0f3ec97ae8ccaf2c 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 4fe5321547a441f38b54a86f5fe7734434906730..ff0845bc96d05caf5b69bf63180848fc408a18c0 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 ac6915e0a0785bbf7321f14e2ae98de8e3349fcf..c0eef10bd4ae0237244632ea3b0c951c757b64ec 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 a7df366071be7fba6e2f24f62ab51c125f86fdfe..6640407b9365fc2da7e2d9a88c2afd8e8a7c88ec 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.InvokeOptions.name.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.InvokeOptions.name.rst index 9d2ac5c5c32e9b91a063fd96035ae4467b611af4..fe53bd4c9456444d6f216a148228a9552f9ceceb 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 1f03f6b5e8ac3492d297780b0a6a3f0aad719a54..6d0b92777ef79d926205fe225177060c82e97822 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 cf4c5d84ade9f796acca0e1493bc9990d38f8dc0..ae1146a5bb23d7afa1140c78ed20b8122b9d5274 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 的运行时环境。 **方法**: 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 16e6e739521b077fdb8d9c0fa8b635641745d7ee..40fc08d4c64c1022327d4f9fef073533bf9eb312 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.java_instance_class.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.java_instance_class.rst index 01b89ffd44c4b570260df4a5de3fec480e5fce71..e603e6ab5230150088b6dadbbb524c4ea1f83d99 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 a77057f4f4752afa8b0f5f08c8f6898e5a52a7d1..df4dfe7a9695621bb197a1ba1fd8dbe89ea7706a 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 dc880c9d35ceb51793185e044e9552dca64bdff3..2f4b9392d073d25a4d57978818a88eca5488bac6 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) - 为保存的数据设置一个键,用于标识该数据。查询数据时使用该键进行查询,不能为空。 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 5f8bee72c70946ce87ce0f36fba83e1b9615eca9..2007571847726ee42b19be2d997c5dffa755a4c3 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(),可选) - 这是为数据系统创建对象时的参数。 返回: 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 081a03f7c6964f8b9b57005274960987ff57297d..a3a75c1b673ba49f5e4552d3a157a023f665bea9 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 50f4426ba0788d6bea80dd9bf353b0ac9bb43163..bcec81c94b12aaf972dbf33bb31ba7ab63545adc 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"} ```