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.

Sign up for GitHub

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

Jump to bottom

Improved docs for pytorch_lightning.core (continued) #1483

Merged
merged 4 commits into from
Apr 16, 2020
Merged

Improved docs for pytorch_lightning.core (continued) #1483

merged 4 commits into from
Apr 16, 2020

Conversation

awaelchli
Copy link
Contributor

@awaelchli awaelchli commented Apr 14, 2020 •
edited by Borda
Loading

Before submitting

  • Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?
  • If you made a notable change (that affects users), did you update the CHANGELOG?

What does this PR do?

A continuation of a series of doc improvements. Follows #1389, #1370 and #1481.

  • typos
  • added links for classes, methods, modules etc. for easier navigation within the page.
  • moved the "hooks lifecycle" up to the top of the page of hooks.rst.
  • added doctest where I could

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

Adrian Wälchli added 2 commits April 14, 2020 03:59
improved docs for core
448f4ff 
update links


add references to hooks lifecycle


wip


continue with __init__.py


improve docs for memory.py


improve docs for saving.py


simpler links


fix formatting
move hooks lifecycle to top of file
28ac65d
@awaelchli awaelchli changed the title Docs/improve core Improved docs for pytorch_lightning.core (continued) Apr 14, 2020
@mergify mergify bot requested a review from a team April 14, 2020 02:17
@codecov
Copy link

codecov bot commented Apr 14, 2020

Codecov Report

Merging #1483 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #1483   +/-   ##
======================================
  Coverage      91%     91%           
======================================
  Files          67      67           
  Lines        3745    3745           
======================================
  Hits         3403    3403           
  Misses        342     342

@awaelchli awaelchli mentioned this pull request Apr 14, 2020
Merged
5 tasks
@mergify mergify bot requested a review from a team April 14, 2020 08:28
@Borda Borda added the docs Documentation related label Apr 14, 2020
Borda
Borda approved these changes Apr 14, 2020
View reviewed changes
Copy link
Member

@Borda Borda left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@mergify mergify bot requested a review from a team April 14, 2020 08:47
@Borda Borda added the ready PRs ready to be merged label Apr 14, 2020
@awaelchli awaelchli mentioned this pull request Apr 14, 2020
Closed
@Borda Borda linked an issue Apr 14, 2020 that may be closed by this pull request
on_before_zero_grad hook #1481
Closed
@williamFalcon williamFalcon merged commit 2ab2f7d into Lightning-AI:master Apr 16, 2020
@awaelchli awaelchli deleted the docs/improve_core branch May 10, 2020 19:16
tullie pushed a commit to tullie/pytorch-lightning that referenced this pull request Jun 7, 2020
@tullie
Improved docs for pytorch_lightning.core (continued) (Lightning-AI#1483)
f461c6d 
* improved docs for core

update links


add references to hooks lifecycle


wip


continue with __init__.py


improve docs for memory.py


improve docs for saving.py


simpler links


fix formatting

* move hooks lifecycle to top of file

* fix doctest import problem

* add missing hook in lifecycle
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Borda Borda Borda approved these changes

@justusschock justusschock justusschock approved these changes

Assignees
No one assigned
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

on_before_zero_grad hook
4 participants
@awaelchli @Borda @justusschock @williamFalcon