-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[doc] fix the incorrect label #19787
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
Conversation
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 🚀 |
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 @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 addresses a minor documentation issue by fixing an incorrect internal label reference. The change ensures that the 'NVIDIA CUDA' installation instructions correctly embed the intended 'set up using Python' section, improving the accuracy and consistency of the documentation for users.
Highlights
- Documentation Link Correction: Corrected an internal documentation link in
docs/getting_started/installation/gpu.md
on line 45. The reference for the 'NVIDIA CUDA' installation section now correctly points toset-up-using-python
instead ofcreate-a-new-python-environment
withincuda.inc.md
. - Content Alignment: Removed a redundant heading
### Create a new Python environment
fromdocs/getting_started/installation/gpu/cuda.inc.md
on line 13. This change aligns the content with the updated internal reference labelset-up-using-python
, ensuring consistency and preventing potential issues with the documentation build process.
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 effectively corrects an issue in the GPU installation documentation, enhancing its accuracy and clarity.
Key changes include:
- In
docs/getting_started/installation/gpu.md
, an incorrect content inclusion anchor was updated. The change from a non-existent anchor (create-a-new-python-environment
) to the correct one (set-up-using-python
) resolves what was likely a broken section in the rendered documentation. - In
docs/getting_started/installation/gpu/cuda.inc.md
, a redundant### Create a new Python environment
heading was removed. This is an appropriate cleanup, preventing duplication as a similar heading already exists in the parent document where this content is included.
Both changes are beneficial and improve the documentation.
For future PRs, consider enhancing the pull request description by:
- More clearly articulating the problem being solved (e.g., detailing that the original anchor was non-existent and its impact).
- Completing the checklist items in the PR template (Purpose, Test Plan, Test Results). For documentation changes, a 'Test Plan' could involve verifying the locally rendered output, and 'Test Results' could confirm the fix.
The code changes themselves are approved.
@@ -42,7 +42,7 @@ vLLM is a Python library that supports the following GPU variants. Select your G | |||
|
|||
=== "NVIDIA CUDA" | |||
|
|||
--8<-- "docs/getting_started/installation/gpu/cuda.inc.md:create-a-new-python-environment" | |||
--8<-- "docs/getting_started/installation/gpu/cuda.inc.md:set-up-using-python" |
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.
This change correctly updates the include anchor from create-a-new-python-environment
to set-up-using-python
. The previous anchor did not exist in docs/getting_started/installation/gpu/cuda.inc.md
, which would likely result in a broken or missing content section in the rendered documentation. This fix significantly improves the correctness and usability of the documentation.
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.
Thanks for fixing!
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: minpeter <kali2005611@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: Yang Wang <elainewy@meta.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Essential Elements of an Effective PR Description Checklist
supported_models.md
andexamples
for a new model.Purpose
It should
set-up-using-python
indocs/getting_started/installation/gpu/cuda.inc.md
.From:

to:

Test Plan
Test Result
(Optional) Documentation Update