topobench.evaluator.base module

Abstract class for the evaluator class.

class ABC

Bases: object

Helper class that provides a standard way to create an ABC using inheritance.

class AbstractEvaluator

Bases: ABC

Abstract class for the evaluator class.

__init__()

abstract compute()

Compute the metrics.

abstract reset()

Reset the metrics.

abstract update(model_out)

Update the metrics with the model output.

Parameters:

model_outdict

The model output.

abstractmethod(funcobj)

A decorator indicating abstract methods.

Requires that the metaclass is ABCMeta or derived from it. A class that has a metaclass derived from ABCMeta cannot be instantiated unless all of its abstract methods are overridden. The abstract methods can be called using any of the normal ‘super’ call mechanisms. abstractmethod() may be used to declare abstract methods for properties and descriptors.

Usage:

class C(metaclass=ABCMeta):

@abstractmethod def my_abstract_method(self, …):

…