ray.util.state.common.ActorState#
- class ray.util.state.common.ActorState(actor_id: str, class_name: str, state: Literal['DEPENDENCIES_UNREADY', 'PENDING_CREATION', 'ALIVE', 'RESTARTING', 'DEAD'], job_id: str, name: str | None, node_id: str | None, pid: int | None, ray_namespace: str | None, serialized_runtime_env: str | None = None, required_resources: dict | None = None, death_cause: dict | None = None, is_detached: bool | None = None, placement_group_id: str | None = None, repr_name: str | None = None)[source]#
Bases:
StateSchema
Actor State
Below columns can be used for the
--filter
option.pid
job_id
name
state
node_id
repr_name
ray_namespace
class_name
actor_id
placement_group_id
Below columns are available only when
get
API is used,--detail
is specified through CLI, ordetail=True
is given to Python APIs.pid
serialized_runtime_env
job_id
name
required_resources
is_detached
state
node_id
repr_name
ray_namespace
class_name
death_cause
actor_id
placement_group_id
- state: Literal['DEPENDENCIES_UNREADY', 'PENDING_CREATION', 'ALIVE', 'RESTARTING', 'DEAD']#
The state of the actor.
DEPENDENCIES_UNREADY: Actor is waiting for dependency to be ready. E.g., a new actor is waiting for object ref that’s created from other remote task.
PENDING_CREATION: Actor’s dependency is ready, but it is not created yet. It could be because there are not enough resources, too many actor entries in the scheduler queue, or the actor creation is slow (e.g., slow runtime environment creation, slow worker startup, or etc.).
ALIVE: The actor is created, and it is alive.
RESTARTING: The actor is dead, and it is restarting. It is equivalent to
PENDING_CREATION
, but means the actor was dead more than once.DEAD: The actor is permanatly dead.
- node_id: str | None#
The node id of this actor. If the actor is restarting, it could be the node id of the dead actor (and it will be re-updated when the actor is successfully restarted).