ray.util.state.common.TaskState#
- class ray.util.state.common.TaskState(task_id: str, attempt_number: int, name: str, state: Literal['NIL', 'PENDING_ARGS_AVAIL', 'PENDING_NODE_ASSIGNMENT', 'PENDING_OBJ_STORE_MEM_AVAIL', 'PENDING_ARGS_FETCH', 'SUBMITTED_TO_WORKER', 'RUNNING', 'RUNNING_IN_RAY_GET', 'RUNNING_IN_RAY_WAIT', 'FINISHED', 'FAILED'], job_id: str, actor_id: str | None, type: Literal['NORMAL_TASK', 'ACTOR_CREATION_TASK', 'ACTOR_TASK', 'DRIVER_TASK'], func_or_class_name: str, parent_task_id: str, node_id: str | None, worker_id: str | None, worker_pid: int | None, error_type: str | None, language: str | None = None, required_resources: dict | None = None, runtime_env_info: dict | None = None, placement_group_id: str | None = None, events: List[dict] | None = None, profiling_data: dict | None = None, creation_time_ms: int | None = None, start_time_ms: int | None = None, end_time_ms: int | None = None, task_log_info: dict | None = None, error_message: str | None = None, is_debugger_paused: bool | None = None)[source]#
Bases:
StateSchema
Task State
Below columns can be used for the
--filter
option.worker_pid
worker_id
func_or_class_name
language
name
error_type
state
task_id
parent_task_id
node_id
placement_group_id
job_id
type
attempt_number
is_debugger_paused
actor_id
Below columns are available only when
get
API is used,--detail
is specified through CLI, ordetail=True
is given to Python APIs.end_time_ms
error_message
state
parent_task_id
type
worker_id
attempt_number
task_log_info
node_id
events
start_time_ms
profiling_data
actor_id
worker_pid
placement_group_id
name
task_id
creation_time_ms
job_id
required_resources
is_debugger_paused
func_or_class_name
language
error_type
runtime_env_info
- state: Literal['NIL', 'PENDING_ARGS_AVAIL', 'PENDING_NODE_ASSIGNMENT', 'PENDING_OBJ_STORE_MEM_AVAIL', 'PENDING_ARGS_FETCH', 'SUBMITTED_TO_WORKER', 'RUNNING', 'RUNNING_IN_RAY_GET', 'RUNNING_IN_RAY_WAIT', 'FINISHED', 'FAILED']#
The state of the task.
Refer to src/ray/protobuf/common.proto for a detailed explanation of the state breakdowns and typical state transition flow.
- actor_id: str | None#
The actor id that’s associated with this task. It is empty if there’s no relevant actors.
- type: Literal['NORMAL_TASK', 'ACTOR_CREATION_TASK', 'ACTOR_TASK', 'DRIVER_TASK']#
The type of the task.
NORMAL_TASK: Tasks created by
func.remote()`
ACTOR_CREATION_TASK: Actors created by
class.remote()
ACTOR_TASK: Actor tasks submitted by
actor.method.remote()
DRIVER_TASK: Driver (A script that calls
ray.init
).
- func_or_class_name: str#
The name of the task. If is the name of the function if the type is a task or an actor task. It is the name of the class if it is a actor scheduling task.
- parent_task_id: str#
The parent task id. If the parent is a normal task, it will be the task’s id. If the parent runs in a concurrent actor (async actor or threaded actor), it will be the actor’s creation task id.
- node_id: str | None#
Id of the node that runs the task. If the task is retried, it could contain the node id of the previous executed task. If empty, it means the task hasn’t been scheduled yet.
- events: List[dict] | None = None#
The list of events of the given task. Refer to src/ray/protobuf/common.proto for a detailed explanation of the state breakdowns and typical state transition flow.
- end_time_ms: int | None = None#
The time when the task is finished or failed. A Unix timestamp in ms.