xaynet

Xaynet：使用联邦学习在边缘进行训练

需要一个支持在边缘进行联邦学习、桌面浏览器中表现良好、与移动应用集成良好、且保护隐私的框架吗？欢迎来到 XayNet，它完全使用 Rust 编写！

让开发者更容易实现联邦学习

机器学习框架已经存在，包括专门为联邦学习设计的框架。这些框架通常便于跨隔离区用例的联邦学习 - 例如在有限数量的医院之间的协作学习，或者多个银行在不需要共享有价值且敏感数据的情况下共同处理一个常见用例。

本仓库专注于掩码跨设备联邦学习，以实现数百万低功耗边缘设备（如智能手机甚至汽车）中机器学习的编排。通过这样做，我们希望也能加快联邦学习的实际应用速度和范围，尤其是保护终端用户数据。所有数据都保留在私有本地场所，只有加密的 AI 模型会自动和异步地聚合。因此，我们提供了一种解决 AI 隐私困境的解决方案，弥合了隐私和便利性之间经常存在的差距。例如，想象一个语音助手可以在设备级别直接学习新单词，并与其他实例共享这些知识，而不需要集中记录和收集您的语音输入。或者，想想一个搜索引擎如何学习个性化搜索结果，而不需要集中收集您通常敏感的搜索查询……现在有数千个这样的用例，仍在以便利性换取隐私。我们认为这不应该成为常态，我们希望提供一个替代方案来克服这个困境。

具体来说，我们为开发者提供

• 应用开发工具：一个 SDK，可以将联邦学习集成到用 Dart 或其他移动开发选择的语言编写的应用程序中，以及如 Flutter 这样的框架。
• 跨设备联邦学习实现隐私：在边缘设备如手机、浏览器甚至在汽车上本地训练AI模型。联邦学习自动将本地模型聚合为全局模型。因此，所有本地模型中固有的洞察都被捕捉到，而用户数据保持在端设备上保持隐私。
• 同态加密实现安全隐私：聚合具有最高安全性和可信度的模型。Xayn的掩码协议以同态加密方式加密所有模型。这使得您可以将加密的本地模型聚合为一个全局模型——而无需解密本地模型。这保护了隐私，甚至是最敏感的数据。

编写此框架的理由

我们的联邦学习框架不仅仅是一个机器学习框架。更确切地说，它支持在可能异构设备上发生的机器学习联邦，并且涉及许多此类设备的使用案例。

此框架所使用的编程语言应为我们提供以下方面的强大支持

• 运行“到处”：该语言不应需要自己的运行时，并且代码应在广泛的设备上编译。
• 内存和并发安全性：编译后的代码应既内存安全又无数据竞争。
• 安全通信：应提供经过审查的先进加密实现。
• 异步通信：应存在抽象以异步通信，从而使联邦学习可扩展。
• 快速且功能性强：该语言应提供功能抽象，同时将代码编译为快速的可执行文件。

Rust是少数几种满足这些要求的现代编程语言之一

• 它的所有权和借用概念使其既内存安全又线程安全（从而避免了许多常见的并发问题）。
• 它具有强大且静态的类型纪律和特性，特性描述了类型的可共享功能。
• 它是一种现代系统编程语言，具有一些功能式风格特性，如模式匹配、闭包和迭代器。
• 其惯用代码在性能上与惯用C代码有可比性。
• 它可以编译为WASM，因此可以在浏览器设置中本地应用。
• 它具有广泛的部署能力，并且不一定依赖于运行时，与Java等语言及其需要虚拟机来运行代码的需求不同。Foreign Function Interfaces支持从其他语言/框架调用，包括Dart、Python和Flutter。
• 它编译为LLVM，因此可以利用丰富的LLVM工具集。

入门指南

最低支持的Rust版本

rustc 1.48.0

运行平台

可以通过Docker、部署到Kubernetes集群或手动编译代码并运行二进制文件来运行后端。

1. 以下说明假定您的shell工作目录是存储库的根目录。
2. 以下说明假定您对一些引用的软件（如docker和docker-compose）有先验知识，或者有一个可用的设置（如果您决定编译Rust代码并手动运行二进制文件）。
3. 如果您需要帮助设置系统，我们建议您参考每个工具的官方文档，因为在这里支持它们超出了本项目的范围
   • Rust
   • Docker和Docker Compose
   • Kubernetes

