Skip to content

Refresh readme.md#209

Open
rogerxfeng8 wants to merge 1 commit intovllm-project:mainfrom
rogerxfeng8:main
Open

Refresh readme.md#209
rogerxfeng8 wants to merge 1 commit intovllm-project:mainfrom
rogerxfeng8:main

Conversation

@rogerxfeng8
Copy link
Collaborator

@rogerxfeng8 rogerxfeng8 commented Mar 20, 2026

Essential Elements of an Effective PR Description Checklist

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

readme.md update.

Copilot AI review requested due to automatic review settings March 20, 2026 09:58
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates README.md to provide a more complete project overview and clearer guidance for installation, usage, testing, benchmarks, and design rationale.

Changes:

  • Expanded README with table of contents and clearer “About”/“Supported Kernels” sections.
  • Added structured installation/build instructions plus testing and benchmark usage.
  • Refined design notes explaining the rationale for statically linking oneDNN.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


### Prepare
- **Python**: 3.9 – 3.12
- **PyTorch**: 2.10.0+xpu
Copy link

Copilot AI Mar 20, 2026

Choose a reason for hiding this comment

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

The README lists PyTorch: 2.10.0+xpu as a requirement, but the build system currently expects torch 2.9.0 for XPU (see CMakeLists.txt TORCH_SUPPORTED_VERSION_XPU). This mismatch is likely to confuse users and may lead to builds running with an unsupported torch version; please align the README requirement with the version(s) actually supported by the build (or update the build checks if 2.10 is now the intended target).

Suggested change
- **PyTorch**: 2.10.0+xpu
- **PyTorch**: 2.9.0+xpu

Copilot uses AI. Check for mistakes.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The CMakLists.txt needs to be updated for TORCH_SUPPORTED_VERSION_XPU to 2.10

Copy link
Collaborator

@jikunshang jikunshang left a comment

Choose a reason for hiding this comment

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

pls fix pre-commit issue, also add this for developer https://docs.vllm.ai/en/latest/contributing/?h=lint#linting

Signed-off-by: Roger Feng <roger.feng@intel.com>
Copy link
Collaborator

@baodii baodii left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants