Skip to content

[KVConnector] Always call connector clear_metadata() at end of step#20756

Merged
njhill merged 2 commits intovllm-project:mainfrom
njhill:clear-kv-metadata
Jul 10, 2025
Merged

[KVConnector] Always call connector clear_metadata() at end of step#20756
njhill merged 2 commits intovllm-project:mainfrom
njhill:clear-kv-metadata

Conversation

@njhill
Copy link
Member

@njhill njhill commented Jul 10, 2025

  • Move call to clear_metadata() from model runner into calling method in worker, so that it's always the last connector method called per step.
  • Reset the connector _connector_metadata field to None rather than an empty KVConnectorMetadata superclass; make that class abstract.
  • Dedup the aggregation logic in multiproc_executor.py.

This PR is mostly changes suggested by @sdavidbd in #19555 (comment).

cc @orozery

Signed-off-by: Nick Hill <nhill@redhat.com>

Co-authored-by: David Ben-David <sdavidbd@gmail.com>
Signed-off-by: Nick Hill <nhill@redhat.com>
@github-actions
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.

🚀

@mergify mergify bot added the v1 label Jul 10, 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.

Summary of Changes

Hello @njhill, 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 refines the management of KVConnector metadata by ensuring the clear_metadata() method is consistently called at the appropriate stage of the execution pipeline. It relocates this crucial cleanup operation to guarantee its execution at the end of each processing step, improving the reliability of the KV transfer mechanism. Additionally, it includes minor refactoring for improved code clarity and maintainability.

Highlights

  • KVConnector Metadata Management: The KVConnectorMetadata class is now an Abstract Base Class (ABC), and the _connector_metadata attribute within KVConnectorBase_V1 is explicitly typed as Optional and initialized to None. This enhances type safety and clarifies the lifecycle of metadata objects.
  • Relocation of clear_metadata() Call: The call to get_kv_transfer_group().clear_connector_metadata() has been moved from vllm/v1/worker/gpu_model_runner.py to vllm/v1/worker/gpu_worker.py. This ensures the KVConnector metadata is consistently cleared at the end of every processing step within the execute_model method, aligning with the intended cleanup timing.
  • Code Refactoring for Aggregation Logic: In vllm/v1/executor/multiproc_executor.py, the _aggregate_workers_output method has been refactored. A new helper function, update_finished_set, was introduced to deduplicate and streamline the logic for processing and updating finished_sending and finished_recving sets.
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 correctly moves the clear_connector_metadata() call to a more reliable location at the end of the worker step, ensuring it's always executed. The changes in base.py to make KVConnectorMetadata an ABC and use Optional typing improve code clarity and correctness. The refactoring in multiproc_executor.py to eliminate duplicated code is also a good improvement for maintainability. Overall, the changes are well-implemented and address the intended issue effectively.

Signed-off-by: Nick Hill <nhill@redhat.com>

Co-authored-by: David Ben-David <sdavidbd@gmail.com>
Signed-off-by: Nick Hill <nhill@redhat.com>
@njhill njhill added the ready ONLY add when PR is ready to merge/full CI is needed label Jul 10, 2025
Copy link
Collaborator

@KuntaiDu KuntaiDu left a comment

Choose a reason for hiding this comment

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

LGTM!

@njhill njhill merged commit 574ad60 into vllm-project:main Jul 10, 2025
77 checks passed
@njhill njhill deleted the clear-kv-metadata branch July 10, 2025 21:37
Pradyun92 pushed a commit to Pradyun92/vllm that referenced this pull request Aug 6, 2025
…vllm-project#20756)

Signed-off-by: Nick Hill <nhill@redhat.com>
Co-authored-by: David Ben-David <sdavidbd@gmail.com>
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 2025
…vllm-project#20756)

Signed-off-by: Nick Hill <nhill@redhat.com>
Co-authored-by: David Ben-David <sdavidbd@gmail.com>
jinzhen-lin pushed a commit to jinzhen-lin/vllm that referenced this pull request Aug 9, 2025
…vllm-project#20756)

Signed-off-by: Nick Hill <nhill@redhat.com>
Co-authored-by: David Ben-David <sdavidbd@gmail.com>
Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
paulpak58 pushed a commit to paulpak58/vllm that referenced this pull request Aug 13, 2025
…vllm-project#20756)

Signed-off-by: Nick Hill <nhill@redhat.com>
Co-authored-by: David Ben-David <sdavidbd@gmail.com>
Signed-off-by: Paul Pak <paulpak58@gmail.com>
diegocastanibm pushed a commit to diegocastanibm/vllm that referenced this pull request Aug 15, 2025
…vllm-project#20756)

Signed-off-by: Nick Hill <nhill@redhat.com>
Co-authored-by: David Ben-David <sdavidbd@gmail.com>
Signed-off-by: Diego-Castan <diego.castan@ibm.com>
epwalsh pushed a commit to epwalsh/vllm that referenced this pull request Aug 27, 2025
…vllm-project#20756)

Signed-off-by: Nick Hill <nhill@redhat.com>
Co-authored-by: David Ben-David <sdavidbd@gmail.com>
@hidva hidva mentioned this pull request Nov 4, 2025
4 tasks
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 v1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants