Skip to content

[Misc][Tools][Benchmark] Add profile to autotune script #19711

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 2 commits into from
Jun 24, 2025

Conversation

Chenyaaang
Copy link
Contributor

It will save the profile with the best parameter set, for developer use.

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 @Chenyaaang, 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 significantly upgrades the auto_tune.sh benchmark script by incorporating a robust profiling capability. The core objective is to automatically capture and store the performance profile associated with the optimal configuration discovered during the autotuning process, thereby providing developers with critical insights into the performance characteristics of the most efficient settings.

Highlights

  • Profiling Integration: The auto_tune.sh script has been enhanced to integrate performance profiling. It now enables the Torch Profiler for the vllm serve command and passes a dedicated directory for profile output.
  • Best Profile Persistence: A new mechanism is introduced to save the performance profile corresponding to the best parameter set (i.e., the configuration yielding the highest goodput) found during the autotuning process. This profile is stored in a designated profile directory for developer analysis.
  • Profile Management Function: A new update_best_profile function has been added. This function is responsible for identifying the correct profile file from a specific benchmark run and copying it to the central PROFILE_PATH when a new best goodput is achieved.
  • Output Clarity: The final output of the autotuning script now explicitly states the path where the best-performing profile has been saved, improving user experience.
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

The pull request adds functionality to the auto-tune script to save PyTorch profiler outputs (.xplane.pb files) corresponding to the best performing parameter set. This is achieved by enabling profiling in the vLLM server and the benchmark client, then copying the relevant profile files when a new best configuration is found.

A critical typo in array indexing within the update_best_profile function needs to be addressed. Additionally, enhancing the robustness of this function with checks for missing files or directories would improve the script's reliability and error reporting.

Copy link
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

1 similar comment
Copy link
Contributor

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

Signed-off-by: Chenyaaang <chenyangli@google.com>
@yaochengji yaochengji added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 17, 2025
Copy link
Collaborator

@yaochengji yaochengji left a comment

Choose a reason for hiding this comment

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

Thanks for supporting profiling!

local profile_dir="$1/plugins/profile"
local profile_index=$2
sorted_folders=($(find "$profile_dir" -maxdepth 1 -type d -not -path "$profile_dir" | sort))
selected_profile_file="${sorted_folders[$profile_index]}/*.xplane.pb"
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the name xplane is only for TPU profiling result? Should we support other hardware?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added gpu profile result.

@mergify mergify bot added the performance Performance-related issues label Jun 22, 2025
Signed-off-by: Chenyaaang <chenyangli@google.com>
Copy link
Collaborator

@yaochengji yaochengji 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 for the contribution!

@yaochengji yaochengji enabled auto-merge (squash) June 23, 2025 21:26
@yaochengji yaochengji merged commit ee5ad8d into vllm-project:main Jun 24, 2025
49 checks passed
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
…#19711)

Signed-off-by: Chenyaaang <chenyangli@google.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
performance Performance-related issues 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.

3 participants