SunCET 项目使用教程

1. 项目目录结构及介绍

Suncet 项目的目录结构如下：

suncet/
├── cifar10_subsets/
├── configs/
├── imagenet_subsets/
├── src/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── main.py
├── main_distributed.py
└── snn_eval.py

目录介绍

• cifar10_subsets/: 包含 CIFAR-10 数据集的子集文件。
• configs/: 包含实验配置文件，用于指定实验参数。
• imagenet_subsets/: 包含 ImageNet 数据集的子集文件。
• src/: 包含项目的源代码文件。
• .gitignore: Git 忽略文件列表。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明文件。
• main.py: 单 GPU 训练的启动文件。
• main_distributed.py: 多 GPU 分布式训练的启动文件。
• snn_eval.py: 模型评估文件。

2. 项目启动文件介绍

main.py

main.py 是 SunCET 项目的单 GPU 训练启动文件。它负责解析实验配置文件并运行指定的脚本（如 PAWS 预训练或微调）。

使用示例：

python main.py --sel paws_train --fname configs/paws/cifar10_train.yaml

main_distributed.py

main_distributed.py 是 SunCET 项目的多 GPU 分布式训练启动文件。它除了解析配置文件和启动脚本外，还允许指定分布式训练的详细信息。

使用示例：

python main_distributed.py --sel paws_train --fname configs/paws/imgnt_train.yaml --partition $slurm_partition --nodes 8 --tasks-per-node 8 --time 1000 --device volta16gb

3. 项目配置文件介绍

配置文件位于 configs/ 目录下，所有实验参数都在配置文件中指定，而不是通过命令行参数。配置文件使得跟踪不同实验和批量启动作业更加容易。

配置文件示例

# configs/paws/cifar10_train.yaml

# 实验参数
experiment:
  name: paws_train
  dataset: cifar10
  batch_size: 64
  epochs: 100
  learning_rate: 0.001
  # 其他参数...

配置文件结构

• experiment: 包含实验的基本参数，如实验名称、数据集、批量大小、训练轮数等。
• model: 包含模型的配置参数，如模型类型、层数等。
• data: 包含数据集的配置参数，如数据路径、预处理方法等。

通过配置文件，用户可以轻松地修改实验参数，而无需修改代码。