xaynet

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

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

让开发者轻松使用联邦学习

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

本存储库专注于掩码跨设备联邦学习，以实现数百万低功耗边缘设备（如智能手机甚至汽车）中机器学习的编排。通过这样做，我们希望加快联邦学习在实践中的采用速度和范围，特别是保护最终用户数据。所有数据都保留在私有本地环境中，而只有加密的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镜像可在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中删除其引用即可）。

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

故障排除

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