Flower：一个友好的联邦人工智能 (Federated AI) 框架

网站 | 博客 | 文档 | 峰会 | Slack

Flower (flwr) 是一个用于构建联邦人工智能 (Federated AI) 系统的框架。 Flower 的设计基于以下几个指导原则：

• 可定制 (Customizable)：联邦学习 (Federated Learning) 系统在不同应用场景中差异巨大。Flower 允许根据每个具体用例的需求进行广泛的配置。

• 可扩展 (Extendable)：Flower 起源于牛津大学的一个研究项目，因此是专为 AI 研究而构建的。许多组件都可以扩展和覆盖，以构建新的最先进系统。

• 与框架无关 (Framework-agnostic)：不同的机器学习 (Machine Learning) 框架各有优势。Flower 可与任何机器学习框架配合使用，例如 PyTorch、TensorFlow、Hugging Face Transformers、PyTorch Lightning、scikit-learn、JAX、TFLite、MONAI、fastai、MLX、XGBoost、CatBoost、LeRobot 用于联邦机器人，Pandas 用于联邦分析，或者甚至原始的 NumPy 供喜欢手动计算梯度的用户使用。

• 易于理解 (Understandable)：Flower 的编写考虑了可维护性。鼓励社区阅读并为代码库做出贡献。

在 flower.ai 上结识 Flower 社区！

联邦学习 (Federated Learning) 教程

Flower 的目标是让每个人都能够轻松使用联邦学习 (Federated Learning)。本系列教程介绍了联邦学习 (Federated Learning) 的基础知识以及如何在 Flower 中实现它们。

0. 什么是联邦学习 (Federated Learning)?

1. 联邦学习 (Federated Learning) 入门

2. 在联邦学习 (Federated Learning) 中应用策略

3. 自定义 Flower 策略

4. 通信自定义消息

敬请期待，更多教程即将推出。主题包括 联邦学习 (Federated Learning) 中的隐私与安全，以及 扩展联邦学习 (Federated Learning)。

文档

Flower 文档:

• 安装
• 快速开始 (TensorFlow)
• 快速开始 (PyTorch)
• 快速开始 (Hugging Face)
• 快速开始 (PyTorch Lightning)
• 快速开始 (Pandas)
• 快速开始 (fastai)
• 快速开始 (JAX)
• 快速开始 (scikit-learn)
• 快速开始 (Android [TFLite])
• 快速开始 (iOS [CoreML])

Flower 基线 (Baselines)

Flower 基线是一个集合了社区贡献项目的合集，用于复现流行联邦学习 (Federated Learning) 出版物中进行的实验。研究人员可以基于 Flower 基线快速评估新想法。Flower 社区热爱贡献！通过将其作为基线 (Baseline) 进行贡献，让您的工作获得更高关注度，并使他人能够在此基础上构建！

• DASHA
• DepthFL
• FedBN
• FedMeta
• FedMLB
• FedPer
• FedProx
• FedNova
• HeteroFL
• FedAvgM
• FedRep
• FedStar
• FedWav2vec2
• FjORD
• MOON
• niid-Bench
• TAMUNA
• FedVSSL
• FedXGBoost
• FedPara
• FedAvg
• FedOpt

请参考 Flower 基线文档 以获取基线的详细分类以及包括以下内容的附加信息：

• 如何使用 Flower 基线
• 如何贡献新的 Flower 基线

Flower 使用示例

多个代码示例展示了 Flower 的不同使用场景（结合流行的机器学习框架，如 PyTorch 或 TensorFlow）。

快速入门示例：

• 快速入门 (TensorFlow)
• 快速入门 (PyTorch)
• 快速入门 (Hugging Face)
• 快速入门 (PyTorch Lightning)
• 快速入门 (fastai)
• 快速入门 (Pandas)
• 快速入门 (JAX)
• 快速入门 (MONAI)
• 快速入门 (scikit-learn)
• 快速入门 (Android [TFLite])
• 快速入门 (iOS [CoreML])
• 快速入门 (MLX)
• 快速入门 (XGBoost)
• 快速入门 (CatBoost)

