Skip to content

river

RiverLearner(model, callbacks=None, progress_interval=100)

Bases: SupervisedIncrementalLearner

Wrapper for River regressors.

Parameters:

Name Type Description Default
model Regressor

The River regressor to use.

required
callbacks list[LearnerCallback] | LearnerCallback | None

Optional callbacks for progress feedback. Use None for silent learning.

None
progress_interval int

Report progress every N samples. Default is 100.

100
Source code in src/flowcean/river/learner.py
43
44
45
46
47
48
49
50
51
52
53
54
def __init__(
    self,
    model: Regressor,
    callbacks: list[LearnerCallback] | LearnerCallback | None = None,
    progress_interval: int = 100,
) -> None:
    if progress_interval <= 0:
        msg = "progress_interval must be greater than 0"
        raise ValueError(msg)
    self.model = model
    self.callback_manager = create_callback_manager(callbacks)
    self.progress_interval = progress_interval