使用 TensorFlow Lite 和 Firebase 將裝置上文字分類新增至您的應用程式 - iOS Codelab

1. 概述

分類結果畫面.png

歡迎來到使用 TensorFlow Lite 和 Firebase 進行文字分類 Codelab。在此 Codelab 中,您將學習如何使用 TensorFlow Lite 和 Firebase 訓練文字分類模型並將其部署到您的應用程式。此 Codelab 基於此 TensorFlow Lite範例

文字分類是根據文字內容為其分配標籤或類別的過程。它是自然語言處理 (NLP) 的基本任務之一,具有廣泛的應用,例如情緒分析、主題標記、垃圾郵件檢測和意圖檢測。

情緒分析是使用文本分析技術對文本資料中的情緒(正面、負面和中性)進行解釋和分類。情緒分析使企業能夠在線上對話和回饋中識別客戶對產品、品牌或服務的情緒。

本教學展示如何建立用於情緒分析的機器學習模型,特別是將文字分類為正面或負面。這是二元分類(或二類分類)的一個範例,是一種重要且廣泛適用的機器學習問題。

你將學到什麼

  • 使用 TF Lite Model Maker 訓練 TF Lite 情緒分析模型
  • 將 TF Lite 模型部署到 Firebase ML 並從您的應用程式存取它們
  • 使用 Firebase Analytics 追蹤用戶回饋以衡量模型準確性
  • 透過 Firebase 效能監控分析模型效能
  • 選擇透過遠端配置載入多個部署模型中的哪一個
  • 透過 Firebase A/B 測試嘗試不同的模型

你需要什麼

  • Xcode 11(或更高版本)
  • CocoaPods 1.9.1(或更高版本)

您將如何使用本教學?

僅通讀一遍閱讀並完成練習

您如何評價您建立 Android 應用程式的體驗?

新手中間的精通

2.建立Firebase控制台項目

將 Firebase 新增到專案中

  1. 轉到Firebase 控制台
  2. 選擇“建立新專案”並將您的專案命名為“Firebase ML iOS Codelab”。

3. 取得範例項目

下載程式碼

首先克隆範例專案並在專案目錄中執行pod update

git clone https://github.com/FirebaseExtended/codelab-textclassification-ios.git
cd codelab-textclassification-ios
pod install --repo-update

如果您沒有安裝 git,您也可以從其 GitHub 頁面或點擊此連結下載範例專案。下載專案後,在 Xcode 中運行它並使用文字分類來了解它的工作原理。

設定 Firebase

依照文件建立新的 Firebase 專案。取得專案後,從Firebase 主機下載專案的GoogleService-Info.plist檔案並將其拖曳到 Xcode 專案的根目錄。

9efb62a92f27e939.png

將 Firebase 新增到您的 Podfile 並執行 pod install。

pod 'FirebaseMLModelDownloader', '9.3.0-beta'

AppDelegatedidFinishLaunchingWithOptions方法中,在檔案頂部匯入 Firebase

import FirebaseCore

並新增一個呼叫來配置 Firebase。

FirebaseApp.configure()

再次運行專案以確保應用程式配置正確並且在啟動時不會崩潰。

4. 訓練情緒分析模型

我們將使用 TensorFlow Lite Model Maker 訓練文字分類模型來預測給定文字的情緒。

此步驟以 Python 筆記本形式呈現,您可以在 Google Colab 中開啟。

在 Colab 中打開

完成此步驟後,您將擁有一個可以部署到行動應用程式的 TensorFlow Lite 情緒分析模型。

5. 將模型部署到 Firebase ML

將模型部署到 Firebase ML 非常有用,主要原因有兩個:

  1. 我們可以保持應用程式安裝較小,僅在需要時下載模型
  2. 該模型可以定期更新,並且發布週期與整個應用程式不同

此模型可以透過控制台部署,也可以使用 Firebase Admin SDK 以程式設計方式部署。在此步驟中,我們將透過控制台進行部署。

首先,打開Firebase 控制台並點擊左側導覽面板中的「機器學習」。如果您是第一次打開,請按一下「開始」。然後導航到“自訂”並點擊“新增模型”按鈕。

出現提示時,將模型命名sentiment_analysis並上傳您在上一個步驟中從 Colab 下載的檔案。

3c3c50e6ef12b3b.png

6. 從 Firebase ML 下載模型

選擇何時將遠端模型從 Firebase 下載到您的應用程式中可能很棘手,因為 TFLite 模型可能會變得相對較大。理想情況下,我們希望避免在應用程式啟動時立即載入模型,因為如果我們的模型僅用於一項功能並且用戶從不使用該功能,那麼我們將無緣無故地下載大量資料。我們還可以設定下載選項,例如僅在連接到 WiFi 時取得模型。如果您想確保模型即使在沒有網路連線的情況下也可用,那麼在沒有應用程式的情況下將其捆綁作為備份也很重要。

