Skip to content

Conversation

@davidxia
Copy link
Contributor

@davidxia davidxia commented Jun 30, 2025

for consistency since uv is now recommended instead of pip for this project.

Put existing pip install commands into collapsed sections.

Slack thread

@github-actions
Copy link

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging.

To run CI, PR reviewers can either: Add ready label to the PR or enable auto-merge.

🚀

@davidxia davidxia marked this pull request as ready for review June 30, 2025 19:50
@davidxia davidxia requested a review from hmellor as a code owner June 30, 2025 19:50
@mergify mergify bot added the documentation Improvements or additions to documentation label Jun 30, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @davidxia, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request updates the GPU installation documentation to consistently recommend and use uv instead of pip for installing vLLM and its dependencies. This change ensures that the documentation reflects the project's current best practices and provides users with the most up-to-date installation instructions.

Highlights

  • Documentation Update: Replaced instances of pip with uv pip in the GPU installation documentation to align with the project's recommendation of using uv for package management.
  • Installation Instructions: Updated the installation instructions for pre-built wheels, latest code, specific revisions, and building from source to use uv pip instead of pip.
  • PyTorch Installation: Modified the instructions for using an existing PyTorch installation to recommend uv pip for installing PyTorch nightly builds.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the GPU installation documentation to consistently use uv instead of pip. I've identified a potential issue with the updated commands for installing nightly PyTorch builds, which could lead to installation failures, and a suggestion to improve the documentation regarding ccache.

Copy link
Member

@hmellor hmellor left a comment

Choose a reason for hiding this comment

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

I'm fine with reducing the complexity of the document by removing dedicated pip/uv sections. But I think we should keep some of the more important information about using pip in collapsed admonitions.

For example

```bash
uv pip install -U vllm \
    --torch-backend=auto \
    --extra-index-url https://wheels.vllm.ai/nightly
```

??? console "pip"
    ```bash
    pip install -U vllm \
        --pre \
        --extra-index-url https://wheels.vllm.ai/nightly
    ```

    `--pre` is required for `pip` to consider pre-released versions.

The reason to do this is that developers might have their own preference for Python package manager, so if we provide them with the pip commands, they can use them to figure out what their commands should be (in a way that would be harder if we only provide the uv commands)

@davidxia davidxia force-pushed the docs10 branch 2 times, most recently from d40ae27 to d3d3204 Compare July 16, 2025 20:29
@davidxia
Copy link
Contributor Author

I'm fine with reducing the complexity of the document by removing dedicated pip/uv sections. But I think we should keep some of the more important information about using pip in collapsed admonitions.

Good point! Added all the important pip parts back as collapsed admonitions. Ready for another review.

Copy link
Member

@hmellor hmellor left a comment

Choose a reason for hiding this comment

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

Thanks for making those changes (sorry it took so long to get back to this PR).

I agree with Gemini's comment about the aarch64 command.

for consistency since `uv` is now recommended instead of `pip` for this
project.

Put existing `pip install` commands into collapsed sections.

Signed-off-by: David Xia <[email protected]>
@davidxia
Copy link
Contributor Author

davidxia commented Jul 29, 2025

@hmellor No worries. Thanks, applied Gemini's suggested edit in 5d46322.

@davidxia davidxia requested a review from hmellor July 29, 2025 17:03
Copy link
Member

@hmellor hmellor left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

@simon-mo simon-mo merged commit 37f86d9 into vllm-project:main Jul 29, 2025
7 of 10 checks passed
@davidxia davidxia deleted the docs10 branch July 29, 2025 17:48
liuyumoye pushed a commit to liuyumoye/vllm that referenced this pull request Jul 31, 2025
davidxia added a commit to davidxia/vllm that referenced this pull request Aug 1, 2025
for consistency since `uv` is now recommended instead of `pip` for this project.
Put existing `pip install` commands into collapsed sections.

[Slack thread](https://vllm-dev.slack.com/archives/C07RLGWAHD2/p1750862187497709)

similar to vllm-project#20277

Also make minor changes to prose for more idiomatic English usage.

Signed-off-by: David Xia <[email protected]>
x22x22 pushed a commit to x22x22/vllm that referenced this pull request Aug 5, 2025
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 2025
jinzhen-lin pushed a commit to jinzhen-lin/vllm that referenced this pull request Aug 9, 2025
noamgat pushed a commit to noamgat/vllm that referenced this pull request Aug 9, 2025
paulpak58 pushed a commit to paulpak58/vllm that referenced this pull request Aug 13, 2025
diegocastanibm pushed a commit to diegocastanibm/vllm that referenced this pull request Aug 15, 2025
epwalsh pushed a commit to epwalsh/vllm that referenced this pull request Aug 28, 2025
zhewenl pushed a commit to zhewenl/vllm that referenced this pull request Aug 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation force-merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants