Skip to content

Common Values

This page contains supplementary values, types and enums that metrics use.

MetricTarget

Bases: Enum

Specifies what type of detection is used to compute the metric.

Attributes:

Name Type Description
BOXES

xyxy bounding boxes
MASKS

Binary masks
ORIENTED_BOUNDING_BOXES

Oriented bounding boxes (OBB)
Source code in supervision/metrics/core.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
class MetricTarget(Enum):
    """
    Specifies what type of detection is used to compute the metric.

    Attributes:
        BOXES: xyxy bounding boxes
        MASKS: Binary masks
        ORIENTED_BOUNDING_BOXES: Oriented bounding boxes (OBB)
    """

    BOXES = "boxes"
    MASKS = "masks"
    ORIENTED_BOUNDING_BOXES = "obb"

AveragingMethod

Bases: Enum

Defines different ways of averaging the metric results.

Suppose, before returning the final result, a metric is computed for each class. How do you combine those to get the final number?

Attributes:

Name Type Description
MACRO

Calculate the metric for each class and average the results. The simplest averaging method, but it does not take class imbalance into account.
MICRO

Calculate the metric globally by counting the total true positives, false positives, and false negatives. Micro averaging is useful when you want to give more importance to classes with more samples. It's also more appropriate if you have an imbalance in the number of instances per class.
WEIGHTED

Calculate the metric for each class and average the results, weighted by the number of true instances of each class. Use weighted averaging if you want to take class imbalance into account.
Source code in supervision/metrics/core.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class AveragingMethod(Enum):
    """
    Defines different ways of averaging the metric results.

    Suppose, before returning the final result, a metric is computed for each class.
    How do you combine those to get the final number?

    Attributes:
        MACRO: Calculate the metric for each class and average the results. The simplest
            averaging method, but it does not take class imbalance into account.
        MICRO: Calculate the metric globally by counting the total true positives, false
            positives, and false negatives. Micro averaging is useful when you want to
            give more importance to classes with more samples. It's also more
            appropriate if you have an imbalance in the number of instances per class.
        WEIGHTED: Calculate the metric for each class and average the results, weighted
            by the number of true instances of each class. Use weighted averaging if
            you want to take class imbalance into account.
    """

    MACRO = "macro"
    MICRO = "micro"
    WEIGHTED = "weighted"

Comments