Skip to content

[Doc] Update pip install instruction for testing dependencies #17963

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

Closed
wants to merge 2 commits into from
Closed

[Doc] Update pip install instruction for testing dependencies #17963

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8b955c
[Doc] Update pip install instruction for testing dependencies
ztang2370 May 11, 2025
6db29dc
add comment
ztang2370 May 18, 2025
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
4 changes: 3 additions & 1 deletion docs/source/contributing/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ Check out the [building from source](#build-from-source) documentation for detai
## Testing

```bash
pip install -r requirements/dev.txt
# The following command assumes CUDA 12.8. For CPU-only, other CUDA versions,
# or ROCm, etc., adjust the torch installation as needed.
Copy link
Contributor Author

@ztang2370 ztang2370 May 18, 2025

Choose a reason for hiding this comment

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

Hi there, I added the comment to make it clearer.
@DarkLight1337 @houseroad @mgoin

pip install -r requirements/dev.txt --extra-index-url https://download.pytorch.org/whl/cu128
Copy link
Member

@DarkLight1337 DarkLight1337 May 12, 2025

Choose a reason for hiding this comment

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

This only applies for developers using CUDA though. How about other backends?

Copy link
Contributor Author

@ztang2370 ztang2370 May 12, 2025

Choose a reason for hiding this comment

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

Thanks for pointing this out! However, since torch==2.7.0+cu128 is now specified in requirements/test.txt (updated via #17576 last week), installing it requires access to the PyTorch CUDA 12.8 wheels via pip install -r requirements/dev.txt --extra-index-url https://download.pytorch.org/whl/cu128. I can think of 2 options:

  1. Make requirements/test.txt backend-agnostic:
    Change requirements/test.txt back to use a backend-neutral spec:
    torch==2.7.0
    Developers using cuda can then install their desired CUDA variant manually, e.g.:
    pip install torch==2.7.0+cu128 --extra-index-url https://download.pytorch.org/whl/cu128
    Add a note in the README or contributing guide like:

Note: If you're using CUDA and install torch==2.7.0 without a specific build, it will default to the CUDA 12.6 variant. However, CUDA 12.6 builds currently have known issues. It’s recommended to install the CUDA 12.8 build explicitly. See PyTorch installation guide.

  1. Keep torch==2.7.0+cu128, but document clearly:
    If we keep the CUDA-specific spec in requirements/test.txt, we should update the doc to say:
    pip install -r requirements/dev.txt --extra-index-url https://download.pytorch.org/whl/cu128
    And add a note:

Note: This assumes you're using CUDA 12.8. For other environments (CPU-only, different CUDA versions, ROCm), you may need to adjust the torch installation manually.

Let me know which direction you'd prefer. I'm happy to update the PR accordingly.

Copy link
Member

@DarkLight1337 DarkLight1337 May 12, 2025

Choose a reason for hiding this comment

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

cc @houseroad @mgoin


# Linting, formatting and static type checking
pre-commit install --hook-type pre-commit --hook-type commit-msg
Expand Down