FactorizedHierarchicalVAE 项目使用教程

FactorizedHierarchicalVAE 项目使用教程

1. 项目目录结构及介绍

FactorizedHierarchicalVAE/
├── data/
│   ├── README.md
│   └── ...
├── models/
│   ├── __init__.py
│   ├── fhvae.py
│   └── ...
├── scripts/
│   ├── train.py
│   ├── evaluate.py
│   └── ...
├── config/
│   ├── default.yaml
│   └── ...
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• data/: 存放项目所需的数据文件。
• models/: 包含项目的核心模型代码，如 fhvae.py。
• scripts/: 包含项目的脚本文件，如训练脚本 train.py 和评估脚本 evaluate.py。
• config/: 存放项目的配置文件，如 default.yaml。
• README.md: 项目的基本介绍和使用说明。
• requirements.txt: 列出项目所需的依赖包。
• setup.py: 用于安装项目的脚本。

2. 项目的启动文件介绍

scripts/train.py

train.py 是项目的启动文件，用于训练模型。可以通过以下命令启动训练：

python scripts/train.py --config config/default.yaml

主要参数

• --config: 指定配置文件路径，默认为 config/default.yaml。
• --data_dir: 指定数据文件夹路径。
• --output_dir: 指定输出文件夹路径，用于保存训练结果。

3. 项目的配置文件介绍

config/default.yaml

default.yaml 是项目的默认配置文件，包含模型的各种参数设置。以下是配置文件的部分内容示例：

model:
  name: "FHVAE"
  latent_dim: 128
  hidden_dim: 256

training:
  batch_size: 64
  epochs: 100
  learning_rate: 0.001

data:
  train_path: "data/train.csv"
  test_path: "data/test.csv"

配置文件参数介绍

• model: 模型相关的配置参数，如 latent_dim（潜在空间的维度）和 hidden_dim（隐藏层的维度）。
• training: 训练相关的配置参数，如 batch_size（批量大小）、epochs（训练轮数）和 learning_rate（学习率）。
• data: 数据相关的配置参数，如 train_path（训练数据路径）和 test_path（测试数据路径）。

通过修改配置文件中的参数，可以调整模型的训练行为和数据处理方式。