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 Progress Bar to docs #11359

Merged
merged 15 commits into from
Mar 24, 2022
Merged

Add Progress Bar to docs #11359

merged 15 commits into from
Mar 24, 2022

Conversation

kaushikb11
Copy link
Contributor

@kaushikb11 kaushikb11 commented Jan 7, 2022

What does this PR do?

Part of #7666

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 @rohitgr7 @SeanNaren @kaushikb11 @awaelchli

@kaushikb11 kaushikb11 added the docs Documentation related label Jan 7, 2022
@kaushikb11 kaushikb11 added this to the 1.6 milestone Jan 7, 2022
@kaushikb11 kaushikb11 marked this pull request as ready for review January 7, 2022 10:40
@rohitgr7
Copy link
Contributor

rohitgr7 commented Jan 7, 2022

hey @kaushikb11 !

doc test failing. can you fix them for review?

Copy link
Member

@ethanwharris ethanwharris left a comment

Choose a reason for hiding this comment

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

LGTM 😃 Some small suggestions

docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Show resolved Hide resolved
docs/source/common/progress_bar.rst Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
docs/source/common/progress_bar.rst Show resolved Hide resolved
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 !

docs/source/common/progress_bar.rst Outdated Show resolved Hide resolved
@mergify mergify bot added the ready PRs ready to be merged label Jan 10, 2022
@mergify mergify bot requested a review from a team January 16, 2022 03:30
Copy link
Contributor

@akihironitta akihironitta left a comment

Choose a reason for hiding this comment

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

Seems like :noindex: is needed somewhere for the build to be successful. https://app.circleci.com/pipelines/github/PyTorchLightning/pytorch-lightning/51279/workflows/aa13874c-25d0-4170-8294-216da74189f5/jobs/146122?invite=true#step-103-616

Warning, treated as error:
/home/docs/project/pytorch_lightning/callbacks/progress/rich_progress.py:docstring of pytorch_lightning.callbacks.progress.rich_progress.RichProgressBar:1:duplicate object description of pytorch_lightning.callbacks.progress.rich_progress.RichProgressBar, other instance in common/generated/pytorch_lightning.callbacks.progress.RichProgressBar, use :noindex: for one of them
Makefile:19: recipe for target 'html' failed

@mergify mergify bot requested a review from a team January 17, 2022 09:01
@akihironitta
Copy link
Contributor

Converting this PR to draft to avoid accidentally getting merged to master.

@akihironitta akihironitta marked this pull request as draft January 19, 2022 15:15
@kaushikb11 kaushikb11 marked this pull request as ready for review March 2, 2022 09:33
@kaushikb11 kaushikb11 marked this pull request as draft March 2, 2022 11:47
kaushikb11 and others added 6 commits March 24, 2022 00:46
@kaushikb11 kaushikb11 marked this pull request as ready for review March 23, 2022 19:19
@kaushikb11 kaushikb11 enabled auto-merge (squash) March 23, 2022 20:20
@codecov
Copy link

codecov bot commented Mar 23, 2022

Codecov Report

Merging #11359 (656747b) into master (7a6efb3) will decrease coverage by 4%.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           master   #11359    +/-   ##
========================================
- Coverage      92%      88%    -4%     
========================================
  Files         207      207            
  Lines       17705    17705            
========================================
- Hits        16235    15522   -713     
- Misses       1470     2183   +713     

@kaushikb11 kaushikb11 self-assigned this Mar 23, 2022
@kaushikb11 kaushikb11 merged commit f740085 into master Mar 24, 2022
@kaushikb11 kaushikb11 deleted the docs/progress_bar branch March 24, 2022 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related progress bar: rich progress bar: tqdm ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants