Ray currently officially supports x86_64, aarch64 (ARM) for Linux, and Apple silicon (M1) hardware. Ray on Windows is currently in beta.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.
Install with pip
The simplest way to install Ray is from PyPI.The default install does not include the dashboard, cluster launcher, or runtime environment dependencies. For most use cases, install
ray[default] or pick the extras you need.Available extras
| Extra | Includes |
|---|---|
default | Core Ray, dashboard, cluster launcher, log aggregation |
data | Ray Data |
train | Ray Train |
tune | Ray Tune |
serve | Ray Serve |
serve-grpc | Ray Serve with gRPC support |
rllib | RLlib for reinforcement learning |
client | Ray Client (deprecated, prefer Ray Jobs) |
observability | Ray observability tooling |
all | All of the above |
Install nightly builds
Nightly releases are tested via automation but do not undergo full release-process review. Use them for previewing upcoming features.Install from a specific commit
To pin to a specific Ray commit, replace<COMMIT_HASH> and the wheel filename with the values for your platform:
Run Ray with Docker
The official Ray image is published on Docker Hub.rayproject/ray— base Ray image with CPU supportrayproject/ray-ml— Ray plus common ML libraries (PyTorch, TensorFlow, scikit-learn)rayproject/ray:<version>-gpu— CUDA-enabled images
Install on macOS Apple silicon
Ray supports Apple silicon natively. Install with pip as usual:xcode-select --install.
Install on Windows
Install Visual C++ Build Tools, then:Build from source
To contribute to Ray or install a development version, build from source.Install build dependencies
Follow the instructions in
BUILD.rst for your platform. You’ll need Bazel, a C++ compiler, and Python development headers.Verify the installation
Next steps
Quickstart
Run your first Ray program.
Ray Core walkthrough
Learn the core Ray API.