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 for ways to access all batch outputs for on_train_epoch_end hook #7389

Merged
merged 3 commits into from
May 5, 2021

Conversation

ananthsub
Copy link
Contributor

@ananthsub ananthsub commented May 5, 2021

What does this PR do?

Follow up to #7338 and #7339 to add documentation on how to best access the epoch output at the end of training, given that the outputs argument is now deprecated.

cc @Borda @awaelchli

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?

Make sure you had fun coding 🙃

@ananthsub ananthsub changed the title Docs follow up to 7338/7339 Add documentation for ways to access all batch outputs for on_train_epoch_end hook May 5, 2021
@codecov
Copy link

codecov bot commented May 5, 2021

Codecov Report

Merging #7389 (5984247) into master (fbcd63a) will decrease coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #7389   +/-   ##
======================================
- Coverage      88%     87%   -0%     
======================================
  Files         200     200           
  Lines       12985   12982    -3     
======================================
- Hits        11397   11357   -40     
- Misses       1588    1625   +37     

@Borda Borda added the docs Documentation related label May 5, 2021
@carmocca carmocca added this to the v1.3 milestone May 5, 2021
Copy link
Contributor

@awaelchli awaelchli left a comment

Choose a reason for hiding this comment

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

THANKS! :)))

pytorch_lightning/callbacks/base.py Outdated Show resolved Hide resolved
pytorch_lightning/core/hooks.py Outdated Show resolved Hide resolved
@awaelchli awaelchli enabled auto-merge (squash) May 5, 2021 21:05
Co-authored-by: Adrian Wälchli <aedu.waelchli@gmail.com>
@awaelchli awaelchli merged commit 651f93a into Lightning-AI:master May 5, 2021
@ananthsub ananthsub deleted the docs-add-epoch-end branch May 6, 2021 02:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants