Skip to content

[Misc] Improve logging for dynamic shape cache compilation #20573

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 4 commits into from
Jul 8, 2025

Conversation

kyolebu
Copy link
Contributor

@kyolebu kyolebu commented Jul 7, 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

Screenshot 2025-07-07 at 9 32 51 AM

When a graph is compiled for dynamic shapes, the previous log message ("Cache the graph of shape None for later use") is ambiguous. This update makes it clear that the cached graph supports dynamic inputs, improving clarity of the compilation process.

Slack Issue: https://vllm-dev.slack.com/archives/C08K1FAHFPH/p1751506800619009

Test Plan

Test Result

(Optional) Documentation Update

Copy link

github-actions bot commented Jul 7, 2025

👋 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 @kyolebu, 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 focuses on a minor but helpful improvement to the logging within the compilation backend. The change ensures that when a graph is cached, the log message accurately reflects whether a specific static shape or a dynamic shape is being cached, enhancing observability during compilation.

Highlights

  • Improved Logging: I've updated the informational log message emitted when a graph is cached. Previously, it always attempted to log a specific shape. Now, if the runtime_shape is None (indicating a dynamic shape), the log message will explicitly state "Cache the graph for DYNAMIC shape for later use", providing clearer context for dynamic shape compilation. Otherwise, it will continue to log the specific shape.
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.

@kyolebu kyolebu changed the title [Core'improve logging for dynamic shape cache compilation [Core] Improve logging for dynamic shape cache compilation Jul 7, 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

This pull request improves logging for dynamic shape cache compilation by providing a more descriptive message when runtime_shape is None.

Comment on lines 181 to 185
if runtime_shape is None:
logger.info("Cache the graph for DYNAMIC shape for later use")
else:
logger.info("Cache the graph of shape %s for later use",
str(runtime_shape))
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This if/else block can be simplified using a conditional expression for constructing the log message, improving readability.

                shape_log_msg = "for DYNAMIC shape" if runtime_shape is None else f"of shape {runtime_shape}"
                logger.info(f"Cache the graph {shape_log_msg} for later use")

@kyolebu kyolebu changed the title [Core] Improve logging for dynamic shape cache compilation [Misc] Improve logging for dynamic shape cache compilation Jul 7, 2025
@tlrmchlsmth tlrmchlsmth added the ready ONLY add when PR is ready to merge/full CI is needed label Jul 7, 2025
Copy link
Collaborator

@tlrmchlsmth tlrmchlsmth 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!

For future improvement, it looks like there are some other places we should hit as well:

logger.info(
"Directly load the compiled graph(s) for shape %s "
"from the cache, took %.3f s", str(runtime_shape), elapsed)

It'd also be nice to be consistent about general vs dynamic shape in the logs:

if runtime_shape is None:
logger.info("Compiling a graph for general shape takes %.2f s",
elapsed)
else:
logger.info("Compiling a graph for shape %s takes %.2f s",
runtime_shape, elapsed)

@kyolebu
Copy link
Contributor Author

kyolebu commented Jul 7, 2025

Looks good, thanks!

For future improvement, it looks like there are some other places we should hit as well:

logger.info(
"Directly load the compiled graph(s) for shape %s "
"from the cache, took %.3f s", str(runtime_shape), elapsed)

It'd also be nice to be consistent about general vs dynamic shape in the logs:

if runtime_shape is None:
logger.info("Compiling a graph for general shape takes %.2f s",
elapsed)
else:
logger.info("Compiling a graph for shape %s takes %.2f s",
runtime_shape, elapsed)

Updated other log areas to be consistent with the new changes for dynamic shape. Also changed wording from "general" to "dynamic." Thanks for the feedback!

Signed-off-by: kyolebu <[email protected]>
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) July 7, 2025 20:22
@mgoin mgoin merged commit d2e841a into vllm-project:main Jul 8, 2025
67 checks passed
huydhn pushed a commit to huydhn/vllm that referenced this pull request Jul 8, 2025
Chen-zexi pushed a commit to Chen-zexi/vllm that referenced this pull request Jul 13, 2025
patrickvonplaten pushed a commit to patrickvonplaten/vllm that referenced this pull request Jul 15, 2025
LyrisZhong pushed a commit to LyrisZhong/vllm that referenced this pull request Jul 23, 2025
avigny pushed a commit to avigny/vllm that referenced this pull request Jul 31, 2025
Pradyun92 pushed a commit to Pradyun92/vllm that referenced this pull request Aug 6, 2025
npanpaliya pushed a commit to odh-on-pz/vllm-upstream that referenced this pull request Aug 6, 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.

4 participants