Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ray-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

For on-premises hardware, use the local provider with a static list of hosts. The launcher SSHes into each host, installs Ray, and starts the head and worker processes.

Cluster config

cluster_name: ray-onprem
provider:
  type: local
  head_ip: 10.0.0.1
  worker_ips:
    - 10.0.0.2
    - 10.0.0.3
    - 10.0.0.4
auth:
  ssh_user: ray
  ssh_private_key: ~/.ssh/id_rsa
min_workers: 3
max_workers: 3
file_mounts:
  /home/ray/code: ./code
setup_commands:
  - pip install -U "ray[default]==2.43.0"

Bring it up

ray up onprem.yaml

SLURM and other schedulers

For HPC environments, use the SLURM integration:
ray slurm submit my_job.sbatch
Ray includes templates for SLURM, LSF, PBS, and Spark integrations.

Next steps

Best practices

Production tuning.

Logging

Where logs go on VM clusters.