Refactor progress bars #1272
Merged
Refactor progress bars #1272
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
tqdm progress bars are used in a couple of places. They don't play so well in non-interactive jobs, testing, ... . They also cause trouble with nbspinx (ICB-DCM#1246, ICB-DCM#1271). Progress bars can be disabled for specific tasks, but not globally (or at least not very conveniently). Since recently, tqdm can be controlled via environment variables (e.g., disabling all progress bars or changing update frequency). However, this works by changing the argument defaults, so it only works if we don't pass explicit `disable=...`. Therefore, this PR introduces some wrapper that checks whether the user explicitly enabled/disabled progress bars. If not, we go with the tqdm default, which means showing all progress bars unless globally disabled. An additional `enabled` argument is added for convenience.
dweindl
requested review from
dilpath,
vwiela,
PaulJonasJost and
a team
as code owners
Codecov ReportAttention:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## develop #1272 +/- ##
===========================================
- Coverage 84.60% 84.59% -0.02%
===========================================
Files 148 148
Lines 12112 12122 +10
===========================================
+ Hits 10247 10254 +7
- Misses 1865 1868 +3 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Dilan Pathirana <59329744+dilpath@users.noreply.github.com>
This was referenced Jan 9, 2024
dweindl
added a commit
to dweindl/pyPESTO
that referenced
this pull request
Jan 9, 2024
A subset of ICB-DCM#1246. After ICB-DCM#1272. Co-authored-by: Doresic <domagoj.doresic@gmail.com>
dweindl
added a commit
to dweindl/pyPESTO
that referenced
this pull request
Jan 9, 2024
A subset of ICB-DCM#1246. After ICB-DCM#1272. Co-authored-by: Doresic <domagoj.doresic@gmail.com>
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.
tqdm progress bars are used in a couple of places. They don't play so well in non-interactive jobs, testing, ... . They also cause trouble with nbspinx (#1246, #1271).
Progress bars can be disabled for specific tasks, but not globally (or at least not very conveniently).
Since recently, tqdm can be controlled via environment variables (e.g., disabling all progress bars or changing update frequency). However, this works by changing the argument defaults, so it only works if we don't pass explicit
disable=.... Therefore, this PR introduces some wrapper that checks whether the user explicitly enabled/disabled progress bars. If not, we go with the tqdm default, which means showing all progress bars unless globally disabled. An additionalenabledargument is added for convenience.