Skip to content
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

feat: add dump_stats to advanced profiler (#19698) #19703

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

clumsy
Copy link
Contributor

@clumsy clumsy commented Mar 26, 2024

What does this PR do?

Adding a new dump_stats flag to AdvanedProfiler to persist .prof files collected during profiling. These files can be visualized by SnakeViz like so: snakeviz fit-run-[Strategy]DDPStrategy.on_train_end.prof

Screenshot 2024-03-26 at 10 04 17 AM

A .prof file is created for each profiled action, e.g.:

...
fit-run-[Strategy]DDPStrategy.on_train_end.prof
fit-run-[Callback]TQDMProgressBar.on_fit_end.prof
fit-run-[Callback]ModelSummary.on_fit_end.prof
fit-run-[Callback]ModelCheckpoint{'monitor': None, 'mode': 'min', 'every_n_train_steps': 0, 'every_n_epochs': 1, 'train_time_interval': None}.on_fit_end.prof
fit-run-[Callback]LearningRateMonitor.on_fit_end.prof
...

Fixes #19698

No breaking changes, adding a new backward-compatible flag, with the new functionality disabled by default.

Before submitting
  • Was this discussed/agreed via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

📚 Documentation preview 📚: https://pytorch-lightning--19703.org.readthedocs.build/en/19703/

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Mar 26, 2024
@clumsy
Copy link
Contributor Author

clumsy commented Mar 26, 2024

For your consideration, @awaelchli

@clumsy clumsy force-pushed the feat/advanced_profiler_dump_stats branch from cf1947c to 0c21547 Compare March 26, 2024 14:31
@clumsy
Copy link
Contributor Author

clumsy commented Apr 8, 2024

Are there any concerns about this change, @awaelchli? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has conflicts pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dump prof files from AdvancedProfiler
2 participants