Skip to content

Conversation

@DarkLight1337
Copy link
Member

@DarkLight1337 DarkLight1337 commented Jun 4, 2025

Essential Elements of an Effective PR Description Checklist

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results

Purpose

Update the V1 Guide based on #16188 (review)

cc @maxdebayser @22quinn

@DarkLight1337 DarkLight1337 requested a review from WoosukKwon June 4, 2025 12:52
@DarkLight1337 DarkLight1337 requested a review from hmellor as a code owner June 4, 2025 12:52
@DarkLight1337 DarkLight1337 added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 4, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @DarkLight1337, 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!

Summary of Changes

Hello! Gemini or gemini-code-assist here, providing a summary of this pull request. This PR, authored by DarkLight1337, focuses on updating the documentation for the V1 Guide. Specifically, it corrects a reference to a related pull request concerning the support for embedding models in V1. The change ensures the documentation points to the correct PR that initiated the initial support for embedding models.

Highlights

  • Documentation Update: The primary change is an update to the docs/usage/v1_guide.md file to correct information regarding the status and related work on embedding models in vLLM V1.
  • Correcting PR Reference: An incorrect pull request link (PR #18015) related to embedding models in the V1 Guide has been replaced with the correct one (PR #16188).

Changelog

  • docs/usage/v1_guide.md
    • Corrected the pull request link for 'Embedding Models' in the status table from PR #18015 to PR #16188 (line 58).
    • Updated the descriptive text about the initial support for Embedding Models, replacing the reference to PR #18015 with PR #16188 and slightly rephrasing the sentence (lines 148-150).
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.


A link was wrong, you see,
Docs needed fixing, quickly.
Now the path is clear.

Footnotes

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 updates the V1 guide for embedding models, aligning the documentation with the feedback provided in the linked PR review (#16188). The changes are accurate and improve the clarity of the guide regarding the status and plans for embedding model support.

Well done on addressing the review comments and ensuring the documentation is up-to-date!

Merge Readiness

The changes in this pull request are clear, correct, and directly address the intended documentation update. The code (Markdown) is in good shape. I am unable to approve the pull request myself, but based on this review, it appears ready for merging after any other necessary reviews and approvals are complete.

@mergify mergify bot added the documentation Improvements or additions to documentation label Jun 4, 2025
@github-actions
Copy link

github-actions bot commented Jun 4, 2025

👋 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 fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

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 ready label to the PR or enable auto-merge.

🚀

@DarkLight1337 DarkLight1337 merged commit 8f4ffbd into vllm-project:main Jun 4, 2025
48 checks passed
@DarkLight1337 DarkLight1337 deleted the update-v1-guide branch June 4, 2025 14:57
christian-pinto pushed a commit to christian-pinto/vllm that referenced this pull request Jun 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants