项目安装步骤 - Docker

由于在不同操作系统（例如 CentOS 与 macOS）之间出现了一些库的不兼容问题，我们决定构建一个 Docker 镜像，并在整个容器中运行该项目。Dockerfile 中包含了所有必要的步骤。

系统先决条件：

1. Python
2. Docker

要通过 Docker 编译并运行该项目，请导航到项目的父目录，然后执行以下操作：

1. 运行 chmod +x ./configure.sh && ./configure.sh 来配置 MetisFL 项目。

   注意：我们在构建 Docker 镜像之前运行上述命令，是为了正确配置项目的所有依赖项。

2. 构建整个项目的 Docker 镜像。

   • Ubuntu 镜像（稳定，推荐使用）：docker build -t projectmetis_ubuntu_22_04 -f DockerfileUbuntu .
   • Ubuntu 开发镜像（用于开发目的）：docker build -t projectmetis_dev -f DockerfileDev .
   • RockyLinux 镜像（不稳定）：docker build -t projectmetis_rockylinux_8 -f DockerfileRockyLinux . 以上任一镜像的大致大小（使用 Docker）：不含 CUDA 约 9GB，含 CUDA 约 12GB。

3. 构建 Docker CUDA 镜像（仅适用于 Ubuntu 和 RockyLinux 镜像）。

   • Ubuntu + CUDA：cd docker_images/cuda/ubuntu/11.7 && docker build -t projectmetis_ubuntu_22_04_cuda -f Dockerfile .
   • RockyLinux + CUDA：cd docker_images/cuda/rockylinux/11.3 && docker build -t projectmetis_rockylinux_8_cuda -f Dockerfile .
   • 验证 Docker CUDA 驱动是否已正确安装：nvidia-docker run --rm --gpus all projectmetis_ubuntu_22_04_cuda nvidia-smi

独立（无 Docker）先决条件

• 安装 googletest（macOS 上使用 brew install googletest）
• 安装 protobuf（macOS 上使用 brew install protobuf）
• 运行 ./configure 脚本

Bazel CLion 相关说明

如果项目文件无法被识别，则需要同步 Bazel。操作步骤如下：

1. 选择上方的 Bazel 选项卡
2. 选择 Sync 子选项卡
3. 然后点击“Sync Project with BUILD Files”

Trello UI

https://trello.com/b/bYLUYqGK/metis-v01

MetisFL 快速上手指南

MetisFL 是一个开源的联邦学习框架，采用 C++ 和 Python3 实现，旨在提供可扩展、高效且安全的联邦学习工作流。由于跨操作系统（如 CentOS 与 MacOS）的库兼容性问题，官方强烈推荐使用 Docker 方式进行部署。

环境准备

系统要求

• 操作系统：Linux (推荐 Ubuntu 22.04) 或 MacOS
• 前置软件：
  • Python (3.8 | 3.9 | 3.10)
  • Docker
  • Git

依赖说明

若选择非 Docker 的独立安装模式（不推荐新手），需手动安装以下依赖：

• googletest (MacOS: brew install googletest)
• protobuf (MacOS: brew install protobuf)

注意：国内开发者若遇到 Docker 拉取慢的问题，建议配置阿里云或腾讯云的 Docker 镜像加速器。

安装步骤 (推荐 Docker 方式)

请进入项目根目录，按顺序执行以下命令：

1. 配置项目依赖

在构建镜像前，必须先运行配置脚本来初始化项目依赖：

chmod +x ./configure.sh && ./configure.sh

2. 构建 Docker 镜像

根据需求选择以下一种镜像进行构建（构建过程较大，约 9GB-12GB）：

• Ubuntu 稳定版（推荐）：

  docker build -t projectmetis_ubuntu_22_04 -f DockerfileUbuntu .
  

• Ubuntu 开发版：

  docker build -t projectmetis_dev -f DockerfileDev .
  

• RockyLinux 版（非稳定）：

  docker build -t projectmetis_rockylinux_8 -f DockerfileRockyLinux .
  

3. (可选) 构建支持 CUDA 的镜像

如需使用 GPU 加速，仅适用于 Ubuntu 和 RockyLinux 环境：

• Ubuntu + CUDA:

  cd docker_images/cuda/ubuntu/11.7 && docker build -t projectmetis_ubuntu_22_04_cuda -f Dockerfile .
  

• 验证 CUDA 驱动：

  nvidia-docker run --rm --gpus all projectmetis_ubuntu_22_04_cuda nvidia-smi
  

基本使用

启动容器

构建完成后，运行容器进入开发环境：

docker run -it projectmetis_ubuntu_22_04 bash

运行示例

在容器内，您可以直接调用 Python 接口启动联邦学习任务。以下是一个最简化的概念示例（具体任务脚本请参考项目 examples 目录）：

from metisfl import Controller, Learner

# 初始化控制器
controller = Controller()

# 配置联邦学习参数并启动
# 此处仅为伪代码示意，具体参数需根据实际任务调整
controller.run(
    num_clients=5,
    rounds=10,
    model="simple_cnn"
)

IDE 配置提示 (CLion/Bazel)

如果您使用 CLion 进行开发且发现项目文件无法识别，请同步 Bazel 配置：

1. 点击上方的 Bazel 标签页。
2. 选择 Sync 子标签。
3. 点击 Sync Project with BUILD Files。