注意

使用Xaynet v0.11时，协调器需要连接到Redis实例以保存其状态。

不要将协调器连接到用于生产的Redis实例！

我们建议将协调器连接到其自己的Redis实例。我们投入了大量时间来确保协调器只删除自己的数据，但在当前的开发状态下，我们无法保证这始终如此。

使用Docker

使用Docker设置的便利性在于，您不需要在系统上设置一个工作的Rust环境，因为所有操作都在容器内完成。

从Docker Hub运行镜像

Docker Hub上提供了最新版本的Docker镜像，可在Docker Hub找到。

您可以通过运行以下命令使用默认的configs/docker-dev.toml来尝试它们：

Xaynet v0.11以下

docker run -v ${PWD}/configs/docker-dev.toml:/app/config.toml -p 8081:8081 xaynetwork/xaynet:v0.10.0 /app/coordinator -c /app/config.toml

Xaynet v0.11+

# don't forget to adjust the Redis url in configs/docker-dev.toml
docker run -v ${PWD}/configs/docker-dev.toml:/app/config.toml -p 8081:8081 xaynetwork/xaynet:v0.11.0

该Docker镜像包含不带可选功能的协调器发布版本。

运行具有额外基础设施的协调器

通过指向docker/docker-compose.yml文件来启动协调器。它会启动所有必要的基础设施，以便以默认或可选功能运行协调器。请注意，此文件仅用于开发。

docker-compose -f docker/docker-compose.yml up --build

创建发布构建

如果您想，您可以创建一个优化的协调器发布版本，但请注意，编译将更慢。

docker build --build-arg RELEASE_BUILD=1 -f ./docker/Dockerfile .

构建具有可选功能的协调器

可以通过构建参数COORDINATOR_FEATURES指定可选功能。

docker build --build-arg COORDINATOR_FEATURES=tls,metrics -f ./docker/Dockerfile .

使用Kubernetes

要将协调器的实例部署到您的Kubernetes集群，请使用位于k8s/coordinator文件夹内的清单。这些清单依赖于kustomize生成（自v1.14起，kubectl官方支持kustomize）。我们建议您仔细查看这些清单，并根据您的配置（命名空间、入口等）进行修改。

请记住，也要检查（并在必要时调整）位于k8s/coordinator/development/config.toml的协调器默认配置。

请调整k8s/coordinator/development/ingress.yaml文件中使用的域，使其符合您的需求（您也可以完全跳过ingress，只需确保您从k8s/coordinator/development/kustomization.yaml中删除其引用即可）。

请注意，ingress配置在k8s/coordinator/development/ingress.yaml中显示，它依赖于此存储库中不可用的资源，因为它们的性质敏感（例如TLS密钥和证书）。

要验证生成的清单，请运行

kubectl kustomize k8s/coordinator/development

要应用它们

kubectl apply -k k8s/coordinator/development

如果您没有通过ingress公开您的协调器，您仍然可以通过端口转发来访问它。以下示例在端口8081上创建端口转发，假设协调器Pod仍在使用app=coordinator标签

kubectl port-forward $(kubectl get pods -l "app=coordinator" -o jsonpath="{.items[0].metadata.name}") 8081

手动构建项目

可以构建并启动不带可选功能的协调器

cd rust
cargo run --bin coordinator -- -c ../configs/config.toml

运行示例

示例可以在rust/examples/下找到。它使用一个虚拟模型，但具有网络功能，因此它是检查与协调器连接的好起点。

试驾

请确保您已启动协调器实例，并且您将使用以下命令生成的客户端能够通过网络访问它。

以下是一个示例，说明如何启动 20 个参与者，这些参与者将连接到运行在 127.0.0.1:8081 上的协调器。

cd rust
RUST_LOG=info cargo run --example test-drive -- -n 20 -u http://127.0.0.1:8081

有关如何运行示例的更多详细信息，请参阅rust/xaynet-server/src/examples.rs 下的配套入门指南。

故障排除

如果您在运行项目时遇到任何困难，请通过提交问题并描述您的设置和遇到的问题来联系我们。