Skip to content

River

flowcean.river wraps River estimators for incremental learning. Install the river extra as described in installation.

river

Classes

RiverLearner

RiverLearner(model: Regressor, callbacks: list[LearnerCallback] | LearnerCallback | None = None, progress_interval: int = 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
Attributes
model instance-attribute
model = model
callback_manager instance-attribute
callback_manager = create_callback_manager(callbacks)
progress_interval instance-attribute
progress_interval = progress_interval
Methods:
learn_incremental
learn_incremental(inputs: LazyFrame, outputs: LazyFrame) -> Model

RiverModel

RiverModel(model: Regressor, output_column: str)

Bases: Model

Attributes
model instance-attribute
model = model
output_column instance-attribute
output_column = output_column

Functions: