Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/source/ray-contribute/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Create a virtual environment to prevent version conflicts and to develop with an

.. code-block:: shell

conda create -c conda-forge python=3.9 -n myenv
conda create -c conda-forge python=3.10 -n myenv
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While updating the Python version to 3.10 here is correct, this file contains another reference to Python 3.9 that was missed. To maintain consistency, please also update the example for installing development wheels.

Specifically, on lines 95-96:

# For example, for Python 3.9:
pip install -U https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp39-cp39-manylinux2014_x86_64.whl

This should be updated to Python 3.10 and use a cp310 wheel.



Activate your virtual environment to tell the shell/terminal to use this particular Python:
Expand Down Expand Up @@ -92,8 +92,8 @@ RLlib, Tune, Autoscaler, and most Python files do not require you to build and c

.. code-block:: shell

# For example, for Python 3.9:
pip install -U https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp39-cp39-manylinux2014_x86_64.whl
# For example, for Python 3.10:
pip install -U https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp310-cp310-manylinux2014_x86_64.whl

4. Replace Python files in the installed package with your local editable copy. We provide a simple script to help you do this: ``python python/ray/setup-dev.py``. Running the script will remove the ``ray/tune``, ``ray/rllib``, ``ray/autoscaler`` dir (among other directories) bundled with the ``ray`` pip package, and replace them with links to your local code. This way, changing files in your git clone will directly affect the behavior of your installed Ray.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Create a new virtual environment and install dependencies.
.. testcode::
:skipif: True

conda create -n myenv python=3.9
conda create -n myenv python=3.10
conda activate myenv
pip install "ray[default]" debugpy

Expand Down
17 changes: 5 additions & 12 deletions doc/source/ray-overview/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ You can install the nightly Ray wheels via the following links. These daily rele
=============================================== ================================================
Linux (x86_64) Linux (arm64/aarch64)
=============================================== ================================================
`Linux Python 3.9 (x86_64)`_ `Linux Python 3.9 (aarch64)`_
`Linux Python 3.10 (x86_64)`_ `Linux Python 3.10 (aarch64)`_
`Linux Python 3.11 (x86_64)`_ `Linux Python 3.11 (aarch64)`_
`Linux Python 3.12 (x86_64)`_ `Linux Python 3.12 (aarch64)`_
Expand All @@ -116,7 +115,6 @@ You can install the nightly Ray wheels via the following links. These daily rele
:header-rows: 1

* - MacOS (arm64)
* - `MacOS Python 3.9 (arm64)`_
* - `MacOS Python 3.10 (arm64)`_
* - `MacOS Python 3.11 (arm64)`_
* - `MacOS Python 3.12 (arm64)`_
Expand All @@ -128,7 +126,6 @@ You can install the nightly Ray wheels via the following links. These daily rele
:header-rows: 1

* - Windows (beta)
* - `Windows Python 3.9 (amd64)`_
* - `Windows Python 3.10 (amd64)`_
* - `Windows Python 3.11 (amd64)`_
* - `Windows Python 3.12 (amd64)`_
Expand All @@ -144,27 +141,23 @@ You can install the nightly Ray wheels via the following links. These daily rele

.. If you change the list of wheel links below, remember to update `get_wheel_filename()` in `https://github.com/ray-project/ray/blob/master/python/ray/_private/utils.py`.

