[doc] update doc format #20673
[doc] update doc format #20673
Conversation
Signed-off-by: reidliu41 <reid201711@gmail.com>
There was a problem hiding this comment.
Summary of Changes
Hello @reidliu41, 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 refining the docs/contributing/ci/update_pytorch_version.md documentation. The primary goal is to improve the document's readability and consistency through various formatting adjustments, ensuring that instructions for updating PyTorch and CUDA versions, as well as building specific dependencies from source, are presented clearly and effectively.
Highlights
- Documentation Formatting: Improved the overall formatting and readability of the
update_pytorch_version.mddocument by converting plain URLs to Markdown links, standardizing code block syntax tobash, and using backticks for inline code and variable names. - Clarity of Instructions: Enhanced the clarity of installation commands and instructions, particularly for
uv pip installcommands, by adding line continuations and providing explicit examples for settinguvindex strategies. - Structured Information: Converted several numbered lists into bullet points and formatted a list of PyTorch extra index URLs into a more readable Markdown table, making the information easier to digest.
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 significantly improves the formatting and readability of the update_pytorch_version.md documentation. The changes include using proper markdown for links, code blocks, and tables, which makes the document much easier to follow. I've found one minor issue with a broken link that should be addressed.
|
|
||
| | Platform | Extra Index URL | | ||
| |----------|-----------------| | ||
| | CPU | [https://download.pytorch.org/whl/cpu](https://download.pytorch.org/whl/cpu )| |
There was a problem hiding this comment.
There's a trailing space in the URL for the CPU platform, which may cause the link to be broken in some markdown renderers. Please remove the space to ensure the link works correctly.
| | CPU | [https://download.pytorch.org/whl/cpu](https://download.pytorch.org/whl/cpu )| | |
| | CPU | [https://download.pytorch.org/whl/cpu](https://download.pytorch.org/whl/cpu)| |
Signed-off-by: reidliu41 <reid201711@gmail.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 🚀 |
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
|
No need to run the job for docs now? |
|
The doc build already passed |
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Signed-off-by: Patrick von Platen <patrick.v.platen@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
Test Plan
Test Result
(Optional) Documentation Update