[doc] split "Other AI Accelerators" tabs #19708
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 🚀 |
![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 @davidxia, 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!
I've refactored the installation documentation for various AI accelerators to provide a more organized and user-friendly experience. This change improves discoverability and readability by giving each accelerator its own dedicated page, rather than grouping them under a single, multi-tabbed document.
Highlights
- Documentation Restructuring: The installation guide's 'Other AI Accelerators' section has been refactored for improved organization and clarity.
- Dedicated Pages for Accelerators: Content for Google TPU, Intel Gaudi, and AWS Neuron, previously grouped within a single
ai_accelerator.mdfile, has been split into their own dedicated Markdown files (google_tpu.md,intel_gaudi.md,aws_neuron.md). - Navigation and Link Updates: The
.nav.ymlfile has been updated to include the new individual pages in the navigation menu, and the mainREADME.mdnow links directly to these separate accelerator guides. - Content Formatting Cleanup: The newly standalone documentation pages have been cleaned up by removing
<!-- --8<-- [start/end:...]snippet markers and promoting section headings for better readability and structure.
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. ↩
mergify
bot
added
documentation
There was a problem hiding this comment.
Code Review
This pull request refactors the AI accelerator documentation by splitting a single page into three dedicated pages, enhancing clarity and organization. The changes are well-implemented, with correct updates to navigation and content structure. A suggestion is provided to improve link formatting and package installation in the documentation files.
| @@ -142,7 +137,7 @@ Install build dependencies: | |||
|
|
|||
| ```bash | |||
| pip install -r requirements/tpu.txt | |||
| sudo apt-get install libopenblas-base libopenmpi-dev libomp-dev | |||
| sudo apt-get install --no-install-recommends -y libopenblas-base libopenmpi-dev libomp-dev | |||
There was a problem hiding this comment.
added --no-install-recommends --yes for convenience
|
This pull request has merge conflicts that must be resolved before it can be |
into their own pages. [Slack thread](https://vllm-dev.slack.com/archives/C07RLGWAHD2/p1749643375045239?thread_ts=1749643284.434679&cid=C07RLGWAHD2) Signed-off-by: David Xia <david@davidxia.com>
|
@mgoin of course. I rebased to fix the conflict. Should be good now. |
Signed-off-by: minpeter <kali2005611@gmail.com>
Signed-off-by: Yang Wang <elainewy@meta.com>
into their own pages.
Slack thread