River extra

Context

This package contains additional estimators that have not been put into the main River package. These estimators still need to be polished and vetted before making the cut to the main package. This reduces the clutter in the main repository. This repository is not (always) a graveyard: an estimator may be moved to the main repository if it is provably "good".

Installation

pip install "river[extra]"

You can also install from source:

pip install git+https://github.com/online-ml/river-extra

The versioning schema is aligned with that of River. In other words, a new river release will be followed by a river-extra release with the same version number.

Code layout

The layout is the same as that in River. Where in River you would do:

from river import cluster

Here you would do:

from river_extra import cluster

Documentation

At the moment there isn't any. We encourage you to dive into the codebase.

Development

git clone https://github.com/online-ml/river_extra
cd river_extra
poetry install
poetry shell

License

River is free and open-source software licensed under the 3-clause BSD license. The same is true for this repository.