Add DeviceSummary callback to control device printout #21457
+285
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR adds a `DeviceSummary` callback and `enable_device_summary` Trainer flag to control the device availability printout (GPU, TPU info), addressing issue Lightning-AI#13378. Changes: - Add `DeviceSummary` callback in `callbacks/device_summary.py` - Add `enable_device_summary` parameter to Trainer (default True) - Remove direct `_log_device_info` call from Trainer init - Device info is now logged via callback at setup stage - Add `show_warnings` parameter to control availability warnings - Handle barebones mode (disable device summary) - Add comprehensive tests Usage: ```python # Default - shows device info trainer = Trainer() # Disable device summary trainer = Trainer(enable_device_summary=False) # Custom callback with warnings disabled trainer = Trainer(callbacks=[DeviceSummary(show_warnings=False)]) ``` Fixes Lightning-AI#13378 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
yurekami
requested review from
ethanwharris,
justusschock,
lantiga and
tchaton
as code owners
for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR adds a
DeviceSummarycallback andenable_device_summaryTrainer flag to control the device availability printout (GPU, TPU info), addressing issue #13378.Based on the discussion in #13378, the callback approach was chosen as it:
ModelSummaryis handledChanges
DeviceSummarycallback incallbacks/device_summary.pyenable_device_summaryparameter to Trainer (defaultTrue)_log_device_infocall from Trainer initshow_warningsparameter to control availability warningsUsage
Test plan
Fixes #13378
🤖 Generated with Claude Code
📚 Documentation preview 📚: https://pytorch-lightning--21457.org.readthedocs.build/en/21457/