為了簡單起見,我們將刪除預設的捆綁模型,並在應用程式首次啟動時始終從 Firebase 下載模型。這樣,在執行情緒分析時,您可以確保推理是使用 Firebase 提供的模型運行的。

ModelLoader.swift的頂部,導入 Firebase 模組。

import FirebaseCore
import FirebaseMLModelDownloader

然後實施以下方法。

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))
          }
  }
}

ViewController.swiftviewDidLoad中,用我們的新模型下載方法取代對loadModel()的呼叫。

// Download the model from Firebase
print("Fetching model...")
ModelLoader.downloadModel(named: "sentiment_analysis") { (customModel, error) in
  guard let customModel = customModel else {
    if let error = error {
      print(error)
    }
    return
  }

  print("Model download complete")

  // TODO: Initialize an NLClassifier from the downloaded model
}

重新運行您的應用程式。幾秒鐘後,您應該在 Xcode 中看到一條日誌,指示遠端模型已成功下載。嘗試輸入一些文字並確認應用程式的行為沒有改變。

7. 將模型整合到您的應用程式中

Tensorflow Lite 任務庫可協助您只需幾行程式碼即可將 TensorFlow Lite 模型整合到您的應用程式中。我們將使用從 Firebase 下載的 TensorFlow Lite 模型初始化TFLNLClassifier實例。然後我們將使用它對應用程式使用者輸入的文字進行分類,並將結果顯示在 UI 上。

新增依賴

前往應用程式的 Podfile 並在應用程式的依賴項中新增 TensorFlow Lite 任務庫(文字)。確保在target 'TextClassification'聲明下新增依賴項。

pod 'TensorFlowLiteTaskText', '~> 0.2.0'

執行pod install以安裝新的依賴項。

初始化文字分類器

然後我們將使用任務庫的NLClassifier來載入從 Firebase 下載的情緒分析模型。

ViewController.swift

讓我們宣告一個 TFLNLClassifier 實例變數。在文件頂部,導入新的依賴項:

import TensorFlowLiteTaskText

在我們在上一步中修改的方法上方找到此註釋:

// TODO: Add a TFLNLClassifier property.

將 TODO 替換為以下程式碼:

private var classifier: TFLNLClassifier?

使用從 Firebase 下載的情緒分析模型初始化textClassifier變數。找到我們在上一步中添加的這條評論:

// TODO: Initialize an NLClassifier from the downloaded model

將 TODO 替換為以下程式碼:

let options = TFLNLClassifierOptions()
self.classifier = TFLNLClassifier.nlClassifier(modelPath: customModel.path, options: options)

對文本進行分類

設定classifier實例後,您可以透過單一方法呼叫來執行情緒分析。

ViewController.swift

classify(text:)方法中,找到TODO註解:

// TODO: Run sentiment analysis on the input text

將註解替換為以下程式碼:

guard let classifier = self.classifier else { return }

// Classify the text
let classifierResults = classifier.classify(text: text)

// Append the results to the list of results
let result = ClassificationResult(text: text, results: classifierResults)
results.append(result)

8. 運行最終的應用程式

您已將情緒分析模型整合到應用程式中,所以我們來測試一下。連接您的 iOS 設備,然後按一下執行( 執行.png )在 Xcode 工具列中。

該應用程式應該能夠正確預測您輸入的電影評論的情緒。

分類結果畫面.png

9. 使用更多 Firebase 功能為應用程式提供支持

除了託管您的 TFLite 模型之外,Firebase 還提供了其他幾個功能來增強您的機器學習用例:

  • Firebase 效能監控,用於測量在使用者裝置上運行的模型推理速度。
  • Firebase Analytics 透過測量使用者反應來衡量模型在生產中的表現如何。
  • Firebase A/B 測試可測試模型的多個版本
  • 您還記得我們之前訓練了兩個版本的 TFLite 模型嗎? A/B 測試是找出哪個版本在生產上表現較好的好方法!

要了解有關如何在應用程式中利用這些功能的更多信息,請查看以下程式碼實驗室:

10. 恭喜!

在此 Codelab 中,您學習如何訓練情緒分析 TFLite 模型並使用 Firebase 將其部署到您的行動應用程式。要了解有關 TFLite 和 Firebase 的更多信息,請查看其他 TFLite範例和 Firebase入門指南。

我們涵蓋的內容

  • TensorFlow Lite
  • Firebase 機器學習

下一步

  • 使用 Firebase 效能監控衡量模型推理速度。
  • 透過 Firebase ML 模型管理 API 將模型從 Colab 直接部署到 Firebase。
  • 新增允許使用者回饋預測結果的機制,並使用 Firebase Analytics 追蹤使用者回饋。
  • 使用 Firebase A/B 檢定對平均詞向量模型和 MobileBERT 模型進行 A/B 測試。

了解更多

有一個問題?

報告問題