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

docs: logits -> probs in Accuracy metric documentation #5340

Conversation

Kulikovpavel
Copy link
Contributor

@Kulikovpavel Kulikovpavel commented Jan 3, 2021

What does this PR do?

Documentation fix for Accuracy metric

There should be probs instead of logits as input.

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?
  • Did you make sure to update the documentation with your changes [if needed]?
  • Did you write any new necessary tests [no need for typos, docs]?
  • 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.
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
  • Check that target branch and milestone are aligned!

Did you have fun?

Make sure you had fun coding 🙃

@Borda
Copy link
Member

Borda commented Jan 3, 2021

@Kulikovpavel pls return the checklist to the PR description, it is there on purpose...

@Borda Borda changed the title fix: logits -> probs in Accuracy metric documentation docs: logits -> probs in Accuracy metric documentation Jan 3, 2021
@codecov
Copy link

codecov bot commented Jan 3, 2021

Codecov Report

Merging #5340 (4d6997a) into master (0e593fb) will decrease coverage by 0%.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master   #5340   +/-   ##
======================================
- Coverage      93%     93%   -0%     
======================================
  Files         134     134           
  Lines        9950    9950           
======================================
- Hits         9261    9254    -7     
- Misses        689     696    +7     

@awaelchli awaelchli added docs Documentation related Metrics labels Jan 3, 2021
@SkafteNicki SkafteNicki added the ready PRs ready to be merged label Jan 4, 2021
@SkafteNicki SkafteNicki added this to the 1.1.x milestone Jan 4, 2021
@rohitgr7 rohitgr7 enabled auto-merge (squash) January 4, 2021 13:34
@rohitgr7 rohitgr7 merged commit 15a400b into Lightning-AI:master Jan 4, 2021
Borda pushed a commit that referenced this pull request Jan 6, 2021
* fix: logits -> probs in accuracy metrics documentation

* Update metrics.rst

* Update metrics.rst

Co-authored-by: Jirka Borovec <[email protected]>
(cherry picked from commit 15a400b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related ready PRs ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants