xaynet

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

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

让联邦学习对开发者来说变得简单

机器学习框架已经存在，包括那些专门用于联邦学习的框架。这些框架通常促进跨领域用例的联邦学习——例如在有限数量医院的协作学习中，或者在不同银行共同处理某个用例而无需共享有价值且敏感的数据时。

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

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

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

编写此框架的理由

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

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

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

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

• 其所有权和借用概念使其既内存安全又线程安全（因此避免了许多常见的并发问题）。
• 它具有强大和静态的类型纪律和特型，特型描述了类型的可共享功能。
• 它是一种现代的系统编程语言，具有一些功能式风格特性，如模式匹配、闭包和迭代器。
• 其惯用代码的性能优于惯用的C代码。
• 它编译成WASM，因此可以在浏览器环境中原生应用。
• 它广泛适用，不一定依赖于运行时，与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配置依赖于此存储库中不可用的资源，因此在k8s/coordinator/development/ingress.yaml中显示的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 下的配套入门指南。

故障排除

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