Skip to content

Add refresh_rate to RichProgressBar #10497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Nov 19, 2021
Merged

Add refresh_rate to RichProgressBar #10497

merged 11 commits into from
Nov 19, 2021

Conversation

kaushikb11
Copy link
Contributor

@kaushikb11 kaushikb11 commented Nov 12, 2021 •
edited by github-actions bot
Loading

What does this PR do?

closes #10607

Changed refresh_rate_per_second param to referesh_rate for RichProgressBar signature to match TQDMProgressBar's interface

Does your PR introduce any breaking changes? If yes, please list them.

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

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:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

cc @Borda @justusschock @kaushikb11 @rohitgr7 @SeanNaren

@kaushikb11 kaushikb11 added this to the 1.5.x milestone Nov 12, 2021
@kaushikb11 kaushikb11 marked this pull request as ready for review November 12, 2021 10:11
@github-actions
Copy link
Contributor

Build Error! No Linked Issue found. Please link an issue or mention it in the body using #<issue_id>

awaelchli
awaelchli reviewed Nov 12, 2021
View reviewed changes
pytorch_lightning/callbacks/progress/rich_progress.py
@@ -289,14 +285,18 @@ def _init_progress(self, trainer):
self.progress = CustomProgress(
*self.configure_columns(trainer),
self._metric_component,
refresh_per_second=self.refresh_rate_per_second,
auto_refresh=False,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is the fix I proposed in #9647 to @SeanNaren to prevent threading issues in the render function.
Did you check that this might enable #9647 to pass the CI now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talked to Sean regarding it, it didn't work!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @kaushikb11, I'm working on #13937 and debugging it has led me to this PR. Do you remember if there is any particular reason why we changed auto_refresh from True to False? Was it for #10362?

ananthsub
ananthsub reviewed Nov 12, 2021
View reviewed changes
@SeanNaren
Copy link
Contributor

SeanNaren commented Nov 14, 2021 •
edited
Loading

EDIT: deleting my comment, as the below proves we need to disable refresh.

@kaushikb11 kaushikb11 mentioned this pull request Nov 18, 2021
Closed
@mergify mergify bot removed the has conflicts label Nov 18, 2021
@kaushikb11
Copy link
Contributor Author

@SeanNaren It works as expected on Colab.

SeanNaren
SeanNaren approved these changes Nov 18, 2021
View reviewed changes
Copy link
Contributor

@SeanNaren SeanNaren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for this @kaushikb11.

Regarding the breaking change, we could make a deprecation process for it but I'm indifferent here.

tchaton
tchaton approved these changes Nov 18, 2021
View reviewed changes
Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@mergify mergify bot added the ready PRs ready to be merged label Nov 18, 2021
@mergify mergify bot added ready PRs ready to be merged and removed ready PRs ready to be merged labels Aug 2, 2022
@akihironitta akihironitta mentioned this pull request Aug 23, 2022
Closed
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akihironitta akihironitta akihironitta left review comments

@ananthsub ananthsub ananthsub approved these changes

@awaelchli awaelchli awaelchli approved these changes

@SeanNaren SeanNaren SeanNaren approved these changes

@tchaton tchaton tchaton approved these changes

@Borda Borda Awaiting requested review from Borda Borda is a code owner

@carmocca carmocca Awaiting requested review from carmocca

@justusschock justusschock Awaiting requested review from justusschock justusschock is a code owner

@rohitgr7 rohitgr7 Awaiting requested review from rohitgr7

@williamFalcon williamFalcon Awaiting requested review from williamFalcon

Assignees
No one assigned
Labels
breaking change Includes a breaking change progress bar: rich
Projects
None yet
Milestone
pl:1.5.x
Development

Successfully merging this pull request may close these issues.

pdb - based debugging with RichProgressBar doesn't show input
6 participants
@kaushikb11 @SeanNaren @ananthsub @awaelchli @tchaton @akihironitta