Skip to content

[doc] wheel: update steps for building and installing #58457

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

[doc] wheel: update steps for building and installing #58457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 2 additions & 9 deletions doc/source/ray-contribute/development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,15 +204,8 @@ Enter into the ``python/`` directory inside of the Ray project directory and ins

.. code-block:: bash

# Install Ray.
cd python/
# Install required dependencies.
pip install -r requirements.txt
# You may need to set the following two env vars if you have a macOS ARM64(M1) platform.
# See https://github.com/grpc/grpc/issues/25082 for more details.
# export GRPC_PYTHON_BUILD_SYSTEM_OPENSSL=1
# export GRPC_PYTHON_BUILD_SYSTEM_ZLIB=1
pip install -e . --verbose # Add --user if you see a permission denied error.
# Build Ray wheels; install Ray and required dependencies in editable mode.
pip wheel -v -c python/requirements_compiled.txt -w .whl -e python
Copy link

@cursor cursor bot Nov 7, 2025

Choose a reason for hiding this comment

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

Bug: pip wheel: Build, Not Install

The command pip wheel -v -c python/requirements_compiled.txt -w .whl -e python only builds wheel files but doesn't install Ray. The pip wheel command creates wheel files in the .whl directory without installing them, so Ray won't be available for development. The comment claims it "install[s] Ray and required dependencies in editable mode" and the explanation states changes will "take effect without reinstalling" which is incorrect since nothing gets installed. The CI scripts show both pip install -v -e python and pip wheel -e python -w .whl are needed as separate steps.

Fix in Cursor Fix in Web

Copy link
Collaborator Author

@aslonnie aslonnie Nov 7, 2025

Choose a reason for hiding this comment

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

this is more correct..

more work to do.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 7, 2025

Choose a reason for hiding this comment

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

critical

The command as written is invalid because pip wheel does not support the -e (--editable) flag. This appears to mix options from pip wheel (-w) and pip install (-e) and will cause the command to fail.

To install Ray in editable mode, you should use pip install. If you also need to build wheels into a directory, that would be a separate pip wheel command. Assuming the primary goal is the editable install, here's a corrected command:

Suggested change
pip wheel -v -c python/requirements_compiled.txt -w .whl -e python
pip install -v -c python/requirements_compiled.txt -e python

Copy link
Collaborator Author

@aslonnie aslonnie Nov 7, 2025

Choose a reason for hiding this comment

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

https://pip.pypa.io/en/stable/cli/pip_wheel/#cmdoption-e

wake up, gemini!

Comment on lines +207 to +208
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 7, 2025

Choose a reason for hiding this comment

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

high

The instruction in the line preceding this code block, Enter into the ``python/`` directory..., is now inconsistent with the new command. The paths used here (e.g., python/requirements_compiled.txt and -e python) indicate that the command should be run from the project's root directory, not from within the python/ directory.

To prevent user confusion, please update the instructional text. For example:
From the Ray project root directory, run the following command to build and install Ray:


The ``-e`` means "editable", so changes you make to files in the Ray
directory will take effect without reinstalling the package.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/ray-contribute/getting-involved.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Getting Involved / Contributing
profiling

Ray is more than a framework for distributed applications but also an active community of developers,
researchers, and folks that love machine learning.
researchers, and people who love machine learning.

.. tip:: Ask questions on `our forum <https://discuss.ray.io/>`_! The
community is extremely active in helping people succeed in building their
Expand Down