Skip to content

Expose PyTorch profiler configuration to environment variables #21803

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jul 30, 2025
Merged

Expose PyTorch profiler configuration to environment variables #21803

merged 4 commits into from
Jul 30, 2025
+60 −4

Conversation

Csrayz
Copy link
Contributor

@Csrayz Csrayz commented Jul 29, 2025 •
edited
Loading

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

Expose inference-related profiler configuration in the worker to environment variables.

  • [FEAT] Expose PyTorch profiler config via environment variables
  • [DOC] update profiling.md
  • NOT change profiler in v0 worker. related to [RFC]: Deprecating vLLM V0 #18571

Test Plan

Test Result

(Optional) Documentation Update

Update docs/contributing/profiling.md for new profiler-related environment variables

@mergify mergify bot added documentation Improvements or additions to documentation v1 labels Jul 29, 2025
gemini-code-assist[bot]
gemini-code-assist bot reviewed Jul 29, 2025
View reviewed changes
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 exposes several PyTorch profiler configurations through environment variables, which is a great enhancement for debugging and performance analysis. My review focuses on an inconsistency in the naming of one of the new environment variables. The variable for memory profiling is named VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY in the code, but the documentation and consistency with other flags suggest it should be VLLM_TORCH_PROFILER_PROFILE_MEMORY. I've provided suggestions to correct this across the codebase to ensure consistency and prevent user confusion.

@github-actions 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.

🚀

@Csrayz
Expose PyTorch profiler configuration to environment variables
ac65e79 
* [FEAT] Expose PyTorch profiler config via environment variables
* [DOC] update profiling.md
* NOT change profiler in v0 worker. related to vllm-project#18571

Signed-off-by: Csrayz <[email protected]>
@Csrayz
[FIX] inconsistency in the naming of one of the new environment
78d3a44 
variables `VLLM_TORCH_PROFILER_WITH_PROFILE_MEMORY`

Signed-off-by: Csrayz <[email protected]>
@Csrayz
[FIX] fix lint
16a9d8e 
Signed-off-by: Csrayz <[email protected]>
jikunshang
jikunshang approved these changes Jul 29, 2025
View reviewed changes
Copy link
Collaborator

@jikunshang jikunshang 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 contributing!

@jikunshang jikunshang added the ready ONLY add when PR is ready to merge/full CI is needed label Jul 29, 2025
hmellor
hmellor reviewed Jul 29, 2025
View reviewed changes
@Csrayz
Copy link
Contributor Author

Csrayz commented Jul 29, 2025

Why does accepting a commit suggestion cause the DCO workflow to fail?

@DarkLight1337
Copy link
Member

It's because GitHub doesn't sign off the commits

@Csrayz
[DOC] Change the Profiler environment variable descriptions from
ba69230 
paragraphs to an unordered list

Signed-off-by: Csrayz <[email protected]>
@Csrayz
Copy link
Contributor Author

Csrayz commented Jul 30, 2025

Any way to run those workflow again? It seems like the failure was caused by network fluctuations.

PixPin_2025-07-30_09-06-18

@vllm-bot vllm-bot merged commit b917da4 into vllm-project:main Jul 30, 2025
62 of 65 checks passed
@DarkLight1337
Copy link
Member

Force merging as the CI failures aren't related

@noooop
Copy link
Contributor

noooop commented Jul 30, 2025

@DarkLight1337

Perhaps this PR is the first buildkite/ci/entrypoints-test-api-server - Failed

@DarkLight1337
Copy link
Member

I have seen these failures yesterday as well

@noooop
Copy link
Contributor

noooop commented Jul 30, 2025 •
edited
Loading

Hmm

There were indeed earlier failures

https://buildkite.com/vllm/ci/builds/25184/steps/canvas?jid=019851ec-29c3-4f63-a655-d664b88e80a0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hmellor hmellor hmellor left review comments

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

@jikunshang jikunshang jikunshang approved these changes

@WoosukKwon WoosukKwon Awaiting requested review from WoosukKwon WoosukKwon is a code owner

@robertgshaw2-redhat robertgshaw2-redhat Awaiting requested review from robertgshaw2-redhat robertgshaw2-redhat is a code owner

@njhill njhill Awaiting requested review from njhill njhill is a code owner

@ywang96 ywang96 Awaiting requested review from ywang96 ywang96 is a code owner

@comaniac comaniac Awaiting requested review from comaniac comaniac is a code owner

@alexm-redhat alexm-redhat Awaiting requested review from alexm-redhat alexm-redhat is a code owner

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed v1
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Csrayz @DarkLight1337 @noooop @hmellor @jikunshang @vllm-bot