Skip to content

[Model][VLM] Support Keye-VL-8B-Preview #20126

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 14 commits into from
Jul 2, 2025

Conversation

Kwai-Keye
Copy link
Contributor

@Kwai-Keye Kwai-Keye commented Jun 26, 2025

Purpose

Example Serving Command

  • The model can be served with
vllm serve \
    Kwai-Keye/Keye-VL-8B-Preview \
    --tensor-parallel-size 8 \
    --enable-prefix-caching \
    --gpu-memory-utilization 0.8 \
    --host 0.0.0.0 \
    --port 8001 \
    --trust-remote-code

Thank you for your time on reviewing this PR :)

@Kwai-Keye Kwai-Keye requested a review from aarnphm as a code owner June 26, 2025 13:33
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 @Kwai-Keye, 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 introduces full support for the Keye-VL-8B-Preview model within vLLM. It includes the necessary components for processing multimodal inputs (images and videos), integrating a vision encoder with the language model, and registering the new model for seamless deployment and serving.

Highlights

  • New Model Support: Adds comprehensive support for the Keye-VL-8B-Preview Vision-Language Model (VLM), enabling it to be served by vLLM.
  • Multimodal Processing: Implements a dedicated KeyeProcessor and related multimodal data handling components to correctly process image and video inputs for the Keye model, including tokenization and embedding integration.
  • Vision Backbone Integration: Integrates a Siglip-based vision encoder and a projector module to extract and transform visual features, which are then merged with the language model's embeddings.
  • Model Registration: Registers the KeyeForConditionalGeneration model within vLLM's internal registry, making it discoverable and loadable via its model name.
  • Token Handling: Updates chat_utils.py to ensure the Keye model correctly uses Qwen-style vision tokens (<|vision_start|><|image_pad|><|vision_end|>, etc.) for multimodal inputs.
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 frontend label Jun 26, 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.

Code Review

The pull request introduces support for the Keye-VL-8B-Preview model, including its vision and multimodal processing components. The changes involve adding new model definitions and integrating them into the existing vLLM framework. The review identifies several areas for improvement related to code clarity, consistency, error handling, and adherence to best practices.

@aarnphm aarnphm requested a review from ywang96 June 27, 2025 04:49
Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

Thanks for adding this model. Left a few initial comments

…ngs() in get_input_embeddings_v0()

Signed-off-by: Kwai-Keye <[email protected]>
…gs & add keye to test registry

Signed-off-by: Kwai-Keye <[email protected]>
@Kwai-Keye Kwai-Keye requested a review from hmellor as a code owner July 1, 2025 10:00
@mergify mergify bot added the documentation Improvements or additions to documentation label Jul 1, 2025
Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

LGTM now (I assume you have tested the examples already)

@DarkLight1337 DarkLight1337 added the ready ONLY add when PR is ready to merge/full CI is needed label Jul 1, 2025
@Kwai-Keye Kwai-Keye requested a review from Isotr0py July 1, 2025 10:54
Copy link
Collaborator

@Isotr0py Isotr0py left a comment

Choose a reason for hiding this comment

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

LGTM now! Would be good if we can add SDPA support for ViT attention in a following PR.

@Isotr0py Isotr0py enabled auto-merge (squash) July 1, 2025 11:37
auto-merge was automatically disabled July 1, 2025 12:00

Head branch was pushed to by a user without write access

@Kwai-Keye Kwai-Keye requested a review from Isotr0py July 1, 2025 12:06
Copy link

mergify bot commented Jul 1, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @Kwai-Keye.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Jul 1, 2025
@Kwai-Keye
Copy link
Contributor Author

LGTM now! Would be good if we can add SDPA support for ViT attention in a following PR.

Considering that xformers is a default dependency listed in requirements/cuda.txt, we've prioritized supporting the xformers backend first~ Kwai-Keye@475d004

@mergify mergify bot removed the needs-rebase label Jul 1, 2025
@Isotr0py Isotr0py enabled auto-merge (squash) July 1, 2025 14:49
auto-merge was automatically disabled July 2, 2025 03:00

Head branch was pushed to by a user without write access

@Isotr0py Isotr0py enabled auto-merge (squash) July 2, 2025 03:15
@vllm-bot vllm-bot merged commit 8452946 into vllm-project:main Jul 2, 2025
64 of 67 checks passed
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 frontend 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.

4 participants