HeteroFL 项目使用文档

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

HeteroFL-Computation-and-Communication-Efficient-Federated-Learning-for-Heterogeneous-Clients/
├── config/
│   └── config.yml
├── data/
│   └── ...
├── models/
│   └── ...
├── utils/
│   └── ...
├── train_classifier_fed.py
├── requirements.txt
└── README.md

• config/: 包含项目的配置文件 config.yml。
• data/: 用于存放数据集的目录。
• models/: 包含模型定义的文件。
• utils/: 包含辅助函数和工具类。
• train_classifier_fed.py: 项目的启动文件，用于训练分类器。
• requirements.txt: 列出了项目依赖的Python包。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

train_classifier_fed.py

train_classifier_fed.py 是项目的启动文件，用于训练分类器。以下是该文件的主要功能和使用方法：

• 数据加载: 支持加载不同的数据集，如 MNIST 和 CIFAR-10。
• 模型选择: 可以选择不同的模型进行训练，如 CNN 和 ResNet。
• 参数配置: 通过命令行参数配置训练参数，如数据集名称、模型名称、用户活跃率等。

示例命令：

python train_classifier_fed.py --data_name MNIST --model_name conv --control_name 1_100_0.1_iid_fix_a2-b8_bn_1_1

3. 项目的配置文件介绍

config.yml

config.yml 是项目的配置文件，包含了全局超参数的配置。以下是该文件的主要内容和配置项：

• 数据集配置: 配置数据集的路径和预处理方法。
• 模型配置: 配置模型的类型和参数。
• 训练配置: 配置训练的批次大小、学习率、迭代次数等。
• 聚合策略: 配置联邦学习中的聚合和分离策略。

示例配置：

dataset:
  name: MNIST
  path: data/MNIST

model:
  name: conv
  parameters:
    batch_size: 64
    learning_rate: 0.001

training:
  epochs: 100
  active_rate: 0.1

aggregation:
  strategy: fix
  split_mode: a-b
  split_ratio: 20%-80%

通过修改 config.yml 文件，可以灵活地调整项目的配置，以适应不同的训练需求。