快速入门 iOS

在本教程中，我们将学习如何在 iOS 设备上使用 Flower 和 CoreML 在 MNIST 上训练神经网络。

First of all, for running the Flower Python server, it is recommended to create a virtual environment and run everything within a virtualenv. For the Flower client implementation in iOS, it is recommended to use Xcode as our IDE.

我们的示例包括一个 Python 服务器*和两个 iPhone *客户端，它们都具有相同的模型。

客户端*负责根据其本地数据集为模型生成独立的模型参数。然后，这些参数更新会被发送到*服务器，由*服务器*汇总后生成一个更好的模型。最后，服务器*将改进后的模型发送回每个*客户端。一个完整的参数更新周期称为一*轮*。

现在我们已经有了一个大致的概念，让我们开始设置 Flower 服务器环境吧。首先，我们需要安装 Flower。你可以使用 pip 来安装：

$ pip install flwr

或者Poetry：

$ poetry add flwr

Flower 客户端

现在我们已经安装了所有依赖项，让我们使用 CoreML 作为本地训练框架和 MNIST 作为数据集，运行一个简单的分布式训练。为了简单起见，我们将使用 CoreML 的完整 Flower 客户端，该客户端已在 Swift SDK 中实现并存储。客户端实现如下：

/// Parses the parameters from the local model and returns them as GetParametersRes struct
///
/// - Returns: Parameters from the local model
public func getParameters() -> GetParametersRes {
  let parameters = parameters.weightsToParameters()
  let status = Status(code: .ok, message: String())

  return GetParametersRes(parameters: parameters, status: status)
}

/// Calls the routine to fit the local model
///
/// - Returns: The result from the local training, e.g., updated parameters
public func fit(ins: FitIns) -> FitRes {
  let status = Status(code: .ok, message: String())
  let result = runMLTask(configuration: parameters.parametersToWeights(parameters: ins.parameters), task: .train)
  let parameters = parameters.weightsToParameters()

  return FitRes(parameters: parameters, numExamples: result.numSamples, status: status)
  }

/// Calls the routine to evaluate the local model
///
/// - Returns: The result from the evaluation, e.g., loss
public func evaluate(ins: EvaluateIns) -> EvaluateRes {
  let status = Status(code: .ok, message: String())
  let result = runMLTask(configuration: parameters.parametersToWeights(parameters: ins.parameters), task: .test)

  return EvaluateRes(loss: Float(result.loss), numExamples: result.numSamples, status: status)
}

让我们在 Xcode 中创建一个新的应用程序项目，并在项目中添加 flwr 作为依赖关系。对于我们的应用程序，我们将在 FLiOSModel.swift 中存储应用程序的逻辑，在 ContentView.swift 中存储 UI 元素。在本快速入门中，我们将更多地关注 FLiOSModel.swift。请参阅 完整代码示例 以了解更多有关应用程序的信息。

在 FLiOSModel.swift 中导入 Flower 和 CoreML 相关软件包：

import Foundation
import CoreML
import flwr

然后通过拖放将 mlmodel 添加到项目中，在部署到 iOS 设备时，mlmodel 将被捆绑到应用程序中。我们需要传递 url 以访问 mlmodel 并运行 CoreML 机器学习进程，可通过调用函数 Bundle.main.url 获取。对于 MNIST 数据集，我们需要将其预处理为 MLBatchProvider 对象。预处理在 DataLoader.swift 中完成。

// prepare train dataset
let trainBatchProvider = DataLoader.trainBatchProvider() { _ in }

// prepare test dataset
let testBatchProvider = DataLoader.testBatchProvider() { _ in }

// load them together
let dataLoader = MLDataLoader(trainBatchProvider: trainBatchProvider,
                              testBatchProvider: testBatchProvider)

Since CoreML does not allow the model parameters to be seen before training, and accessing the model parameters during or after the training can only be done by specifying the layer name, we need to know this information beforehand, through looking at the model specification, which are written as proto files. The implementation can be seen in MLModelInspect.

After we have all of the necessary information, let's create our Flower client.

let compiledModelUrl = try MLModel.compileModel(at: url)

// inspect the model to be able to access the model parameters
// to access the model we need to know the layer name
// since the model parameters are stored as key value pairs
let modelInspect = try MLModelInspect(serializedData: Data(contentsOf: url))
let layerWrappers = modelInspect.getLayerWrappers()
self.mlFlwrClient = MLFlwrClient(layerWrappers: layerWrappers,
                                 dataLoader: dataLoader,
                                 compiledModelUrl: compiledModelUrl)

然后启动 Flower gRPC 客户端，并通过将 Flower 客户端传递给函数 startFlwrGRPC 来开始与服务器通信。

self.flwrGRPC = FlwrGRPC(serverHost: hostname, serverPort: port)
self.flwrGRPC.startFlwrGRPC(client: self.mlFlwrClient)

这就是客户端。我们只需实现 Client 或调用提供的 MLFlwrClient 并调用 startFlwrGRPC()。属性 hostname 和 port 会告诉客户端要连接到哪个服务器。这可以通过在应用程序中输入主机名和端口来实现，然后再点击开始按钮启动联邦学习进程。

Flower 服务器

对于简单的工作负载，我们可以启动 Flower 服务器，并将所有配置选项保留为默认值。在名为 server.py 的文件中，导入 Flower 并启动服务器：

import flwr as fl

fl.server.start_server(config=fl.server.ServerConfig(num_rounds=3))

联邦训练模型！

客户端和服务器都已准备就绪，我们现在可以运行一切，看看联邦学习的实际效果。FL 系统通常有一个服务器和多个客户端。因此，我们必须先启动服务器：

$ python server.py

服务器运行后，我们就可以在不同的终端启动客户端。通过 Xcode 构建并运行客户端，一个通过 Xcode 模拟器，另一个通过部署到 iPhone。要了解更多有关如何将应用程序部署到 iPhone 或模拟器的信息，请访问 此处。

恭喜您！ 您已经成功地在 ios 设备中构建并运行了第一个联邦学习系统。本示例的`完整源代码 <https://github.com/adap/flower/blob/main/examples/ios>`_ 可在 examples/ios 中找到。