Merge pull request #208 from IFCA/fix-base-classes

Fix base classes

Author: Jaime Céspedes Sisniega

docs/source/api_reference/utils.md

@@ -56,7 +56,6 @@
     :toctree: auto_generated/
     :template: class.md
 
-    Stat
     IncrementalStat
     Mean
     EWMA

frouros/callbacks/__init__.py

@@ -1,11 +1,9 @@
 """Callbacks init."""
 
-from .base import Callback
 from .batch import PermutationTestOnBatchData, ResetOnBatchDataDrift
 from .streaming import History, mSPRT, WarningSamplesBuffer
 
 __all__ = [
-    "Callback",
     "History",
     "mSPRT",
     "PermutationTestOnBatchData",

frouros/callbacks/base.py

@@ -1,10 +1,10 @@
-"""Callbacks base module."""
+"""Base callback module."""
 
 import abc
 from typing import Optional
 
 
-class Callback(abc.ABC):
+class BaseCallback(abc.ABC):
     """Abstract class representing a callback."""
 
     def __init__(self, name: Optional[str] = None) -> None:
@@ -43,15 +43,15 @@ def set_detector(self, detector) -> None:
         self.detector = detector
 
     # @property
-    # def detector(self) -> Optional[ConceptDriftBase, DataDriftBatchBase]:
+    # def detector(self) -> Optional[BaseConceptDrift, BaseDataDriftBatch]:
     #     return self._detector
     #
     # @detector.setter
-    # def detector(self, value: Optional[ConceptDriftBase, DataDriftBatchBase]) -> None:
+    # def detector(self, value: Optional[BaseConceptDrift, BaseDataDriftBatch]) -> None:
     #     if not isinstance(
-    #             value, (ConceptDriftBase, DataDriftBatchBase)):
+    #             value, (BaseConceptDrift, BaseDataDriftBatch)):
     #         raise TypeError(
-    #             "value must be of type ConceptDriftBase or DataDriftBatchBase."
+    #             "value must be of type BaseConceptDrift or BaseDataDriftBatch."
     #         )
     #     self._detector = value
 

frouros/callbacks/batch/base.py

@@ -1,12 +1,12 @@
-"""Batch base test module."""
+"""Base callback batch module."""
 
 import abc
 
-from frouros.callbacks.base import Callback
+from frouros.callbacks.base import BaseCallback
 
 
-class BatchCallback(Callback):
-    """Batch callback class."""
+class BaseCallbackBatch(BaseCallback):
+    """Callback batch class."""
 
     def on_compare_start(self) -> None:
         """On compare start method."""

frouros/callbacks/batch/permutation_test.py

@@ -6,11 +6,11 @@
 import numpy as np  # type: ignore
 from scipy.stats import norm  # type: ignore
 
-from frouros.callbacks.batch.base import BatchCallback
+from frouros.callbacks.batch.base import BaseCallbackBatch
 from frouros.utils.stats import permutation, z_score
 
 
-class PermutationTestOnBatchData(BatchCallback):
+class PermutationTestOnBatchData(BaseCallbackBatch):
     """Permutation test on batch data callback class."""
 
     def __init__(
@@ -163,11 +163,11 @@ def on_compare_end(self, **kwargs) -> None:
     #
     #     :raises TypeError: Type error exception
     #     """
-    #     if not isinstance(detector, DataDriftBatchBase):
+    #     if not isinstance(detector, BaseDataDriftBatch):
     #         raise TypeError(
     #             f"callback {self.__class__.name} cannot be used with detector"
     #             f" {detector.__class__name}. Must be used with a detector of "
-    #             f"type DataDriftBatchBase."
+    #             f"type BaseDataDriftBatch."
     #         )
     #     self.detector = detector
 

frouros/callbacks/batch/reset_drift.py

@@ -2,10 +2,10 @@
 
 from typing import Optional
 
-from frouros.callbacks.batch.base import BatchCallback
+from frouros.callbacks.batch.base import BaseCallbackBatch
 
 
-class ResetOnBatchDataDrift(BatchCallback):
+class ResetOnBatchDataDrift(BaseCallbackBatch):
     """Reset on batch data drift callback class."""
 
     def __init__(self, alpha: float, name: Optional[str] = None) -> None:
@@ -56,11 +56,11 @@ def on_compare_end(self, **kwargs) -> None:
     #
     #     :raises TypeError: Type error exception
     #     """
-    #     if not isinstance(detector, DataDriftBatchBase):
+    #     if not isinstance(detector, BaseDataDriftBatch):
     #         raise TypeError(
     #             f"callback {self.__class__.name} cannot be used with detector"
     #             f" {detector.__class__name}. Must be used with a detector of "
-    #             f"type DataDriftBatchBase."
+    #             f"type BaseDataDriftBatch."
     #         )
     #     self.detector = detector
 

frouros/callbacks/streaming/base.py

@@ -1,14 +1,13 @@
-"""Streaming base test module."""
+"""Base callback streaming module."""
 
 import abc
-
 from typing import Union
 
-from frouros.callbacks.base import Callback
+from frouros.callbacks.base import BaseCallback
 
 
-class StreamingCallback(Callback):
-    """Streaming callback class."""
+class BaseCallbackStreaming(BaseCallback):
+    """Callback streaming class."""
 
     def on_update_start(self, value: Union[int, float], **kwargs) -> None:
         """On update start method."""

frouros/callbacks/streaming/history.py

@@ -2,11 +2,11 @@
 
 from typing import Any, Dict, List, Optional, Union
 
-from frouros.callbacks.streaming.base import StreamingCallback
-from frouros.utils.stats import Stat
+from frouros.callbacks.streaming.base import BaseCallbackStreaming
+from frouros.utils.stats import BaseStat
 
 
-class History(StreamingCallback):
+class History(BaseCallbackStreaming):
     """History callback class."""
 
     def __init__(self, name: Optional[str] = None) -> None:
@@ -49,7 +49,7 @@ def on_update_end(self, value: Union[int, float], **kwargs) -> None:
             #  add_addtional_vars is called (avoid the same computation)
             self.history[var].append(
                 additional_var.get()
-                if isinstance(additional_var, Stat)
+                if isinstance(additional_var, BaseStat)
                 else additional_var
             )
 
@@ -64,11 +64,11 @@ def on_update_end(self, value: Union[int, float], **kwargs) -> None:
     #
     #     :raises TypeError: Type error exception
     #     """
-    #     if not isinstance(detector, ConceptDriftBase):
+    #     if not isinstance(detector, BaseConceptDrift):
     #         raise TypeError(
     #             f"callback {self.__class__.name} cannot be used with detector"
     #             f" {detector.__class__name}. Must be used with a detector of "
-    #             f"type ConceptDriftBase."
+    #             f"type BaseConceptDrift."
     #         )
     #     self.detector = detector
 

frouros/callbacks/streaming/msprt.py

@@ -4,11 +4,11 @@
 
 import numpy as np  # type: ignore
 
-from frouros.callbacks.streaming.base import StreamingCallback
+from frouros.callbacks.streaming.base import BaseCallbackStreaming
 from frouros.utils.stats import CircularMean
 
 
-class mSPRT(StreamingCallback):  # noqa: N801 # pylint: disable=invalid-name
+class mSPRT(BaseCallbackStreaming):  # noqa: N801 # pylint: disable=invalid-name
     """mSPRT (mixing Sequentially Probability Ratio Test) callback class.
 
     :References:

frouros/callbacks/streaming/warning_samples.py

@@ -3,10 +3,10 @@
 import copy
 from typing import Any, List, Optional, Union
 
-from frouros.callbacks.streaming.base import StreamingCallback
+from frouros.callbacks.streaming.base import BaseCallbackStreaming
 
 
-class WarningSamplesBuffer(StreamingCallback):
+class WarningSamplesBuffer(BaseCallbackStreaming):
     """Store warning samples as a buffer callback class."""
 
     def __init__(self, name: Optional[str] = None) -> None: