N-BEATS 开源项目使用教程

1. 项目目录结构及介绍

N-BEATS 项目的目录结构如下：

n-beats/
├── common/
├── datasets/
├── experiments/
├── models/
├── notebooks/
├── summary/
├── test/
├── .gitignore
├── Dockerfile
├── LICENSE
├── Makefile
├── README.md
├── nbeats.png
└── requirements.txt

目录介绍

• common/: 包含项目中使用的通用工具和辅助函数。
• datasets/: 包含数据集加载器，用于加载实验中使用的各种数据集。
• experiments/: 包含实验代码，每个实验包包含训练和预测逻辑，以及配置文件。
• models/: 包含 N-BEATS 模型的 PyTorch 实现。
• notebooks/: 包含 Jupyter Notebook，用于分析实验结果。
• summary/: 包含实验结果的汇总和分析。
• test/: 包含测试代码，用于验证数据集和指标计算的正确性。
• .gitignore: Git 忽略文件配置。
• Dockerfile: Docker 配置文件，用于构建项目环境。
• LICENSE: 项目许可证文件。
• Makefile: 项目构建和运行脚本。
• README.md: 项目介绍和使用说明。
• nbeats.png: 项目图标或示意图。
• requirements.txt: 项目依赖库列表。

2. 项目启动文件介绍

项目的启动文件主要位于 experiments/ 目录下。每个实验包包含一个 main.py 文件，该文件负责训练和预测逻辑。以下是一个典型的启动文件结构：

experiments/
└── m4/
    ├── main.py
    ├── config_generic.gin
    └── config_interpretable.gin

启动文件介绍

• main.py: 这是实验的主要启动文件，负责加载配置、初始化模型、训练模型和进行预测。
• config_generic.gin: 通用模型的配置文件，定义了模型的超参数和训练参数。
• config_interpretable.gin: 可解释模型的配置文件，定义了模型的超参数和训练参数。

3. 项目的配置文件介绍

配置文件主要用于定义模型的超参数和训练参数。以下是 config_generic.gin 文件的一个示例：

# 定义模型的超参数
model.hidden_layer_units = 128
model.num_blocks = 2
model.num_layers_per_block = 4

# 定义训练参数
train.batch_size = 32
train.learning_rate = 0.001
train.epochs = 50

配置文件介绍

• model.hidden_layer_units: 定义模型隐藏层的单元数。
• model.num_blocks: 定义模型的块数。
• model.num_layers_per_block: 定义每个块中的层数。
• train.batch_size: 定义训练时的批量大小。
• train.learning_rate: 定义学习率。
• train.epochs: 定义训练的轮数。

通过这些配置文件，用户可以灵活地调整模型的结构和训练参数，以适应不同的实验需求。