TimeVQVAE项目使用教程

1. 项目目录结构及介绍

TimeVQVAE项目是一个基于PyTorch的时间序列生成模型，其目录结构如下：

• datasets/: 存储数据集的目录，包括原始的UCR数据集和重新组织后的版本。
• encoder_decoders/: 包含编码器和解码器模块的代码。
• evaluation/: 评估模型的脚本和指标计算。
• experiments/: 运行实验的配置文件和脚本。
• generators/: 包含生成器模块的代码。
• preprocessing/: 数据预处理脚本，包括数据集下载和重新组织。
• results/: 存储实验结果的目录。
• utils/: 通用工具和辅助函数。
• vector_quantization/: 包含向量量化模块的代码。
• .gitignore: 用于Git的忽略文件列表。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• custom_dataset_sampling.ipynb: 用于自定义数据集采样的Jupyter笔记本。
• evaluate.py: 评估模型性能的脚本。
• requirements.txt: 项目依赖的Python包列表。
• run_CAS.py: 运行分类准确度评分（CAS）的脚本。
• simple_sampling.ipynb: 简单采样的Jupyter笔记本。
• stage1.py: 第一阶段的训练脚本。
• stage2.py: 第二阶段的训练脚本。
• stage_neural_mapper.py: 与神经映射器相关的训练脚本。

2. 项目的启动文件介绍

启动文件主要有两个，分别是stage1.py和stage2.py：

• stage1.py: 该脚本负责模型的第一个训练阶段，即数据压缩到离散潜在空间的向量量化阶段。运行此脚本前，需要确保已配置好数据集路径，并安装了所有必要的依赖。
• stage2.py: 该脚本负责模型的第二个训练阶段，即使用双向变换器学习先验模型的阶段。运行此脚本前，同样需要确保数据集路径配置正确，且所有依赖已安装。

这两个脚本的运行都需要指定数据集名称和GPU设备索引。

3. 项目的配置文件介绍

项目的配置文件主要包括：

• config/config.yaml: 包含数据集、数据加载、优化器和模型配置（编码器、解码器、向量量化和MaskGIT）的配置文件。
• config/sconfig_cas.yaml: 用于运行分类准确度评分（CAS）的配置文件。

这些配置文件可以使用标准的Python yaml库进行读取和修改，以便于根据实际需求调整模型参数和训练设置。在运行训练或评估脚本前，应确保配置文件中的参数设置正确。