fatf.utils.metrics.metrics.multiclass_positive_predictive_value

fatf.utils.metrics.metrics.multiclass_positive_predictive_value(confusion_matrix: numpy.ndarray, label_index: int) → float[source]

Gets the “positive predictive value” for a multi-class confusion matrix.

The positive predictive value is also known as precision.

See the documentation of fatf.utils.metrics.tools.validate_confusion_matrix for all the possible errors and exceptions.

Parameters
confusion_matrixnumpy.ndarray

A confusion matrix based on which the metric will be computed.

label_indexinteger

The index of a label that should be treated as “positive”. All the other labels will be treated as “negative”.

Returns
metricnumber

The “positive predictive value”.