MetricResult dataclass

The result of a metric computation.

Each MetricResult contains:

  • name: The name of the metric.

  • scope: The scope of the metric (binary, micro, macro, class).

  • type: The type of the metric (probs, labels, etc).

  • value: The computed metric value.

  • metadata: Optional additional information about the computation.

Source code in metrics_toolbox/metrics/results.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@dataclass(frozen=True)
class MetricResult:
    """The result of a metric computation.

    Each MetricResult contains:

    - name: The name of the metric.

    - scope: The scope of the metric (binary, micro, macro, class).

    - type: The type of the metric (probs, labels, etc).

    - value: The computed metric value.

    - metadata: Optional additional information about the computation.
    """

    name: MetricNameEnum
    scope: MetricScopeEnum
    type: MetricTypeEnum
    value: float
    metadata: Optional[Dict[str, Any]] = None

    def __repr__(self) -> str:
        return (
            f"MetricResult(\n"
            f"    name={self.name.value}, scope={self.scope.value}, type={self.type.value}, \n"
            f"    value={self.value}, \n"
            f"    metadata={self.metadata}\n"
        )