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.

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

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

Merged
merged 4 commits into from
Nov 17, 2022

Conversation

mattip
Copy link
Contributor

@mattip mattip commented Nov 13, 2022

Why are these changes needed?

Recently ray has grown support on conda for 2.0.1 and 2.1.0 is close to release. Mention it in the documentation. Also mention that the official releases only support x86_64 architecture.

Related issue number

Related to #12128, #4309, #7476, #13780 since they all want non-x86_64 binary builds which are currently not available.

Related to conda-forge/ray-packages-feedstock#78 (for 2.1.0 on conda-forge) and conda-forge/ray-packages-feedstock#80 (for macos on conda-forge).

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@mattip mattip requested a review from a team as a code owner November 13, 2022 15:09
Comment on lines 43 to 44
# Install Ray with support for the dashboard + cluster launcher
conda install -c condaforge "ray[default]"

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.

Comment on lines 53 to 56
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

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

Signed-off-by: mattip <[email protected]>
@@ -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

@@ -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!


If you use `Anaconda`_ (`installation instructions`_) and want to use Ray in a defined environment, e.g, ``ray``, use these commands:
# Install Ray with support for the dashboard + cluster launcher
conda install -c condaforge "ray-default"
Copy link
Collaborator

Choose a reason for hiding this comment

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

conda-forge?

.. code-block:: bash

# also works with mamba
conda create -c conda-forge python=3.9 -n ray_dev
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: ray_dev -> ray

@jjyao jjyao merged commit 79d12c0 into ray-project:master Nov 17, 2022
WeichenXu123 pushed a commit to WeichenXu123/ray that referenced this pull request Dec 19, 2022
…#30237)

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]>
Signed-off-by: Weichen Xu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants