开源项目 TGN 使用教程

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

tgn/
├── configs/
│   ├── config.yaml
│   └── ...
├── data/
│   ├── preprocess.py
│   └── ...
├── models/
│   ├── tgn.py
│   └── ...
├── notebooks/
│   └── ...
├── scripts/
│   ├── train.py
│   └── ...
├── tests/
│   └── ...
├── utils/
│   └── ...
├── README.md
└── setup.py

• configs/: 包含项目的配置文件，如 config.yaml。
• data/: 包含数据预处理脚本和其他数据相关文件。
• models/: 包含模型的实现，如 tgn.py。
• notebooks/: 包含 Jupyter 笔记本，用于交互式分析和实验。
• scripts/: 包含训练和评估模型的脚本，如 train.py。
• tests/: 包含测试脚本，用于确保代码的正确性。
• utils/: 包含各种实用工具和辅助函数。
• README.md: 项目说明文档。
• setup.py: 用于安装项目的脚本。

2. 项目的启动文件介绍

项目的启动文件主要位于 scripts/ 目录下，其中 train.py 是主要的启动文件。该文件负责加载配置、初始化模型、加载数据并进行训练。

# scripts/train.py

import argparse
from models.tgn import TGN
from utils.config import load_config
from data.preprocess import load_data

def main(config_path):
    config = load_config(config_path)
    model = TGN(config)
    data = load_data(config)
    model.train(data)

if __name__ == "__main__":
    parser = argparse.ArgumentParser()
    parser.add_argument("--config", type=str, required=True, help="Path to config file")
    args = parser.parse_args()
    main(args.config)

3. 项目的配置文件介绍

配置文件位于 configs/ 目录下，主要文件是 config.yaml。该文件包含了模型训练所需的各种参数，如数据路径、模型参数、训练参数等。

# configs/config.yaml

data:
  path: "data/processed/"
  batch_size: 32

model:
  embedding_dim: 128
  num_layers: 2

train:
  epochs: 10
  learning_rate: 0.001

• data: 数据相关配置，如数据路径和批次大小。
• model: 模型相关配置，如嵌入维度、层数等。
• train: 训练相关配置，如训练轮数和学习率。

通过修改 config.yaml 文件，可以灵活地调整模型和训练过程的参数。