Skip to content

Commit

Permalink
DOC: rework conda section
Browse files Browse the repository at this point in the history
  • Loading branch information
mattip committed Nov 14, 2022
1 parent 4d654e3 commit a5e6e0e
Showing 1 changed file with 22 additions and 38 deletions.
60 changes: 22 additions & 38 deletions doc/source/ray-overview/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Installing Ray
==============

Ray currently officially supports x86_64 hardware.
Ray currently officially supports x86_64 and Apple silicon (M1) hardware.
Ray on Windows is currently in beta.

Official Releases
Expand Down Expand Up @@ -31,32 +31,6 @@ To install Ray libraries:
pip install -U "ray[rllib]" # installs Ray + dependencies for Ray RLlib
pip install -U "ray[serve]" # installs Ray + dependencies for Ray Serve
From conda-forge
~~~~~~~~~~~~~~~~
Ray can also be installed as a conda package on linux and windows

.. code-block:: bash
conda create -c conda-forge python=3.9 -n ray_dev
conda activate ray_dev
# Install Ray with support for the dashboard + cluster launcher
conda install -c condaforge "ray-default"
# Install Ray with minimal dependencies
# conda install -c conda-forge ray
To install Ray libraries:

.. 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
.. _install-nightlies:

Daily Releases (Nightlies)
Expand Down Expand Up @@ -278,30 +252,40 @@ on the AUR page of ``python-ray`` `here`_.

.. _ray_anaconda:

Installing Ray with Anaconda
----------------------------
Installing From conda-forge
---------------------------
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_dev
conda activate ray_dev
# Install Ray with support for the dashboard + cluster launcher
conda install -c condaforge "ray-default"
# Install Ray with minimal dependencies
# conda install -c conda-forge ray
If you use `Anaconda`_ (`installation instructions`_) and want to use Ray in a defined environment, e.g, ``ray``, use these commands:
To install Ray libraries, you can use ``pip`` as above or ``conda``/``mamba``

.. code-block:: bash
conda config --env --add channels conda-forge
conda create -n ray # works with mamba too
conda activate ray
pip install ray # or `conda install ray-core`
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 a5e6e0e

Please sign in to comment.