Skip to content

Commit

Permalink
[Doc] [KubeRay] Add new RayJob arguments RuntimeEnvYAML, entrypoint_n…
Browse files Browse the repository at this point in the history
…um_cpus/gpus/resources (ray-project#39088)

Ports over new RayJob arguments from the KubeRay doc https://ray-project.github.io/kuberay/guidance/rayjob/ to the Ray docs.

---------

Signed-off-by: Archit Kulkarni <[email protected]>
  • Loading branch information
architkulkarni committed Sep 6, 2023
1 parent c20103f commit d5fdce4
Showing 1 changed file with 5 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,14 @@ A RayJob manages two aspects:
* `rayClusterSpec` - The spec for the **RayCluster** to run the job on.
* `jobId` - _(Optional)_ Job ID to specify for the job. If not provided, one will be generated.
* `metadata` - _(Optional)_ Arbitrary user-provided metadata for the job.
* `runtimeEnv` - _(Optional)_ base64-encoded string of the runtime env json string.
* `runtimeEnvYAML` - _(Optional)_ The runtime environment configuration provided as a multi-line YAML string. _(New in KubeRay version 1.0.)_
* `shutdownAfterJobFinishes` - _(Optional)_ whether to recycle the cluster after the job finishes. Defaults to false.
* `ttlSecondsAfterFinished` - _(Optional)_ TTL to clean up the cluster. This only works if `shutdownAfterJobFinishes` is set.
* `submitterPodTemplate` - _(Optional)_ Pod template spec for the pod that runs `ray job submit` against the Ray cluster.
* `entrypointNumCpus` - _(Optional)_ Specifies the quantity of CPU cores to reserve for the entrypoint command. _(New in KubeRay version 1.0.)_
* `entrypointNumGpus` - _(Optional)_ Specifies the number of GPUs to reserve for the entrypoint command. _(New in KubeRay version 1.0.)_
* `entrypointResources` - _(Optional)_ A json formatted dictionary to specify custom resources and their quantity. _(New in KubeRay version 1.0.)_
* `runtimeEnv` - [DEPRECATED] _(Optional)_ base64-encoded string of the runtime env json string.

## Example: Run a simple Ray job with RayJob

Expand Down

0 comments on commit d5fdce4

Please sign in to comment.