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

Explicit mention that 1 is the positive class in docs #1383

Merged
merged 9 commits into from
Dec 14, 2022

Conversation

SkafteNicki
Copy link
Member

@SkafteNicki SkafteNicki commented Dec 9, 2022

What does this PR do?

Fixes #1376
Make it more explicit that 1 is always considered the positive class in the documentation (since we removed pos_label argument).

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?

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 🙃

@SkafteNicki SkafteNicki added the documentation Improvements or additions to documentation label Dec 9, 2022
@SkafteNicki SkafteNicki added this to the v0.12 milestone Dec 9, 2022
@Borda Borda enabled auto-merge (squash) December 9, 2022 13:23
@codecov
Copy link

codecov bot commented Dec 13, 2022

Codecov Report

Merging #1383 (2e4693b) into master (a042c54) will decrease coverage by 0%.
The diff coverage is 100%.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #1383   +/-   ##
======================================
- Coverage      90%     90%   -0%     
======================================
  Files         210     210           
  Lines       10750   10749    -1     
======================================
- Hits         9639    9638    -1     
  Misses       1111    1111           

@mergify mergify bot added ready and removed ready labels Dec 13, 2022
@Borda Borda disabled auto-merge December 14, 2022 12:20
@Borda Borda closed this Dec 14, 2022
@Borda Borda deleted the docs/positive_class branch December 14, 2022 12:36
@Borda Borda restored the docs/positive_class branch December 14, 2022 13:16
@Borda Borda reopened this Dec 14, 2022
src/torchmetrics/__init__.py Outdated Show resolved Hide resolved
@Borda Borda enabled auto-merge (squash) December 14, 2022 13:22
@mergify mergify bot added the ready label Dec 14, 2022
@Borda Borda disabled auto-merge December 14, 2022 16:46
@Borda Borda merged commit 4ecb62b into master Dec 14, 2022
@Borda Borda deleted the docs/positive_class branch December 14, 2022 16:47
Borda pushed a commit that referenced this pull request Jan 30, 2023
* Apply suggestions from code review

Co-authored-by: Jirka <[email protected]>
Co-authored-by: Jirka Borovec <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 4ecb62b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pos_label is missing from AUROC
3 participants