ray.job_submission.JobInfo#

class ray.job_submission.JobInfo(status: JobStatus, entrypoint: str, message: str | None = None, error_type: str | None = None, start_time: int | None = None, end_time: int | None = None, metadata: Dict[str, str] | None = None, runtime_env: Dict[str, Any] | None = None, entrypoint_num_cpus: int | float | None = None, entrypoint_num_gpus: int | float | None = None, entrypoint_memory: int | None = None, entrypoint_resources: Dict[str, float] | None = None, driver_agent_http_address: str | None = None, driver_node_id: str | None = None, driver_exit_code: int | None = None)[source]#

A class for recording information associated with a job and its execution.

Please keep this in sync with the JobsAPIInfo proto in src/ray/protobuf/gcs.proto.

Methods

from_json

Initialize this object from a JSON dictionary.

to_json

Convert this object to a JSON-serializable dictionary.

Attributes

driver_agent_http_address

Driver agent http address

driver_exit_code

The driver process exit code after the driver executed.

driver_node_id

end_time

The time when the job moved into a terminal state.

entrypoint_memory

The amount of memory for workers requesting memory for the entrypoint command.

entrypoint_num_cpus

The quantity of CPU cores to reserve for the entrypoint command.

entrypoint_num_gpus

The number of GPUs to reserve for the entrypoint command.

entrypoint_resources

The quantity of various custom resources to reserve for the entrypoint command.

error_type

Internal error, user script error

message

A message describing the status in more detail.

metadata

Arbitrary user-provided metadata for the job.

runtime_env

The runtime environment for the job.

start_time

The time when the job was started.

status

The status of the job.

entrypoint

The entrypoint command for this job.