IBM 联邦学习

是什么？

IBM 联邦学习是一个用于企业环境中联邦学习（FL）的 Python 框架。联邦学习是一种分布式机器学习过程，其中每个参与节点（或参与方）在其本地保留数据，并通过学习协议与其他参与方进行交互。联邦学习的主要驱动力是隐私和机密性问题、监管合规要求，以及将数据集中到一个中心位置进行学习的实际可行性。

IBM 联邦学习提供了一个联邦学习的基础框架，可以在其上添加高级功能。它不依赖于任何特定的机器学习框架，支持不同的学习拓扑结构，例如共享聚合器，以及多种协议。它既支持深度神经网络（DNN），也支持线性回归和 k-means 等经典机器学习技术。这涵盖了监督学习、无监督学习以及强化学习等多种方法。下图展示了由 IBM 联邦学习支持的基于聚合器的典型联邦学习配置。

一组参与方各自拥有数据，并在本地训练模型。这些参与方使用联邦学习协议与聚合器交换更新信息。聚合器会融合（聚合）来自不同参与方的结果，并将整合后的结果返回给各参与方。这一过程可以反复进行，直到满足终止条件为止。IBM 联邦学习支持对这些训练场景的配置。

IBM 联邦学习的关键设计点在于：易于机器学习专业人员使用、可配置于不同的计算环境——从数据中心到边缘设备——以及高度可扩展性。它可以扩展以兼容不同的机器学习（ML）库、学习协议和融合算法。这为运行联邦学习项目和开展联邦学习研究提供了基础框架。

IBM 联邦学习自带一个庞大的融合算法库，涵盖深度神经网络和经典机器学习方法，其中包括常见的已发表融合算法以及我们自主研发的新算法。

支持的功能

IBM 联邦学习支持以下机器学习模型类型：

• 神经网络（Keras、PyTorch 和 Tensorflow 支持的任意神经网络拓扑）
• ID3 决策树
• 带正则化的线性分类器/回归模型：逻辑回归、线性 SVM、岭回归、Kmeans 和朴素贝叶斯
• 深度强化学习算法，包括 DQN、DDPG、PPO 等

IBM 联邦学习支持多种最先进的融合算法，用于结合来自多个参与方的模型更新。调整这些算法可以加快收敛速度、缩短训练时间或提高模型的鲁棒性。 对于特定的机器学习模型，您可以选择多种融合算法：

支持的机器学习模型	支持的融合算法
神经网络	迭代平均
	FedAvg McMahan 等人
	梯度平均
	PFNM Yurochkin 等人
	Krum Blanchard 等人
	坐标中位数 Yin 等人
	Zeno Xie 等人
	SPAHM Yurochkin 等人
	Fed+ Yu 等人
	FedProx: Tian Li 等人
	洗牌迭代平均 Cheng 等人
	比较消除 Gupta 等人
	自适应联邦平均 Muñoz-González 等人
ID3 决策树	ID3 融合 Quinlan
强化学习 RLLib 模型	迭代平均
	FedAvg McMahan 等人
带 SGD 的线性分类器	迭代平均
K-means	SPAHM Yurochkin 等人
朴素贝叶斯	结合差分隐私的朴素贝叶斯融合

我们还支持以下公平性技术，这些技术有助于缓解联邦学习中的偏见，并且可以与多种机器学习模型结合使用：

公平性技术	算法类型	支持的机器学习模型
本地重加权 Abay 等人	预处理	所有机器学习模型
全局重加权结合差分隐私 Abay 等人	预处理	所有机器学习模型
联邦偏见消除 Abay 等人	处理中	逻辑回归

为了帮助用户使用 IBMFL 库编排联邦学习实验，我们还提供了一个基于 Jupyter Notebook 的 UI 界面，即 实验管理仪表板，用户可以在其中选择模型、融合算法、参与方数量以及其他（超）参数来运行实验。这种编排可以在运行笔记本的机器上完成，即本地或跨远程机器。关于如何使用该仪表板的使用指南可以在此处找到 这里。

IBMFL 多云和混合云编排器能够自动化部署和监控使用联邦学习库 Docker 镜像的聚合器和参与方进程，这些进程运行在不同云数据中心区域上搭建的 OpenShift 集群中。有关如何使用 OpenShift 编排器的更多信息，请参阅 README。

如何开始？

克隆仓库。主框架运行时被打包在一个 whl 文件中。

尝试 单节点联邦学习设置指南。

尝试 加密设置指南，以使用全同态加密（HE）运行联邦学习。

有许多带有说明的 示例，涵盖了不同类型的联邦学习任务和不同的模型类型，可供入门参考。

通过 预配置示例在流行的数据集上玩转 IBM FL，例如 MNIST、CIFAR10、FEMNIST 和 Adult 等。

在这里尝试我们的实验管理器 这里。

在这里尝试 IBM FL 与 OpenShift 的结合 这里。

它是如何工作的？

我们提供了一个 docs 文件夹，其中包含教程和 API 文档，帮助您学习如何使用和扩展 IBM 联邦学习。此外，我们还准备了几段 视频教程。

