river

<img height="220px" src="https://github.com/online-ml/river/assets/8095957/64ad5fb6-383c-4bfb-af71-3d055a103a1a" alt="river_logo">  <a href="https://github.com/online-ml/river/actions/workflows/unit-tests.yml"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/b1ce2490-705c-4eaa-a479-94693328cfb7.svg" alt="unit-tests"> </a>  <a href="https://github.com/online-ml/river/actions/workflows/code-quality.yml"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/aba8d29e-9500-48bb-8ceb-6529c5ff68d4.svg" alt="code-quality"> </a>  <a href="https://riverml.xyz"> <img src="https://img.shields.io/website?label=docs&style=flat-square&url=https%3A%2F%2Friverml.xyz%2F" alt="documentation"> </a>  <a href="https://discord.gg/qNmrKEZMAn"> <img src="https://dcbadge.vercel.app/api/server/qNmrKEZMAn?style=flat-square" alt="discord"> </a>  <a href="https://pypi.org/project/river"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/d9f185fa-65d3-4e5d-8d5a-248322ef58af.svg?label=release&color=blue&style=flat-square" alt="pypi"> </a>  <a href="https://pepy.tech/project/river"> <img src="https://static.pepy.tech/badge/river?style=flat-square" alt="pepy"> </a>  <a href="https://github.com/psf/black"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/7ddc1a9f-5e30-4c42-8059-a8a13453befa.svg" alt="black"> </a>  <a href="http://mypy-lang.org/"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/c8ecc559-9183-40c8-bed2-d37486e5eddb.svg" alt="mypy"> </a>  <a href="https://opensource.org/licenses/BSD-3-Clause"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/bd335f1d-54dc-441c-8121-80af9acc745b.svg?style=flat-square" alt="bsd_3_license"> </a> River是一个用于<a href="https://www.wikiwand.com/en/Online_machine_learning">在线机器学习</a>的Python库。它旨在成为对流数据进行机器学习最用户友好的库。River是<a href="https://github.com/MaxHalford/creme">creme</a>和<a href="https://github.com/scikit-multiflow/scikit-multiflow">scikit-multiflow</a>合并的结果。

⚡️ 快速入门

作为一个快速示例，我们将训练一个逻辑回归模型来分类网站钓鱼数据集。以下是数据集中第一个观测值的样子。

>>> from pprint import pprint
>>> from river import datasets

>>> dataset = datasets.Phishing()

>>> for x, y in dataset:
...     pprint(x)
...     print(y)
...     break
{'age_of_domain': 1,
 'anchor_from_other_domain': 0.0,
 'empty_server_form_handler': 0.0,
 'https': 0.0,
 'ip_in_url': 1,
 'is_popular': 0.5,
 'long_url': 1.0,
 'popup_window': 0.0,
 'request_from_other_domain': 0.0}
True

现在让我们以流式方式在数据集上运行模型。我们按顺序交替进行预测和模型更新。同时，我们更新一个性能指标来查看模型的表现如何。

>>> from river import compose
>>> from river import linear_model
>>> from river import metrics
>>> from river import preprocessing

>>> model = compose.Pipeline(
...     preprocessing.StandardScaler(),
...     linear_model.LogisticRegression()
... )

>>> metric = metrics.Accuracy()

>>> for x, y in dataset:
...     y_pred = model.predict_one(x)      # 进行预测
...     metric.update(y, y_pred)  # 更新指标
...     model.learn_one(x, y)              # 让模型学习

>>> metric
Accuracy: 89.28%

当然，这只是一个人为构造的例子。我们欢迎您查看文档的介绍部分，以获得更全面的教程。

🛠 安装

River旨在与Python 3.8及以上版本一起使用。可以使用pip进行安装：

pip install river

Linux、MacOS 和 Windows 都有可用的 wheel 包。这意味着您很可能不需要从源代码构建 River。

您可以通过以下方式从 GitHub 安装最新的开发版本:

pip install git+https://github.com/online-ml/river --upgrade
pip install git+ssh://git@github.com/online-ml/river.git --upgrade  # 使用 SSH

此方法要求您的机器上安装了 Cython 和 Rust。

🔮 特性

River 提供了以下算法家族的在线实现:

线性模型，配备多种优化器
决策树和随机森林
(近似)最近邻
异常检测
漂移检测
推荐系统
时间序列预测
多臂老虎机
因子分解机
不平衡学习
聚类
Bagging/boosting/stacking
主动学习

River 还提供其他在线工具:

特征提取和选择
在线统计和度量
预处理
内置数据集
渐进式模型验证
模型管道

查看API 文档以获得全面概述

🤔 我应该使用 River 吗?

您应该问自己是否需要在线机器学习。答案可能是否定的。大多数情况下，批量学习就足够了。在以下情况下，在线方法可能更合适:

您希望模型能从新数据中学习，而无需重新访问过去的数据。
您希望模型对概念漂移具有鲁棒性。
您希望以更接近生产环境的方式开发模型，通常是基于事件的。

River 的一些特点是:

它更注重清晰度和用户体验，而不是性能。
它在一次处理一个样本时非常快。试试看，您会发现的。
它与 Python 生态系统的其他部分配合得很好。

🔗 有用链接

👐 贡献

随时以任何方式做出贡献，我们始终欢迎新的想法和方法。

如果您有任何问题或疑问，请开启一个讨论。在公开场合提问比发送私人邮件更有用。在贡献之前开启讨论也是受鼓励的，这样可以确保每个人都达成一致，避免不必要的工作。
如果您认为发现了 bug 或性能问题，欢迎提出 issue。
我们的路线图是公开的。随时处理任何引起您兴趣的内容，或提出建议。

如果您想对代码库进行修改，请查看贡献指南。

🤝 附属机构

💬 引用

如果 River 对您有用，并且您想在科学出版物中引用它，请参考在 JMLR 上发表的论文:

@article{montiel2021river,
  title={River: machine learning for streaming data in Python},
  author={Montiel, Jacob and Halford, Max and Mastelini, Saulo Martiello
          and Bolmier, Geoffrey and Sourty, Raphael and Vaysse, Robin and Zouitine, Adil
          and Gomes, Heitor Murilo and Read, Jesse and Abdessalem, Talel and others},
  year={2021}
}