Skip to content

Conversation

yaochengji
Copy link
Collaborator

@yaochengji yaochengji commented Jun 13, 2025

Purpose

To support models whose head dim is smaller than 128 on TPU.
Note: for head_dim which is a multiply of 128, we will support it in a separate PR.

Test Plan

pytest -s -v tests/v1/tpu/test_basic.py::test_phi3

Test Result

Passed.

Signed-off-by: Chengji Yao <chengjiyao@google.com>
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.

🚀

@yaochengji yaochengji requested a review from mgoin June 13, 2025 18:41
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 @yaochengji, 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 enables VLLM to run models with attention head dimensions less than 128 on TPU devices. This is achieved by strategically padding tensors to meet the hardware's requirement for dimensions to be multiples of 128 during attention computation and KV cache operations, and then unpadding the final output. A dedicated test case for a relevant model has been included.

Highlights

  • TPU Support Expansion: I've added support for attention head dimensions smaller than 128 when running on TPU, addressing a previous limitation.
  • Padding Implementation: To accommodate TPU hardware requirements, I've implemented padding for query, key, and value tensors, as well as the KV cache, to ensure the head dimension is a multiple of 128 during computation. The padding is removed from the final output.
  • New Test Case: A new test (test_phi3) has been added specifically for models like Phi-3 (which has a head size of 96) to verify the new functionality on TPU.
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 configureGemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@mergify mergify bot added v1 tpu Related to Google TPUs labels Jun 13, 2025
@yaochengji yaochengji requested a review from vanbasten23 June 13, 2025 18:42
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 adds support for attention head dimensions smaller than 128 on TPUs. The changes are well-targeted, and a new test case validates the functionality. The review includes suggestions to enhance maintainability and clarify a potentially redundant check.

Signed-off-by: Chengji Yao <chengjiyao@google.com>
@yaochengji yaochengji requested a review from lsy323 June 13, 2025 19:58

logger = init_logger(__name__)

# TPU requires the head size to be a multiple of 128.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is it more of a Pallas kernel requirement?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I believe the fundamental issue lies with the TPU hardware. We need to implement padding, either within the model or the kernel. In this case, we've opted to pad at the model level.

Copy link
Collaborator

@vanbasten23 vanbasten23 left a comment

Choose a reason for hiding this comment

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

Looks good. Thanks Chengji.

Copy link
Member

@mgoin mgoin left a comment

Choose a reason for hiding this comment

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

Great idea!

yaochengji and others added 2 commits June 14, 2025 21:31
Signed-off-by: Chengji Yao <chengjiyao@google.com>
@mgoin mgoin enabled auto-merge (squash) June 16, 2025 02:30
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 16, 2025
@mgoin mgoin merged commit a77aea5 into vllm-project:main Jun 16, 2025
76 of 77 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready ONLY add when PR is ready to merge/full CI is needed tpu Related to Google TPUs v1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants