Log SMC progress via Python logger when progress bar deactivated #7410
Conversation
This file contains 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
Output terminals that do not support cursor movement ANSI control sequences do not support rich ProgressBars, and thus need progressbar=false. However, it is still very worthy to know how the SMC tasks are progressing. Therefore, when progress bars are deactivated, any chance to the state of the chains is logged to the default logger, using the exact same state dictionary as used for the progressbars. The fact we only log when a change happens means we do not flood the log. The use of the logging facility also allows the called to add timestamps in the logging handlers for a sense of elapsing time.
|
@fonnesbeck That might be of interest to you :) |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7410 +/- ##
=======================================
Coverage 92.18% 92.18%
=======================================
Files 103 103
Lines 17258 17270 +12
=======================================
+ Hits 15909 15921 +12
Misses 1349 1349
|
|
@zaxtax @ricardoV94 Would you please be able to review, given how you were the reviewers for #7233 and thus already know that part of the code? Thank you :) |
|
I'm still not convinced the change to rich progressbar was a net positive :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Output terminals that do not support cursor movement ANSI control sequences behave very badly with Rich ProgressBars, and thus need progressbar=false. See discussion in #7233 (comment)
However, even in those cases it is still very worthy to know how the SMC tasks are progressing.
Therefore, in this PR, when progress bars are deactivated, any change to the state of the chains is logged to the default logger, using the exact same state dictionary as used for the progressbars. The fact we only log when a change happens means we do not flood the log.
The use of the logging facility also allows the caller to add timestamps in the logging handlers for a sense of elapsing time, or to filter out these progress updates.
Related Issue
Checklist
Included tests that prove the fix is effective or that the new feature works(no test for logging)Added necessary documentation (docstrings and/or example notebooks)(no documentation necessary)Type of change
📚 Documentation preview 📚: https://pymc--7410.org.readthedocs.build/en/7410/