Skip to content

Commit

Permalink
DOC: mention conda-forge ray packages and x86_64 support (#30237)
Browse files Browse the repository at this point in the history
Recently ray has grown support on conda for 2.0.1 and 2.1.0 is close to release. Mention it in the documentation.

Signed-off-by: mattip <[email protected]>
  • Loading branch information
mattip authored Nov 17, 2022
1 parent 87b821c commit 79d12c0
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions doc/source/ray-overview/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -249,30 +252,40 @@ 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::

Ray conda packages are maintained by the community, not the Ray team. While
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
------------------------

Expand Down

0 comments on commit 79d12c0

Please sign in to comment.