• 官方网站
• 聚合器与参与方配置教程
• API 文档
• 相关论文
• 白皮书

如何联系我们？

我们非常欢迎反馈和问题。如果您遇到任何问题，请提交 Issue。

我们已建立了一个 Slack 频道，用于持续交流。请加入 IBM 联邦学习工作区：https://ibm-fl.slack.com/。如果该链接无法访问，您也可以使用此邀请链接：https://join.slack.com/t/ibm-fl/shared_invite/zt-ff0k1xgh-IL9Aq6sW6rNny9gDdnEttQ。

引用 IBM 联邦学习

如果您使用了 IBM 联邦学习，请引用以下参考文献：

@article{ibmfl2020ibm,
  title={IBM Federated Learning: an Enterprise Framework White Paper V0. 1},
  author={Ludwig, Heiko and Baracaldo, Nathalie and Thomas, Gegi and Zhou, Yi and Anwar, Ali and Rajamoni, Shashank and Ong, Yuya and Radhakrishnan, Jayaram and Verma, Ashish and Sinn, Mathieu and others},
  journal={arXiv preprint arXiv:2007.10987},
  year={2020}
}

持续改进中

本项目仍在持续开发中。随着新功能的不断添加，我们将定期更新此仓库。

许可协议

本仓库中分发的 IBM 联邦学习仅供非商业性和实验性用途，遵循此 许可协议。如需商业用途，IBM 联邦学习可在 IBM CloudPak for Data 中获得，也可作为一项 服务 使用。

IBM Federated Learning (IBMFL) 快速上手指南

IBM Federated Learning 是一个专为企业环境设计的 Python 联邦学习框架。它支持分布式机器学习，允许参与节点在本地保留数据，仅通过协议交换模型更新，从而满足隐私保护和合规性要求。该框架不依赖特定的机器学习后端，支持 Keras、PyTorch、TensorFlow 等主流库，涵盖深度学习、经典机器学习（如线性回归、K-means）及强化学习等多种场景。

1. 环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux (推荐 Ubuntu/CentOS)、macOS 或 Windows (需配置 WSL)。
• Python 版本：Python 3.7 或更高版本（推荐 3.8+）。
• 前置依赖：
  • pip (Python 包管理工具)
  • git (用于克隆代码库)
  • 根据您选择的模型后端，可能需要安装 tensorflow, pytorch, 或 scikit-learn。

注意：国内开发者若遇到网络延迟，建议在安装 Python 依赖时使用清华或阿里镜像源（见安装步骤）。

2. 安装步骤

第一步：克隆仓库

首先从 GitHub 克隆项目代码：

git clone https://github.com/IBM/federated-learning-lib.git
cd federated-learning-lib

第二步：安装核心库

框架的核心运行时打包在 .whl 文件中。进入目录并安装：

pip install federated-learning-lib/dist/*.whl

国内加速建议：如果默认源下载缓慢，请使用以下命令指定清华镜像源安装：

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple federated-learning-lib/dist/*.whl

第三步：安装额外依赖（可选）

根据您的具体任务（如使用 PyTorch 或 TensorFlow），可能需要安装额外的深度学习库。框架本身是通用的，但运行示例通常需要这些后端：

# 示例：安装常见的深度学习依赖
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple tensorflow torch torchvision scikit-learn

3. 基本使用

IBMFL 提供了丰富的示例和可视化管理工具。以下是两种最快捷的启动方式。

方式一：运行预配置示例 (命令行)

框架内置了基于 MNIST、CIFAR10 等数据集的示例。以简单的迭代平均（Iterative Average）为例：

1. 进入示例目录：

   cd examples/iter_avg
   

2. 查看该目录下的 README.md 或脚本，通常可以通过运行启动脚本来模拟聚合器（Aggregator）和参与方（Party）：

   # 启动聚合器 (在一个终端窗口)
   python run_aggregator.py
   
   # 启动参与方 (在另一个终端窗口)
   python run_party.py
   

   (注：具体脚本文件名请参考 examples/iter_avg 目录下的实际文件)

方式二：使用实验管理仪表盘 (Jupyter Notebook)

IBMFL 提供了一个基于 Jupyter Notebook 的图形化界面，用于编排实验、选择模型、融合算法及设置超参数。

1. 启动 Jupyter Notebook：

   jupyter notebook experiment_manager/Experiment_Manager_dashboard.ipynb
   

2. 在浏览器打开的界面中：
   • 选择机器学习模型类型（如 Neural Networks, Linear Regression）。
   • 选择融合算法（如 FedAvg, Krum, SPAHM）。
   • 设置参与方数量和其他超参数。
   • 点击运行即可在本地或远程机器上 orchestrate（编排）联邦学习实验。

进阶：加密与云部署

• 同态加密：如需启用完全同态加密（HE），请参考 setup-crypto.md 指南进行配置。
• OpenShift 部署：若需在多云或混合云环境自动化部署，可参考 openshift_fl/README.md 使用 Docker 镜像在 OpenShift 集群上运行。

---

更多详细教程、API 文档及视频指南，请访问官方文档目录 docs/ 或访问 IBMFL 官网。