Before you can start using on-demand Ray clusters on Domino you must ensure that this functionality is enabled and properly configured on your deployment.
Domino Administrators must Enable on-demand Ray functionality by setting the ShortLived.RayClustersEnabled feature flag to true.
The flag is on by default unless a Domino Administrator disables it for a deployment.
By default, Domino does not include a Ray compatible Compute Environment that can be used for the components of the cluster. Without at least one such environment available, you cannot create a cluster.
When using on-demand Ray in Domino you will have two separate environments, one for the Ray cluster (base or worker environment) and one for the workspace/job execution (compute environment).
To create a new base Ray cluster environment, follow the
general
Environment Management with
the following environment_attributes.
-
Base image
Select the Custom Image option and enter an image URI that points to a deployable Ray image.
Domino recommends that you use the latest release tag for your version of Ray from the options published by the Ray project at https://hub.docker.com/u/rayproject.
The images available include a core image as well as an image with all required prerequisites for ML workload. Additionally, the images are available for different python versions, as well as for CPU and GPU variants.
For example, for Ray 1.3.0 and Python 3.8 the options are:
-
rayproject/ray:1.3.0-py38 -
rayproject/ray:1.3.0-py38-gpu -
rayproject/ray-ml:1.3.0-py38 -
rayproject/ray-ml:1.3.0-py38-gpu
-
-
Supported clusters
Select Domino managed Ray (Required). This ensures that the environment will be available for use when creating Ray clusters from workspaces and jobs.
-
Visibility
You can set this attribute the same way you would for any other Compute Environment based on your desired visibility.
-
Dockerfile Instructions
Leave blank to use the images as provided by Ray project.
You can modify this section to include additional packages that might be necessary for your workloads and must be available on the Ray cluster nodes.
To learn more, see Managing Dependencies
-
Pluggable Notebooks / Workspace Sessions
Leave this section blank because the Ray base environments are not intended to include notebook configuration.
In addition to the base Ray cluster environment, you must configure the Ray compute environments for workspaces and/or jobs that will connect to your cluster.
Domino recommends that you use the following base image to create a compatible workspace: quay.io/domino/ray-environment. See Domino Ray Environment for more information about this base image.
-
Use the image mentioned previously and add Docker Instructions.
-
Use your own image and customizations. Then, use the following Docker Instructions to add the Ray packages.
USER root ### Change Ray version as needed. ENV RAY_VERSION=<ENTER_RAY_VERSION> ### If you want install Ray RLlib or "all", which includes it, you must ### install "cmake" first. RUN sudo apt-get install -y cmake ### Change this depending on which Ray extras you want to install: ### All options are ray, ray[tune], ray[rllib], ray[serve] ### If you want everything you can just use ray[all]. ### See note above the "cmake" is required for ray[rllib] or ray[all]. RUN pip install ray[all]==$RAY_VERSION ### Add any additional packages that you may need which are not included ### in the base image you are using for the compute environment. You would ### want the versions of these to match the versions of these packages on ### the base Ray cluster image. ### For example, for Torch you may include ### RUN pip install torch==1.8.0 torchvision==0.9.0 USER ubuntu