Skip to content

[Core] Add update_config RPC method #20095

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

22quinn
Copy link
Collaborator

@22quinn 22quinn commented Jun 25, 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

Part of #19886

Test Plan

# Create an LLM without loading real weights
llm = LLM(
    model="facebook/opt-125m",
    load_format="dummy",
    enforce_eager=True,
)

llm.collective_rpc("update_config", args=({"load_config": {"load_format": "auto"}},))
llm.collective_rpc("load_model")

# Check real weights are loaded
outputs = llm.generate(prompts, sampling_params)
print("\nGenerated Outputs:\n" + "-" * 60)
for output in outputs:
    prompt = output.prompt
    generated_text = output.outputs[0].text
    print(f"Prompt:    {prompt!r}")
    print(f"Output:    {generated_text!r}")
    print("-" * 60)

Test Result

Generated Outputs:
------------------------------------------------------------
Prompt:    'Hello, my name is'
Output:    ' Joel, my dad is my friend and we are in a relationship. I am'
------------------------------------------------------------
Prompt:    'The president of the United States is'
Output:    ' reportedly being investigated by the FBI over the allegations that he broke campaign finance laws in'
------------------------------------------------------------
Prompt:    'The capital of France is'
Output:    ' all set to open a new gateway to the most notorious terror camps in Europe,'
------------------------------------------------------------
Prompt:    'The future of AI is'
Output:    ' in their hands. We cannot prevent the future.\nAgreed.  '
------------------------------------------------------------

(Optional) Documentation Update

22quinn added 3 commits June 19, 2025 17:57
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.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.

🚀

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 @22quinn, 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 a new RPC method, update_config, designed to provide greater flexibility in managing model configurations within the vLLM framework. This enhancement allows for programmatic adjustments to various configuration objects on both GPU and TPU model runners, enabling dynamic changes such as altering model loading behavior after initialization but prior to the actual model weights being loaded.

Highlights

  • New RPC Method: I've added a new RPC method, update_config, to the core vLLM system. This method allows for dynamic modification of configuration objects (e.g., load_config) on ModelRunner instances.
  • Configuration Update Mechanism: The update_config method is implemented to iterate through provided overrides, retrieve the existing configuration object, and then use dataclasses.replace to create a new configuration with the specified changes. This ensures that configuration objects are updated immutably and correctly.
  • Worker Integration: The GPUWorker and TPUWorker classes now expose the update_config method, which simply delegates the call to their respective model_runner instances. This makes the new configuration update functionality accessible at the worker level, enabling scenarios like updating load_format before model loading.
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 v1 tpu Related to Google TPUs labels Jun 25, 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 an update_config RPC method to both GPU and TPU model runners, allowing for dynamic updates to configuration parameters at runtime. The code includes basic error handling for unknown configurations but lacks type validation for the override values, which could lead to runtime issues. Consider adding type validation to ensure the override values match the expected types.

Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Copy link
Collaborator

@aarnphm aarnphm left a comment

Choose a reason for hiding this comment

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

It seems like we might want to merge recursively here. might be good to have a utils for it to implement deepmerge 🤔

Copy link
Collaborator

@aarnphm aarnphm left a comment

Choose a reason for hiding this comment

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

some comments

Copy link
Collaborator

@houseroad houseroad left a comment

Choose a reason for hiding this comment

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

Otherwise, looks good to me.

@houseroad houseroad added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 26, 2025
@ProExpertProg
Copy link
Collaborator

Do we have tests that this works correctly with quantization and torch compilation?

22quinn added 2 commits June 26, 2025 13:34
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Copy link

mergify bot commented Jun 26, 2025

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

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 Jun 26, 2025
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
@mergify mergify bot removed the needs-rebase label Jun 27, 2025
@@ -1721,6 +1721,14 @@ def generate_draft_token_ids(
draft_token_ids.append(drafter_output.tolist())
return draft_token_ids

def update_config(self, overrides: dict[str, Any]) -> None:
Copy link
Collaborator

Choose a reason for hiding this comment

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

this function feels a bit scary to to be really honest. due to:
1/ not every config would be updatable even if they exist -- for example updating parallel_config probably wouldn't work :(
2/ do we guarantee that the model runner always read values from self.xxxx_config not vllm_config.xxxx_config?
3/ how do we ensure the new config is a valid config for its type?

potentially we can limit updates to limited known good configs first

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

  1. very good point. I've updated the PR to restrict the change to load_config and model_config for now, to fulfill our purpose of model/weights update
  2. this is messy in model runner itself, we should perhaps clean up in a separate PR.
  3. pydantic config validation still runs as we do dataclasses.replace

22quinn added 5 commits June 26, 2025 18:47
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
Signed-off-by: 22quinn <33176974+22quinn@users.noreply.github.com>
@22quinn
Copy link
Collaborator Author

22quinn commented Jun 27, 2025

It seems like we might want to merge recursively here. might be good to have a utils for it to implement deepmerge 🤔

@aarnphm Good point! I've added a recursive merge function to support updating nested config, with unit tests.

@aarnphm aarnphm requested review from aarnphm and houseroad June 27, 2025 04:40
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.

5 participants