其他 示例：

• 树莓派与 Nvidia Jetson 教程
• PyTorch：从集中式到联邦式
• 垂直联邦学习 (Vertical FL)
• OpenAI 的 Whisper 的联邦微调
• 大型语言模型的联邦微调
• 视觉 Transformer 的联邦微调
• 高级 PyTorch Flower
• 全面的 Flower+XGBoost
• 使用 lifelines 库中的 KaplanMeierFitter 的 Flower
• 使用 Opacus 的样本级隐私保护
• 带有表格数据集的 Flower

社区

Flower 由一群出色的研究人员和工程师构建。加入 Slack 来认识他们，贡献 是受欢迎的。

引用

如果您发表了使用 Flower 的工作，请按以下方式引用 Flower：

@article{beutel2020flower,
  title={Flower: A Friendly Federated Learning Research Framework},
  author={Beutel, Daniel J and Topal, Taner and Mathur, Akhil and Qiu, Xinchi and Fernandez-Marques, Javier and Gao, Yan and Sani, Lorenzo and Kwing, Hei Li and Parcollet, Titouan and Gusmão, Pedro PB de and Lane, Nicholas D},
  journal={arXiv preprint arXiv:2007.14390},
  year={2020}
}

也请考虑将您的出版物添加到文档中的基于 Flower 的出版物列表中，只需打开一个 Pull Request (拉取请求)。

为 Flower 做贡献

我们欢迎贡献。请参阅 CONTRIBUTING.md 开始！

Flower 快速上手指南

Flower (flwr) 是一个友好的联邦 AI 框架，旨在让每个人都能轻松构建联邦学习系统。它支持多种主流机器学习框架（如 PyTorch、TensorFlow、Hugging Face 等），具有高度的可定制性和可扩展性。

环境准备

• 操作系统: Linux, macOS, Windows
• Python: 推荐版本 3.8 及以上
• 依赖管理: pip

安装步骤

1. 基础安装

使用 pip 安装 Flower 核心包。

pip install flwr

💡 国内开发者提示：为了加快下载速度，建议使用国内 PyPI 镜像源（如清华大学镜像）：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple flwr

2. 安装特定框架支持

根据您使用的机器学习框架，建议安装对应的扩展包以获得最佳体验：

# PyTorch 支持
pip install flwr[pytorch]

# TensorFlow 支持
pip install flwr[tensorflow]

# 安装所有常用框架支持
pip install flwr[all]

详细安装要求请参考官方文档：Installation

基本使用

Flower 的核心架构包含 客户端 (Client) 和 服务器 (Server)。以下是一个基于 PyTorch 的最小化使用示例流程。

1. 定义客户端逻辑

在客户端编写模型训练逻辑，并将其封装为 Flower 的 Client。

import flwr as fl
import torch

def train_fn(context):
    # 加载本地数据并训练模型
    # ...
    return model_parameters

client = fl.client.NumPyClient(
    get_parameters=train_fn,
    fit=train_fn,
    evaluate=train_fn
)

2. 配置服务器策略

选择或自定义聚合策略（例如 FedAvg）。

from flwr.server.strategy import FedAvg

strategy = FedAvg(
    fraction_fit=1.0,
    fraction_evaluate=1.0
)

3. 启动服务器

运行服务器以协调多个客户端的训练过程。

python server.py

📝 完整示例：上述仅为概念演示，完整的可运行代码请查看官方教程：

• Quickstart (PyTorch)
• Quickstart (TensorFlow)

更多资源

• 官方文档: Flower Docs
• 联邦学习教程系列: Tutorial Series
• 社区交流: Join Slack
• GitHub 仓库: flwrlabs/flower