Python SDK API Reference

For an overview with examples see Ray Jobs.

For the CLI reference see Ray Job Submission CLI Reference.

JobSubmissionClient

JobSubmissionClient([address, ...])

A local client for submitting and interacting with jobs on a remote cluster.

JobSubmissionClient.submit_job(*, entrypoint)	Submit and execute a job asynchronously.
JobSubmissionClient.stop_job(job_id)	Request a job to exit asynchronously.
JobSubmissionClient.get_job_status(job_id)	Get the most recent status of a job.
JobSubmissionClient.get_job_info(job_id)	Get the latest status and other information associated with a job.
JobSubmissionClient.list_jobs()	List all jobs along with their status and other information.
JobSubmissionClient.get_job_logs(job_id)	Get all logs produced by a job.
JobSubmissionClient.tail_job_logs(job_id)	Get an iterator that follows the logs of a job.

JobStatus

JobStatus(value)

An enumeration for describing the status of a job.

JobInfo

JobInfo(status, entrypoint[, message, ...])

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

JobDetails

JobDetails

Job data with extra details about its driver and its submission.

JobType

JobType(value)

An enumeration for describing the different job types.

DriverInfo

DriverInfo

A class for recording information about the driver related to the job.