package.experimental.train.metrics.metric.Metric Class Reference

Public Member Functions
None	reset_state (self)
None	update_state (self, Any outputs, Any expecteds)
float	result (self)

Detailed Description

Abstract base class for all metrics.

Definition at line 4 of file metric.py.

Member Function Documentation

reset_state()

None package.experimental.train.metrics.metric.Metric.reset_state

(

self

)

Reset the metric's state.

Reimplemented in package.experimental.train.metrics.categorical_accuracy.CategoricalAccuracy.

Definition at line 8 of file metric.py.

    def reset_state(self) -> None:
        """
        Reset the metric's state.
        """
        raise NotImplementedError
 

result()

float package.experimental.train.metrics.metric.Metric.result

(

self

)

Compute and return the final metric value.

Returns:
    float: Metric value.

Reimplemented in package.experimental.train.metrics.categorical_accuracy.CategoricalAccuracy.

Definition at line 24 of file metric.py.

    def result(self) -> float:
        """
        Compute and return the final metric value.
 
        Returns:
            float: Metric value.
        """
        raise NotImplementedError

update_state()

None package.experimental.train.metrics.metric.Metric.update_state	(		self,
		Any	outputs,
		Any	expecteds
	)

Update the metric's state based on the outputs and expecteds.

Args:
    outputs (Any): Model outputs.
    expecteds (Any): Expected ground truth values.

Reimplemented in package.experimental.train.metrics.categorical_accuracy.CategoricalAccuracy.

Definition at line 14 of file metric.py.

    def update_state(self, outputs: Any, expecteds: Any) -> None:
        """
        Update the metric's state based on the outputs and expecteds.
 
        Args:
            outputs (Any): Model outputs.
            expecteds (Any): Expected ground truth values.
        """
        raise NotImplementedError
 

---

The documentation for this class was generated from the following file:

• runtime/onert/api/python/package/experimental/train/metrics/metric.py