-
-
Notifications
You must be signed in to change notification settings - Fork 11k
[Doc] Update V1 Guide for embedding models #19141
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: DarkLight1337 <[email protected]>
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.
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.mdfile 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
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
-
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 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.
|
👋 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: DarkLight1337 <[email protected]>
Essential Elements of an Effective PR Description Checklist
Purpose
Update the V1 Guide based on #16188 (review)
cc @maxdebayser @22quinn