Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Improve benchmark documentation #9927

Merged
merged 3 commits into from
Nov 7, 2024

Conversation

rafvasq
Copy link
Contributor

@rafvasq rafvasq commented Nov 1, 2024

This PR tries to improve the documentation regarding vLLM performance including benchmarking vLLM where information can be found in multiple places (1, 2)

  • "Performance" header instead of "Performance Benchmarks" to accommodate future performance-related doc
  • Include more overview information on the website docs, pointing to the github docs for more information

A possible follow-up to this PR would be to clean up the docs found in the repo assuming that's where the detailed, technical information will live, otherwise it should get pulled out for the website docs.

Copy link

github-actions bot commented Nov 1, 2024

👋 Hi! Thank you for contributing to the vLLM project.
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 can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

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 do one of these:

  • Add ready label to the PR
  • Enable auto-merge.

🚀

@mergify mergify bot added the documentation Improvements or additions to documentation label Nov 1, 2024
@rafvasq rafvasq changed the title Doc: Improve benchmark doc Doc: Improve benchmark documentation Nov 1, 2024
@rafvasq rafvasq marked this pull request as ready for review November 5, 2024 14:51
Copy link
Collaborator

@russellb russellb left a comment

Choose a reason for hiding this comment

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

The changes lgtm overall.

The one thing I'd change if you have to update this anyway is to try to get git to recognize benchmarks.rst as a move instead of a delete + create. As it is, you lose history of the file. Generally git mv will do what you want.

docs/source/dev/profiling/profiling_index.rst Show resolved Hide resolved
@rafvasq rafvasq force-pushed the organize-perf-docs branch from e18a232 to abc5927 Compare November 5, 2024 21:12
Signed-off-by: Rafael Vasquez <[email protected]>
@rafvasq rafvasq force-pushed the organize-perf-docs branch from 4835e70 to 4806ab6 Compare November 6, 2024 21:27
@simon-mo simon-mo merged commit d7263a1 into vllm-project:main Nov 7, 2024
15 checks passed
@rafvasq rafvasq deleted the organize-perf-docs branch November 7, 2024 14:04
Isotr0py pushed a commit to Isotr0py/vllm that referenced this pull request Nov 8, 2024
JC1DA pushed a commit to JC1DA/vllm that referenced this pull request Nov 11, 2024
@rafvasq rafvasq changed the title Doc: Improve benchmark documentation [Doc] Improve benchmark documentation Nov 11, 2024
sumitd2 pushed a commit to sumitd2/vllm that referenced this pull request Nov 14, 2024
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Sumit Dubey <[email protected]>
KuntaiDu pushed a commit to KuntaiDu/vllm that referenced this pull request Nov 20, 2024
mfournioux pushed a commit to mfournioux/vllm that referenced this pull request Nov 20, 2024
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Maxime Fournioux <[email protected]>
tlrmchlsmth pushed a commit to neuralmagic/vllm that referenced this pull request Nov 23, 2024
Signed-off-by: Rafael Vasquez <[email protected]>
Signed-off-by: Tyler Michael Smith <[email protected]>
sleepwalker2017 pushed a commit to sleepwalker2017/vllm that referenced this pull request Dec 13, 2024
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.

3 participants