xaynet

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

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

让开发者轻松实现联邦学习

机器学习框架已经存在，包括那些专门用于联邦学习的框架。这些框架通常促进跨隔离区的联邦学习——例如在有限数量的医院之间进行协作学习，或者多个银行在没有共享宝贵和敏感数据的情况下，共同处理一个共同用例。

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

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

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

编写此框架的Rust的理由

我们的联邦学习框架不仅是一个机器学习框架，它还支持在可能异构设备上进行的机器学习联邦，并且涉及许多此类设备的用例。

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

• 在“任何地方”运行：语言不应需要自己的运行时，且代码应能在广泛的设备上编译。
• 内存和并发安全：编译的代码应既内存安全又无数据竞争。
• 安全通信：在经过验证的实现中提供最先进的加密。
• 异步通信：存在异步通信的抽象，这使联邦学习可扩展。
• 快速且功能强大：语言应提供功能抽象，同时将代码编译成快速的可执行文件。

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

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

入门指南

最低支持的Rust版本

rustc 1.51.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镜像可在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开始，kustomize由kubectl官方支持）。我们建议您仔细阅读这些清单，并根据您的设置（命名空间、入口等）进行调整。

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

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

请注意，由于敏感性质（例如TLS密钥和证书），ingress配置依赖于本存储库中不存在的资源。

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

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 下的配套入门指南。

故障排除

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