TSFM：时间序列基础模型

用于处理时间序列基础模型（TSFM）的公开笔记本、实用工具和服务组件。

核心 TSFM 时间序列模型已在 Hugging Face 上发布——请在此处查看 Granite 时间序列模型合集 链接。更多详细信息请参阅我们的 维基。服务组件的相关信息请见 此处。

Python 版本

当前支持的 Python 版本为 3.10、3.11、3.12 和 3.13。

初始设置

首先克隆仓库：

git clone "https://github.com/ibm-granite/granite-tsfm.git" 
cd granite-tsfm

📕 笔记本安装

notebooks 文件夹中提供了多个笔记本，可用于对模型进行预训练和微调。使用 pip 进行安装：

pip install ".[notebooks]"

🔗 笔记本链接

• 使用 PatchTSMixer 入门 [试用]
• 使用 PatchTSMixer 迁移学习 [试用]
• 使用 PatchTST 迁移学习 [试用]
• 使用 TinyTimeMixer (TTM) 入门 [试用]
• TTM 的完整基准测试脚本及结果可在此处获取 [链接]
• FlowState 示例笔记本可在此处获取 [链接]
• PatchTST-FM 示例笔记本可在此处获取 [链接]

📗 Google Colab 教程

在 Google Colab 中运行 TTM 教程，快速构建基于预训练 TSFM 模型的预测应用。

• TTM Colab 教程

💻 演示安装

在 NeurIPS 2023 上展示的演示可在 tsfmhfdemos 中找到。该演示需要您已准备好预训练和微调好的模型（我们计划稍后发布这些模型）。使用 pip 安装所需依赖：

pip install ".[demos]"

🪲 问题

如果您在此项目中遇到任何问题，欢迎提交 错误报告。在新建问题之前，请先搜索是否有类似的问题，可能已经有人报告过。

🌏 维基

维基页面

注意事项

本仓库旨在简化并演示已在 Hugging Face 转换器库 中发布的 Granite 时间序列组件的使用。随着我们持续开发这些功能，我们将不断更新此处的代码。

IBM 公开仓库声明：本仓库中的所有内容，包括代码，均由 IBM 根据相关开源软件许可证提供，IBM 不承担提供增强、更新或支持的义务。IBM 开发人员将此代码作为开源项目而非 IBM 产品进行开发，IBM 不对代码的质量或安全性作出任何保证，并且今后将不再维护此代码。

Granite-TSFM 快速上手指南

Granite-TSFM 是 IBM 开源的时间序列基础模型（TSFM）工具集，提供了用于预训练、微调和推理的 Notebook 示例及实用组件。核心模型已托管于 Hugging Face。

环境准备

• 操作系统：Linux / macOS / Windows
• Python 版本：支持 3.10, 3.11, 3.12, 3.13
• 前置依赖：
  • Git
  • pip
  • 建议配置国内镜像源以加速下载（如清华源）：

    pip config set global.index-url https://pypi.tuna.tsinghua.edu.cn/simple
    

安装步骤

1. 克隆仓库

   git clone "https://github.com/ibm-granite/granite-tsfm.git" 
   cd granite-tsfm
   

2. 安装 Notebook 依赖 若需运行预训练和微调示例，请执行：

   pip install ".[notebooks]"
   

3. 安装演示组件（可选） 若需运行 NeurIPS 2023 演示项目（需自备模型），请执行：

   pip install ".[demos]"
   

基本使用

本项目主要通过 Jupyter Notebook 提供开箱即用的示例。以下是快速体验流程：

1. 运行入门示例

启动 Jupyter 并打开 PatchTSMixer 入门教程：

jupyter notebook notebooks/hfdemo/patch_tsmixer_getting_started.ipynb

该示例将演示如何加载预训练模型并进行简单的时间序列预测。

2. 在线快速体验 (Google Colab)

无需本地环境，可直接在浏览器中运行 TinyTimeMixer (TTM) 教程：

• TTM Colab 教程链接

3. 更多模型示例

仓库 notebooks/hfdemo 目录下包含以下模型的完整示例：

• PatchTST 迁移学习
• TinyTimeMixer (TTM) 基准测试
• FlowState 示例
• PatchTST-FM 示例

提示：核心模型文件需从 Hugging Face granite time series collection 自动下载或手动获取。详细 API 用法请参考各 Notebook 内的代码注释。