OpenSTL 项目使用教程

1. 项目的目录结构及介绍

OpenSTL 项目的目录结构如下：

OpenSTL/
├── configs/
├── docs/
├── examples/
├── openstl/
│   ├── api/
│   ├── core/
│   ├── datasets/
│   ├── methods/
│   ├── models/
│   ├── modules/
├── requirements/
├── tests/
├── tools/
├── .coveragerc
├── .gitignore
├── readthedocs.yml
├── style.yapf
├── LICENSE
├── README.md
├── environment.yml
├── requirements.txt
├── setup.py

目录介绍：

• configs/: 包含项目的配置文件，用于定义不同任务和模型的配置。
• docs/: 包含项目的文档文件，包括用户指南、API 文档等。
• examples/: 包含示例代码和教程，帮助用户快速上手。
• openstl/: 核心代码库，包含 API、核心训练插件、数据集、训练方法、模型架构和网络模块等。
  • api/: 包含实验运行器。
  • core/: 包含核心训练插件和评估指标。
  • datasets/: 包含数据集和数据加载器。
  • methods/: 包含各种视频预测方法的训练方法。
  • models/: 包含各种视频预测方法的主要网络架构。
  • modules/: 包含网络模块和层。
• requirements/: 包含项目的依赖文件。
• tests/: 包含测试代码。
• tools/: 包含可执行的 Python 文件，如训练、验证和测试的工具。
• .coveragerc: 代码覆盖率配置文件。
• .gitignore: Git 忽略文件配置。
• readthedocs.yml: ReadTheDocs 配置文件。
• style.yapf: 代码风格配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• environment.yml: Conda 环境配置文件。
• requirements.txt: Python 依赖文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

OpenSTL 项目的启动文件主要位于 tools/ 目录下，常用的启动文件包括：

• tools/train.py: 用于训练模型的启动文件。用户可以通过命令行参数指定数据集、学习率、配置文件等。
• tools/test.py: 用于测试模型的启动文件。用户可以通过命令行参数指定模型路径、数据集等。

使用示例：

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

3. 项目的配置文件介绍

OpenSTL 项目的配置文件主要位于 configs/ 目录下，每个配置文件对应一个特定的任务或模型。配置文件通常包含以下内容：

• 数据集配置: 定义数据集的路径、预处理方式等。
• 模型配置: 定义模型的架构、超参数等。
• 训练配置: 定义训练的超参数，如学习率、批量大小、优化器等。

配置文件示例：

# configs/mmnist/simvp/SimVP_gSTA.py

dataset = dict(
    name='mmnist',
    path='data/mmnist',
    preprocess=['normalize', 'resize'],
    batch_size=32,
    shuffle=True
)

model = dict(
    name='SimVP',
    architecture='gSTA',
    input_shape=(64, 64, 1),
    output_shape=(64, 64, 1)
)

train = dict(
    lr=1e-3,
    epochs=100,
    optimizer='adam',
    loss='mse'
)

通过配置文件，用户可以灵活地调整模型的训练和测试参数，以适应不同的任务需求。