slickml.base._metrics#

Module Contents#

Classes#

Metrics

Protocol for Metrics.
class slickml.base._metrics.Metrics[source]#

Bases: Protocol

Protocol for Metrics.

Notes

The main reason of this protocol is proper duck typing (PEP-544) [1] when using metrics such as RegressionMetrics or ClassificationMetrics in pipelines.

References

__slots__ = []#
classmethod __class_getitem__(params)#
classmethod __init_subclass__(*args, **kwargs)#
get_metrics(dtype: Optional[str]) → Union[pandas.DataFrame, Dict[str, Optional[float]]][source]#

Returns calculated metrics in a desired output dtype.

Parameters:

dtype (Optional[str]) – Metrics output dtype

Returns:

Union[pd.DataFrame, Dict[str, Optional[float]]]

plot() → matplotlib.figure.Figure[source]#

Plots calculated metrics visualization.

Returns:

Figure