-
-
Couldn't load subscription status.
- Fork 10.9k
Add full serve CLI reference back to docs #20978
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
Add full serve CLI reference back to docs #20978
Conversation
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
|
👋 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 @hmellor, 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 reintroduces the comprehensive CLI reference for the vllm serve command into the documentation. It achieves this by centralizing the definition of serve command arguments and updating the documentation generation process to automatically include these details, ensuring the serve --help output is fully reflected in the MkDocs documentation.
Highlights
- Documentation Restoration: Reinstated the full
vllm serve --helpCLI reference in the MkDocs documentation, which was previously lost during a documentation system migration. - Argument Definition Centralization: Moved the
vllm servecommand's argument definitions fromvllm/entrypoints/cli/serve.pytovllm/entrypoints/openai/cli_args.pyto centralize them for consistent documentation generation. - Documentation Generation Improvement: Enhanced the
generate_argparse.pyscript to dynamically create markdown for CLI arguments with configurable heading levels, ensuring accurate and flexible documentation output.
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. ↩
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 is a great improvement, as it not only restores the vllm serve CLI reference to the documentation but also refactors the argument parsing logic for better maintainability. By centralizing the argument definitions, the code is now cleaner and less prone to inconsistencies.
I've identified a couple of areas for improvement in the documentation generation logic to ensure the output is both complete and as clear as possible for users. My suggestions are detailed in the review comments.
docs/cli/README.md
Outdated
| vllm serve --help=page | ||
| ``` | ||
|
|
||
| ### help |
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.
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.
I would call this section Options
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.
Can you update configuration/serve_args.md to link to this page as well?
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
| parser.add_argument( | ||
| "--headless", | ||
| action="store_true", | ||
| default=False, | ||
| help="Run in headless mode. See multi-node data parallel " | ||
| "documentation for more details.") | ||
| parser.add_argument( | ||
| "--data-parallel-start-rank", | ||
| "-dpr", | ||
| type=int, | ||
| default=0, | ||
| help="Starting data parallel rank for secondary nodes. " | ||
| "Requires --headless.") | ||
| parser.add_argument("--api-server-count", | ||
| "-asc", | ||
| type=int, | ||
| default=1, | ||
| help="How many API server processes to run.") |
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.
At high level, these belong to FrontEndArgs?
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.
I thought about adding them, but I wasn't sure about the data parallel ones though, because they are sort of "pre-frontend"
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: x22x22 <wadeking@qq.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: Paul Pak <paulpak58@gmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: Diego-Castan <diego.castan@ibm.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Now that #20206 has merged. This PR reinstates the full
vllm serve --helpCLI reference that was unfortunately removed in the upgrade from Sphinx to MkDocs in #18145.