Skip to content

Commit 694b035

Browse files
authored
Merge branch 'master' into map-expression
2 parents 1fd50f6 + a80f765 commit 694b035

File tree

1 file changed

+42
-49
lines changed

1 file changed

+42
-49
lines changed

docker/ray/README.md

Lines changed: 42 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,52 @@
1-
## About
2-
Default docker images for [Ray](https://github.com/ray-project/ray)! This includes
3-
everything needed to get started with running Ray! They work for both local development and *are ideal* for use with the [Ray Cluster Launcher](https://docs.ray.io/en/master/cluster/cloud.html). [Find the Dockerfile here.](https://github.com/ray-project/ray/blob/master/docker/ray/Dockerfile)
1+
Official container images for [Ray](https://github.com/ray-project/ray).
2+
These images contains working Python virtual environments and required
3+
dependencies to run launche Ray nodes and form Ray clusters.
4+
everything needed to get started with running Ray. One can use the images
5+
for local development, or launch clusters with [Ray VM launcher][vm-launcher],
6+
[KubeRay][kuberay], or running them on [Anyscale][anyscale].
47

5-
## Tags
8+
Source that builds the images are [here][source].
69

7-
Images are `tagged` with the format `{Ray version}[-{Python version}][-{Platform}][-{Architecture}]`. `Ray version` tag can be one of the following:
10+
[vm-launcher]: https://docs.ray.io/en/latest/cluster/vms/index.html
11+
[kuberay]: https://ray-project.github.io/kuberay/
12+
[anyscale]: https://www.anyscale.com/
13+
[source]: https://github.com/ray-project/ray/blob/master/docker/ray/Dockerfile
814

9-
| Ray version tag | Description |
10-
| --------------- | ----------- |
11-
| `latest` | The most recent Ray release. |
12-
| `x.y.z` | A specific Ray release, e.g. 2.9.3 |
13-
| `nightly` | The most recent Ray development build (a recent commit from GitHub `master`) |
15+
## Tags
1416

15-
The optional `Python version` tag specifies the Python version in the image. All Python versions supported by Ray are available, e.g. `py39`, `py310` and `py311`. If unspecified, the tag points to an image using `Python 3.9`.
17+
Images are `tagged` with the format
18+
`{Ray version}[-{Python version}][-{Platform}][-{Architecture}]`.
1619

17-
The optional `Platform` tag specifies the platform where the image is intended for:
20+
`Ray version` tag can be one of the following:
1821

19-
| Platform tag | Description |
22+
| Ray version tag | Description |
2023
| --------------- | ----------- |
21-
| `-cpu` | These are based off of an Ubuntu image. |
22-
| `-cuXX` | These are based off of an NVIDIA CUDA image with the specified CUDA version `xx`. They require the NVIDIA Docker Runtime. |
23-
| `-gpu` | Aliases to a specific `-cuXX` tagged image. |
24-
| no tag | Aliases to `-cpu` tagged images for `ray`, and aliases to ``-gpu`` tagged images for `ray-ml`. |
25-
26-
The optional `Architecture` tag can be used to specify images for different CPU architectures.
27-
Currently, we support the `x86_64` (`amd64`) and `aarch64` (`arm64`) architectures.
28-
29-
Please note that suffixes are only used to specify `aarch64` images. No suffix means
30-
`x86_64`/`amd64`-compatible images.
24+
| `latest` | The most recent Ray release. |
25+
| `x.y.z` | A specific Ray release version, e.g. 2.53.0 |
26+
| `nightly` | The most recent Ray development build (a recent commit from GitHub `master`) |
3127

32-
| Platform tag | Description |
33-
|--------------|-------------------------|
34-
| `-aarch64` | arm64-compatible images |
35-
| no tag | Defaults to `amd64` |
28+
The optional `Python version` tag specifies the Python version in the image.
29+
All Python versions supported by Ray are available, e.g. `py310`, `py311`, and
30+
`py312`. If unspecified, the tag points to an image using `Python 3.10`.
3631

37-
Examples tags:
38-
- none: equivalent to `latest`
39-
- `latest`: equivalent to `latest-py39-cpu`, i.e. image for the most recent Ray release
40-
- `nightly-py39-cpu`
41-
- `806c18-py39-cu112`
42-
- `806c18-py39-cu116-aarch64`
32+
The optional `Platform` tag specifies the platform where the image is intended
33+
for:
4334

44-
## Roadmap
45-
46-
Ray 2.3 will be the first release for which arm64 images are released. These images will have the `-aarch64` suffix.
47-
48-
There won't be a `:latest-aarch64` image, instead `:2.3.0-aarch64` should be used explicitly. This is because
49-
we may remove suffixes in the next release.
50-
51-
For Ray 2.4, we aim to have support for multiplatform images. This means that specifying the suffix
52-
will not be needed anymore - docker will automatically choose a compatible image.
53-
54-
We may stop publishing architecture suffixes completely when we have support for multiplatform images.
55-
56-
There is an open RFC issue on GitHub to discuss this roadmap: [Link to issue](https://github.com/ray-project/ray/issues/31966)
57-
58-
## Other Images
59-
* [`rayproject/ray-ml`](https://hub.docker.com/repository/docker/rayproject/ray-ml) - This image with common ML libraries to make development & deployment more smooth!
35+
| Platform tag | Description |
36+
| --------------- | ----------- |
37+
| `-cpu` | Based off of an Ubuntu image. |
38+
| `-cuXX` | Based off of an NVIDIA CUDA image with the specified CUDA version `xx`. They require the NVIDIA Docker Runtime. |
39+
| `-gpu` | Aliases to a specific `-cuXX` tagged image. |
40+
| no tag | Aliases to `-cpu` tagged images. |
41+
42+
The optional `Architecture` tag can be used to specify images for different CPU
43+
architectures. Currently, we support the `x86_64` (`amd64`) and `aarch64`
44+
(`arm64`) architectures.
45+
46+
Please note that suffixes are only used to specify `aarch64` images.
47+
No suffix means that it is a multi-platform image index.
48+
49+
| Platform tag | Description |
50+
|--------------|-----------------------------|
51+
| no tag | Multi-platform image index. |
52+
| `-aarch64` | arm64-compatible images |

0 commit comments

Comments
 (0)