Skip to content

Conversation

@sjhddh
Copy link
Contributor

@sjhddh sjhddh commented Jan 23, 2026

Summary

Update the README.md "Getting Started" section to:

  • Add Python version requirements (3.10 - 3.13) prominently
  • Recommend uv as the preferred installation method
  • Keep pip as an alternative for users who prefer it
  • Update installation guide link to the general installation page

Motivation

  • uv is significantly faster than pip for installing vLLM
  • The docs already recommend uv, README should be consistent
  • Python version requirements are important for new users
  • Link to general installation page covers more platforms

Changes

**Requirements:** Python 3.10 - 3.13

Install vLLM with `uv` (recommended) or `pip`. For source builds...

# Recommended: using uv (https://docs.astral.sh/uv/)
uv pip install vllm --torch-backend=auto

# Alternative: using pip
pip install vllm

Test Plan

  • Visual inspection of README rendering on GitHub
  • Verify both installation commands work

Risk

  • Low risk: documentation-only change
  • Both pip and uv paths are preserved

@mergify
Copy link

mergify bot commented Jan 23, 2026

Documentation preview: https://vllm--32987.org.readthedocs.build/en/32987/

@mergify mergify bot added the documentation Improvements or additions to documentation label Jan 23, 2026
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 README.md to recommend uv for installation and to specify the required Python versions. The changes are clear and align with the project's move towards uv for a better user experience. I have one suggestion to improve the alternative pip installation instructions to prevent potential issues for new GPU users.

README.md Outdated
# Recommended: using uv (https://docs.astral.sh/uv/)
uv pip install vllm --torch-backend=auto

# Alternative: using pip
Copy link
Contributor

Choose a reason for hiding this comment

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

high

The simple pip install vllm command that follows is likely to cause issues for GPU users, as pip may install a CPU-only version of PyTorch if a compatible GPU version isn't already installed. This can lead to runtime failures and a frustrating experience for new users.

To avoid this, I recommend adding a note to guide pip users to the detailed installation instructions, making it clear that the simple pip command has caveats for the primary use case (GPU acceleration).

Suggested change
# Alternative: using pip
# Alternative: using pip (see installation guide for GPU)

…ements

- Add Python version requirements (3.10 - 3.13) for visibility
- Recommend uv as the preferred installation method (while keeping pip)
- Update installation guide link to the general installation page
- Align with the documentation's installation recommendations

Signed-off-by: 7. Sun <jhao.sun@gmail.com>
@sjhddh sjhddh force-pushed the docs/readme-uv-python-version branch from 12acfc6 to 991bcd3 Compare January 23, 2026 23:24
Signed-off-by: 7. Sun <jhao.sun@gmail.com>
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant