Skip to content

Comments

[Docs] Clean up README_TUNING.md#28088

Merged
russellb merged 1 commit intovllm-project:mainfrom
windsonsea:tunyh
Nov 5, 2025
Merged

[Docs] Clean up README_TUNING.md#28088
russellb merged 1 commit intovllm-project:mainfrom
windsonsea:tunyh

Conversation

@windsonsea
Copy link
Contributor

@windsonsea windsonsea commented Nov 5, 2025

Perform cleanup actions to this tunning readme:

  • Tweak long lines to easily maintain in future
  • Use 1-2-3 list for steps
  • Use a table to describe filename templates and examples
  • Fix typos

@windsonsea windsonsea requested a review from jeejeelee as a code owner November 5, 2025 02:30
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 cleans up the README_TUNING.md file, improving its readability by reformatting long lines, using numbered lists, and adding a table for file naming conventions. The changes make the documentation easier to follow. I've added a couple of suggestions to further improve the documentation by fixing a fragile link that points to a personal fork and correcting a typo in a code snippet. These changes will enhance the clarity and long-term maintainability of the tuning guide.

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 does a good job of cleaning up the README_TUNING.md file, improving its readability and maintainability. The use of a numbered list for steps and a table for file naming conventions are excellent changes. I've pointed out a couple of minor issues: a typo in an example code block and a link that points to a personal fork instead of the main repository. Addressing these will further improve the quality of the documentation.

Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
@russellb russellb enabled auto-merge (squash) November 5, 2025 19:00
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Nov 5, 2025
@russellb russellb merged commit 518ec6b into vllm-project:main Nov 5, 2025
8 checks passed
@windsonsea windsonsea deleted the tunyh branch November 6, 2025 02:25
ZhengHongming888 pushed a commit to ZhengHongming888/vllm that referenced this pull request Nov 8, 2025
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
devpatelio pushed a commit to SumanthRH/vllm that referenced this pull request Nov 29, 2025
Signed-off-by: windsonsea <haifeng.yao@daocloud.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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