[doc] fix "Other AI accelerators" getting started page #19457
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.
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!
This pull request focuses on improving the accuracy and formatting of the documentation for getting started with TPUs. It addresses issues with list rendering, command formatting, and restores previously truncated parameter descriptions in a table.
Highlights
- Documentation Formatting: I've fixed some markdown formatting issues on the TPU getting started page, specifically ensuring lists are correctly rendered by adding required newlines.
- Command Readability: I've improved the readability of the multi-line
gcloudcommand example by properly indenting the continuation lines. - Restore Parameter Descriptions: I've restored parameter descriptions in the table that were truncated in a previous PR (#18145), providing complete details for
TPU_NAME,ZONE,ACCELERATOR_TYPE, andSERVICE_ACCOUNT.
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 configureGemini 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 effectively addresses several documentation issues in the TPU getting started guide, including restoring truncated parameter descriptions, correcting list formatting, and improving the indentation of a gcloud command example. The changes significantly enhance the clarity and correctness of the documentation. My review includes suggestions for ensuring consistency in Markdown link formatting and verifying the accessibility of an external link.
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
1 similar comment
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
c146995 to
7bb73d6
Compare
* add `configure-a-new-environment` snippet tag to all included sub-pages to fix malformed page layout and headers * restore TPU parameter descriptions truncated in vllm-project#18145 [link] * list in "Provision Cloud TPUs with GKE" requires newline before start * indent line continuation for `gcloud` command in "Provision a Cloud TPU with the queued resource API" [link]: https://github.com/vllm-project/vllm/pull/18145/files#diff-5c4190821389df4c03e59603ce0143a517beb8ae241103b83914ebb000a2b9ba Signed-off-by: David Xia <david@davidxia.com>
|
@DarkLight1337 thanks! Will the canceled checks prevent auto-merging? |
|
No they won't |
…19457) Signed-off-by: David Xia <david@davidxia.com> Signed-off-by: minpeter <kali2005611@gmail.com>
…19457) Signed-off-by: David Xia <david@davidxia.com>
…19457) Signed-off-by: David Xia <david@davidxia.com> Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
…19457) Signed-off-by: David Xia <david@davidxia.com>
configure-a-new-environmentsnippet tag to all included sub-pages tofix malformed page layout and headers
gcloudcommand in "Provision a Cloud TPU withthe queued resource API"