Skip to main content
Back to top
Ctrl
+
K
入门
使用案例
文档
Choose version
Choose version
Search
Ctrl
+
K
首页
入门
安装部署
安装指南
在主机上部署 openYuanrong 集群
入门
用户指南
环境准备
部署 openYuanrong
安全通信
部署参数表
在 K8s 上部署 openYuanrong 集群
用户指南
环境准备
部署 openYuanrong
规格与限制
资源池管理 API
创建 pod 资源池
更新 pod 资源池
查询 pod 资源池
删除 Pod 资源池
部署 openYuanrong 作业类应用
作业管理 API
提交作业
查询作业详情
查询作业列表
删除作业
停止作业
部署 openYuanrong 服务类应用
使用案例
基于 vLLM 部署多机 PD 分离服务，长序列推理 TTFT 下降 20%
推理实例模型加载速度 10 倍提升，快速弹性响应业务流量变化
迁移 SpringBoot 容器微服务到 openYuanrong
多语言函数编程接口
关键概念
开发指南
有状态函数
具名函数实例
并发
容错
无状态函数
并发
容错
数据对象
KV 缓存
数据流
函数服务
配置函数
版本管理
调度
资源
亲和
进阶教程
自定义优雅退出
openYuanrong 生成器
接口免序列化与反序列化
避免过度并发
嵌套调用
使用 yr.wait 限制并发/待处理任务的数量
使用资源用量限制任务并发数量
使用有状态函数构造树状作业图
AI Agent 会话与亲和性调度
使用有状态函数作为全局信号站
示例
函数编程简单示例
函数中使用数据流
基于 AI Agent 会话实现多轮对话助手
函数服务中运行分布式作业
配置函数实例亲和
有状态函数中使用 NPU 资源
函数服务连接后端存储
基于 openYuanrong 实现 MapReduce
基于 openYuanrong 实现蒙特卡罗方法
基于 openYuanrong 实现强化学习走迷宫
跨语言调用无状态和有状态函数
API
单机程序分布式并行化 SDK
Python
yr.init
yr.is_initialized
yr.finalize
yr.Config
yr.Config.auto
yr.Config.certificate_file_path
yr.Config.code_dir
yr.Config.connection_nums
yr.Config.cpp_function_id
yr.Config.deployment_config
yr.Config.ds_address
yr.Config.ds_public_key_path
yr.Config.enable_ds_encrypt
yr.Config.enable_metrics
yr.Config.enable_mtls
yr.Config.function_id
yr.Config.invoke_timeout
yr.Config.is_driver
yr.Config.job_id
yr.Config.local_mode
yr.Config.log_dir
yr.Config.log_file_num_max
yr.Config.log_file_size_max
yr.Config.log_flush_interval
yr.Config.log_level
yr.Config.max_task_instance_num
yr.Config.ns
yr.Config.private_key_path
yr.Config.recycle_time
yr.Config.rpc_timeout
yr.Config.rt_server_address
yr.Config.runtime_id
yr.Config.runtime_private_key_path
yr.Config.runtime_public_key_path
yr.Config.server_address
yr.Config.server_name
yr.Config.tls_config
yr.Config.verify_file_path
yr.Config.working_dir
yr.Config.load_paths
yr.config.custom_envs
yr.config.master_addr_list
yr.Config.dedup_logs
yr.Config.__init__
yr.config.ClientInfo
yr.config.ClientInfo.__init__
yr.config.ClientInfo.job_id
yr.invoke
yr.StatelessFunction
yr.StatelessFunction.invoke
yr.StatelessFunction.options
yr.StatelessFunction.invoke
yr.FunctionProxy
yr.FunctionProxy.__init__
yr.FunctionProxy.get_original_func
yr.FunctionProxy.invoke
yr.FunctionProxy.options
yr.FunctionProxy.set_function_group_size
yr.FunctionProxy.set_urn
yr.FunctionProxy.invoke
yr.instance
yr.StatefulInstanceCreator
yr.StatefulInstanceCreator.invoke
yr.StatefulInstanceCreator.options
yr.StatefulInstanceCreator.get_instance
yr.StatefulInstance
yr.StatefulInstance.terminate
yr.StatefulInstance.is_activate
yr.InstanceProxy
yr.InstanceProxy.__init__
yr.InstanceProxy.deserialization
yr.InstanceProxy.get_function_group_handler
yr.InstanceProxy.is_activate
yr.InstanceProxy.real_id
yr.InstanceProxy.serialization
yr.InstanceProxy.terminate
yr.method
yr.MethodProxy
yr.MethodProxy.__init__
yr.MethodProxy.invoke
yr.MethodProxy.options
yr.get_instance
yr.InstanceCreator
yr.InstanceCreator.__init__
yr.InstanceCreator.create_cpp_user_class
yr.InstanceCreator.create_cross_user_class
yr.InstanceCreator.create_from_user_class
yr.InstanceCreator.get_instance
yr.InstanceCreator.get_original_cls
yr.InstanceCreator.invoke
yr.InstanceCreator.options
yr.InstanceCreator.set_function_group_size
yr.cancel
yr.exit
yr.save_state
yr.load_state
yr.InvokeOptions
yr.InvokeOptions.concurrency
yr.InvokeOptions.cpu
yr.InvokeOptions.max_instances
yr.InvokeOptions.max_invoke_latency
yr.InvokeOptions.memory
yr.InvokeOptions.min_instances
yr.InvokeOptions.name
yr.InvokeOptions.namespace
yr.InvokeOptions.need_order
yr.InvokeOptions.preferred_anti_other_labels
yr.InvokeOptions.preferred_priority
yr.InvokeOptions.recover_retry_times
yr.InvokeOptions.required_priority
yr.InvokeOptions.retry_times
yr.InvokeOptions.trace_id
yr.InvokeOptions.custom_resources
yr.InvokeOptions.custom_extensions
yr.InvokeOptions.pod_labels
yr.InvokeOptions.labels
yr.InvokeOptions.schedule_affinities
yr.InvokeOptions.resource_group_options
yr.InvokeOptions.function_group_options
yr.InvokeOptions.env_vars
yr.InvokeOptions.alias_params
yr.InvokeOptions.runtime_env
yr.InvokeOptions.__init__
yr.InvokeOptions.check_options_valid
yr.InvokeOptions.is_data_affinity
yr.list_named_instances
yr.put
yr.get
yr.wait
yr.object_ref.ObjectRef
yr.object_ref.ObjectRef.id
yr.object_ref.ObjectRef.task_id
yr.object_ref.ObjectRef.__init__
yr.object_ref.ObjectRef.as_future
yr.object_ref.ObjectRef.cancel
yr.object_ref.ObjectRef.done
yr.object_ref.ObjectRef.exception
yr.object_ref.ObjectRef.get
yr.object_ref.ObjectRef.get_future
yr.object_ref.ObjectRef.is_exception
yr.object_ref.ObjectRef.on_complete
yr.object_ref.ObjectRef.set_data
yr.object_ref.ObjectRef.set_exception
yr.object_ref.ObjectRef.wait
yr.ProducerConfig
yr.ProducerConfig.auto_clean_up
yr.ProducerConfig.delay_flush_time
yr.ProducerConfig.encrypt_stream
yr.ProducerConfig.max_stream_size
yr.ProducerConfig.page_size
yr.ProducerConfig.reserve_size
yr.ProducerConfig.retain_for_num_consumers
yr.ProducerConfig.extend_config
yr.ProducerConfig.__init__
yr.SubscriptionConfig
yr.SubscriptionConfig.subscriptionType
yr.SubscriptionConfig.subscription_name
yr.SubscriptionConfig.extend_config
yr.SubscriptionConfig.__init__
yr.Element
yr.Element.__init__
yr.create_stream_producer
yr.create_stream_consumer
yr.delete_stream
yr.fnruntime.Producer
yr.fnruntime.Producer.__init__
yr.fnruntime.Producer.close
yr.fnruntime.Producer.send
yr.fnruntime.Consumer
yr.fnruntime.Consumer.__init__
yr.fnruntime.Consumer.ack
yr.fnruntime.Consumer.close
yr.fnruntime.Consumer.receive
yr.cpp_function
yr.cpp_instance_class
yr.cpp_instance_class.__init__
yr.cpp_instance_class.invoke
yr.cpp_instance_class.options
yr.cpp_instance_class.get_class_name
yr.cpp_instance_class.get_factory_name
yr.cpp_instance_class.get_function_key
yr.java_function
yr.java_instance_class
yr.create_function_group
yr.get_function_group_context
yr.FunctionGroupOptions
yr.FunctionGroupOptions.concurrency
yr.FunctionGroupOptions.cpu
yr.FunctionGroupOptions.memory
yr.FunctionGroupOptions.recover_retry_times
yr.FunctionGroupOptions.scheduling_affinity_each_bundle_size
yr.FunctionGroupOptions.scheduling_affinity_type
yr.FunctionGroupOptions.timeout
yr.FunctionGroupOptions.resources
yr.FunctionGroupOptions.__init__
yr.FunctionGroupContext
yr.FunctionGroupContext.rank_id
yr.FunctionGroupContext.world_size
yr.FunctionGroupContext.server_list
yr.FunctionGroupContext.device_name
yr.FunctionGroupContext.__init__
yr.FunctionGroupHandler
yr.FunctionGroupHandler.__init__
yr.FunctionGroupHandler.accelerate
yr.FunctionGroupHandler.terminate
yr.FunctionGroupMethodProxy
yr.FunctionGroupMethodProxy.use_shared_memory
yr.FunctionGroupMethodProxy.rpc_broadcast_mq
yr.FunctionGroupMethodProxy.__init__
yr.FunctionGroupMethodProxy.invoke
yr.FunctionGroupMethodProxy.set_rpc_broadcast_mq
yr.device.DataInfo
yr.device.DataInfo.__init__
yr.Group
yr.Group.__init__
yr.Group.invoke
yr.Group.terminate
yr.Group.suspend
yr.Group.resume
yr.config.GroupOptions
yr.config.GroupOptions.__init__
yr.config.GroupOptions.timeout
yr.config.GroupOptions.same_lifecycle
yr.config.GroupOptions.strategy
yr.create_resource_group
yr.remove_resource_group
yr.ResourceGroup
yr.ResourceGroup__init__
yr.ResourceGroup.wait
yr.ResourceGroup.bundle_count
yr.ResourceGroup.bundle_specs
yr.ResourceGroup.resource_group_name
yr.config.ResourceGroupOptions
yr.config.ResourceGroupOptions.__init__
yr.config.ResourceGroupOptions.resource_group_name
yr.config.ResourceGroupOptions.bundle_index
yr.config.SchedulingAffinityType
yr.config.UserTLSConfig
yr.config.UserTLSConfig.__init__
yr.config.UserTLSConfig.server_name
yr.config.UserTLSConfig.root_cert_path
yr.config.UserTLSConfig.module_cert_path
yr.config.UserTLSConfig.module_key_path
yr.config.DeploymentConfig
yr.config.DeploymentConfig.cpu
yr.config.DeploymentConfig.datamem
yr.config.DeploymentConfig.mem
yr.config.DeploymentConfig.spill_limit
yr.config.DeploymentConfig.spill_path
yr.config.DeploymentConfig.__init__
yr.kv_write
yr.kv_write_with_param
yr.kv_m_write_tx
yr.kv_read
yr.kv_del
yr.kv_set
yr.kv_get
yr.kv_get_with_param
yr.runtime.ExistenceOpt
yr.runtime.ExistenceOpt.NONE
yr.runtime.ExistenceOpt.NX
yr.runtime.WriteMode
yr.runtime.WriteMode.NONE_L2_CACHE
yr.runtime.WriteMode.WRITE_THROUGH_L2_CACHE
yr.runtime.WriteMode.WRITE_BACK_L2_CACHE
yr.runtime.WriteMode.NONE_L2_CACHE_EVICT
yr.runtime.CacheType
yr.runtime.CacheType.MEMORY
yr.runtime.CacheType.DISK
yr.runtime.ConsistencyType
yr.runtime.ConsistencyType.PRAM
yr.runtime.ConsistencyType.CAUSAL
yr.runtime.GetParam
yr.runtime.GetParam.__init__
yr.runtime.GetParam.offset
yr.runtime.GetParam.size
yr.runtime.GetParams
yr.runtime.GetParams.__init__
yr.runtime.GetParams.get_params
yr.runtime.SetParam
yr.runtime.SetParam.cache_type
yr.runtime.SetParam.existence
yr.runtime.SetParam.ttl_second
yr.runtime.SetParam.write_mode
yr.runtime.SetParam.__init__
yr.runtime.MSetParam
yr.runtime.MSetParam.cache_type
yr.runtime.MSetParam.existence
yr.runtime.MSetParam.write_mode
yr.runtime.MsetParam.ttl_second
yr.runtime.MSetParam.__init__
yr.runtime.CreateParam
yr.runtime.CreateParam.__init__
yr.runtime.CreateParam.cache_type
yr.runtime.CreateParam.consistency_type
yr.Gauge
yr.Gauge.__init__
yr.Gauge.add_labels
yr.Gauge.set
yr.Alarm
yr.Alarm.__init__
yr.Alarm.set
yr.AlarmInfo
yr.AlarmInfo.__init__
yr.AlarmInfo.alarm_name
yr.AlarmInfo.alarm_severity
yr.AlarmInfo.cause
yr.AlarmInfo.ends_at
yr.AlarmInfo.location_info
yr.AlarmInfo.starts_at
yr.AlarmInfo.timeout
yr.AlarmInfo.custom_options
yr.AlarmSeverity
yr.AlarmSeverity.OFF
yr.AlarmSeverity.INFO
yr.AlarmSeverity.MINOR
yr.AlarmSeverity.MAJOR
yr.AlarmSeverity.CRITICAL
yr.DoubleCounter
yr.DoubleCounter.__init__
yr.DoubleCounter.add_labels
yr.DoubleCounter.set
yr.DoubleCounter.reset
yr.DoubleCounter.increase
yr.DoubleCounter.get_value
yr.UInt64Counter
yr.UInt64Counter__init__
yr.UInt64Counter.add_labels
yr.UInt64Counter.set
yr.UInt64Counter.reset
yr.UInt64Counter.increase
yr.UInt64Counter.get_value
yr.resources
yr.affinity.AffinityType
yr.affinity.AffinityType.PREFERRED
yr.affinity.AffinityType.PREFERRED_ANTI
yr.affinity.AffinityType.REQUIRED
yr.affinity.AffinityType.REQUIRED_ANTI
yr.affinity.AffinityKind
yr.affinity.AffinityKind.RESOURCE
yr.affinity.AffinityKind.INSTANCE
yr.affinity.OperatorType
yr.affinity.OperatorType.LABEL_IN
yr.affinity.OperatorType.LABEL_NOT_IN
yr.affinity.OperatorType.LABEL_EXISTS
yr.affinity.OperatorType.LABEL_NOT_EXISTS
yr.affinity.LabelOperator
yr.affinity.LabelOperator.__init__
yr.affinity.Affinity
yr.affinity.Affinity.__init__
yr.affinity.Affinity.affinity_kind
yr.affinity.Affinity.affinity_type
yr.affinity.Affinity.label_operators
yr.exception.YRError
yr.exception.CancelError
yr.exception.YRInvokeError
yr.exception.YRequestError
C++
Init
IsInitialized
IsLocalMode
Finalize
Config 结构体
InstanceRange 结构体
Exception
YR_INVOKE
YR_STATE
YR_RECOVER
YR_SHUTDOWN
Function
FunctionHandler::Invoke
FunctionHandler::Options
FunctionHandler::SetUrn
Instance
InstanceCreator::Invoke
InstanceCreator::Options
InstanceCreator::SetUrn
InstanceFunctionHandler::Invoke
InstanceFunctionHandler::Options
NamedInstance
GetInstance
Cancel
Exit
SaveState
LoadState
InvokeOptions 结构体
Put
Get
Wait
ObjectRef
Stream
Collective
PyFunction
PyInstanceClass::FactoryCreate
JavaFunction
JavaInstanceClass FactoryCreate
CppFunction
CppInstanceClass FactoryCreate
Group
KV().Set
KV().MSetTx
KV().Write
KV().MWriteTx
KV().WriteRaw
KV().Get
KV().GetWithParam
KV().Read
KV().ReadRaw
KV().Del
ParallelFor
RuntimeEnv
Affinity
Java
init
Finalize
Config
invoke
function
FunctionHandler
function options
Instance
InstanceCreator
InstanceHandler
InstanceHandler function
InstanceFunctionHandler
InstanceHandler exportHandler
InstanceHandler importHandler
InstanceHandler terminate
saveState
loadState
yrShutdown
yrRecover
InvokeOptions
put
get
wait
ObjectRef
Stream
setUrn
CppFunction
CppFunctionHandler
CppInstanceClass
CppInstanceMethod
CppInstanceCreator
CppInstanceHandler
CppInstanceHandler function
CppInstanceFunctionHandler
CppInstanceHandler exportHandler
CppInstanceHandler importHandler
CppInstanceHandler terminate
JavaFunction
JavaFunctionHandler
JavaInstanceClass
JavaInstanceMethod
JavaInstanceCreator
JavaInstanceHandler
JavaInstanceHandler function
JavaInstanceFunctionHandler
JavaInstanceHandler exportHandler
JavaInstanceHandler importHandler
JavaInstanceHandler terminate
VoidFunctionHandler
VoidInstanceFunctionHandler
YR.kv().set()
YR.kv().mSetTx()
YR.kv().write()
YR.kv().mWriteTx()
YR.kv().get()
YR.kv().getWithParam()
YR.kv().read()
YR.kv().del
Group
Affinity
函数服务 API
Python SDK
yr.Context.__init__
yr.Context.getCPUNumber
yr.Context.getFunctionName
yr.Context.getLogger
yr.Context.getMemorySize
yr.Context.getPackage
yr.Context.getRequestID
yr.Context.getTenantID
yr.Context.getUserData
yr.Context.getVersion
yr.Context.get_session_service
yr.Context.set_session_id
yr.SessionService.load_session
yr.Session.wait_for_notify
yr.Session.notify
yr.Session.is_interrupted
yr.Function.__init__
yr.Function.invoke
yr.Function.options
C++ SDK
Java SDK
调用服务
订阅流服务
中断会话
删除会话
注册函数
更新函数
发布函数
查询函数的指定版本
查询函数的所有版本
查询函数列表
删除函数
创建预留实例配置
更新预留实例配置
查询预留实例配置
删除预留实例配置
CLI - the yr command
start
launch
health
status
stop
config
–version
错误码
更多使用方式
单独使用数据系统
监控与调试
Dashboard
日志
指标
系统指标
告警指标
配置并获取指标
应用指标
链路追踪
分布式融合调用栈
常见问题
多语言函数编程 FAQ
安装部署 FAQ
贡献者指南
源码编译 openYuanrong
贡献文档
参考
常用工具安装
词汇表
下载 openYuanrong
安全
.rst
.pdf
yr.Alarm.__init__
Contents
Alarm.__init__()
yr.Alarm.__init__
#
Alarm.
__init__
(
name
:
str
,
description
:
str
)
#
Contents
Alarm.__init__()
