请注意，该项目目前仍处于测试阶段。若遇到问题或有建议，请提交 Issue，我们将尽快处理。欢迎贡献代码！

NeuralProphet：以人为本的时间序列预测

NeuralProphet 是一个易于学习、可解释的时间序列预测框架。它基于 PyTorch，结合了神经网络与传统时间序列算法，灵感源自 Facebook Prophet 和 AR-Net。

• 只需几行代码，即可定义、定制、可视化和评估你的预测模型。
• 专为“人在回路中”的迭代式模型构建而设计。你可以快速构建初始模型，解读结果，优化改进，再重复此过程。由于注重可解释性和可定制性，NeuralProphet 的初始默认模型可能并非最高精度；因此，建议根据结果不断调整与迭代。
• NeuralProphet 最适合较高频率（亚日级别）且持续时间较长（至少两个完整周期/年）的时间序列数据。

文档

文档页面 可能未完全更新。如有疑问，请以 docstring 为准。我们正在努力改进文档，欢迎任何帮助与贡献。

如需直观了解 NeuralProphet，可查看 演示文稿。

贡献

我们编写了 贡献指南，其中包含实用说明和更多资源，帮助你加入社区。

社区

讨论与帮助

如有任何问题或建议，可参与 我们的 GitHub 社区讨论。

Slack 聊天

我们也有一个活跃的 Slack 社区。欢迎加入交流！

教程

我们提供了多个 示例笔记本 帮助入门。

教程中使用的数据集（包括数据预处理示例）可在 neuralprophet-data 仓库 中找到。

更多资源请参考 文档页面。

最小示例

from neuralprophet import NeuralProphet

导入包后，即可在代码中使用 NeuralProphet：

m = NeuralProphet()
metrics = m.fit(df)
forecast = m.predict(df)

可使用内置绘图函数可视化结果：

fig_forecast = m.plot(forecast)
fig_components = m.plot_components(forecast)
fig_model = m.plot_parameters()

如需预测未知未来，在预测前扩展数据框：

m = NeuralProphet().fit(df, freq="D")
df_future = m.make_future_dataframe(df, periods=30)
forecast = m.predict(df_future)
fig_forecast = m.plot(forecast)

安装

可直接通过 pip 安装 neuralprophet：

pip install neuralprophet

安装选项

若在 Jupyter notebook 中使用，建议安装包含实时功能的版本：

pip install neuralprophet[live]

这样可以在 fit 函数中启用 plot_live_loss，实时显示训练（及验证）损失。

如需使用最新版，可直接从 GitHub 安装：

git clone <从 GitHub 复制链接>
cd neural_prophet
pip install .

Windows 用户请使用 WSL2。

功能特性

模型组件

• 自回归：自相关建模 — 线性或神经网络（AR-Net）。
• 趋势：分段线性趋势，可选自动变化点检测。
• 季节性：不同周期（如年、日、周、小时）的傅里叶项。
• 滞后回归因子：滞后观测值（如温度传感器） — 线性或神经网络。
• 未来回归因子：预先已知的特征（如温度预报） — 线性或神经网络。
• 事件：国家节假日和重复自定义事件。
• 全局建模：组件可以是本地、全局或“全局 + 正则化本地”。

框架功能

• 多时间序列：使用（部分）共享参数拟合全局/本地模型。
• 不确定性：估计特定分位数的值 — 分位数回归。
• 模型组件正则化。
• 绘制预测组件、模型系数等。
• 时间序列交叉验证工具。
• 模型检查点与验证。

即将推出

• 滞后回归因子的交叉关系。
• 多序列的静态元数据回归。
• 趋势组件的逻辑增长。

历史变更请参考 发布页面。

引用

若 NeuralProphet 对你的研究有帮助，请在出版物中引用 NeuralProphet 论文：

@misc{triebe2021neuralprophet,
      title={NeuralProphet: Explainable Forecasting at Scale}, 
      author={Oskar Triebe and Hansika Hewamalage and Polina Pilyugina and Nikolay Laptev and Christoph Bergmeir and Ram Rajagopal},
      year={2021},
      eprint={2111.15397},
      archivePrefix={arXiv},
      primaryClass={cs.LG}
}

感谢所有贡献者：

关于

NeuralProphet 是一个开源社区项目，由像你这样优秀的人支持。如果你有兴趣加入项目，请随时联系我 (Oskar) —— 你可以在 NeuralProphet 论文 中找到我的邮箱。