-
Notifications
You must be signed in to change notification settings - Fork 3.6k
refresh LightningModule API docs #8276
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #8276 +/- ##
======================================
- Coverage 93% 92% -0%
======================================
Files 212 212
Lines 13720 13720
======================================
- Hits 12751 12684 -67
- Misses 969 1036 +67 |
awaelchli
commented
Jul 4, 2021
awaelchli
commented
Jul 4, 2021
SeanNaren
approved these changes
Jul 5, 2021
Contributor
SeanNaren
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @awaelchli :)
kaushikb11
approved these changes
Jul 5, 2021
Contributor
kaushikb11
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great!
ethanwharris
approved these changes
Jul 5, 2021
tchaton
approved these changes
Jul 5, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR includes several improvements to the API docs in
lightning.py.The build of the html can be viewed here or by going to the workflows
ci-tests -> click on tab "artifacts" -> navigate to html/api/pytorch_lightning.core.lightning.htmlBefore submitting
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:
Did you have fun?
I made sure I had fun coding 🙃