Skip to content

[Doc] Update V1 user guide for embedding models #19842

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

Merged
merged 2 commits into from
Jun 19, 2025

Conversation

22quinn
Copy link
Collaborator

@22quinn 22quinn commented Jun 19, 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
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

Purpose

Update V1 pooling support status following the merge of #16188

Test Plan

N/A

Test Result

N/A

(Optional) Documentation Update

Done

Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
@22quinn 22quinn requested a review from hmellor as a code owner June 19, 2025 06:35
Copy link

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

🚀

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.

Summary of Changes

Hello @22quinn, 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 primarily updates the V1 user guide documentation to accurately reflect the current status of embedding models. Following the successful integration of previous work (PR #16188), embedding models are now marked as fully functional, and outdated sections detailing their "Work In Progress" status and future plans have been removed to streamline the guide.

Highlights

  • Documentation Update: The status of "Embedding Models" in the V1 user guide has been updated from "🚧 WIP" (Work In Progress) to "🟢 Functional", reflecting their current operational state after the merge of PR #16188.
  • Content Refinement: An entire subsection detailing the "WIP" status and future plans for embedding models has been removed from the documentation, as this information is now obsolete given their functional status.
  • Minor Formatting: Trailing whitespace characters were removed from several lines defining status indicators, improving document cleanliness.
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

  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.

@mergify mergify bot added the documentation Improvements or additions to documentation label Jun 19, 2025
@22quinn 22quinn requested a review from DarkLight1337 June 19, 2025 06:36
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 updates the V1 user guide for embedding models, reflecting their new status as 'Functional' after the merge of PR #16188. The changes involve:

  1. Updating the status of 'Embedding Models' in the main model support table from '🚧 WIP' to '🟢 Functional'.
  2. Removing the link to the merged PR #16188 from this table entry.
  3. Removing the detailed sub-section under 'Models not yet supported in V1' that previously described the WIP status and future plans for Embedding Models. This is logical as they are now considered functional.
  4. Minor stylistic cleanup by removing trailing spaces from some list items in the status legend.

The changes are consistent with the PR's purpose and improve the accuracy and clarity of the documentation. No issues of medium or higher severity were identified in this review.

@mgoin mgoin enabled auto-merge (squash) June 19, 2025 06:51
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 19, 2025
@mgoin mgoin disabled auto-merge June 19, 2025 08:04
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) June 19, 2025 08:28
@DarkLight1337 DarkLight1337 merged commit 6f68c49 into vllm-project:main Jun 19, 2025
40 checks passed
juncheoll pushed a commit to juncheoll/vllm that referenced this pull request Jun 20, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: juncheoll <th6re8e@naver.com>
@22quinn 22quinn deleted the doc-v1-pooling branch June 20, 2025 03:58
yeqcharlotte pushed a commit to yeqcharlotte/vllm that referenced this pull request Jun 22, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
juncheoll pushed a commit to juncheoll/vllm that referenced this pull request Jun 23, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: juncheoll <th6re8e@naver.com>
minpeter pushed a commit to minpeter/vllm that referenced this pull request Jun 24, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: minpeter <kali2005611@gmail.com>
gmarinho2 pushed a commit to gmarinho2/vllm that referenced this pull request Jun 26, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jun 30, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
wseaton pushed a commit to wseaton/vllm that referenced this pull request Jun 30, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: Will Eaton <weaton@redhat.com>
wseaton pushed a commit to wseaton/vllm that referenced this pull request Jun 30, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
wwl2755-google pushed a commit to wwl2755-google/vllm that referenced this pull request Jul 1, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
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.

3 participants