Skip to content
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.

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

Rename ProgressBar callback to TQDMProgressBar #9302

Closed
daniellepintz opened this issue Sep 3, 2021 · 7 comments · Fixed by #10134
Closed

Rename ProgressBar callback to TQDMProgressBar #9302

daniellepintz opened this issue Sep 3, 2021 · 7 comments · Fixed by #10134
Labels
feature Is an improvement or enhancement refactor

Comments

@daniellepintz
Copy link
Contributor

Proposed refactoring or deprecation

Rename ProgressBar callback to TQDMProgressBar (https://github.com/tqdm/tqdm)
https://github.com/daniellepintz/pytorch-lightning/blob/a49690dfa3502508c8765e6bb46ded17e561af8e/pytorch_lightning/callbacks/progress/progress.py#L55-L55

Motivation

After we added the RichProgressBar in #8929, it makes sense to rename ProgressBar to something more specific.

Pitch

Update all references of ProgressBar to TQDMProgressBar

Additional context


If you enjoy Lightning, check out our other projects! ⚡

  • Metrics: Machine learning metrics for distributed, scalable PyTorch applications.

  • Flash: The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, finetuning and solving problems with deep learning

  • Bolts: Pretrained SOTA Deep Learning models, callbacks and more for research and production with PyTorch Lightning and PyTorch

  • Lightning Transformers: Flexible interface for high performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.

@daniellepintz daniellepintz added feature Is an improvement or enhancement help wanted Open to be worked on refactor labels Sep 3, 2021
@daniellepintz
Copy link
Contributor Author

Could someone please add the good first issue label? Also could someone advise on how we usually go about making these kinds of changes backwards compatible? Or is this a breaking change?

@tchaton tchaton added the good first issue Good for newcomers label Sep 3, 2021
@tchaton
Copy link
Contributor

tchaton commented Sep 3, 2021

This is a breaking change and would have to go through depreciation cycle.

@carmocca
Copy link
Contributor

carmocca commented Sep 3, 2021

If we do the following, it wouldn't be breaking, right?

class TQDMProgressBar(ProgressBarBase):
    ...

# points to the default implementation
ProgressBar = TQDMProgressBar

@daniellepintz
Copy link
Contributor Author

@carmocca yeah makes sense to me! looks like @kaushikb11 's PR fixes this

@stale
Copy link

stale bot commented Oct 7, 2021

This issue has been automatically marked as stale because it hasn't had any recent activity. This issue will be closed in 7 days if no further activity occurs. Thank you for your contributions, Pytorch Lightning Team!

@stale stale bot added the won't fix This will not be worked on label Oct 7, 2021
@daniellepintz daniellepintz removed the won't fix This will not be worked on label Oct 7, 2021
@InCogNiTo124
Copy link
Contributor

I'd like to take on this, would you please assing this to me? @daniellepintz

@daniellepintz
Copy link
Contributor Author

Thanks @InCogNiTo124 ! I think @kaushikb11 already has a PR out for this #9229 but hasnt merged it yet. @kaushikb11 what is the status of the PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Is an improvement or enhancement refactor
Projects
None yet
4 participants