Skip to content

Conversation

@SkafteNicki
Copy link
Collaborator

What does this PR do?

Based on discussion in slack and in issue #4357, it is not clear to users that metrics should be re-initialized per mode (training, validation, testing) such that metric states are not mixed.
This PR adds a warning to the docs.

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

  • Is this pull request ready for review? (if not, please submit in draft mode)

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 🙃

@SkafteNicki SkafteNicki added docs Documentation related Metrics labels Oct 27, 2020
@SkafteNicki SkafteNicki added this to the 1.0.x milestone Oct 27, 2020
@mergify mergify bot requested a review from a team October 27, 2020 10:50
@codecov
Copy link

codecov bot commented Oct 27, 2020

Codecov Report

Merging #4388 into master will increase coverage by 1%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #4388    +/-   ##
=======================================
+ Coverage      92%     93%    +1%     
=======================================
  Files         111     111            
  Lines        8228    8044   -184     
=======================================
- Hits         7565    7454   -111     
+ Misses        663     590    -73     

@SeanNaren SeanNaren self-requested a review October 28, 2020 15:14
@SkafteNicki SkafteNicki merged commit 4a095e1 into Lightning-AI:master Oct 28, 2020
@SkafteNicki SkafteNicki deleted the metrics/doc_warning branch October 28, 2020 15:42
Borda pushed a commit that referenced this pull request Nov 4, 2020
* warning on states

* suggestion

* Update metrics.rst

Co-authored-by: Sean Naren <[email protected]>
(cherry picked from commit 4a095e1)
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.

5 participants