NVIDIA FLARE

官网 | 论文 | 博客 | 演讲与论文 | 网络研讨会 | 研究 | 文档

NVIDIA FLARE (NVIDIA Federated Learning Application Runtime Environment) 是一个领域无关、开源且可扩展的 Python SDK，使研究人员和数据科学家能够将现有的机器学习/深度学习工作流迁移到联邦学习范式。它还支持平台开发者构建安全、保护隐私的分布式多方协作解决方案。

特性

FLARE 基于组件化架构，允许您将联邦学习任务从研究和仿真阶段过渡到实际生产部署。

应用特性

• 同时支持深度学习和传统机器学习算法（如 PyTorch、TensorFlow、scikit-learn、XGBoost 等）
• 支持横向和纵向联邦学习
• 内置联邦学习算法（如 FedAvg、FedProx、FedOpt、Scaffold、Ditto 等）
• 支持多种服务器和客户端控制的训练流程（如散聚式、循环式）以及验证流程（全局模型评估、跨站点验证）
• 同时支持数据分析（联邦统计）和机器学习生命周期管理
• 通过差分隐私、同态加密、私有集合交集（PSI）等技术实现隐私保护

从仿真到真实世界

• FLARE 客户端 API 可以在 ML/DL 和 FL 之间无缝切换，只需少量代码修改
• 提供模拟器和 POC 模式，便于快速开发和原型设计
• 组件完全可定制且可扩展，采用模块化设计
• 支持云端和本地部署
• 提供项目管理和部署仪表盘
• 通过联邦授权和隐私策略强化安全性
• 内置系统弹性与容错机制

请参阅 NVIDIA FLARE 概览 获取完整介绍，以及 新功能 查看最新更新。

安装

要安装当前版本：

$ python -m pip install nvflare

有关详细安装说明，请参阅NVIDIA FLARE 安装指南。

入门

• 如需开始使用，请参考快速入门文档。

• 网站上提供了结构化的自学课程和培训路径。

  • DLI 课程：
    • https://learn.nvidia.com/courses/course-detail?course_id=course-v1:DLI+S-FX-28+V1
    • https://learn.nvidia.com/courses/course-detail?course_id=course-v1:DLI+S-FX-29+V1

• 请访问开发者门户。

社区

我们欢迎社区贡献！更多详情请参阅贡献指南。

您可以在NVFlare 讨论区提问、回答问题、分享想法并与社区成员互动。

相关演讲与出版物

请查看我们不断增长的演讲与出版物列表，以及与 NVIDIA FLARE 相关的技术博客。

许可证

NVIDIA FLARE 采用Apache 2.0 许可证发布。

NVIDIA FLARE (NVFlare) 快速上手指南

NVIDIA FLARE 是一个开源、可扩展的 Python SDK，旨在帮助研究人员和数据科学家将现有的机器学习/深度学习工作流适配到联邦学习（Federated Learning）范式。它支持从模拟仿真到真实生产环境的无缝部署，内置多种联邦学习算法及隐私保护机制。

1. 环境准备

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

• 操作系统：Linux (推荐 Ubuntu 18.04/20.04/22.04) 或 macOS。Windows 用户建议使用 WSL2。
• Python 版本：Python 3.8, 3.9, 3.10 或 3.11。
• 前置依赖：
  • 已安装 pip 包管理工具。
  • 若需运行深度学习示例，建议预先安装对应的深度学习框架（如 PyTorch 或 TensorFlow）。
• 网络环境：确保可以访问 PyPI 源。国内用户可配置清华或阿里镜像源以加速下载。

2. 安装步骤

标准安装

使用 pip 直接安装最新稳定版：

python -m pip install nvflare

国内加速安装（推荐）

如果您在中国大陆地区，建议使用国内镜像源以提高下载速度：

python -m pip install nvflare -i https://pypi.tuna.tsinghua.edu.cn/simple

验证安装

安装完成后，可通过以下命令检查版本信息，确认安装成功：

python -c "import nvflare; print(nvflare.__version__)"

3. 基本使用

NVFlare 的核心优势在于能够通过极少的代码改动，将现有的单机训练脚本转换为联邦学习流程。以下是最简单的入门路径：

步骤一：准备现有模型

假设您已经有一个基于 PyTorch 的标准训练脚本 train.py。NVFlare 不需要您重写整个训练逻辑，而是通过封装器（Wrapper）来适配。

步骤二：使用模拟器快速原型开发

在生产环境部署前，您可以使用 NVFlare 自带的 Simulator 在单机上模拟多客户端的联邦训练过程。这是最快的验证方式。

创建一个配置文件 config_fed_server.json 和 config_fed_client.json（或使用官方提供的示例配置），然后运行模拟器：

# 使用模拟器运行联邦学习任务，模拟 2 个客户端
python -m nvflare.fuel.hci.tools.simulator --workspace ./my_sim_workspace --clients 2

提示：初学者可以直接克隆官方仓库中的 examples 目录，里面包含了针对 PyTorch、TensorFlow 和 Scikit-learn 的完整演示项目（如 hello-pt），直接运行其中的启动脚本即可观察效果。

步骤三：过渡到真实部署

当模拟测试通过后，只需将运行模式从 Simulator 切换为 POC (Proof of Concept) 模式或生产模式，即可在分布式环境中启动：

1. 初始化工作空间：

   python -m nvflare.fuel.hci.tools.provisioner
   

2. 启动服务器与客户端： 在生成的部署包中，分别在不同机器或终端执行启动脚本：

   # 在服务器端
   ./start.sh
   
   # 在客户端端
   ./start.sh
   

通过以上步骤，您即可完成从本地单机训练到分布式联邦学习的快速迁移。更多详细教程和进阶用法，请访问 NVFlare 官方文档。