[Docs] Data Parallel deployment documentation #20768
Conversation
Signed-off-by: Nick Hill <[email protected]>
|
👋 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 🚀 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @njhill, 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 significantly enhances vLLM's documentation by introducing a dedicated guide for Data Parallel deployment. This new content covers the setup and considerations for deploying models, particularly Mixture of Experts (MoE) models, using data parallelism, and integrates these updates into the project's existing documentation structure.
Highlights
- New Documentation: A comprehensive guide for Data Parallel deployment in vLLM has been added, detailing its use with dense and MoE models, including internal and external load balancing strategies.
- README Updates: The main
README.mdanddocs/README.mdfiles have been updated to reflect support for data and expert parallelism. - Distributed Serving Guide Integration: The
docs/serving/distributed_serving.mdfile now includes a new section specifically for MoE models, linking to the new Data Parallel deployment documentation.
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.
Code Review
This pull request introduces documentation for Data Parallel deployment. The documentation covers internal and external load-balancing scenarios with examples. The review focuses on improving the clarity and accuracy of technical descriptions, correcting a statement about Expert Parallelism, and fixing terminology inconsistencies.
Signed-off-by: Nick Hill <[email protected]>
There was a problem hiding this comment.
Could we save versions of these images with no grid?
There was a problem hiding this comment.
I agree this would be good! I will try to do it but not sure I will get a chance since I will be out next week and have a lot to get done before I leave.
So we could always merge this and I can improve the images as a follow-on when I'm back.
There was a problem hiding this comment.
Yeah let's get it in and polish the diagrams after
Signed-off-by: Nick Hill <[email protected]> Signed-off-by: x22x22 <[email protected]>
Signed-off-by: Nick Hill <[email protected]>
Signed-off-by: Nick Hill <[email protected]>
Signed-off-by: Nick Hill <[email protected]> Signed-off-by: Jinzhen Lin <[email protected]>
Signed-off-by: Nick Hill <[email protected]> Signed-off-by: Paul Pak <[email protected]>
Signed-off-by: Nick Hill <[email protected]> Signed-off-by: Diego-Castan <[email protected]>
Signed-off-by: Nick Hill <[email protected]>
Adapted from google doc, with some additions/improvements https://docs.google.com/document/d/1mSYsWQEbp4Oq50ghFWUun7OgagbuUJivAC8Ds-pu-xU/edit?tab=t.0