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

Add documentation note for TQDMProgressBar #20198

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

NishantDahal
Copy link
Contributor

@NishantDahal NishantDahal commented Aug 14, 2024

What does this PR do?

This PR adds a note to the documentation of TQDMProgressBar to clarify the behavior of the smoothing option. The note explains that the smoothing option has no effect when using the default implementation of TQDMProgressBar and suggests a possible solution.

Fixes #20003

  • Was this discussed/agreed via a GitHub issue? (not for typos and docs) -> Yes, discussed in issue Smoothing in tqdm progress bar has no effect #20003
  • 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). -> Yes
  • Did you write any new necessary tests? (not for typos and docs). -> No
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request? -> No
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors). -> Yes

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing, make sure you have read the review guidelines. In short, see the following bullet-list:

Reviewer checklist
  • 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

📚 Documentation preview 📚: https://pytorch-lightning--20198.org.readthedocs.build/en/20198/

@github-actions github-actions bot added docs Documentation related pl Generic label for PyTorch Lightning package labels Aug 14, 2024
@Borda Borda merged commit 66508ff into Lightning-AI:master Sep 30, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related pl Generic label for PyTorch Lightning package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Smoothing in tqdm progress bar has no effect
2 participants