-
-
Notifications
You must be signed in to change notification settings - Fork 11.3k
[Perf] Validate @config in pre-commit instead of dynamically #20200
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
Conversation
|
👋 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 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 🚀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @lionelvillard, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refactors how configuration validation is performed by shifting it from runtime checks to a pre-commit static analysis. This change aims to improve code quality and consistency by catching configuration-related issues earlier in the development cycle, ensuring that all configuration fields are properly defined and documented.
Highlights
- Shifted Configuration Validation: I've moved the validation logic for
@configdecorated classes from dynamic runtime checks withinvllm/config.pyto a static pre-commit hook. This ensures that configuration fields adhere to required standards (default values, docstrings, correctLiteralusage) before code is committed. - New Static Analysis Tool: I've introduced a new Python script,
tools/validate_config.py, which leverages Python'sastmodule to perform static analysis on configuration files. This script programmatically checks for the presence of default values and docstrings for fields in classes decorated with@configand@dataclass, and also validates the correct usage ofLiteraltypes. - Pre-commit Hook Integration: A new
validate-confighook has been added to.pre-commit-config.yaml. This hook executes thetools/validate_config.pyscript againstvllm/config.py(andtests/test_config.py, though not shown in the patch) during the pre-commit stage, enforcing configuration standards early in the development workflow.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
3c63ed9 to
0fe23bf
Compare
There was a problem hiding this 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 refactors the validation of @config decorated classes by moving the logic from a runtime decorator to a pre-commit hook. The new validation script tools/validate_config.py is well-structured, but there are suggestions to improve its readability, style, and correctness. The tests for the removed runtime validation in tests/test_config.py should be removed to align with the changes in this PR.
Signed-off-by: Lionel Villard <[email protected]>
Signed-off-by: Lionel Villard <[email protected]>
5977132 to
cc82578
Compare
Signed-off-by: Lionel Villard <[email protected]>
cc82578 to
57a1146
Compare
mgoin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks reasonable to me, very nice! Can you maybe demonstrate speedup by timing the import of vllm.config?
Signed-off-by: Lionel Villard <[email protected]>
I added 2 screenshots demonstrating the speedup |
Signed-off-by: Lionel Villard <[email protected]>
mgoin
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work, LGTM
| """ | ||
| Get any docstrings placed after attribute assignments in a class body. | ||
| https://davidism.com/mit-license/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this file need a "Adapted from https://github.com/..." message? Not sure what the intent of linking this URL is.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure. The link is needed because of the MIT license:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
Signed-off-by: Lionel Villard <[email protected]>
Signed-off-by: Lionel Villard <[email protected]>
a0ce90a to
e3db3bd
Compare
|
/label startup-ux |
…oject#20200) Signed-off-by: Lionel Villard <[email protected]> Signed-off-by: Jinzhen Lin <[email protected]>
This PR is about optimizing vLLM cold start by validating the code defining vLLM configuration at static time in precommit instead of at runtime. By doing so, vLLM cold start is reduced by at least 500ms per worker.
Before this PR:
After this PR:
@ProExpertProg @aarnphm @hmellor @mgoin