diff --git a/api/python/yr/apis.py b/api/python/yr/apis.py index 396b9d66f70c0160eadfdc74a7a6d42a788d3d0c..65433812b363afba1fd85549a20e989d6ce479cd 100644 --- a/api/python/yr/apis.py +++ b/api/python/yr/apis.py @@ -236,14 +236,9 @@ def put(obj: object, create_param: CreateParam = CreateParam()) -> ObjectRef: Examples: >>> import yr >>> yr.init() - >>> # The worker startup parameters need to be configured with shared_disk_directory and shared_disk_size_mb; - >>> # otherwise, this example will result in an error >>> param = yr.CreateParam() >>> param.cache_type = yr.CacheType.DISK >>> bs = bytes(0) - >>> obj_ref1 = yr.put(bs, param) - >>> print(yr.get(obj_ref1)) - >>> # ValueError: value is None or has zero length >>> mem = memoryview(bytes(100)) >>> obj_ref2 = yr.put(mem) >>> print(yr.get(obj_ref2)) @@ -254,7 +249,6 @@ def put(obj: object, create_param: CreateParam = CreateParam()) -> ObjectRef: >>> # The final print output is a memoryview pointer. >>> obj_ref4 = yr.put(100) >>> print(yr.get(obj_ref4)) - >>> 100 """ if (isinstance(obj, (bytes, bytearray, memoryview)) and len(obj) == 0): raise ValueError("value is None or has zero length") @@ -1297,7 +1291,7 @@ class cpp_instance_class: class_name (str): cpp class name. factory_name (str): Name of the static factory function of the cpp class. function_urn (str): Function URN, Defaults to - sn:cn:yrk:12345678901234561234567890123456:function:0-defaultservice-py:$latest. + sn:cn:yrk:12345678901234561234567890123456:function:0-defaultservice-cpp:$latest. Examples: .. code-block:: cpp @@ -1331,8 +1325,11 @@ class cpp_instance_class: >>> import yr >>> yr.init() - >>> cpp_function_urn = "sn:cn:yrk:12345678901234561234567890123456:function:0-yr-mycpp:$latest" - >>> counter_class = yr.cpp_instance_class("Counter", "Counter::FactoryCreate",cpp_function_urn) + >>> cpp_function_urn = ( + ... "sn:cn:yrk:12345678901234561234567890123456:" + ... "function:0-yr-defaultservice-cpp:$latest" + ... ) + >>> counter_class = yr.cpp_instance_class("Counter", "Counter::FactoryCreate", cpp_function_urn) >>> opt = yr.InvokeOptions(cpu=1000, memory=1024) >>> ins = counter_class.options(opt).invoke(11) >>> result = ins.Add.invoke(9) @@ -1420,11 +1417,13 @@ def cpp_function(function_name: str, function_urn: str) -> FunctionProxy: >>> import yr >>> yr.init() - >>> cpp_function_urn = "sn:cn:yrk:12345678901234561234567890123456:function:0-yr-mycpp:$latest" + >>> cpp_function_urn = ( + ... "sn:cn:yrk:12345678901234561234567890123456:" + ... "function:0-yr-defaultservice-cpp:$latest" + ... ) >>> square_func = yr.cpp_function("Square", cpp_function_urn) >>> result = square_func.invoke(5) >>> print(yr.get(result)) - >>> >>> yr.finalize() """ @@ -1470,7 +1469,10 @@ def java_function(class_name: str, function_name: str, function_urn: str) -> Fun >>> import yr >>> yr.init() - >>> java_function_urn = "sn:cn:yrk:12345678901234561234567890123456:function:0-yr-myjava:$latest" + >>> java_function_urn = ( + ... "sn:cn:yrk:12345678901234561234567890123456:" + ... "function:0-yr-defaultservice-java:$latest" + ... ) >>> java_add = yr.java_function("com.yuanrong.demo.PlusOne", "PlusOne", java_function_urn) >>> result = java_add.invoke(1) >>> print(yr.get(result)) @@ -1523,7 +1525,10 @@ def java_instance_class(class_name: str, function_urn: str) -> InstanceCreator: >>> import yr >>> yr.init() - >>> java_function_urn = "sn:cn:yrk:12345678901234561234567890123456:function:0-yr-myjava:$latest" + >>> java_function_urn = ( + ... "sn:cn:yrk:12345678901234561234567890123456:" + ... "function:0-yr-defaultservice-java:$latest" + ... ) >>> >>> java_instance = yr.java_instance_class("com.yuanrong.demo.Counter", java_function_urn).invoke(1) >>> res = java_instance.Add.invoke(5) diff --git a/api/python/yr/config.py b/api/python/yr/config.py index 6c2dfddced3b73b0cac3e2867fcfdfebacff28e7..356333a58281961a68c8ba1ff20bf054978166b1 100644 --- a/api/python/yr/config.py +++ b/api/python/yr/config.py @@ -356,7 +356,7 @@ class InvokeOptions: >>> import yr >>> yr.init() >>> opt = yr.InvokeOptions() - >>> opt.custom_extensions["YR_Metrics"] = "{\"endpoint\":\"127.0.0.1\", \"project_id\":\"my_project_id\"}" + >>> opt.custom_extensions["YR_Metrics"] = "{\'endpoint\':\'127.0.0.1\', \'project_id\':\'my_project_id\'}" In Prometheus, select `metrics name` as `yr_app_instance_billing_invoke_latency`, and you can find the custom tag information in the collected invoke information: diff --git a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.DoubleCounter.set.rst b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.DoubleCounter.set.rst index a28af2639d12534efdee104d7457e4b893ad5e08..acff9e8bb8113c456a550d87b6e5b70476da2293 100644 --- a/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.DoubleCounter.set.rst +++ b/docs/multi_language_function_programming_interface/api/distributed_programming/zh_cn/Python/yr.DoubleCounter.set.rst @@ -14,7 +14,7 @@ yr.DoubleCounter.set 样例: >>> import yr - >>> config = yr.Config(enable_metrics=True) + >>> config = yr.Config(enable_metrics=True) >>> yr.init(config) >>> >>> @yr.instance 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..69fb80abcc1d8afbcfc05ba1600c86f6749920d6 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 @@ -19,8 +19,6 @@ yr.kv_m_write_tx 样例: >>> import yr >>> yr.init() - >>> # worker启动参数需要配置为 shared_disk_directory 和 shared_disk_size_mb - >>> # 否则,此示例将导致错误 >>> mset_param = yr.MSetParam() >>> mset_param.existence = yr.ExistenceOpt.NX >>> mset_param.write_mode = yr.WriteMode.NONE_L2_CACHE_EVICT 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..ccbbf4f1f66b6fb7ba508cf57e53ce9ea8a39a53 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 @@ -28,14 +28,9 @@ yr.put 样例: >>> import yr >>> yr.init() - >>> # worker启动参数需要配置为shared_disk_directory和shared_disk_size_mb - >>> # 否则,此示例将导致错误 >>> param = yr.CreateParam() >>> param.cache_type = yr.CacheType.DISK >>> bs = bytes(0) - >>> obj_ref1 = yr.put(bs, param) - >>> print(yr.get(obj_ref1)) - >>> # ValueError: value is None or has zero length >>> mem = memoryview(bytes(100)) >>> obj_ref2 = yr.put(mem) >>> print(yr.get(obj_ref2)) @@ -46,6 +41,5 @@ yr.put >>> # 最后输出一个 memoryview 指针 >>> obj_ref4 = yr.put(100) >>> print(yr.get(obj_ref4)) - >>> 100 .. _ObjectRef: ../../Python/generated/yr.object_ref.ObjectRef.html#yr.object_ref.ObjectRef