Improvements for rich progress bar #9559
Merged
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
SeanNaren
requested review from
awaelchli,
Borda,
carmocca,
justusschock,
kaushikb11,
tchaton and
williamFalcon
as code owners
SeanNaren
commented
Sep 16, 2021
SeanNaren
changed the title
added 2 commits
September 16, 2021 13:01
awaelchli
approved these changes
Sep 16, 2021
carmocca
approved these changes
Sep 16, 2021
Co-authored-by: Adrian Wälchli <[email protected]>
Codecov Report
@@ Coverage Diff @@
## master #9559 +/- ##
=======================================
- Coverage 93% 89% -4%
=======================================
Files 180 180
Lines 15110 15117 +7
=======================================
- Hits 14036 13429 -607
- Misses 1074 1688 +614 |
akihironitta
reviewed
Dec 8, 2021
Comment on lines
-80
to
+108
| STYLES: Dict[str, str] = { | ||
| "train": "red", | ||
| "sanity_check": "yellow", | ||
| "validate": "yellow", | ||
| "test": "yellow", | ||
| "predict": "yellow", | ||
| } | ||
| @dataclass | ||
| class RichProgressBarTheme: | ||
| """Styles to associate to different base components. | ||
|
|
||
| https://rich.readthedocs.io/en/stable/style.html | ||
| """ | ||
|
|
||
| text_color: str = "white" | ||
| progress_bar_complete: Union[str, Style] = "#6206E0" | ||
| progress_bar_finished: Union[str, Style] = "#6206E0" | ||
| batch_process: str = "white" | ||
| time: str = "grey54" | ||
| processing_speed: str = "grey70" |
There was a problem hiding this comment.
noob question: Why did we introduce this new class RichProgressBarTheme and pass an instance to RichProgressBar? I'm asking because if we didn't have this class and passed colours (or a dictionary of colours) directly to RichProgressBar, colour customisation would be easier for users in my opinion. (One less thing to remember :])
from pytorch_lightning.callbacks import RichProgressBar
-from pytorch_lightning.callbacks.progress.rich_progress import RichProgressBarTheme
progress_bar = RichProgressBar(
- theme=RichProgressBarTheme(
description="green_yellow",
progress_bar="green1",
progress_bar_finished="green1",
batch_progress="green_yellow",
time="grey82",
processing_speed="grey82",
metrics="grey82",
- )
)FYI, I'm looking at the example in the blog post: https://devblog.pytorchlightning.ai/super-charged-progress-bars-with-rich-lightning-669653d6ab97
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?
Fixes #9547
Introduces a theme dataclass to control the styles, fix keyboard interrupts and sets defaults to style like the linked issue.
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 🙃