module change_detection.river.river_change_detector

River Change Detection Model Wrapper.

This module contains a wrapper class for river concept drift detection methods.

Copyright (C) 2022 Johannes Haug.

class RiverChangeDetector

Wrapper class for river change detection classes.

Attributes:

  • detector (BaseDriftDetector): The river concept drift detector object.

method RiverChangeDetector.__init__

__init__(
    detector: river.base.drift_detector.DriftDetector,
    reset_after_drift: bool = False
)

Inits the wrapper.

Args:

  • detector: The river concept drift detector object.
  • reset_after_drift: A boolean indicating if the change detector will be reset after a drift was detected.

method RiverChangeDetector.detect_change

detect_change() → bool

Detects global concept drift.

Returns:

  • bool: True, if a concept drift was detected, False otherwise.

method RiverChangeDetector.detect_partial_change

detect_partial_change() → Tuple[bool, list]

Detects partial concept drift.

Notes:

River change detectors do not detect partial change.

method RiverChangeDetector.detect_warning_zone

detect_warning_zone() → bool

Detects a warning zone.

Returns:

  • bool: True, if the change detector has detected a warning zone, False otherwise.

method RiverChangeDetector.partial_fit

partial_fit(pr_scores: List[bool])

Updates the change detector.

Args:

  • pr_scores: A boolean vector indicating correct predictions. 'True' values indicate that the prediction by the online learner was correct, otherwise the vector contains 'False'.

method RiverChangeDetector.reset

reset()

Resets the change detector.

This file was automatically generated via lazydocs.