Fix typo and document normalize values in confusion_matrix README - #788
Open
RudrenduPaul wants to merge 1 commit into
Open
Fix typo and document normalize values in confusion_matrix README#788RudrenduPaul wants to merge 1 commit into
RudrenduPaul wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix typo and document normalize values in confusion_matrix README
Closes #652
What this fixes
In
metrics/confusion_matrix/README.md:Typo in Output Values: "or the number of examples input" is missing
a word and should read "or the number of examples in the input". The
same sentence also referenced
normalizebeing set toTrue, butnormalizeis a string parameter (passed straight through tosklearn.metrics.confusion_matrix) and its default isNone, not aboolean
True. Corrected to "ifnormalizeis set toNone(default)".Missing valid values for
normalize: The Inputs section describedwhat
normalizedoes but never listed the permitted values. Added thepermitted values
'true','pred','all', orNone(default),matching the underlying
sklearn.metrics.confusion_matriximplementationused by this metric (see
metrics/confusion_matrix/confusion_matrix.py,which passes
normalizestraight through to sklearn).Verification
mainthat both issues were still presentbefore this fix.
Note: this documentation fix was prepared with AI assistance (Claude Code)
and reviewed before submission.