OpenSTL 开源项目使用教程

1. 项目介绍

OpenSTL 是一个由 CAIRI AI Lab 研究人员创建的开源项目，专注于时空预测学习（Spatio-Temporal Predictive Learning）。该项目提供了一个全面的基准，涵盖了从合成移动物体轨迹到现实世界场景（如人类运动、驾驶场景、交通流量和天气预报）的广泛方法和多样任务。OpenSTL 提供了一个模块化和可扩展的框架，具有用户友好性、组织性和全面性。

2. 项目快速启动

2.1 环境设置

首先，克隆 OpenSTL 项目到本地：

git clone https://github.com/chengtan9907/OpenSTL.git
cd OpenSTL

2.2 创建并激活虚拟环境

使用 conda 创建并激活虚拟环境：

conda env create -f environment.yml
conda activate OpenSTL

2.3 安装项目依赖

安装项目依赖：

python setup.py develop

2.4 运行示例

以下是一个在 Moving MNIST 数据集上使用 SimVP+gSTA 模型进行单 GPU 非分布式训练的示例：

bash tools/prepare_data/download_mmnist.sh
python tools/train.py -d mmnist --lr 1e-3 -c configs/mmnist/simvp/SimVP_gSTA.py --ex_name mmnist_simvp_gsta

3. 应用案例和最佳实践

3.1 自定义数据训练

OpenSTL 提供了如何在自定义数据上进行训练、评估和可视化的教程。用户可以参考 examples/ 目录下的 tutorial.ipynb 文件，快速构建自己的项目。

3.2 模型库和数据集

OpenSTL 支持多种时空预测方法，并提供了多个数据集的基准测试。用户可以在模型库中找到各种方法的实现，并在支持的数据集上进行实验。

4. 典型生态项目

4.1 PyTorch Lightning

OpenSTL 推荐使用 PyTorch Lightning 实现，即 OpenSTL-Lightning。PyTorch Lightning 是一个轻量级的 PyTorch 封装，简化了训练和验证流程。

4.2 Huggingface

OpenSTL 还与 Huggingface 集成，用户可以利用 Huggingface 的模型库和数据集进行更广泛的实验和应用。

通过以上步骤，用户可以快速上手 OpenSTL 项目，并开始进行时空预测学习的研究和应用。