Skip to content

Conversation

@maryamtahhan
Copy link
Contributor

Purpose

This PR fixes several grammar issues in the CPU installation documentation to improve clarity and readability.

Test Plan

Manual review of the documentation changes. The changes are purely grammatical improvements with no functional impact:

  • Fixed "allow vLLM running" → "allow vLLM to run"
  • Fixed "bound to a same NUMA node" → "bound to the same NUMA node"
  • Fixed "If have any performance problems" → "If you have any performance problems"
  • Fixed "it is recommend" → "it is recommended"
  • Fixed "When deploy vLLM" → "When deploying vLLM"
  • Fixed "on a same NUMA node" → "on the same NUMA node"
  • Fixed "Larger batch usually provides" → "A larger batch usually provides"
  • Fixed "Tuning max batch size starts from default value" → "Tuning the max batch size starting from the default value"
  • Fixed "can provides better performance" → "can provide better performance" (2 instances)

Test Result

No functional changes - documentation only. All grammar corrections improve readability and follow standard English conventions.

Before: "larger setting will allow vLLM running more requests in parallel"
After: "larger setting will allow vLLM to run more requests in parallel"

(See full diff for all corrections)

@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 ask your reviewers to trigger select CI tests on top of fastcheck CI.

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.

If you have any questions, please reach out to us on Slack at https://slack.vllm.ai.

🚀

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 introduces a series of grammatical corrections to the CPU installation guide. The changes, such as fixing verb forms, articles, and sentence structures, significantly improve the clarity and readability of the documentation. All the corrections are accurate and well-justified. The pull request successfully achieves its goal of enhancing the documentation quality.

@mergify
Copy link

mergify bot commented Nov 11, 2025

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

@mergify mergify bot added the documentation Improvements or additions to documentation label Nov 11, 2025
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) November 11, 2025 14:00
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Nov 11, 2025
@DarkLight1337 DarkLight1337 merged commit fa19702 into vllm-project:main Nov 11, 2025
8 checks passed
@maryamtahhan maryamtahhan deleted the hotfix-cpu-doc branch November 11, 2025 14:52
xuebwang-amd pushed a commit to xuebwang-amd/vllm that referenced this pull request Nov 13, 2025
devpatelio pushed a commit to SumanthRH/vllm that referenced this pull request Nov 29, 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 ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants