1. 概述
|
|
欢迎使用 TensorFlow Lite 和 Firebase Codelab 的推荐。在此 Codelab 中，您将学习如何使用 TensorFlow Lite 和 Firebase 将推荐模型部署到您的应用。此 Codelab 基于此 TensorFlow Lite示例。
推荐允许应用程序使用机器学习来智能地为每个用户提供最相关的内容。他们会考虑过去的用户行为，通过使用根据大量其他用户的聚合行为进行训练的模型来建议用户将来可能希望与之交互的应用程序内容。
本教程介绍如何使用 Firebase Analytics 从应用的用户获取数据，构建机器学习模型以根据该数据提供建议，然后在 iOS 应用中使用该模型来运行推理并获取建议。特别是，我们的推荐将根据用户之前喜欢的电影列表来建议用户最有可能观看哪些电影。
你将学到什么
- 将 Firebase Analytics 集成到 Android 应用中以收集用户行为数据
- 将该数据导出到 Google Big Query
- 预处理数据并训练 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. 测试您的 Analytics 集成
在此步骤中，我们将在应用程序中生成 Analytics 事件并验证它们是否被发送到 Firebase 控制台。
启用分析调试日志记录
通常，您的应用程序记录的事件会在大约一小时的时间内批量处理并一起上传。这种方法可以节省最终用户设备的电池并减少网络数据的使用。但是，为了验证分析实施（并且为了在 DebugView 报告中查看分析），您可以在开发设备上启用调试模式，以便以最小的延迟上传事件。
要在开发设备上启用分析调试模式，请在 Xcode 中指定以下命令行参数：
-FIRDebugEnabled
至此，您已成功将 Firebase Analytics 集成到您的应用中。当用户使用您的应用程序并喜欢电影时，他们的喜欢将被汇总。我们将在本 Codelab 的其余部分中使用这些聚合数据来训练我们的推荐模型。以下是一个可选步骤，用于查看您在 Logcat 中看到的相同 Analytics 事件也流入 Firebase 控制台。请随意跳至下一页。
可选：在 Firebase 控制台中确认 Analytics 事件
- 转到Firebase 控制台。
- 选择 Analytics 下的DebugView
- 在 Xcode 中，选择“运行”以启动应用程序并将一些电影添加到“喜欢”列表中。
- 在 Firebase 控制台的 DebugView 中，验证在应用中添加电影时是否记录了这些事件。
6. 将 Analytics 数据导出到 Big Query
Big Query 是一款 Google Cloud 产品，可让您检查和处理大量数据。在此步骤中，您将把 Firebase 控制台项目连接到 Big Query，以便应用生成的 Analytics 数据自动导出到 Big Query。
启用 Big Query 导出
- 转到Firebase 控制台。
- 选择“项目概述”旁边的“设置”齿轮图标，然后选择“项目设置”
- 选择集成选项卡。
- 在BigQuery块内选择“链接” （或“管理”）。
- 在关于将 Firebase 链接到 BigQuery步骤中选择下一步。
- 在配置集成部分下，单击开关以启用发送 Google Analytics 数据，然后选择链接到 BigQuery 。
您现在已启用 Firebase 控制台项目，以自动将 Firebase Analytics 事件数据发送到 Big Query。此过程会自动发生，无需任何进一步的交互，但是，在 BigQuery 中创建分析数据集的首次导出可能需要 24 小时才能进行。创建数据集后，Firebase 不断将新的 Analytics 事件导出到 Big Query 到日内表中，并对事件表中过去几天的事件进行分组。
训练推荐模型需要大量数据。由于我们还没有生成大量数据的应用程序，因此在下一步中，我们将向 BigQuery 导入示例数据集以用于本教程的其余部分。
7.使用BigQuery获取模型训练数据
现在我们已经连接 Firebase 控制台以导出到 BigQuery，我们的应用分析事件数据将在一段时间后自动显示在 BigQuery 控制台中。为了获取本教程所需的一些初始数据，在此步骤中，我们将现有的示例数据集导入您的 BigQuery 控制台，以用于训练我们的推荐模型。
将示例数据集导入 BigQuery
- 转到 Google 云控制台中的BigQuery仪表板。
- 在菜单中选择您的项目名称。
- 在 BigQuery 左侧导航底部选择您的项目名称以查看详细信息。
- 选择创建数据集以打开数据集创建面板。
- 输入 'firebase_recommendations_dataset' 作为数据集 ID ，然后选择创建数据集。
- 新数据集将显示在项目名称下的左侧菜单中。点击它。
- 选择创建表以打开表创建面板。
- 对于创建表，请选择“Google 云存储”。
- 在“从 GCS 存储桶中选择文件”字段中，输入“gs://firebase-recommendations/recommendations-test/formatted_data_filtered.txt”。
- 在文件格式下拉列表中选择“JSONL”。
- 输入“recommendations_table”作为表名称。
- 选中架构 > 自动检测 > 架构和输入参数下的框
- 选择创建表
探索示例数据集
此时，您可以选择探索架构并预览此数据集。
- 在左侧菜单中选择firebase-recommendations-dataset以展开其包含的表。
- 选择推荐表以查看表架构。
- 选择预览以查看此表包含的实际 Analytics 事件数据。
创建服务帐户凭据
现在，我们将在 Google Cloud 控制台项目中创建服务帐户凭据，我们可以在接下来的步骤中在 Colab 环境中使用该凭据来访问和加载 BigQuery 数据。
- 确保您的 Google Cloud 项目已启用结算功能。
- 启用 BigQuery 和 BigQuery Storage API API。 <点击这里>
- 转至创建服务帐户密钥页面。
- 从服务帐户列表中，选择新建服务帐户。
- 在服务帐户名称字段中，输入名称。
- 从角色列表中，选择项目>所有者。
- 单击创建。包含您的密钥的 JSON 文件将下载到您的计算机。
下一步，我们将使用 Google Colab 预处理这些数据并训练我们的推荐模型。
8. 预处理数据并训练推荐模型
在此步骤中，我们将使用 Colab 笔记本执行以下步骤：
- 将 BigQuery 数据导入 Colab 笔记本
- 预处理数据，为模型训练做好准备
- 根据分析数据训练推荐模型
- 将模型导出为 TF lite 模型
- 将模型部署到 Firebase 控制台，以便我们可以在我们的应用程序中使用它
在启动 Colab 训练笔记本之前，我们将首先启用 Firebase 模型管理 API，以便 Colab 可以将经过训练的模型部署到我们的 Firebase 控制台。
启用 Firebase 模型管理 API
创建一个存储桶来存储您的 ML 模型
在 Firebase 控制台中，转到“存储”并单击“开始”。 
按照对话设置您的存储桶。
启用 Firebase ML API
转到 Google Cloud Console 上的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中以设置模型下载发生的条件，并创建下载任务以将远程模型同步到我们的应用程序。
模型加载器.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文件中。复制以下代码以加载这些候选项。
推荐视图控制器.swift
func getMovies() -> [MovieItem] {
let barController = self.tabBarController as! TabBarController
return barController.movies
}
实施预处理
在预处理步骤中，我们更改输入数据的形式以匹配我们的模型所期望的。在这里，如果我们还没有产生大量用户喜欢，我们会用占位符值填充输入长度。复制下面的代码：
推荐视图控制器.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
}
运行解释器以生成建议
在这里，我们使用在上一步中下载的模型对预处理的输入运行推理。我们为模型设置输入和输出的类型，并运行推理来生成电影推荐。将以下代码复制到您的应用程序中。
推荐视图控制器.swift
import TensorFlowLite
推荐视图控制器.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)")
}
}
实施后处理
最后，在此步骤中，我们对模型的输出进行后处理，选择置信度最高的结果并删除包含的值（用户已经喜欢的电影）。将以下代码复制到您的应用程序中。
推荐视图控制器.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 机器学习
- Firebase 分析
- 将分析事件导出到 BigQuery
- 预处理分析事件
- 训练推荐 TensorFlow 模型
- 导出模型并部署到 Firebase 控制台
- 在应用程序中提供电影推荐
下一步
- 在您的应用中实施 Firebase ML 建议。
了解更多
有一个问题？
报告问题