Enable RichProgressBar by default if Rich is available #9647
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
SeanNaren
requested review from
awaelchli,
Borda,
carmocca,
justusschock,
kaushikb11,
tchaton and
williamFalcon
as code owners
rohitgr7
reviewed
Sep 22, 2021
# Conflicts: # CHANGELOG.md
Co-authored-by: Rohit Gupta <[email protected]>
awaelchli
approved these changes
Sep 23, 2021
…eat/enable_rich_default # Conflicts: # pytorch_lightning/trainer/connectors/callback_connector.py
Co-authored-by: Danielle Pintz <[email protected]>
awaelchli
reviewed
Oct 25, 2021
Borda
reviewed
Oct 25, 2021
Comment on lines
245
to
249
| if os.getenv("COLAB_GPU") and refresh_rate is None: | ||
| # smaller refresh rate on colab causes crashes for TQDM, choose a higher value | ||
| refresh_rate = 20 | ||
| refresh_rate = 1 if refresh_rate is None else refresh_rate | ||
| progress_bar_callback = ProgressBar(refresh_rate=refresh_rate, process_position=process_position) |
There was a problem hiding this comment.
Suggested change
| if os.getenv("COLAB_GPU") and refresh_rate is None: | |
| # smaller refresh rate on colab causes crashes for TQDM, choose a higher value | |
| refresh_rate = 20 | |
| refresh_rate = 1 if refresh_rate is None else refresh_rate | |
| progress_bar_callback = ProgressBar(refresh_rate=refresh_rate, process_position=process_position) | |
| if refresh_rate is None: | |
| if os.getenv("COLAB_GPU"): | |
| # smaller refresh rate on colab causes crashes for TQDM, choose a higher value | |
| refresh_rate = 20 | |
| else: | |
| refresh_rate = 1 | |
| progress_bar_callback = ProgressBar(refresh_rate=refresh_rate, process_position=process_position) |
awaelchli
approved these changes
Oct 26, 2021
12 tasks
for more information, see https://pre-commit.ci
| " please pass `callbacks=RichProgressBar(refresh_rate=X)`." | ||
| " Setting to the `TQDM ProgressBar`." | ||
| ) | ||
| # else return new TQDMProgressBar |
There was a problem hiding this comment.
should be indented in?
12 tasks
12 tasks
12 tasks
|
Closing it in favor of #10912 |
11 tasks
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.
What does this PR do?
Closes #9580. By default if Rich (10.0.2 or later) is available, we use the Rich Progress Bar!
Related to #9616, we throw a warning if the user sets
progress_bar_refresh_ratefrom the Trainer and default to TQDM (theProgressBar). This is because the meaning of refresh rate is different for Rich/TQDM, and are not related. Since in #9616 the argument is being deprecated, I felt it made sense to ask the users to pass theRichProgressBarto callbacks likecallbacks=RichProgressBar(refresh_rate_per_second=20).cc @daniellepintz
Before submitting
PR review
Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:
Did you have fun?
Make sure you had fun coding 🙃