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

[CI/Build] Add nightly benchmarking for tgi, tensorrt-llm and lmdeploy #5362

Merged
merged 152 commits into from
Jul 11, 2024

Conversation

KuntaiDu
Copy link
Collaborator

@KuntaiDu KuntaiDu commented Jun 9, 2024

Following PR #5073, this PR aims to compare vllm and alternatives (like tgi, tensorrt-llm and lmdeploy --- feel free to comment if you feel there are also other alternatives we need to benchmark) ON THE SAME WORKLOAD (the same as PR #5073) USING THE SAME BENCHMARKING SCRIPT (benchmark_serving.py).

For fair comparison, we will run vllm and alternatives in their corresponding official docker image.

This will be a nightly benchmark as running all alternatives on all workloads can be pretty time-consuming.

TODO lists:

  • implement initial version of one-click runnable benchmarking script for tgi
  • implement initial version of one-click runnable benchmarking script for tensorrt-llm
  • implement initial version of one-click runnable benchmarking script for lmdeploy
  • adjust these scripts so that they parse the workload from nightly-tests.json
  • integrate it inside the CI system
  • adjust the presentation of the benchmarking result (in the format of a markdown file)

PR Checklist (Click to Expand)

Thank you for your contribution to vLLM! Before submitting the pull request, please ensure the PR meets the following criteria. This helps vLLM maintain the code quality and improve the efficiency of the review process.

PR Title and Classification

Only specific types of PRs will be reviewed. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

  • [Bugfix] for bug fixes.
  • [CI/Build] for build or continuous integration improvements.
  • [Doc] for documentation fixes and improvements.
  • [Model] for adding a new model or improving an existing model. Model name should appear in the title.
  • [Frontend] For changes on the vLLM frontend (e.g., OpenAI API server, LLM class, etc.)
  • [Kernel] for changes affecting CUDA kernels or other compute kernels.
  • [Core] for changes in the core vLLM logic (e.g., LLMEngine, AsyncLLMEngine, Scheduler, etc.)
  • [Hardware][Vendor] for hardware-specific changes. Vendor name should appear in the prefix (e.g., [Hardware][AMD]).
  • [Misc] for PRs that do not fit the above categories. Please use this sparingly.

Note: If the PR spans more than one category, please include all relevant prefixes.

Code Quality

The PR need to meet the following code quality standards:

  • We adhere to Google Python style guide and Google C++ style guide.
  • Pass all linter checks. Please use format.sh to format your code.
  • The code need to be well-documented to ensure future contributors can easily understand the code.
  • Include sufficient tests to ensure the project to stay correct and robust. This includes both unit tests and integration tests.
  • Please add documentation to docs/source/ if the PR modifies the user-facing behaviors of vLLM. It helps vLLM user understand and utilize the new features or changes.

Notes for Large Changes

Please keep the changes as concise as possible. For major architectural changes (>500 LOC excluding kernel/data/config/test), we would expect a GitHub issue (RFC) discussing the technical design and justification. Otherwise, we will tag it with rfc-required and might not go through the PR.

What to Expect for the Reviews

The goal of the vLLM team is to be a transparent reviewing machine. We would like to make the review process transparent and efficient and make sure no contributor feel confused or frustrated. However, the vLLM team is small, so we need to prioritize some PRs over others. Here is what you can expect from the review process:

  • After the PR is submitted, the PR will be assigned to a reviewer. Every reviewer will pick up the PRs based on their expertise and availability.
  • After the PR is assigned, the reviewer will provide status update every 2-3 days. If the PR is not reviewed within 7 days, please feel free to ping the reviewer or the vLLM team.
  • After the review, the reviewer will put an action-required label on the PR if there are changes required. The contributor should address the comments and ping the reviewer to re-review the PR.
  • Please respond to all comments within a reasonable time frame. If a comment isn't clear or you disagree with a suggestion, feel free to ask for clarification or discuss the suggestion.

Thank You

Finally, thank you for taking the time to read these guidelines and for your interest in contributing to vLLM. Your contributions make vLLM a great tool for everyone!

@KuntaiDu
Copy link
Collaborator Author

I have finished an initial implementation on lmdeploy and tgi, which has entry point run-nightly-suite.sh that can parses nightly-tests.json and generate benchmarking results. This script is one-click runnable in the official docker of lmdeploy and tgi. I will continue on trt.

@KuntaiDu KuntaiDu requested a review from simon-mo July 11, 2024 17:01
Copy link
Collaborator

@simon-mo simon-mo left a comment

Choose a reason for hiding this comment

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

This looks good. One thing I couldn't find a single place to find all the workload description (i.e. where is the parameters for benchmark serving which should be identical for all backends).

@simon-mo simon-mo merged commit a4feba9 into vllm-project:main Jul 11, 2024
71 checks passed
@KuntaiDu KuntaiDu deleted the kuntai-benchmark-dev branch July 11, 2024 20:39
@zhyncs
Copy link
Contributor

zhyncs commented Jul 13, 2024

Hi @KuntaiDu Nice work! May we consider adding benchmarks for glm-4-9b-chat and Qwen2-72B-Instruct? They are currently the SOTA models in CJK native support. If OK and needed, I am happy to help. Thanks. cc @simon-mo

@KuntaiDu
Copy link
Collaborator Author

Hi @KuntaiDu Nice work! May we consider adding benchmarks for glm-4-9b-chat and Qwen2-72B-Instruct? They are currently the SOTA models in CJK native support. If OK and needed, I am happy to help. Thanks. cc @simon-mo

Sorry for the late reply (github somehow did not remind me of this message). Feel free to raise a new PR to do this!

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

Successfully merging this pull request may close these issues.

5 participants