diff --git a/doc/source/ray-overview/installation.rst b/doc/source/ray-overview/installation.rst index feb987fcabfed..5bd939fe476f3 100644 --- a/doc/source/ray-overview/installation.rst +++ b/doc/source/ray-overview/installation.rst @@ -3,13 +3,16 @@ Installing Ray ============== -Ray currently supports Linux, MacOS and Windows. +Ray currently officially supports x86_64 and Apple silicon (M1) hardware. Ray on Windows is currently in beta. Official Releases ----------------- -You can install the latest official version of Ray as follows. +From Wheels +~~~~~~~~~~~ +You can install the latest official version of Ray from PyPI on linux, windows +and macos as follows: .. code-block:: bash @@ -249,20 +252,33 @@ on the AUR page of ``python-ray`` `here`_. .. _ray_anaconda: -Installing Ray with Anaconda ----------------------------- - -If you use `Anaconda`_ (`installation instructions`_) and want to use Ray in a defined environment, e.g, ``ray``, use these commands: +Installing From conda-forge +--------------------------- +Ray can also be installed as a conda package on linux and windows .. code-block:: bash - conda config --env --add channels conda-forge - conda create -n ray # works with mamba too + # also works with mamba + conda create -c conda-forge python=3.9 -n ray conda activate ray - pip install ray # or `conda install ray-core` + + # Install Ray with support for the dashboard + cluster launcher + conda install -c conda-forge "ray-default" + + # Install Ray with minimal dependencies + # conda install -c conda-forge ray + +To install Ray libraries, you can use ``pip`` as above or ``conda``/``mamba`` + +.. code-block:: bash + + conda install -c conda-forge "ray-air" # installs Ray + dependencies for Ray AI Runtime + conda install -c conda-forge "ray-tune" # installs Ray + dependencies for Ray Tune + conda install -c conda-forge "ray-rllib" # installs Ray + dependencies for Ray RLlib + conda install -c conda-forge "ray-serve" # installs Ray + dependencies for Ray Serve For a complete list of available ``ray`` libraries on Conda-forge, have a look -at: https://github.com/conda-forge/ray-packages-feedstock +at https://anaconda.org/conda-forge/ray-default .. note:: @@ -270,9 +286,6 @@ at: https://github.com/conda-forge/ray-packages-feedstock using a conda environment, it is recommended to install Ray from PyPi using `pip install ray` in the newly created environment. -.. _`Anaconda`: https://www.anaconda.com/ -.. _`installation instructions`: https://docs.anaconda.com/anaconda/install/index.html - Building Ray from Source ------------------------