[docs] Add contributor guide for editing and managing Python dependencies#63547
Open
ans9868 wants to merge 4 commits into
Open
[docs] Add contributor guide for editing and managing Python dependencies#63547ans9868 wants to merge 4 commits into
ans9868 wants to merge 4 commits into
Conversation
…cies Signed-off-by: Adel Nour <ans9868@nyu.edu>
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation guide, dependency-management.md, which provides a comprehensive overview of Ray's three-layer Python dependency structure (Source, Compiled, and Locks). It also includes instructions for updating dependencies and troubleshooting resolution conflicts using tools like uv. The review feedback identifies minor typographical errors, trailing whitespace, and capitalization inconsistencies for terms like 'Python', 'Ray', and 'uv'.
7 tasks
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Nour999 <130527901+ans9868@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Nour999 <130527901+ans9868@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: Nour999 <130527901+ans9868@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a contributor guide for editing and managing Ray's Python dependencies. Covers the three-layer architecture (source files → compiled requirements → per-image lock files), how to add or update a dependency, how to diagnose conflicts with
uvvspip, and the edge cases that bite contributors (ARM64 skip, platform-specific CPU vs GPU wheels, Wanda Docker cache invalidation,requirements.txt↔setup.pysync requirement).Why
Completes item 4 of #60512. I had to map out the dependency structure and hit most of the gotchas described here while landing #60522 (modernizing AxSearch for ax-platform 1.0+). This doc is meant to keep the next contributor out of those holes.
Scope
Two files, pure docs change. No build-system changes, no lock regeneration needed.
doc/source/ray-contribute/dependency-management.md(new)doc/source/ray-contribute/getting-involved.rst(one-line toctree entry)The page slots into the Getting Involved / Contributing sidebar between "CI Testing Workflow on PRs" and "Contributing to the Ray Documentation."
Built locally with
make developunder-W(warnings-as-errors). There are no Sphinx warnings on the new file.Miscellaneous
The framing of this doc borrows from @elliot-barn's ray-dependencies skill on the
elliot-barn-dependencies-skillbranch, especially therequirements.txt↔setup.pysync rule.@aslonnie / @elliot-barn -- you were both deep in the dependency issues during #60522 (and the related side-quest PRs I opened along the way, #62596 and #62471). Happy to have either of you review if you have time.