.. _`Linux Python 3.9 (x86_64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp39-cp39-manylinux2014_x86_64.whl
.. _`Linux Python 3.10 (x86_64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp310-cp310-manylinux2014_x86_64.whl
.. _`Linux Python 3.11 (x86_64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp311-cp311-manylinux2014_x86_64.whl
.. _`Linux Python 3.12 (x86_64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp312-cp312-manylinux2014_x86_64.whl
.. _`Linux Python 3.13 (x86_64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp313-cp313-manylinux2014_x86_64.whl

.. _`Linux Python 3.9 (aarch64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp39-cp39-manylinux2014_aarch64.whl
.. _`Linux Python 3.10 (aarch64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp310-cp310-manylinux2014_aarch64.whl
.. _`Linux Python 3.11 (aarch64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp311-cp311-manylinux2014_aarch64.whl
.. _`Linux Python 3.12 (aarch64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp312-cp312-manylinux2014_aarch64.whl
.. _`Linux Python 3.13 (aarch64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp313-cp313-manylinux2014_aarch64.whl


.. _`MacOS Python 3.9 (arm64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp39-cp39-macosx_12_0_arm64.whl
.. _`MacOS Python 3.10 (arm64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp310-cp310-macosx_12_0_arm64.whl
.. _`MacOS Python 3.11 (arm64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp311-cp311-macosx_12_0_arm64.whl
.. _`MacOS Python 3.12 (arm64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp312-cp312-macosx_12_0_arm64.whl
.. _`MacOS Python 3.13 (arm64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp313-cp313-macosx_12_0_arm64.whl


.. _`Windows Python 3.9 (amd64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp39-cp39-win_amd64.whl
.. _`Windows Python 3.10 (amd64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp310-cp310-win_amd64.whl
.. _`Windows Python 3.11 (amd64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp311-cp311-win_amd64.whl
.. _`Windows Python 3.12 (amd64)`: https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp312-cp312-win_amd64.whl
Expand All @@ -178,11 +171,11 @@ You can install the Ray wheels of any particular commit on ``master`` with the f

pip install https://s3-us-west-2.amazonaws.com/ray-wheels/master/{COMMIT_HASH}/ray-{RAY_VERSION}-{PYTHON_VERSION}-{PYTHON_VERSION}-{OS_VERSION}.whl

For example, here are the Ray 3.0.0.dev0 wheels for Python 3.9, MacOS for commit ``4f2ec46c3adb6ba9f412f09a9732f436c4a5d0c9``:
For example, here are the Ray 3.0.0.dev0 wheels for Python 3.10, MacOS for commit ``4f2ec46c3adb6ba9f412f09a9732f436c4a5d0c9``:

.. code-block:: bash

pip install https://s3-us-west-2.amazonaws.com/ray-wheels/master/4f2ec46c3adb6ba9f412f09a9732f436c4a5d0c9/ray-3.0.0.dev0-cp39-cp39-macosx_12_0_arm64.whl
pip install https://s3-us-west-2.amazonaws.com/ray-wheels/master/4f2ec46c3adb6ba9f412f09a9732f436c4a5d0c9/ray-3.0.0.dev0-cp310-cp310-macosx_12_0_arm64.whl

There are minor variations to the format of the wheel filename; it's best to match against the format in the URLs listed in the :ref:`Nightlies section <install-nightlies>`.
Here's a summary of the variations:
Expand Down Expand Up @@ -273,7 +266,7 @@ Ray can also be installed as a conda package on Linux and Windows.
.. code-block:: bash

# also works with mamba
conda create -c conda-forge python=3.9 -n ray
conda create -c conda-forge python=3.10 -n ray
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This change is good for recommending Python 3.10. However, to avoid confusion, other parts of this document should also be updated. The file still contains multiple references to Python 3.9, especially in the "Daily Releases (Nightlies)" section and in examples.

For instance:

  • The tables of nightly wheels (lines 106, 119, 131) still list Python 3.9.
  • The example for installing from a specific commit (lines 181-185) uses a Python 3.9 wheel.

If Python 3.9 support is being phased out, it would be best to update these references to Python 3.10 or remove them to ensure the documentation is consistent.

conda activate ray

# Install Ray with support for the dashboard + cluster launcher
Expand Down Expand Up @@ -332,7 +325,7 @@ Images are `tagged` with the format ``{Ray version}[-{Python version}][-{Platfor
* - nightly
- The most recent Ray development build (a recent commit from Github ``master``)

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 of the lowest Python version that the Ray version supports.
The optional ``Python version`` tag specifies the Python version in the image. All Python versions supported by Ray are available, e.g. ``py310``, ``py311`` and ``py312``. If unspecified, the tag points to an image of the lowest Python version that the Ray version supports.

The optional ``Platform`` tag specifies the platform where the image is intended for:

Expand All @@ -351,7 +344,7 @@ The optional ``Platform`` tag specifies the platform where the image is intended
* - <no tag>
- Aliases to ``-cpu`` tagged images.

Example: for the nightly image based on ``Python 3.9`` and without GPU support, the tag is ``nightly-py39-cpu``.
Example: for the nightly image based on ``Python 3.10`` and without GPU support, the tag is ``nightly-py310-cpu``.

If you want to tweak some aspects of these images and build them locally, refer to the following script:

Expand Down