fatf.utils.metrics.metrics.true_positive_rate

fatf.utils.metrics.metrics.true_positive_rate(confusion_matrix: numpy.ndarray) → float

Calculates the true positive rate for a binary confusion matrix.

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

Parameters

confusion_matrixnumpy.ndarray

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

Returns

metricnumber

The true positive rate.