Skip to content

Conversation

@DarkLight1337
Copy link
Member

@DarkLight1337 DarkLight1337 commented Nov 28, 2025

Purpose

The benchmark documentation is getting a bit long, so let's split it up into multiple pages.

Also, since benchmarks can also be done by users who want to optimize the settings, I have made Benchmarks its own tab.

Test Plan

Test Result


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.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft in the Google Doc.

Signed-off-by: DarkLight1337 <[email protected]>
@mergify
Copy link

mergify bot commented Nov 28, 2025

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

@mergify mergify bot added the documentation Improvements or additions to documentation label Nov 28, 2025
Signed-off-by: DarkLight1337 <[email protected]>
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 great job of reorganizing the benchmark documentation into its own dedicated section, which significantly improves discoverability. The content has been split into logical pages for CLI, parameter sweeps, and the performance dashboard. My review focuses on ensuring the correctness of the documentation after this refactoring. I've found several broken links (to source files and images) that were likely missed during the file moves. I've provided suggestions to fix these incorrect relative paths.

Signed-off-by: DarkLight1337 <[email protected]>
@DarkLight1337 DarkLight1337 force-pushed the reorganize-benchmark-docs branch 2 times, most recently from 2062055 to 7fd2fd8 Compare November 28, 2025 08:25
Signed-off-by: DarkLight1337 <[email protected]>
@DarkLight1337 DarkLight1337 force-pushed the reorganize-benchmark-docs branch from 7fd2fd8 to ef6882d Compare November 28, 2025 08:26
@DarkLight1337 DarkLight1337 added the ready ONLY add when PR is ready to merge/full CI is needed label Nov 28, 2025
Signed-off-by: DarkLight1337 <[email protected]>
@DarkLight1337 DarkLight1337 merged commit ccbdf51 into vllm-project:main Nov 28, 2025
7 checks passed
@DarkLight1337 DarkLight1337 deleted the reorganize-benchmark-docs branch November 28, 2025 09:19
kitaekatt pushed a commit to kitaekatt/vllm that referenced this pull request Dec 1, 2025
amd-hhashemi pushed a commit to amd-hhashemi/vllm that referenced this pull request Dec 2, 2025
Signed-off-by: DarkLight1337 <[email protected]>
Signed-off-by: Hashem Hashemi <[email protected]>
charlotte12l pushed a commit to charlotte12l/vllm that referenced this pull request Dec 5, 2025
Signed-off-by: DarkLight1337 <[email protected]>
Signed-off-by: Xingyu Liu <[email protected]>
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