From b12d7195261f92010dcabc5827cafd3304c6ce88 Mon Sep 17 00:00:00 2001 From: dantp-ai <1534513+dantp-ai@users.noreply.github.com> Date: Tue, 10 Dec 2024 22:03:32 +0100 Subject: [PATCH] Fix typo in readme for output values of confusion matrix when `normalize` is used * Also, specify valid values for `normalize` in Inputs section. --- metrics/confusion_matrix/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/metrics/confusion_matrix/README.md b/metrics/confusion_matrix/README.md index c7ae9482..eee676a4 100644 --- a/metrics/confusion_matrix/README.md +++ b/metrics/confusion_matrix/README.md @@ -54,11 +54,11 @@ At minimum, this metric requires predictions and references as inputs. - **references** (`list` of `int`): Ground truth labels. - **labels** (`list` of `int`): List of labels to index the matrix. This may be used to reorder or select a subset of labels. - **sample_weight** (`list` of `float`): Sample weights. -- **normalize** (`str`): Normalizes confusion matrix over the true (rows), predicted (columns) conditions or all the population. +- **normalize** (`str`): Normalizes confusion matrix over the true (rows), predicted (columns) conditions or all the population. (Valid values are `'pred', 'all', 'true'` or `None`). ### Output Values -- **confusion_matrix**(`list` of `list` of `str`): Confusion matrix. Minimum possible value is 0. Maximum possible value is 1.0, or the number of examples input, if `normalize` is set to `True`. +- **confusion_matrix** (`list` of `list` of `str`): Confusion matrix. Minimum possible value is 0. Maximum possible value is 1.0, or the number of examples in the input, if `normalize` is set to `None` (default value). Output Example(s): ```python