FL-bench：联邦学习基准测试框架使用指南

一、项目目录结构及介绍

FL-bench项目基于Git托管在GitHub上，其主要结构设计以支持高效和灵活的联邦学习研究和实验。以下是项目的基本目录结构概述：

FL-bench/
│
├── env               # 环境配置相关，包括依赖库安装脚本
│
├── src               # 核心源代码，分为server和client子目录，以及utils辅助工具
│   ├── server         # 服务器端联邦学习算法实现
│   │   ├── fedavg.py   # 示例：FedAvg算法实现
│   │   ├── fedprox.py  # 示例：FedProx算法实现
│   ├── client         # 客户端逻辑实现
│   ├── utils          # 工具函数，包括模型、常量、数据处理等
│
├── data              # 数据集相关文件，含数据预处理和分割脚本
│   └── utils          # 数据处理工具模块
│
├── tests             # 测试案例，用于验证代码正确性
│
├── CITATION.cff      # 引用该框架的标准方式
├── LICENSE           # 开源许可证文件
├── README.md         # 项目简介和快速入门指南
│
├── generate_data.py  # 脚本用于生成或准备联邦学习的数据划分
│
└── main.py            # 主运行文件，执行实验的核心入口

二、项目的启动文件介绍

main.py

这是项目的主要执行脚本，通过此文件，你可以配置并启动联邦学习实验。使用时，需要指定想要运行的联邦学习算法名、配置文件路径以及其他可能的命令行参数。例如，运行基础的FedAvg算法，可以通过以下命令：

python main.py method=fedavg

该脚本提供了灵活性，允许用户通过命令行参数或者配置文件定制实验设置，如数据集选择、模型架构、训练轮数等。

三、项目的配置文件介绍

配置文件通常位于config目录下，它们提供了高度可配置的环境，使用户能够细化他们的实验设置。主要有两个层次的配置：

1. 默认配置 (defaults.yaml)：包含了大多数联邦学习实验的基础配置。

2. 特定配置文件：用户可以创建自定义的.yaml文件来覆盖默认设置，比如my_cfg.yaml，允许更细致的实验定制。

配置文件中的关键设置项包括但不限于：

• dataset: 指定使用的数据集名称。
• model: 选用的模型架构。
• optimizer, lr_scheduler: 客户端的优化器和学习率调度器设定。
• common: 包含通用实验设置，如批处理大小、通信轮次等。
• parallel: 当启用并行计算时的相关设置，比如工作进程数量(num_workers)。

例如，若要自定义FedProx的超参数，可以在相应的配置文件中这样添加：

fedprox:
    mu: 0.01

在使用配置文件时，可以通过命令行通过--config-name参数指定特定的配置文件：

python main.py --config-name my_cfg.yaml method=fedprox

确保在进行实验之前，理解这些配置文件的结构和所控制的实验参数，以便有效地利用FL-bench的强大功能。