Models

Variants of model performance estimation algorithms.

This package contains model definitions of performance estimation and calculation of different confidence scores.

This module is a registry and currently contains the options [‘ac-model’, ‘ts-model’, ‘doc-model’, ‘atc-model’, ‘ts-atc-model’, ‘max_class_probability-conf’, ‘energy-conf’, ‘entropy-conf’, ‘doctor-conf’].

To retrieve a list of options, call:

>>> print(moval.models.get_options())
['ac-model', 'ts-model', 'doc-model', 'atc-model', 'ts-atc-model', ...]

To obtain an initialized instance, call moval.models.init, defined in moval.registry.add_helper_functions(). The first parameter to provide is the models name to use, which is one of the available options presented above. Then the required positional arguments specific to the module are provided, if needed.

You can register additional options by defining and registering classes with a name. To do that, you can add a decorator on top of it: @moval.models.register("my-moval-models").

Later, initialize your class similarly to the pre-defined options, using moval.models.init with the models name set to my-moval-models.

Note that these customized options will not be automatically added to this docstring.