docs(pyproject): clarify uv is required for installation#441
Open
x4v13r64 wants to merge 1 commit into
Open
Conversation
Adds a comment above the [tool.uv.sources] block in the four pyproject.toml files that pin packages to the PyTorch XPU wheel index. The note explains that uv must be used to install these samples because vanilla pip does not parse [tool.uv.sources] / [[tool.uv.index]] and will not find the XPU wheels on PyPI. The READMEs already say to use uv, but the pyproject is what a developer reads when they're already poking at the codebase, so making the requirement local to the file helps anyone who tries pip first.
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
1 participant
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.
The four samples that pin packages to the PyTorch XPU wheel index (
Finetune_Image_Captioning,Genre-driven-storytelling,LLM/PyTorch,AI-Upscaling-With-NPU) rely on[tool.uv.sources]+[[tool.uv.index]]to resolvetorch,torchvision,torchaudio, andpytorch-triton-xpufromhttps://download.pytorch.org/whl/xpu. Vanilla pip does not parse these blocks, so a developer who runspip install -e .instead ofuv syncwill not find the XPU wheels (they are not on PyPI).The READMEs already document
uvas the install tool for three of the four directories, but the pyproject is what someone reads when they are already inside the codebase. Adding a one-paragraph note above the[tool.uv.sources]block makes the requirement local to the file, so anyone who reaches forpipfirst sees why it will not work.Pure-comment change: no behavior, no dependency, no formatting touched.