ray.job_submission.JobStatus

class ray.job_submission.JobStatus(value)

Bases: str, enum.Enum

An enumeration for describing the status of a job.

PublicAPI: This API is stable across Ray releases.

PENDING = 'PENDING'

The job has not started yet, likely waiting for the runtime_env to be set up.

RUNNING = 'RUNNING'

The job is currently running.

STOPPED = 'STOPPED'

The job was intentionally stopped by the user.

SUCCEEDED = 'SUCCEEDED'

The job finished successfully.

FAILED = 'FAILED'

The job failed.

is_terminal() → bool

Return whether or not this status is terminal.

A terminal status is one that cannot transition to any other status. The terminal statuses are “STOPPED”, “SUCCEEDED”, and “FAILED”.

Returns

True if this status is terminal, otherwise False.