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

Update docstrings for backward methods #13886

Merged
merged 22 commits into from
Aug 3, 2022
Merged

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Jul 27, 2022

What does this PR do?

After recent changes in #13863, I forgot to update the docstrings.

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 update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is free to review the PR once the tests have passed.
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?

I made sure I had fun coding 🙃

cc @Borda @rohitgr7 @awaelchli @akihironitta

@github-actions github-actions bot added the pl Generic label for PyTorch Lightning package label Jul 27, 2022
@awaelchli awaelchli marked this pull request as ready for review July 27, 2022 17:10
@awaelchli awaelchli added the docs Documentation related label Jul 27, 2022
@awaelchli awaelchli added this to the pl:1.6.x milestone Jul 27, 2022
@mergify mergify bot added the ready PRs ready to be merged label Jul 28, 2022
@codecov
Copy link

codecov bot commented Jul 28, 2022

Codecov Report

Merging #13886 (6920ca5) into master (a58a406) will increase coverage by 14%.
The diff coverage is 100%.

@@            Coverage Diff            @@
##           master   #13886     +/-   ##
=========================================
+ Coverage      61%      76%    +14%     
=========================================
  Files         332      343     +11     
  Lines       26078    27311   +1233     
=========================================
+ Hits        15939    20647   +4708     
+ Misses      10139     6664   -3475     

@kaushikb11
Copy link
Contributor

@tchaton @justusschock

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 !

src/pytorch_lightning/plugins/precision/deepspeed.py Outdated Show resolved Hide resolved
Co-authored-by: thomas chaton <thomas@grid.ai>
@awaelchli awaelchli enabled auto-merge (squash) August 3, 2022 08:16
@carmocca carmocca modified the milestones: pl:1.6.x, pl:1.8 Aug 3, 2022
@awaelchli awaelchli merged commit dcb4dd5 into master Aug 3, 2022
@awaelchli awaelchli deleted the docs/backward-docstrings branch August 3, 2022 13:06
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 ready PRs ready to be merged strategy: deepspeed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants