Skip to content

ClassifierEvaluationMetrics

Source code in docs_src/capo_comprehend/types/classifier_evaluation_metrics.py
class ClassifierEvaluationMetrics(TypedDict, closed=True):
    accuracy: NotRequired["capo_comprehend.types.double.Double"]
    """<p>The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.</p>"""
    precision: NotRequired["capo_comprehend.types.double.Double"]
    """<p>A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.</p>"""
    recall: NotRequired["capo_comprehend.types.double.Double"]
    """<p>A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. </p>"""
    f1_score: NotRequired["capo_comprehend.types.double.Double"]
    """<p>A measure of how accurate the classifier results are for the test data. It is derived from the <code>Precision</code> and <code>Recall</code> values. The <code>F1Score</code> is the harmonic average of the two scores. The highest score is 1, and the worst score is 0. </p>"""
    micro_precision: NotRequired["capo_comprehend.types.double.Double"]
    """<p>A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.</p>"""
    micro_recall: NotRequired["capo_comprehend.types.double.Double"]
    """<p>A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.</p>"""
    micro_f1_score: NotRequired["capo_comprehend.types.double.Double"]
    """<p>A measure of how accurate the classifier results are for the test data. It is a combination of the <code>Micro Precision</code> and <code>Micro Recall</code> values. The <code>Micro F1Score</code> is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.</p>"""
    hamming_loss: NotRequired["capo_comprehend.types.double.Double"]
    """<p>Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.</p>"""

accuracy instance-attribute

accuracy: NotRequired[Double]

The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

f1_score instance-attribute

f1_score: NotRequired[Double]

A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

hamming_loss instance-attribute

hamming_loss: NotRequired[Double]

Indicates the fraction of labels that are incorrectly predicted. Also seen as the fraction of wrong labels compared to the total number of labels. Scores closer to zero are better.

micro_f1_score instance-attribute

micro_f1_score: NotRequired[Double]

A measure of how accurate the classifier results are for the test data. It is a combination of the Micro Precision and Micro Recall values. The Micro F1Score is the harmonic mean of the two scores. The highest score is 1, and the worst score is 0.

micro_precision instance-attribute

micro_precision: NotRequired[Double]

A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones. Unlike the Precision metric which comes from averaging the precision of all available labels, this is based on the overall score of all precision scores added together.

micro_recall instance-attribute

micro_recall: NotRequired[Double]

A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results. Specifically, this indicates how many of the correct categories in the text that the model can predict. It is a percentage of correct categories in the text that can found. Instead of averaging the recall scores of all labels (as with Recall), micro Recall is based on the overall score of all recall scores added together.

precision instance-attribute

precision: NotRequired[Double]

A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.

recall instance-attribute

recall: NotRequired[Double]

A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.