deep-river 0.3.0__tar.gz → 0.3.2__tar.gz

deep_river-0.3.2/PKG-INFO

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: deep_river
+Version: 0.3.2
+Summary: Online Deep Learning for river
+Author-email: Cedric Kulbach <cedric.kulbach@googlemail.com>, Lucas Cazzonelli <Cazzonelli@fzi.de>, Hoang-Anh Ngo <hoang-anh.ngo@alumni.polytechnique.org>, Max Halford <maxhalford25@gmail.com>, Saulo Martiello Mastelini <saulomastelini@gmail.com>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/online-ml/deep-river
+Project-URL: Repository, https://github.com/online-ml/deep-river
+Project-URL: Documentation, https://github.com/online-ml/deep-river
+Keywords: online-learning,deep-learning,data-streams
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: <3.13,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: scikit-learn~=1.5.0
+Requires-Dist: torch==2.2.2
+Requires-Dist: pandas~=2.2.2
+Requires-Dist: numpy~=1.26.4
+Requires-Dist: river
+Requires-Dist: tqdm~=4.66.5
+Requires-Dist: torchviz~=0.0.2
+Requires-Dist: mkdocstrings[python]>=0.19.0
+Requires-Dist: pytkdocs[numpy-style]>=0.5.0
+Requires-Dist: sortedcontainers>=2.4.0
+Provides-Extra: dev
+Requires-Dist: graphviz>=0.20.3; extra == "dev"
+Requires-Dist: matplotlib>=3.9.2; extra == "dev"
+Requires-Dist: mypy>=1.11.1; extra == "dev"
+Requires-Dist: codecov>=2.1.13; extra == "dev"
+Requires-Dist: pre-commit>=3.8.0; extra == "dev"
+Requires-Dist: pytest>=8.3.2; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: black>=24.8.0; extra == "dev"
+Requires-Dist: flake8>=7.1.1; extra == "dev"
+Requires-Dist: isort>=5.13.2; extra == "dev"
+Requires-Dist: jupyter>=1.0.0; extra == "dev"
+Requires-Dist: pyupgrade==3.17.0; extra == "dev"
+Requires-Dist: flask>=3.0.2; extra == "dev"
+Requires-Dist: ipykernel>=6.9.0; extra == "dev"
+Requires-Dist: mike>=0.5.3; extra == "dev"
+Requires-Dist: mkdocs>=1.2.3; extra == "dev"
+Requires-Dist: mkdocs-awesome-pages-plugin>=2.7.0; extra == "dev"
+Requires-Dist: mkdocs-gen-files>=0.3.5; extra == "dev"
+Requires-Dist: mkdocs-charts-plugin>=0.0.8; extra == "dev"
+Requires-Dist: mkdocs-literate-nav>=0.4.1; extra == "dev"
+Requires-Dist: mkdocs-material>=8.1.11; extra == "dev"
+Requires-Dist: ipython_genutils>=0.1.0; extra == "dev"
+Requires-Dist: mkdocs-jupyter>=0.20.0; extra == "dev"
+Requires-Dist: nbconvert>=6.4.2; extra == "dev"
+Requires-Dist: jupyter_contrib_nbextensions==0.7.0; extra == "dev"
+Requires-Dist: numpydoc>=1.2; extra == "dev"
+Requires-Dist: notebook==6.4.3; extra == "dev"
+Requires-Dist: spacy>=3.2.2; extra == "dev"
+Requires-Dist: jinja2>=3.0.3; extra == "dev"
+Requires-Dist: dominate; extra == "dev"
+Requires-Dist: jupyter-client; extra == "dev"
+Requires-Dist: python-slugify; extra == "dev"
+Requires-Dist: watermark==2.3.1; extra == "dev"
+Requires-Dist: plotly>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img height="150px" src="https://raw.githubusercontent.com/online-ml/deep-river/master/docs/img/logo.png" alt="incremental dl logo">
+</p>
+<p align="center">
+    <img alt="PyPI" src="https://img.shields.io/pypi/v/deep-river">
+    <!-- Single Coverage Badge (Shields.io) -->
+    <a href="https://app.codecov.io/gh/online-ml/deep-river" >
+        <img alt="Coverage" src="https://img.shields.io/codecov/c/github/online-ml/deep-river?branch=master&logo=codecov&label=coverage" />
+    </a>
+    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/deep-river">
+    <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/deep-river">
+    <img alt="GitHub" src="https://img.shields.io/github/license/online-ml/deep-river">
+    <a href="https://joss.theoj.org/papers/6a76784f55e8b041d71a7fa776eb386a"><img src="https://joss.theoj.org/papers/6a76784f55e8b041d71a7fa776eb386a/status.svg"></a>
+    <a href="https://doi.org/10.5281/zenodo.14601980"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14601980.svg" alt="DOI"></a>
+</p>
+<p align="center">
+    deep-river is a Python library for online deep learning.
+    deep-river's ambition is to enable <a href="https://www.wikiwand.com/en/Online_machine_learning">online machine learning</a> for neural networks.
+    It combines the <a href="https://www.riverml.xyz">river</a> API with the capabilities of designing neural networks based on <a href="https://pytorch.org">PyTorch</a>.
+</p>
+
+## 📚 [Documentation](https://online-ml.github.io/deep-river/)
+The [documentation](https://online-ml.github.io/deep-river/) contains an overview of all features of this repository as well as the repository's full features list. 
+In each of these, the git repo reference is listed in a section that shows [examples](https://github.com/online-ml/deep-river/blob/master/docs/examples) of the features and functionality.
+As we are always looking for further use cases and examples, feel free to contribute to the documentation or the repository itself via a pull request
+
+## 💈 Installation
+
+```shell
+pip install deep-river
+```
+or
+```shell
+pip install "river[deep]"
+```
+You can install the latest development version from GitHub as so:
+
+```shell
+pip install https://github.com/online-ml/deep-river/archive/refs/heads/master.zip
+```
+
+### Development Environment
+
+For contributing to deep-river, we recommend using [uv](https://docs.astral.sh/uv/) for fast dependency management and environment setup:
+
+```shell
+# Install uv if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Clone the repository
+git clone https://github.com/online-ml/deep-river.git
+cd deep-river
+
+# Install all dependencies (including dev dependencies)
+uv sync --extra dev
+
+# Run tests
+make test
+
+# Format code
+make format
+
+# Build documentation
+make doc
+```
+
+## 🍫 Quickstart
+
+We build the development of neural networks on top of the <a href="https://www.riverml.xyz">river API</a> and refer to the rivers design principles.
+The following example creates a simple MLP architecture based on PyTorch and incrementally predicts and trains on the website phishing dataset.
+For further examples check out the <a href="https://online-ml.github.io/deep-river">Documentation</a>.
+
+
+### Classification
+
+```python
+>>> import random, numpy as np
+>>> from river import metrics, datasets, preprocessing, compose
+>>> from deep_river.classification import Classifier
+>>> from torch import nn, manual_seed
+>>> _ = manual_seed(42); random.seed(42); np.random.seed(42)
+>>> first_x, _ = next(iter(datasets.Phishing()))
+>>> n_features = len(first_x)
+>>> class MyModule(nn.Module):
+...     def __init__(self, n_features):
+...         super().__init__()
+...         self.net = nn.Sequential(
+...             nn.Linear(n_features, 16),
+...             nn.ReLU(),
+...             nn.Linear(16, 2)
+...         )
+...     def forward(self, x):
+...         return self.net(x)
+>>> model = compose.Pipeline(
+...     preprocessing.StandardScaler(),
+...     Classifier(
+...         module=MyModule(n_features),
+...         loss_fn='cross_entropy',
+...         optimizer_fn='adam',
+...         lr=1e-3,
+...         is_class_incremental=True
+...     )
+... )
+>>> metric = metrics.Accuracy()
+>>> for i, (x, y) in enumerate(datasets.Phishing().take(200)):
+...     if i > 0:
+...         y_pred = model.predict_one(x)
+...         metric.update(y, y_pred)
+...     model.learn_one(x, y)
+>>> assert 0.5 <= metric.get() <= 1.0
+>>> print(f"Accuracy: {metric.get():.4f}")  # doctest: +ELLIPSIS
+Accuracy: ...
+
+```
+
+### Multi Target Regression
+
+```python
+>>> import random, numpy as np
+>>> from river import stream, metrics, preprocessing, compose
+>>> from sklearn import datasets as sk_datasets
+>>> from deep_river.regression import MultiTargetRegressor
+>>> from torch import nn, manual_seed
+>>> _ = manual_seed(42); random.seed(42); np.random.seed(42)
+>>> linnerud_stream = stream.iter_sklearn_dataset(sk_datasets.load_linnerud(), shuffle=True, seed=42)
+>>> first_x, first_y = next(iter(linnerud_stream))
+>>> n_features, n_outputs = len(first_x), len(first_y)
+>>> class TinyNet(nn.Module):
+...     def __init__(self, n_features, n_outputs):
+...         super().__init__()
+...         self.net = nn.Sequential(
+...             nn.Linear(n_features, 16),
+...             nn.ReLU(),
+...             nn.Linear(16, n_outputs)
+...         )
+...     def forward(self, x):
+...         return self.net(x)
+>>> model = compose.Pipeline(
+...     preprocessing.StandardScaler(),  # feature scaling stabilizes training
+...     MultiTargetRegressor(
+...         module=TinyNet(n_features, n_outputs),
+...         loss_fn='mse', optimizer_fn='adam', lr=5e-3,
+...         is_feature_incremental=False, is_target_incremental=False,
+...         gradient_clip_value=1.0,
+...     )
+... )
+>>> mae_micro = metrics.multioutput.MicroAverage(metrics.MAE())
+>>> mae_macro = metrics.multioutput.MacroAverage(metrics.MAE())
+>>> rmse_micro = metrics.multioutput.MicroAverage(metrics.RMSE())
+>>> # Recreate the iterator (the first sample was consumed to infer shapes)
+>>> linnerud_stream = stream.iter_sklearn_dataset(sk_datasets.load_linnerud(), shuffle=True, seed=42)
+>>> for i, (x, y_dict) in enumerate(linnerud_stream):
+...     if i > 0:
+...         y_pred = model.predict_one(x)
+...         mae_micro.update(y_dict, y_pred)
+...         mae_macro.update(y_dict, y_pred)
+...         rmse_micro.update(y_dict, y_pred)
+...     model.learn_one(x, y_dict)
+>>> assert 0.0 <= mae_micro.get() < 300.0
+>>> assert 0.0 <= mae_macro.get() < 300.0
+>>> assert 0.0 <= rmse_micro.get() < 400.0
+>>> print({
+...     'MAE_micro': round(mae_micro.get(), 4),
+...     'MAE_macro': round(mae_macro.get(), 4),
+...     'RMSE_micro': round(rmse_micro.get(), 4)
+... })  # doctest: +ELLIPSIS
+{'MAE_micro': ..., 'MAE_macro': ..., 'RMSE_micro': ...}
+
+```
+
+### Anomaly Detection
+
+```python
+>>> import random, numpy as np
+>>> from torch import nn, manual_seed
+>>> from river import metrics
+>>> from deep_river.anomaly import Autoencoder
+>>> _ = manual_seed(42); random.seed(42); np.random.seed(42)
+>>> # Create a deterministic synthetic stream: normals (y=0) vs. anomalies (y=1)
+>>> def synthetic_stream(n_norm=2000, n_anom=200, n_features=8, seed=42):
+...     rng = np.random.default_rng(seed)
+...     # Normals around 0, anomalies shifted
+...     X_norm = rng.normal(loc=0.0, scale=1.0, size=(n_norm, n_features))
+...     y_norm = np.zeros(n_norm, dtype=int)
+...     X_anom = rng.normal(loc=5.0, scale=1.0, size=(n_anom, n_features))
+...     y_anom = np.ones(n_anom, dtype=int)
+...     # Interleave anomalies every k steps to keep streaming flavour
+...     k = max(1, n_norm // n_anom)
+...     X, Y = [], []
+...     i_norm = i_anom = 0
+...     for t in range(n_norm + n_anom):
+...         take_anom = (t % k == 0) and (i_anom < n_anom)
+...         if take_anom:
+...             X.append(X_anom[i_anom]); Y.append(y_anom[i_anom]); i_anom += 1
+...         else:
+...             if i_norm < n_norm:
+...                 X.append(X_norm[i_norm]); Y.append(y_norm[i_norm]); i_norm += 1
+...             elif i_anom < n_anom:
+...                 X.append(X_anom[i_anom]); Y.append(y_anom[i_anom]); i_anom += 1
+...     for row, label in zip(X, Y):
+...         yield {f"f{i}": float(v) for i, v in enumerate(row)}, int(label)
+>>> n_features = 8
+>>> class MyAutoEncoder(nn.Module):
+...     def __init__(self, n_features, latent_dim=4):
+...         super().__init__()
+...         self.encoder = nn.Sequential(
+...             nn.Linear(n_features, latent_dim),
+...             nn.LeakyReLU()
+...         )
+...         self.decoder = nn.Sequential(
+...             nn.Linear(latent_dim, n_features),
+...             nn.Sigmoid()
+...         )
+...     def forward(self, x):
+...         z = self.encoder(x)
+...         return self.decoder(z)
+>>> ae = Autoencoder(module=MyAutoEncoder(n_features), lr=5e-3, optimizer_fn='adam')
+>>> metric = metrics.ROCAUC()
+>>> # Train only on normal samples to keep the model focused on the normal manifold
+>>> for x, y in synthetic_stream(n_norm=2000, n_anom=200, n_features=n_features, seed=42):
+...     score = ae.score_one(x)
+...     if y == 0:
+...         ae.learn_one(x)
+...     metric.update(y, score)
+>>> print(f"ROCAUC: {metric.get():.4f}")  # doctest: +ELLIPSIS
+ROCAUC: ...
+
+```
+
+## 💬 Citation
+
+To acknowledge the use of the `DeepRiver` library in your research, please refer to our [paper](https://joss.theoj.org/papers/10.21105/joss.07226) published on Journal of Open Source Software (JOSS):
+
+```bibtex
+@article{Kulbach2025, 
+    doi = {10.21105/joss.07226}, 
+    url = {https://doi.org/10.21105/joss.07226}, 
+    year = {2025}, 
+    publisher = {The Open Journal}, 
+    volume = {10}, 
+    number = {105}, 
+    pages = {7226}, 
+    author = {Cedric Kulbach and Lucas Cazzonelli and Hoang-Anh Ngo and Max Halford and Saulo Martiello Mastelini}, 
+    title = {DeepRiver: A Deep Learning Library for Data Streams}, 
+    journal = {Journal of Open Source Software} 
+}
+```
+
+## 🏫 Affiliations
+
+<p align="center">
+    <img src="https://upload.wikimedia.org/wikipedia/de/thumb/4/44/Fzi_logo.svg/1200px-Fzi_logo.svg.png?raw=true" alt="FZI Logo" height="200"/>
+</p>
+
+<p align="center">
+    <img src="https://lieferbotnet.de/wp-content/uploads/2022/09/LieferBotNet-Logo.png?raw=true" alt="Lieferbot net" height="200"/>
+</p>

deep_river-0.3.2/README.md

@@ -0,0 +1,257 @@
+<p align="center">
+  <img height="150px" src="https://raw.githubusercontent.com/online-ml/deep-river/master/docs/img/logo.png" alt="incremental dl logo">
+</p>
+<p align="center">
+    <img alt="PyPI" src="https://img.shields.io/pypi/v/deep-river">
+    <!-- Single Coverage Badge (Shields.io) -->
+    <a href="https://app.codecov.io/gh/online-ml/deep-river" >
+        <img alt="Coverage" src="https://img.shields.io/codecov/c/github/online-ml/deep-river?branch=master&logo=codecov&label=coverage" />
+    </a>
+    <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/deep-river">
+    <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/deep-river">
+    <img alt="GitHub" src="https://img.shields.io/github/license/online-ml/deep-river">
+    <a href="https://joss.theoj.org/papers/6a76784f55e8b041d71a7fa776eb386a"><img src="https://joss.theoj.org/papers/6a76784f55e8b041d71a7fa776eb386a/status.svg"></a>
+    <a href="https://doi.org/10.5281/zenodo.14601980"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14601980.svg" alt="DOI"></a>
+</p>
+<p align="center">
+    deep-river is a Python library for online deep learning.
+    deep-river's ambition is to enable <a href="https://www.wikiwand.com/en/Online_machine_learning">online machine learning</a> for neural networks.
+    It combines the <a href="https://www.riverml.xyz">river</a> API with the capabilities of designing neural networks based on <a href="https://pytorch.org">PyTorch</a>.
+</p>
+
+## 📚 [Documentation](https://online-ml.github.io/deep-river/)
+The [documentation](https://online-ml.github.io/deep-river/) contains an overview of all features of this repository as well as the repository's full features list. 
+In each of these, the git repo reference is listed in a section that shows [examples](https://github.com/online-ml/deep-river/blob/master/docs/examples) of the features and functionality.
+As we are always looking for further use cases and examples, feel free to contribute to the documentation or the repository itself via a pull request
+
+## 💈 Installation
+
+```shell
+pip install deep-river
+```
+or
+```shell
+pip install "river[deep]"
+```
+You can install the latest development version from GitHub as so:
+
+```shell
+pip install https://github.com/online-ml/deep-river/archive/refs/heads/master.zip
+```
+
+### Development Environment
+
+For contributing to deep-river, we recommend using [uv](https://docs.astral.sh/uv/) for fast dependency management and environment setup:
+
+```shell
+# Install uv if you haven't already
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Clone the repository
+git clone https://github.com/online-ml/deep-river.git
+cd deep-river
+
+# Install all dependencies (including dev dependencies)
+uv sync --extra dev
+
+# Run tests
+make test
+
+# Format code
+make format
+
+# Build documentation
+make doc
+```
+
+## 🍫 Quickstart
+
+We build the development of neural networks on top of the <a href="https://www.riverml.xyz">river API</a> and refer to the rivers design principles.
+The following example creates a simple MLP architecture based on PyTorch and incrementally predicts and trains on the website phishing dataset.
+For further examples check out the <a href="https://online-ml.github.io/deep-river">Documentation</a>.
+
+
+### Classification
+
+```python
+>>> import random, numpy as np
+>>> from river import metrics, datasets, preprocessing, compose
+>>> from deep_river.classification import Classifier
+>>> from torch import nn, manual_seed
+>>> _ = manual_seed(42); random.seed(42); np.random.seed(42)
+>>> first_x, _ = next(iter(datasets.Phishing()))
+>>> n_features = len(first_x)
+>>> class MyModule(nn.Module):
+...     def __init__(self, n_features):
+...         super().__init__()
+...         self.net = nn.Sequential(
+...             nn.Linear(n_features, 16),
+...             nn.ReLU(),
+...             nn.Linear(16, 2)
+...         )
+...     def forward(self, x):
+...         return self.net(x)
+>>> model = compose.Pipeline(
+...     preprocessing.StandardScaler(),
+...     Classifier(
+...         module=MyModule(n_features),
+...         loss_fn='cross_entropy',
+...         optimizer_fn='adam',
+...         lr=1e-3,
+...         is_class_incremental=True
+...     )
+... )
+>>> metric = metrics.Accuracy()
+>>> for i, (x, y) in enumerate(datasets.Phishing().take(200)):
+...     if i > 0:
+...         y_pred = model.predict_one(x)
+...         metric.update(y, y_pred)
+...     model.learn_one(x, y)
+>>> assert 0.5 <= metric.get() <= 1.0
+>>> print(f"Accuracy: {metric.get():.4f}")  # doctest: +ELLIPSIS
+Accuracy: ...
+
+```
+
+### Multi Target Regression
+
+```python
+>>> import random, numpy as np
+>>> from river import stream, metrics, preprocessing, compose
+>>> from sklearn import datasets as sk_datasets
+>>> from deep_river.regression import MultiTargetRegressor
+>>> from torch import nn, manual_seed
+>>> _ = manual_seed(42); random.seed(42); np.random.seed(42)
+>>> linnerud_stream = stream.iter_sklearn_dataset(sk_datasets.load_linnerud(), shuffle=True, seed=42)
+>>> first_x, first_y = next(iter(linnerud_stream))
+>>> n_features, n_outputs = len(first_x), len(first_y)
+>>> class TinyNet(nn.Module):
+...     def __init__(self, n_features, n_outputs):
+...         super().__init__()
+...         self.net = nn.Sequential(
+...             nn.Linear(n_features, 16),
+...             nn.ReLU(),
+...             nn.Linear(16, n_outputs)
+...         )
+...     def forward(self, x):
+...         return self.net(x)
+>>> model = compose.Pipeline(
+...     preprocessing.StandardScaler(),  # feature scaling stabilizes training
+...     MultiTargetRegressor(
+...         module=TinyNet(n_features, n_outputs),
+...         loss_fn='mse', optimizer_fn='adam', lr=5e-3,
+...         is_feature_incremental=False, is_target_incremental=False,
+...         gradient_clip_value=1.0,
+...     )
+... )
+>>> mae_micro = metrics.multioutput.MicroAverage(metrics.MAE())
+>>> mae_macro = metrics.multioutput.MacroAverage(metrics.MAE())
+>>> rmse_micro = metrics.multioutput.MicroAverage(metrics.RMSE())
+>>> # Recreate the iterator (the first sample was consumed to infer shapes)
+>>> linnerud_stream = stream.iter_sklearn_dataset(sk_datasets.load_linnerud(), shuffle=True, seed=42)
+>>> for i, (x, y_dict) in enumerate(linnerud_stream):
+...     if i > 0:
+...         y_pred = model.predict_one(x)
+...         mae_micro.update(y_dict, y_pred)
+...         mae_macro.update(y_dict, y_pred)
+...         rmse_micro.update(y_dict, y_pred)
+...     model.learn_one(x, y_dict)
+>>> assert 0.0 <= mae_micro.get() < 300.0
+>>> assert 0.0 <= mae_macro.get() < 300.0
+>>> assert 0.0 <= rmse_micro.get() < 400.0
+>>> print({
+...     'MAE_micro': round(mae_micro.get(), 4),
+...     'MAE_macro': round(mae_macro.get(), 4),
+...     'RMSE_micro': round(rmse_micro.get(), 4)
+... })  # doctest: +ELLIPSIS
+{'MAE_micro': ..., 'MAE_macro': ..., 'RMSE_micro': ...}
+
+```
+
+### Anomaly Detection
+
+```python
+>>> import random, numpy as np
+>>> from torch import nn, manual_seed
+>>> from river import metrics
+>>> from deep_river.anomaly import Autoencoder
+>>> _ = manual_seed(42); random.seed(42); np.random.seed(42)
+>>> # Create a deterministic synthetic stream: normals (y=0) vs. anomalies (y=1)
+>>> def synthetic_stream(n_norm=2000, n_anom=200, n_features=8, seed=42):
+...     rng = np.random.default_rng(seed)
+...     # Normals around 0, anomalies shifted
+...     X_norm = rng.normal(loc=0.0, scale=1.0, size=(n_norm, n_features))
+...     y_norm = np.zeros(n_norm, dtype=int)
+...     X_anom = rng.normal(loc=5.0, scale=1.0, size=(n_anom, n_features))
+...     y_anom = np.ones(n_anom, dtype=int)
+...     # Interleave anomalies every k steps to keep streaming flavour
+...     k = max(1, n_norm // n_anom)
+...     X, Y = [], []
+...     i_norm = i_anom = 0
+...     for t in range(n_norm + n_anom):
+...         take_anom = (t % k == 0) and (i_anom < n_anom)
+...         if take_anom:
+...             X.append(X_anom[i_anom]); Y.append(y_anom[i_anom]); i_anom += 1
+...         else:
+...             if i_norm < n_norm:
+...                 X.append(X_norm[i_norm]); Y.append(y_norm[i_norm]); i_norm += 1
+...             elif i_anom < n_anom:
+...                 X.append(X_anom[i_anom]); Y.append(y_anom[i_anom]); i_anom += 1
+...     for row, label in zip(X, Y):
+...         yield {f"f{i}": float(v) for i, v in enumerate(row)}, int(label)
+>>> n_features = 8
+>>> class MyAutoEncoder(nn.Module):
+...     def __init__(self, n_features, latent_dim=4):
+...         super().__init__()
+...         self.encoder = nn.Sequential(
+...             nn.Linear(n_features, latent_dim),
+...             nn.LeakyReLU()
+...         )
+...         self.decoder = nn.Sequential(
+...             nn.Linear(latent_dim, n_features),
+...             nn.Sigmoid()
+...         )
+...     def forward(self, x):
+...         z = self.encoder(x)
+...         return self.decoder(z)
+>>> ae = Autoencoder(module=MyAutoEncoder(n_features), lr=5e-3, optimizer_fn='adam')
+>>> metric = metrics.ROCAUC()
+>>> # Train only on normal samples to keep the model focused on the normal manifold
+>>> for x, y in synthetic_stream(n_norm=2000, n_anom=200, n_features=n_features, seed=42):
+...     score = ae.score_one(x)
+...     if y == 0:
+...         ae.learn_one(x)
+...     metric.update(y, score)
+>>> print(f"ROCAUC: {metric.get():.4f}")  # doctest: +ELLIPSIS
+ROCAUC: ...
+
+```
+
+## 💬 Citation
+
+To acknowledge the use of the `DeepRiver` library in your research, please refer to our [paper](https://joss.theoj.org/papers/10.21105/joss.07226) published on Journal of Open Source Software (JOSS):
+
+```bibtex
+@article{Kulbach2025, 
+    doi = {10.21105/joss.07226}, 
+    url = {https://doi.org/10.21105/joss.07226}, 
+    year = {2025}, 
+    publisher = {The Open Journal}, 
+    volume = {10}, 
+    number = {105}, 
+    pages = {7226}, 
+    author = {Cedric Kulbach and Lucas Cazzonelli and Hoang-Anh Ngo and Max Halford and Saulo Martiello Mastelini}, 
+    title = {DeepRiver: A Deep Learning Library for Data Streams}, 
+    journal = {Journal of Open Source Software} 
+}
+```
+
+## 🏫 Affiliations
+
+<p align="center">
+    <img src="https://upload.wikimedia.org/wikipedia/de/thumb/4/44/Fzi_logo.svg/1200px-Fzi_logo.svg.png?raw=true" alt="FZI Logo" height="200"/>
+</p>
+
+<p align="center">
+    <img src="https://lieferbotnet.de/wp-content/uploads/2022/09/LieferBotNet-Logo.png?raw=true" alt="Lieferbot net" height="200"/>
+</p>

{deep_river-0.3.0 → deep_river-0.3.2}/deep_river/__version__.py

@@ -1,3 +1,3 @@
-VERSION = (0, 3, 0)
+VERSION = (0, 3, 2)
 
 __version__ = ".".join(map(str, VERSION))  # noqa: F401

deep_river-0.3.2/deep_river/anomaly/__init__.py

@@ -0,0 +1,17 @@
+from .ae import Autoencoder
+from .probability_weighted_ae import ProbabilityWeightedAutoencoder
+from .rolling_ae import RollingAutoencoder
+from .scaler import AnomalyMeanScaler, AnomalyMinMaxScaler, AnomalyStandardScaler
+
+"""
+This module contains the anomaly detection algorithms for the
+deep_river package.
+"""
+__all__ = [
+    "AnomalyStandardScaler",
+    "AnomalyMeanScaler",
+    "AnomalyMinMaxScaler",
+    "Autoencoder",
+    "ProbabilityWeightedAutoencoder",
+    "RollingAutoencoder",
+]