状态 API#

备注

API 是 alpha 。此功能需要使用 pip install "ray[default]" 完整安装 Ray。

有关示例的概述,请参见 监控 Ray 状态

有关CLI参考,请参阅 Ray State CLI 参考Ray Log CLI 参考

State Python SDK#

状态API也被导出为函数。

摘要 API#

ray.util.state.summarize_actors

总结集群中的角色。

ray.util.state.summarize_objects

总结集群中的对象。

ray.util.state.summarize_tasks

总结集群中的任务。

列出 API#

ray.util.state.list_actors

列出集群中的演员。

ray.util.state.list_placement_groups

列出集群中的放置组。

ray.util.state.list_nodes

列出集群中的节点。

ray.util.state.list_jobs

列出提交到集群的作业,参考 Ray 作业提交

ray.util.state.list_workers

列出集群中的工作节点。

ray.util.state.list_tasks

列出集群中的任务。

ray.util.state.list_objects

列出集群中的对象。

ray.util.state.list_runtime_envs

列出集群中的运行时环境。

获取API#

ray.util.state.get_actor

通过ID获取演员。

ray.util.state.get_placement_group

通过ID获取放置组。

ray.util.state.get_node

通过id获取节点。

ray.util.state.get_worker

通过ID获取一个工作者。

ray.util.state.get_task

通过ID获取任务的尝试次数。

ray.util.state.get_objects

通过ID获取对象。

日志 API#

ray.util.state.list_logs

列出可用的日志文件。

ray.util.state.get_log

根据文件名或某些实体ID(pid、actor id、task id)检索日志文件。

状态 API 模式#

ray.util.state.common.ActorState

Actor State

ray.util.state.common.TaskState

任务状态

ray.util.state.common.NodeState

节点状态

ray.util.state.common.PlacementGroupState

PlacementGroup 状态

ray.util.state.common.WorkerState

工作状态

ray.util.state.common.ObjectState

对象状态

ray.util.state.common.RuntimeEnvState

运行时环境状态

ray.util.state.common.JobState

Ray 的 Job API 或驱动程序作业提交的工作状态

ray.util.state.common.StateSummary

ray.util.state.common.TaskSummaries

ray.util.state.common.TaskSummaryPerFuncOrClassName

ray.util.state.common.ActorSummaries

ray.util.state.common.ActorSummaryPerClass

ray.util.state.common.ObjectSummaries

ray.util.state.common.ObjectSummaryPerKey

状态 API 异常#

ray.util.state.exception.RayStateApiException