Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: mention conda-forge ray packages and x86_64 support #30237

Merged
merged 4 commits into from
Nov 17, 2022
Merged

DOC: mention conda-forge ray packages and x86_64 support #30237

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cbf4fd1
DOC: mention conda-forge ray packages and x86_64 support
mattip Nov 13, 2022
4d654e3
fixes from review
mattip Nov 14, 2022
622957e
DOC: rework conda section
mattip Nov 14, 2022
8f70505
fixes from review
mattip Nov 15, 2022
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
33 changes: 31 additions & 2 deletions doc/source/ray-overview/installation.rst
View file
Open in desktop
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 hardware.
Copy link
Collaborator

Choose a reason for hiding this comment

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

We also supports mac M1 in pypi packages.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

+1

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 All @@ -28,6 +31,32 @@ 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
Copy link
Collaborator

Choose a reason for hiding this comment

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

We already have a section down below called Installing Ray with Anaconda.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oy, I missed that, sorry. I will redo this to improve that documentation since it is not really Anaconda but the conda-forge open source channel that provides ray. Anaconda provides the hosting, but people need to use the -c conda-forge channel.

Copy link
Collaborator

Choose a reason for hiding this comment

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

sg!

~~~~~~~~~~~~~~~~
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]"
Copy link

Choose a reason for hiding this comment

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

Suggested change
# Install Ray with support for the dashboard + cluster launcher
conda install -c condaforge "ray[default]"
# Install Ray with support for the dashboard + cluster launcher
conda install -c conda-forge "ray-default"

Conda doesn't support the [optional] syntax, which is why we need to use separate outputs.


# 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
Copy link

Choose a reason for hiding this comment

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

Same here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, fixed




.. _install-nightlies:

Daily Releases (Nightlies)
Expand Down