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

Fix math typo in confusion matrix doc #2634

Merged
merged 3 commits into from
Jul 17, 2024
Merged

Conversation

sweber1
Copy link
Contributor

@sweber1 sweber1 commented Jul 16, 2024

What does this PR do?

Fix a doc typo for MulticlassConfusionMatrix, specifically in the equation that describes false positive calculation from the confusion matrix.
The sum in the equation is over i (the rows), therefore the result corresponds to the number of true negatives for class j, not i.

Before submitting
  • Was this discussed/agreed 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.


📚 Documentation preview 📚: https://torchmetrics--2634.org.readthedocs.build/en/2634/

Copy link

codecov bot commented Jul 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 41%. Comparing base (98e7130) to head (19df354).
Report is 100 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff            @@
##           master   #2634     +/-   ##
========================================
- Coverage      69%     41%    -28%     
========================================
  Files         314     314             
  Lines       17716   17716             
========================================
- Hits        12208    7271   -4937     
- Misses       5508   10445   +4937     

@mergify mergify bot added the ready label Jul 16, 2024
@SkafteNicki SkafteNicki enabled auto-merge (squash) July 17, 2024 10:10
@Borda Borda disabled auto-merge July 17, 2024 10:35
@Borda Borda merged commit ab66665 into Lightning-AI:master Jul 17, 2024
59 of 64 checks passed
Borda pushed a commit that referenced this pull request Aug 2, 2024
Borda pushed a commit that referenced this pull request Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants