Sign in

Submit Job

Submit a job to the cluster.

post/api/jobs

Request body

entrypointstring required

Command to start execution, ex: 'python script.py'

submission_idstring

Optional submission_id to specify for the job.

job_idstring

Optional job_id to specify for the job.

runtime_envobject

The runtime environment for the job.

metadataobject

Arbitrary user-provided metadata for the job.

entrypoint_num_cpusnumber

Number of CPUs to allocate for the execution of the entrypoint command, separately from any Ray tasks or actors that are created by it.

entrypoint_num_gpusnumber

Number of GPUs to allocate for the execution of the entrypoint command, separately from any Ray tasks or actors that are created by it.

entrypoint_memoryinteger

The quantity of memory to reserve for the execution of the entrypoint command, separately from any tasks or actors launched by it.

entrypoint_resourcesobject

The quantity of various custom resources to allocate for the execution of the entrypoint command, separately from any Ray tasks or actors that are created by it.

Response

The ID of the submitted job.

job_idstring

The ID of the submitted job.

submission_idstring

The ID of the submitted job.

Changes

Changed in 2 of the 7 revisions of this API.11