tempor.metrics.prediction.one_off.plugin_builtin_regression module¶

Module with built-in metric plugins for the category: prediction -> one-off -> regression.

class tempor.metrics.prediction.one_off.plugin_builtin_regression.MseOneOffRegressionMetric[source]¶

Bases: OneOffRegressionMetric

Mean squared error regression metric

The base class that all plugins must inherit from.

property direction : Literal[minimize] | Literal[maximize]¶

The direction of the metric

category : ClassVar[str] = 'prediction.one_off.regression'¶

Plugin category, such as 'prediction.one_off.classification'. Must be set by the plugin class using @register_plugin.

name : ClassVar[str] = 'mse'¶

Plugin name, such as 'my_nn_classifier'. Must be set by the plugin class using @register_plugin.

plugin_type : ClassVar[None | Literal[all] | str] = 'metric'¶

Plugin type, such as 'method'. May be optionally set by the plugin class using @register_plugin, else will set the default plugin type.

class tempor.metrics.prediction.one_off.plugin_builtin_regression.MaeOneOffRegressionMetric[source]¶

Bases: OneOffRegressionMetric

Mean absolute error regression metric

The base class that all plugins must inherit from.

property direction : Literal[minimize] | Literal[maximize]¶

The direction of the metric

category : ClassVar[str] = 'prediction.one_off.regression'¶

Plugin category, such as 'prediction.one_off.classification'. Must be set by the plugin class using @register_plugin.

name : ClassVar[str] = 'mae'¶

Plugin name, such as 'my_nn_classifier'. Must be set by the plugin class using @register_plugin.

plugin_type : ClassVar[None | Literal[all] | str] = 'metric'¶

Plugin type, such as 'method'. May be optionally set by the plugin class using @register_plugin, else will set the default plugin type.

class tempor.metrics.prediction.one_off.plugin_builtin_regression.R2OneOffRegressionMetric[source]¶

Bases: OneOffRegressionMetric

R^2 (coefficient of determination) score regression metric

The base class that all plugins must inherit from.

property direction : Literal[minimize] | Literal[maximize]¶

The direction of the metric

category : ClassVar[str] = 'prediction.one_off.regression'¶

Plugin category, such as 'prediction.one_off.classification'. Must be set by the plugin class using @register_plugin.

name : ClassVar[str] = 'r2'¶

Plugin name, such as 'my_nn_classifier'. Must be set by the plugin class using @register_plugin.

plugin_type : ClassVar[None | Literal[all] | str] = 'metric'¶

Plugin type, such as 'method'. May be optionally set by the plugin class using @register_plugin, else will set the default plugin type.