integrate metrics API with self.log

[ananyahjha93]

Co-authored-by: Teddy Koker teddy.koker@gmail.com

What does this PR do?

Fixes # (issue)

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 your PR does only one thing, instead of bundling different changes together? Otherwise, we ask you to create a separate PR for every change.
• Did you make sure to update the documentation with your changes?
• Did you write any new necessary tests?
• Did you verify new and existing tests pass locally with your changes?
• If you made a notable change (that affects users), did you update the CHANGELOG?

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 🙃

[codecov]

Codecov Report

Merging #3961 into master will decrease coverage by 0%.
The diff coverage is 86%.

@@          Coverage Diff           @@
##           master   #3961   +/-   ##
======================================
- Coverage      90%     90%   -0%     
======================================
  Files         218     218           
  Lines       15654   15625   -29     
======================================
- Hits        14045   14005   -40     
- Misses       1609    1620   +11     

[ananthsub]

How does this interact with sync_dist on the log API? does that trigger the sync of the metric?

[teddykoker]

@ananthsub sync_dist is automatically called on compute() of the metric, and on forward() if ddp_sync_on_step=True. The only thing we have to do to automate with lightning is call compute at the end of the epoch.

[pep8speaks]

Hello @ananyahjha93! Thanks for updating this PR.

• In the file pytorch_lightning/core/step_result.py:

Line 279:78: W291 trailing whitespace
Line 302:78: W291 trailing whitespace

Comment last updated at 2020-10-08 02:07:59 UTC