TensorFlow Federated

TensorFlow Federated (TFF) 是一个用于在去中心化数据上进行机器学习及其他计算的开源框架。TFF 的开发旨在促进对 联邦学习 (FL) 的开放研究与实验。联邦学习是一种机器学习方法，其中共享的全局模型由众多参与客户端协作训练，而这些客户端则将其训练数据保留在本地。例如，联邦学习已被用于训练 移动键盘预测模型，且无需将敏感的输入数据上传至服务器。

TFF 使开发者能够在其模型和数据上使用内置的联邦学习算法，同时也可以尝试新的算法。此外，TFF 提供的构建模块还可用于实现非学习类计算，例如对去中心化数据的聚合分析。

TFF 的接口分为两层：

• 联邦学习 (FL) API
  tff.learning 层提供了一组高级接口，允许开发者将内置的联邦训练和评估实现应用于其现有的 TensorFlow 模型。

• 联邦核心 (FC) API
  系统的核心是一组低级接口，可在强类型函数式编程环境中，通过结合 TensorFlow 和分布式通信算子，简洁地表达新颖的联邦算法。这一层也是我们构建 tff.learning 的基础。

TFF 允许开发者以声明式的方式表达联邦计算，从而使其能够部署到不同的运行时环境。TFF 自带单机模拟运行时，可用于实验。请参阅教程并亲自试用！

安装

有关如何将 TensorFlow Federated 作为软件包安装或从源代码构建的说明，请参阅 安装文档。

入门

有关如何使用 TensorFlow Federated 的说明，请参阅 入门文档。

贡献

根据您的兴趣，有多种方式可以参与贡献：

• 如果您对开发新的联邦学习算法感兴趣，最好的起点是研究 tff.learning 中联邦平均和评估的实现，并思考对现有实现的扩展（或替代方案）。如果您有新的算法提案，建议先将其项目暂存于 research 目录中，并附上 Colab 笔记本来展示新功能。

  您也可以在自己的仓库中开发新算法。我们很乐意在 tensorflow.org/federated 上推荐使用 TFF 的学术论文和/或代码库链接。

• 如果您对应用联邦学习感兴趣，可以考虑贡献教程、新的联邦数据集，或可供他人用于实验和测试的示例模型；或者编写帮助类，以便他人在搭建模拟环境时使用。

• 如果您希望帮助我们改善开发者体验，最好的开始方式是研究 tff.learning API 背后的实现，并思考如何使代码更加简洁高效。您可以贡献基于 FC API 的辅助类，或为 FC API 本身提出改进建议。

• 如果您希望帮助我们开发用于模拟及其他场景的运行时基础设施，请等待未来的版本发布，届时我们将推出用于贡献模拟基础设施的接口和指南。

请务必阅读 贡献指南，了解具体的贡献方式。

问题

请使用 GitHub Issues 来跟踪请求和 bug。

问答

如有疑问，请在 Stack Overflow 上使用 tensorflow-federated 标签提问。

TensorFlow Federated 快速上手指南

TensorFlow Federated (TFF) 是一个开源框架，旨在支持去中心化数据上的机器学习与其他计算。它专为联邦学习（Federated Learning, FL）的研究与实验而设计，允许在数据保留在本地客户端的情况下训练共享的全局模型。

环境准备

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

• 操作系统：Linux 或 macOS（Windows 用户建议使用 WSL2 或 Docker）。
• Python 版本：推荐 Python 3.8 - 3.10。
• 前置依赖：
  • 已安装 pip 包管理工具。
  • 建议先安装基础版 tensorflow（CPU 或 GPU 版本均可），TFF 会自动处理其余依赖。

国内加速建议： 在中国大陆地区，建议在安装命令中指定清华或阿里镜像源，以显著提升下载速度。 临时使用镜像源方法：在 pip 命令后添加 -i https://pypi.tuna.tsinghua.edu.cn/simple。

安装步骤

您可以选择通过 PyPI 直接安装稳定版，或从源码构建（适合需要最新特性的开发者）。

方式一：使用 pip 安装（推荐）

执行以下命令安装 TensorFlow Federated：

pip install tensorflow-federated

国内用户加速安装命令：

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

方式二：从源码构建

如果需要最新的开发版本，可以克隆仓库并安装：

git clone https://github.com/google-parfait/tensorflow-federated.git
cd tensorflow-federated
pip install .

基本使用

TFF 提供了两层接口：高层的 tff.learning（适用于快速应用联邦学习算法）和低层的 tff.federated.core（适用于自定义算法）。以下是一个使用 tff.learning 进行简单联邦平均（Federated Averaging）的最小化示例。

1. 导入库并准备数据

首先导入必要的模块，并加载一个简单的数据集（此处以 EMNIST 为例，TFF 内置了数据加载工具）。

import tensorflow as tf
import tensorflow_federated as tff

# 加载预处理的 EMNIST 数据集
emnist_train, emnist_test = tff.simulation.datasets.emnist.load_data()

# 定义数据预处理函数
def preprocess(dataset):
    return dataset.batch(20)

# 将数据转换为联邦格式
train_data = emnist_train.create_tf_dataset_for_client(emnist_train.client_ids[0])
train_data = preprocess(train_data)

2. 定义模型与联邦学习过程

使用 Keras 定义一个基础模型，并将其转换为 TFF 可用的联邦学习流程。

# 创建一个简单的 Keras 模型
def create_keras_model():
    return tf.keras.Sequential([
        tf.keras.layers.InputLayer(input_shape=(28, 28)),
        tf.keras.layers.Flatten(),
        tf.keras.layers.Dense(10, activation='softmax')
    ])

# 将 Keras 模型转换为 TFF 模型
model_spec = tff.learning.models.from_keras_model(
    create_keras_model(),
    input_spec=train_data.element_spec,
    loss=tf.keras.losses.SparseCategoricalCrossentropy(),
    metrics=[tf.keras.metrics.SparseCategoricalAccuracy()]
)

# 构建联邦平均算法
iterative_process = tff.learning.algorithms.build_weighted_fed_avg(model_spec)

# 初始化全局状态
state = iterative_process.initialize()

3. 执行联邦训练

模拟一轮联邦训练过程。在实际场景中，client_data 会来自多个不同的客户端。

# 模拟一轮训练 (Round)
# 在实际应用中，这里会选取多个客户端的数据进行聚合
client_data = [preprocess(emnist_train.create_tf_dataset_for_client(cid)) 
               for cid in emnist_train.client_ids[:5]]

# 执行下一轮训练
state, metrics = iterative_process.next(state, client_data)

print(f"训练后的指标: {metrics}")

通过以上步骤，您已成功运行了一个基础的联邦学习流程。您可以参考官方文档中的 tff.learning 和 tff.federated.core 教程，进一步探索自定义算法或更复杂的部署场景。