1. 概览
|
|
欢迎学习“使用 TensorFlow Lite 和 Firebase 提供建议”Codelab。在此 Codelab 中，您将学习如何使用 TensorFlow Lite 和 Firebase 将推荐模型部署到您的应用。此 Codelab 基于此 TensorFlow Lite 示例。
借助推荐功能，应用可以运用机器学习技术，以智能方式为每个用户提供相关度最高的内容。该公司利用根据大量其他用户的汇总行为训练的模型，结合过往的用户行为，向用户推荐未来可能希望与之互动的应用内容。
本教程介绍如何使用 Firebase Analytics 从应用用户那里获取数据，构建机器学习模型以获得这些数据推荐，然后在 iOS 应用中使用该模型进行推理并获取推荐。具体而言，我们的推荐会根据用户之前喜欢的电影列表，推荐用户最有可能观看的电影。
学习内容
- 将 Firebase Analytics 集成到 Android 应用中，以便收集用户行为数据
- 将该数据导出到 Google BigQuery 中
- 预处理数据并训练 TF Lite 推荐模型
- 将 TF Lite 模型部署到 Firebase ML 并从您的应用访问该模型
- 使用模型进行设备端推断，以便向用户推荐商品
所需条件
- Xcode 11（或更高版本）
- CocoaPods 1.9.1（或更高版本）
您将如何使用本教程？
您如何评价自己在构建 iOS 应用方面的经验水平？
2. 创建 Firebase 控制台项目
将 Firebase 添加到项目中
- 前往 Firebase 控制台。
- 选择创建新项目，并将您的项目命名为“Firebase ML iOS Codelab”。
3. 获取示例项目
下载代码
首先克隆示例项目，并在项目目录中运行 pod update：
git clone https://github.com/FirebaseExtended/codelab-contentrecommendation-ios.git cd codelab-contentrecommendation-ios/start pod install --repo-update
如果您未安装 git，也可以从其 GitHub 页面或点击此链接下载示例项目。下载项目后，在 Xcode 中运行它并试试相关建议，以了解其工作方式。
设置 Firebase
按照文档中的说明创建一个新的 Firebase 项目。获得项目后，从 Firebase 控制台下载项目的 GoogleService-Info.plist 文件，并将其拖到 Xcode 项目的根目录。
将 Firebase 添加到您的 Podfile 并运行 pod install。
pod 'FirebaseAnalytics' pod 'FirebaseMLModelDownloader', '9.3.0-beta' pod 'TensorFlowLiteSwift'
在 AppDelegate 的 didFinishLaunchingWithOptions 方法中，在文件顶部导入 Firebase
import FirebaseCore
然后添加一个用于配置 Firebase 的调用。
FirebaseApp.configure()
再次运行项目，确保应用配置正确，不会在启动时崩溃。
- 确保已启用“为此项目启用 Google Analytics（分析）”。
- 在 Firebase 控制台中完成剩下的设置步骤，然后点击“创建项目”（如果您使用的是现有 Google 项目，则点击“添加 Firebase”）。
4.将 Firebase Analytics 添加到应用
在此步骤中，您将向应用添加 Firebase Analytics 以记录用户行为数据（在本例中，即用户喜欢哪些影片）。这些数据将在未来步骤中汇总用于训练推荐模型。
在应用中设置 Firebase Analytics
LikedMoviesViewModel 包含用于存储用户喜欢的电影的函数。此外，每当用户赞了一部新电影时，我们还希望发送一个分析日志事件来记录这次顶。
添加以下代码，以便在用户点击电影按钮时注册分析事件。
AllMoviesCollectionViewController.swift
import FirebaseAnalytics
//
override func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
//
if movie.liked == nil {
movie.liked = true
Analytics.logEvent(AnalyticsEventSelectItem, parameters: [AnalyticsParameterItemID: movie.id])
} else {
movie.liked?.toggle()
}
}
5. 测试您的 Google Analytics（分析）集成
在此步骤中，我们将在应用中生成 Analytics 事件，并验证这些事件是否会发送到 Firebase 控制台。
启用 Analytics 调试日志记录
通常，应用程序所记录的事件会在大约一小时的时间内一起批量上传，并一起上传。这种方法可以节省最终用户设备的电量并减少网络流量消耗。不过，为了验证您的分析实现效果（以及为了在 DebugView 报告中查看您的分析），您可以在开发设备上启用调试模式，以尽可能减少延迟上传事件。
要在开发设备上启用 Google Analytics（分析）“调试”模式，请在 Xcode 中指定以下命令行参数：
-FIRDebugEnabled
现在，您已成功将 Firebase Analytics 集成到您的应用中。当用户使用您的应用并点赞电影时，系统会汇总记录他们顶过的内容。在此 Codelab 的其余部分，我们将使用这些汇总数据来训练我们的推荐模型。您可以选择执行下面的可选步骤，查看您在 Logcat 中看到的那些 Analytics 事件也会流式传输到 Firebase 控制台。请直接跳到下一页。
可选：在 Firebase 控制台中确认 Analytics 事件
- 前往 Firebase 控制台。
- 选择“Google Analytics（分析）”下的 DebugView
- 在 Xcode 中，选择 Run 以启动该应用，并向“赞过的视频”列表中添加一些电影。
- 在 Firebase 控制台的 DebugView 中，验证当您在应用中添加影片时，系统是否正在记录这些事件。
6. 将 Google Analytics（分析）数据导出到 BigQuery
BigQuery 是一款 Google Cloud 产品，可用于检查和处理大量数据。在此步骤中，您会将 Firebase 控制台项目与 BigQuery 相关联，以便将您的应用生成的 Analytics 数据自动导出到 BigQuery 中。
启用 BigQuery 导出功能
- 前往 Firebase 控制台。
- 选择“项目概览”旁边的“设置”齿轮图标，然后选择项目设置
- 选择集成标签页。
- 选择 BigQuery 代码块内的关联（或管理）。
- 在关于将 Firebase 关联至 BigQuery 步骤中选择下一步。
- 在配置集成部分下，点击开关以启用 Google Analytics（分析）数据发送功能，然后选择关联到 BigQuery。
现在，您已将自己的 Firebase 控制台项目设置为自动将 Firebase Analytics 事件数据发送到 BigQuery。此过程会自动进行，无需任何进一步的互动，但是，在 BigQuery 中创建分析数据集的首次导出可能在 24 小时后才发生。创建数据集后，Firebase 会不断将新的 Analytics 事件导出到 BigQuery 的当日表中，并将过去几天的事件归入到事件表中。
训练推荐模型需要大量数据。由于我们还没有生成大量数据的应用，因此在下一步中，我们会将示例数据集导入 BigQuery，以供本教程的其余部分使用。
7. 使用 BigQuery 获取模型训练数据
现在，我们已经关联了 Firebase 控制台以导出到 BigQuery，一段时间后，我们的应用分析事件数据将自动显示在 BigQuery 控制台中。为了获得本教程介绍的一些初始数据，在此步骤中，我们会将一个现有示例数据集导入您的 BigQuery 控制台，用于训练我们的推荐模型。
将示例数据集导入 BigQuery
- 前往 Google Cloud 控制台中的 BigQuery 信息中心。
- 在菜单中选择项目名称。
- 在 BigQuery 左侧导航栏的底部选择您的项目名称，以查看详细信息。
- 选择创建数据集以打开数据集创建面板。
- 输入“firebase_recommendations_dataset”作为数据集 ID，然后选择创建数据集。
- 新数据集会显示在左侧菜单中的项目名称下方。点击该图标。
- 选择创建表以打开表创建面板。
- 在基于以下数据创建表部分，选择“Google Cloud Storage”。
- 在从 GCS 存储分区中选择文件字段中，输入“gs://firebase-recommendations/recommendations-test/formatted_data_filtered.txt。
- 在文件格式下拉菜单中选择“JSONL”。
- 在表格名称中输入“recommendations_table”。
- 选中架构 > 自动检测 > 架构和输入参数下的复选框
- 选择创建表
探索示例数据集
此时，您可以选择探索架构并预览此数据集。
- 在左侧菜单中选择 firebase-recommendations-dataset，展开其中包含的表。
- 选择 recommendations-table 表以查看表架构。
- 选择预览可查看此表格包含的实际 Google Analytics（分析）事件数据。
创建服务账号凭据
现在，我们将在 Google Cloud 控制台项目中创建服务帐号凭据，在下一步中，我们可以在 Colab 环境中使用这些凭据来访问和加载 BigQuery 数据。
- 确保您的 Google Cloud 项目已启用结算功能。
- 启用 BigQuery 和 BigQuery Storage API API。<点击此处>
- 转到“创建服务帐号密钥”页面。
- 从服务账号列表中，选择新的服务账号。
- 在服务账号名称字段中，输入一个名称。
- 从角色列表中，选择项目 > 所有者。
- 点击创建。包含密钥的 JSON 文件就会下载到您的计算机。
在下一步中，我们将使用 Google Colab 对这些数据进行预处理，并训练我们的推荐模型。
8. 预处理数据并训练推荐模型
在此步骤中，我们将使用 Colab 笔记本执行以下步骤：
- 将 BigQuery 数据导入 Colab 笔记本
- 预处理数据，为模型训练做好准备
- 使用分析数据来训练推荐模型
- 将模型导出为 TF Lite 模型
- 将模型部署到 Firebase 控制台，以便我们在应用中使用它
在发布 Colab 训练笔记本之前，我们将先启用 Firebase Model Management API，以便 Colab 可以将经过训练的模型部署到 Firebase 控制台。
启用 Firebase Model Management API
创建存储分区以存储机器学习模型
在 Firebase 控制台中，点击“Storage”（开始），然后点击“Get started”（开始使用）。
按照对话框设置存储分区。
启用 Firebase ML API
转到 Google Cloud 控制台上的 Firebase ML API 页面，然后点击“启用”。
使用 Colab 笔记本训练和部署模型
使用以下链接打开 Colab 笔记本，并完成其中的步骤。在 Colab 笔记本中完成相关步骤后，您将得到一个部署到 Firebase 控制台的 TF Lite 模型文件，我们可以将该文件向下同步到我们的应用。
在 Colab 中打开
9. 在应用中下载模型
在此步骤中，我们将修改应用，以下载我们刚刚从 Firebase 机器学习训练的模型。
添加 Firebase ML 依赖项
需要以下依赖项才能在您的应用中使用 Firebase 机器学习模型。您应该已经添加了该依赖项（验证）。
Podfile
import FirebaseCore
import FirebaseMLModelDownloader
使用 Firebase Model Manager API 下载模型
将以下代码复制到 ModelLoader.swift 中，以设置模型下载的条件，并创建下载任务以将远程模型同步到我们的应用。
ModelLoader.swift
static func downloadModel(named name: String,
completion: @escaping (CustomModel?, DownloadError?) -> Void) {
guard FirebaseApp.app() != nil else {
completion(nil, .firebaseNotInitialized)
return
}
guard success == nil && failure == nil else {
completion(nil, .downloadInProgress)
return
}
let conditions = ModelDownloadConditions(allowsCellularAccess: false)
ModelDownloader.modelDownloader().getModel(name: name, downloadType: .localModelUpdateInBackground, conditions: conditions) { result in
switch (result) {
case .success(let customModel):
// Download complete.
// The CustomModel object contains the local path of the model file,
// which you can use to instantiate a TensorFlow Lite classifier.
return completion(customModel, nil)
case .failure(let error):
// Download was unsuccessful. Notify error message.
completion(nil, .downloadFailed(underlyingError: error))
}
}
}
10. 在您的应用中集成 Tensorflow Lite 推荐模型
Tensorflow Lite 运行时可让您在应用中使用模型来生成推荐。在上一步中，我们使用下载的模型文件初始化了 TFlite 解释器。在此步骤中，我们首先加载一个字典和标签，以配合推理步骤中的模型，然后添加预处理，为模型生成输入和后处理，从推理中提取结果。
加载字典和标签
用于由推荐模型生成推荐候选内容的标签列在资源文件夹的 sorted_movie_vocab.json 文件中。复制以下代码以加载这些候选项。
RecommendationsViewController.swift
func getMovies() -> [MovieItem] {
let barController = self.tabBarController as! TabBarController
return barController.movies
}
实现预处理
在预处理步骤中，我们更改了输入数据的形式，以匹配模型所需的格式。在本示例中，如果我们尚未生成很多用户“喜欢”，我们将用占位符值填充输入长度。复制以下代码：
RecommendationsViewController.swift
// Given a list of selected items, preprocess to get tflite input.
func preProcess() -> Data {
let likedMovies = getLikedMovies().map { (MovieItem) -> Int32 in
return MovieItem.id
}
var inputData = Data(copyingBufferOf: Array(likedMovies.prefix(10)))
// Pad input data to have a minimum of 10 context items (4 bytes each)
while inputData.count < 10*4 {
inputData.append(0)
}
return inputData
}
运行解释器以生成建议
在这里，我们使用在上一步中下载的模型，根据预处理的输入进行推断。我们为模型设置输入和输出类型，然后进行推理以生成电影推荐。将以下代码复制到您的应用中。
RecommendationsViewController.swift
import TensorFlowLite
RecommendationsViewController.swift
private var interpreter: Interpreter?
func loadModel() {
// Download the model from Firebase
print("Fetching recommendations model...")
ModelDownloader.fetchModel(named: "recommendations") { (filePath, error) in
guard let path = filePath else {
if let error = error {
print(error)
}
return
}
print("Recommendations model download complete")
self.loadInterpreter(path: path)
}
}
func loadInterpreter(path: String) {
do {
interpreter = try Interpreter(modelPath: path)
// Allocate memory for the model's input `Tensor`s.
try interpreter?.allocateTensors()
let inputData = preProcess()
// Copy the input data to the input `Tensor`.
try self.interpreter?.copy(inputData, toInputAt: 0)
// Run inference by invoking the `Interpreter`.
try self.interpreter?.invoke()
// Get the output `Tensor`
let confidenceOutputTensor = try self.interpreter?.output(at: 0)
let idOutputTensor = try self.interpreter?.output(at: 1)
// Copy output to `Data` to process the inference results.
let confidenceOutputSize = confidenceOutputTensor?.shape.dimensions.reduce(1, {x, y in x * y})
let idOutputSize = idOutputTensor?.shape.dimensions.reduce(1, {x, y in x * y})
let confidenceResults =
UnsafeMutableBufferPointer<Float32>.allocate(capacity: confidenceOutputSize!)
let idResults =
UnsafeMutableBufferPointer<Int32>.allocate(capacity: idOutputSize!)
_ = confidenceOutputTensor?.data.copyBytes(to: confidenceResults)
_ = idOutputTensor?.data.copyBytes(to: idResults)
postProcess(idResults, confidenceResults)
print("Successfully ran inference")
DispatchQueue.main.async {
self.tableView.reloadData()
}
} catch {
print("Error occurred creating model interpreter: \(error)")
}
}
实现后处理
最后，在此步骤中，我们对模型的输出进行后处理，选择置信度最高的结果，并移除包含的值（用户已经表示喜欢的影片）。将以下代码复制到您的应用中。
RecommendationsViewController.swift
// Postprocess to get results from tflite inference.
func postProcess(_ idResults: UnsafeMutableBufferPointer<Int32>, _ confidenceResults: UnsafeMutableBufferPointer<Float32>) {
for i in 0..<10 {
let id = idResults[i]
let movieIdx = getMovies().firstIndex { $0.id == id }
let title = getMovies()[movieIdx!].title
recommendations.append(Recommendation(title: title, confidence: confidenceResults[i]))
}
}
测试您的应用！
重新运行应用。当您选择一些电影时，它应该会自动下载新模型并开始生成推荐！
11. 恭喜！
您已使用 TensorFlow Lite 和 Firebase 在应用中构建了推荐功能。请注意，此 Codelab 中显示的技术和流水线可以进行泛化，也可以用于提供其他类型的推荐。
所学内容
- Firebase ML
- Firebase Analytics
- 将分析事件导出到 BigQuery
- 预处理分析事件
- 训练推荐 TensorFlow 模型
- 导出模型并部署到 Firebase 控制台
- 在应用中提供电影推荐服务
后续步骤
- 在您的应用中实现 Firebase ML 建议。
了解详情
有疑问？
报告问题