Skip to content

[Kernel] correct cpu worker function parameter type #19745

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

Conversation

andyxning
Copy link
Contributor

@andyxning andyxning commented Jun 17, 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

The type hints for src_to_dst and src_to_dsts should be torch.Tensor.

Test Plan

NA

Test Result

NA

(Optional) Documentation Update

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 @andyxning, 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 focuses on enhancing code clarity and correctness by refining type hints for parameters in CPU worker functions, ensuring they accurately reflect the use of torch.Tensor objects for cache operations. A small stylistic cleanup was also included.

Highlights

  • Type Hint Refinement: Updated the type hints for src_to_dst and src_to_dsts parameters in the swap_in, swap_out, and copy methods within vllm/worker/cpu_worker.py from dictionary types to torch.Tensor. This clarifies the expected input type for these cache operation functions.
  • Minor Code Style Improvement: Removed redundant parentheses from a tuple return statement in the get_kv_cache_shape static method within vllm/attention/ops/ipex_attn.py, improving code readability.
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.

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 type hints for src_to_dst in swap_in/swap_out methods and src_to_dsts in the copy method of CPUCacheEngine to torch.Tensor. These changes align the method signatures with their intended usage, the WorkerInput data structures, and the underlying attention backend interfaces (specifically IPEXAttnBackend). This enhances code clarity, maintainability, and type consistency.

@@ -88,13 +88,13 @@ def _allocate_kv_cache(
torch.empty(kv_cache_shape, dtype=self.dtype, device="cpu"))
return kv_cache

def swap_in(self, src_to_dst: Dict[int, int]) -> None:
def swap_in(self, src_to_dst: torch.Tensor) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Changing the type hint for src_to_dst from Dict[int, int] to torch.Tensor improves type consistency with the blocks_to_swap_in field in the WorkerInput dataclass and the swap_blocks method in the IPEXAttnBackend.

src_to_dst: torch.Tensor

raise NotImplementedError("Swap is not supported in CPUCacheEngine.")

def swap_out(self, src_to_dst: Dict[int, int]) -> None:
def swap_out(self, src_to_dst: torch.Tensor) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Updating the type hint for src_to_dst to torch.Tensor improves type consistency with the blocks_to_swap_out field in WorkerInput and the IPEXAttnBackend.swap_blocks method signature.

src_to_dst: torch.Tensor

raise NotImplementedError("Swap is not supported in CPUCacheEngine.")

def copy(self, src_to_dsts: Dict[int, List[int]]) -> None:
def copy(self, src_to_dsts: torch.Tensor) -> None:
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

Changing the type hint for src_to_dsts from Dict[int, List[int]] to torch.Tensor improves type consistency with the blocks_to_copy which is a torch.Tensor in CPUWorker.prepare_worker_input and with the IPEXAttnBackend.copy_blocks method, which expects src_to_dists: torch.Tensor.

src_to_dsts: torch.Tensor

Signed-off-by: Andy Xie <andy.xning@gmail.com>
@andyxning andyxning force-pushed the correct_cpu_worker_function_parameter_type branch from ff513aa to e59c760 Compare June 17, 2025 14:41
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.

LGTM, thanks!

@mgoin mgoin enabled auto-merge (squash) June 20, 2025 06:53
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 20, 2025
@mgoin mgoin merged commit 71d1219 into vllm-project:main Jun 20, 2025
77 checks passed
@andyxning andyxning deleted the correct_cpu_worker_function_parameter_type branch June 20, 2025 13:52
yeqcharlotte pushed a commit to yeqcharlotte/vllm that referenced this pull request Jun 22, 2025
juncheoll pushed a commit to juncheoll/vllm that referenced this pull request Jun 23, 2025
Signed-off-by: Andy Xie <andy.xning@gmail.com>
Signed-off-by: juncheoll <th6re8e@naver.com>
fhl2000 pushed a commit to fhl2000/vllm that referenced this pull request Jun 25, 2025
Signed-off-by: Andy Xie <andy.xning@gmail.com>
Signed-off-by: fhl <2410591650@qq.com>
gmarinho2 pushed a commit to gmarinho2/vllm that referenced this pull request Jun 26, 2025
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jun 30, 2025
wseaton pushed a commit to wseaton/vllm that referenced this pull request Jun 30, 2025
Signed-off-by: Andy Xie <andy.xning@gmail.com>
Signed-off-by: Will Eaton <weaton@redhat.com>
wseaton pushed a commit to wseaton/vllm that referenced this pull request Jun 30, 2025
wwl2755-google pushed a commit to wwl2755-google/vllm that referenced this pull request Jul 1, 2025
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants