Skip to content

Conversation

@daniellepintz
Copy link
Contributor

What does this PR do?

Follow up from #9616
Fixes #9500

Creates a new flag enable_progress_bar which allows users to disable the progress bar, since the previous method, setting progress_bar_refresh_rate to 0, was deprecated in #9616
Also, replace progress_bar_refresh_rate with enable_progress_bar in the tests.

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 🙃

Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

we would need one more follow up to also update the occurrences in the docs

@daniellepintz
Copy link
Contributor Author

@awaelchli added it to this PR!

@codecov
Copy link

codecov bot commented Sep 24, 2021

Codecov Report

Merging #9664 (ba016cf) into master (568a1e0) will increase coverage by 0%.
The diff coverage is 100%.

❗ Current head ba016cf differs from pull request most recent head 71027b1. Consider uploading reports for the commit 71027b1 to get more accurate results

@@          Coverage Diff           @@
##           master   #9664   +/-   ##
======================================
  Coverage      89%     89%           
======================================
  Files         179     179           
  Lines       15329   15331    +2     
======================================
+ Hits        13603   13605    +2     
  Misses       1726    1726           

@mergify mergify bot added the ready PRs ready to be merged label Sep 24, 2021
Copy link
Collaborator

@Borda Borda left a comment

Choose a reason for hiding this comment

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

missing test for raising deprecation warning

@mergify mergify bot removed the ready PRs ready to be merged label Sep 24, 2021
@ananthsub
Copy link
Contributor

missing test for raising deprecation warning

@Borda a test was added here: https://github.com/PyTorchLightning/pytorch-lightning/blob/9148a13de0b121985bdf03e2832daf424f450ae5/tests/deprecated_api/test_remove_1-7.py#L230-L233 as part of #9616

@mergify mergify bot added the ready PRs ready to be merged label Sep 25, 2021
@daniellepintz daniellepintz merged commit b3a5c7f into Lightning-AI:master Sep 25, 2021
@daniellepintz daniellepintz deleted the enable_pbar branch September 25, 2021 05:53
@awaelchli
Copy link
Contributor

I'm asking myself now why did we prefix this with "enable_"? Just progress_bar=True/False would be shorter and the type makes it clear that a bool is expected.

@ananthsub
Copy link
Contributor

I'm asking myself now why did we prefix this with "enable_"? Just progress_bar=True/False would be shorter and the type makes it clear that a bool is expected.

Likely to avoid any confusion with ProgressBar as a callback instance. Similar to how checkpoint_callback is now typed as a bool, but sometimes people still pass a callback instance there

@daniellepintz
Copy link
Contributor Author

@awaelchli Yeah it's exactly what @ananthsub said. See discussion here #9616 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Deprecate progress_bar_refresh_rate from Trainer constructor

6 participants