Skip to content


[ ]

Metric Objects#

class Metric(Registrable)

A very general abstract class representing a metric which can be accumulated.


 | def get_metric(
 |     self,
 |     reset: bool
 | ) -> Union[float, Tuple[float, ...], Dict[str, float], Dict[str, List[float]]]

Compute and return the metric. Optionally also call self.reset.


 | def reset(self) -> None

Reset any accumulators or internal state.


 | @staticmethod
 | def detach_tensors(*tensors: torch.Tensor) -> Iterable[torch.Tensor]

If you actually passed gradient-tracking Tensors to a Metric, there will be a huge memory leak, because it will prevent garbage collection for the computation graph. This method ensures the tensors are detached.