---

教程： 在 Colab 中打开

文档： https://reservoirpy.readthedocs.io/

---

功能概览：

• 轻松创建包含多个储层（例如深度储层）的复杂架构， 读出层
• 反馈回路
• 离线和在线训练
• 并行实现
• 稀疏矩阵计算
• 高级学习规则（例如内在可塑性、局部可塑性或NVAR（下一代储层计算））
• 与 scikit-learn 模型接口对接
• 以及更多功能！

此外，还包含了图形化工具，借助 hyperopt 库可以轻松探索超参数。

快速尝试 ⚡

安装

pip install reservoirpy

对于更完整的安装（包括超参数搜索等），请查看 ReadTheDocs 上的 完整安装指南。

混沌时间序列预测示例（Mackey-Glass）

关于储层计算和 ReservoirPy 功能的通用介绍，请查看 教程。

from reservoirpy.datasets import mackey_glass, to_forecasting
from reservoirpy.nodes import Reservoir, Ridge
from reservoirpy.observables import rmse, rsquare

### Step 1: Load the dataset

X = mackey_glass(n_timesteps=2000)  # (2000, 1)-shaped array
# create y by shifting X, and train/test split
x_train, x_test, y_train, y_test = to_forecasting(X, test_size=0.2)

### Step 2: Create an Echo State Network

# 100 neurons reservoir, spectral radius = 1.25, leak rate = 0.3
reservoir = Reservoir(units=100, sr=1.25, lr=0.3)
# feed-forward layer of neurons, trained with L2-regularization
readout = Ridge(ridge=1e-5)
# connect the two nodes
esn = reservoir >> readout

### Step 3: Fit, run and evaluate the ESN

esn.fit(x_train, y_train, warmup=100)
predictions = esn.run(x_test)

print(f"RMSE: {rmse(y_test, predictions)}; R^2 score: {rsquare(y_test, predictions)}")
# RMSE: 0.0020282; R^2 score: 0.99992

更多示例和教程 🎓

教程

• 1 - 开始使用 ReservoirPy
• 2 - 高级功能
• 3 - 储层计算通用介绍
• 4 - 理解并优化超参数
• 5 - 使用储层计算进行分类
• 6 - ReservoirPy 与 scikit-learn 接口对接

示例

对于高级用户，我们还展示了部分关于**水库计算（Reservoir Computing）**论文的重现，以展示库的一些功能。

• 利用内在可塑性（Intrinsic Plasticity）改进水库 (Schrauwen et al., 2008)
• 用于信息流分块（Chunking）的交互式水库计算 (Asabuki et al., 2018)
• 下一代水库计算 (Gauthier et al., 2021)
• 稳定性边缘回声状态网络（Echo State Network） (Ceni et al., 2023)

使用 ReservoirPy 的论文和项目

如果您希望您的论文出现在这里，请联系我们（见下方的联系链接）。

• ( HAL | PDF | Code ) Leger 等人 (2024) Evolving Reservoirs for Meta Reinforcement Learning. EvoAPPS 2024
• ( arXiv | PDF ) Chaix-Eichel 等人 (2022) From implicit learning to explicit representations. arXiv preprint arXiv:2204.02484.
• ( HTML | HAL | PDF ) Trouvain & Hinaut (2021) Canary Song Decoder: Transduction and Implicit Segmentation with ESNs and LTSMs. ICANN 2021
• ( HTML ) Pagliarini 等人 (2021) Canary Vocal Sensorimotor Model with RNN Decoder and Low-dimensional GAN Generator. ICDL 2021.
• ( HAL | PDF ) Pagliarini 等人 (2021) What does the Canary Say? Low-Dimensional GAN Applied to Birdsong. HAL preprint.
• ( HTML | HAL | PDF ) Hinaut & Trouvain (2021) Which Hype for My New Task? Hints and Random Search for Echo State Networks Hyperparameters. ICANN 2021

精彩的水库计算资源

我们在此提供了一个精选的**水库计算（Reservoir Computing）**教程、论文、项目和工具列表（不一定与 ReservoirPy 相关）：

https://github.com/reservoirpy/awesome-reservoir-computing

联系方式

如果您有关于该库的问题，请提交一个 issue。

如果您有更一般的问题或反馈，可以通过电子邮件联系我们：xavier dot hinaut the-famous-home-symbol inria dot fr。

引用 ReservoirPy

Trouvain, N., Pedrelli, L., Dinh, T. T., Hinaut, X. (2020) ReservoirPy: an efficient and user-friendly library to design echo state networks. In International Conference on Artificial Neural Networks (pp. 494-505). Springer, Cham. ( HTML | HAL | PDF )

如果您在研究中使用了 ReservoirPy，请使用以下 bibtex 条目引用我们的包：

@incollection{Trouvain2020,
  doi = {10.1007/978-3-030-61616-8_40},
  url = {https://doi.org/10.1007/978-3-030-61616-8_40},
  year = {2020},
  publisher = {Springer International Publishing},
  pages = {494--505},
  author = {Nathan Trouvain and Luca Pedrelli and Thanh Trung Dinh and Xavier Hinaut},
  title = {{ReservoirPy}: An Efficient and User-Friendly Library to Design Echo State Networks},
  booktitle = {Artificial Neural Networks and Machine Learning {\textendash} {ICANN} 2020}
}

致谢

本包由法国波尔多 Inria 的 Mnemosyne 小组开发和支持。Inria 是一家法国的数字科学研究所（计算机科学、数学、机器人技术等...）。

reservoirpy 快速上手指南

ReservoirPy 是一个简单且灵活的开源库，专为构建储备池计算（Reservoir Computing）架构而设计，例如回声状态网络（Echo State Networks, ESN）。它支持复杂的网络结构、多种学习规则以及与 scikit-learn 的无缝集成。

环境准备

• 操作系统: Linux, macOS, Windows
• Python 版本: Python 3.7 及以上版本
• 包管理工具: pip

建议在一个干净的虚拟环境中进行安装，以避免依赖冲突。

安装步骤

通过 pip 安装核心库：

pip install reservoirpy

如需使用超参数搜索等高级功能，请参考官方文档中的完整安装指南。

基本使用

以下示例展示了如何使用 ReservoirPy 对 Mackey-Glass 混沌时间序列进行预测。

1. 导入必要的模块

from reservoirpy.datasets import mackey_glass, to_forecasting
from reservoirpy.nodes import Reservoir, Ridge
from reservoirpy.observables import rmse, rsquare

2. 加载数据集并划分训练集与测试集

X = mackey_glass(n_timesteps=2000)  # (2000, 1)-shaped array
# create y by shifting X, and train/test split
x_train, x_test, y_train, y_test = to_forecasting(X, test_size=0.2)

3. 构建回声状态网络 (ESN)

创建一个包含 100 个神经元的储备池，并连接一个带有 L2 正则化的读出头（Readout）。

# 100 neurons reservoir, spectral radius = 1.25, leak rate = 0.3
reservoir = Reservoir(units=100, sr=1.25, lr=0.3)
# feed-forward layer of neurons, trained with L2-regularization
readout = Ridge(ridge=1e-5)
# connect the two nodes
esn = reservoir >> readout

4. 训练、运行与评估

esn.fit(x_train, y_train, warmup=100)
predictions = esn.run(x_test)

print(f"RMSE: {rmse(y_test, predictions)}; R^2 score: {rsquare(y_test, predictions)}")
# RMSE: 0.0020282; R^2 score: 0.99992

---

更多教程和示例请访问 Google Colab Tutorials 或查阅 官方文档。