このページは Cloud Translation API によって翻訳されました。

TensorFlow Lite と Firebase を使用してアプリにオンデバイスのテキスト分類を追加する - iOS Codelab

1. 概要

TensorFlow Lite と Firebase によるテキスト分類の Codelab へようこそ。この Codelab では、TensorFlow Lite と Firebase を使用してテキスト分類モデルをトレーニングし、アプリにデプロイする方法を学びます。この Codelab は、この TensorFlow Lite の例に基づいています。

テキスト分類は、コンテンツに応じてテキストにタグまたはカテゴリを割り当てるプロセスです。これは、感情分析、トピックのラベル付け、スパム検出、インテント検出などの幅広いアプリケーションを持つ、自然言語処理（NLP）の基本的なタスクの一つです。

感情分析とは、テキスト分析技術を使用して、テキストデータ内の感情（ポジティブ、ネガティブ、ニュートラル）を解釈して分類することです。感情分析を使用すると、オンラインでの会話やフィードバックから、商品、ブランド、サービスに対する顧客の感情を特定できます。

このチュートリアルでは、感情分析用の機械学習モデルを構築する方法について説明します。具体的には、テキストをポジティブまたはネガティブに分類します。これは、バイナリ（2 クラス）分類の例です。これは、重要で広範囲に適用できる種類の ML 問題です。

学習内容

TF Lite Model Maker で TF Lite 感情分析モデルをトレーニングする
TF Lite モデルを Firebase ML にデプロイしてアプリからアクセスする
ユーザーフィードバックを追跡し、Firebase 向け Google アナリティクスでモデルの精度を測定する
Firebase Performance Monitoring を使用してモデルのパフォーマンスをプロファイリングする
デプロイされた複数のモデルの中から、Remote Config から読み込むモデルを選択する
Firebase A/B Testing でさまざまなモデルをテストする

必要なもの

Xcode 11 以降
CocoaPods 1.9.1 以降

このチュートリアルをどのように使用されますか？

通読のみ

通読して演習を行う

Android アプリの作成に関するご経験について、満足度をお知らせください。

<ph type="x-smartling-placeholder"></ph> 初心者

中級

上達

をご覧ください。

2. Firebase コンソールプロジェクトを作成する

プロジェクトに Firebase を追加する

Firebase コンソールに移動します。
[Create New Project] を選択し、プロジェクトに「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 プロジェクトのルートにドラッグします。

Podfile に Firebase を追加し、pod install を実行します。

pod 'FirebaseMLModelDownloader', '9.3.0-beta'

AppDelegate の didFinishLaunchingWithOptions メソッドで、ファイルの先頭に Firebase をインポートします。

import FirebaseCore

そして、Firebase を構成する呼び出しを追加します。

FirebaseApp.configure()

プロジェクトを再度実行して、アプリが正しく設定され、起動時にクラッシュしないことを確認します。

4. 感情分析モデルをトレーニングする

TensorFlow Lite Model Maker を使用してテキスト分類モデルをトレーニングし、指定されたテキストの感情を予測します。

このステップは、Google Colab で開くことができる Python ノートブックとして示されています。

Colab で開く

このステップが完了すると、TensorFlow Lite 感情分析モデルをモバイルアプリにデプロイする準備が整います。

5. モデルを Firebase ML にデプロイする

モデルを Firebase ML にデプロイする主な理由は 2 つあります。

アプリのインストールサイズを小さく抑え、必要な場合にのみモデルをダウンロードできる
モデルは定期的に、アプリ全体とは異なるリリースサイクルで更新できる

モデルは、コンソールから、または Firebase Admin SDK を使用してプログラムでデプロイできます。このステップでは、コンソールからデプロイします。

まず、Firebase コンソールを開き、左側のナビゲーションパネルで [Machine Learning] をクリックします。初めて開く場合は、[使ってみる] をクリックします。[カスタム]を選択します[モデルを追加]をクリックします] ボタンを離します。

プロンプトが表示されたら、モデルに sentiment_analysis という名前を付け、前の手順で Colab からダウンロードしたファイルをアップロードします。

6. Firebase ML からモデルをダウンロードする

TFLite モデルは比較的大きくなる可能性があるため、Firebase からアプリにリモートモデルをダウンロードするタイミングの選択は簡単ではありません。理想的には、アプリの起動時にモデルをすぐに読み込まないようにします。モデルが 1 つの機能にのみ使用され、ユーザーがその機能を使用しない場合は、無駄に大量のデータをダウンロードすることになります。また、ダウンロードオプション（Wi-Fi に接続されているときにのみモデルを取得するなど）を設定することもできます。ネットワーク接続がなくてもモデルを利用できるようにしたい場合は、アプリなしでもバックアップとしてモデルをバンドルすることが重要です。

わかりやすくするために、デフォルトのバンドルモデルを削除し、アプリの初回起動時には常に 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.swift の viewDidLoad で、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 Task Library を使用すると、数行のコードで 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 インスタンスを設定したら、1 回のメソッド呼び出しで感情分析を実行できます。

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 デバイスを接続し、Xcode ツールバーで [Run]（実行.png ）をクリックします。

アプリは、入力した映画レビューの感情を正しく予測できる必要があります。

分類結果画面.png

9. Firebase のその他の機能を使用してアプリを強化する

Firebase には、TFLite モデルのホスティング以外にも、ML のユースケースを強化するための機能がいくつか用意されています。

Firebase Performance Monitoring を使用して、ユーザーのデバイスで実行されているモデルの推論速度を測定できます。
Firebase アナリティクス: ユーザーの反応を測定して、モデルが本番環境でどれだけ優れているかを測定します。
Firebase A/B Testing を使用してモデルの複数のバージョンをテストする
前のセクションで、2 つのバージョンの TFLite モデルをトレーニングしたことを覚えていますか？A/B テストは、本番環境でのパフォーマンスが優れているバージョンを調べるのに適しています。

これらの機能をアプリで活用する方法について詳しくは、以下の Codelab をご覧ください。

10. 完了

この Codelab では、感情分析 TFLite モデルをトレーニングし、Firebase を使用してモバイルアプリにデプロイする方法を学びました。TFLite と Firebase の詳細については、他の TFLite サンプルと Firebase スタートガイドをご覧ください。

学習した内容

TensorFlow Lite
Firebase ML

次のステップ

Firebase Performance Monitoring を使用してモデルの推論速度を測定します。
Firebase ML Model Management API を介して、Colab から Firebase に直接モデルをデプロイする。
予測結果についてユーザーがフィードバックできるようにするメカニズムを追加し、Firebase アナリティクスを使用してユーザーフィードバックをトラッキングします。
Firebase A/B Testing を使用して、平均単語ベクトルモデルと MobileBERT モデルの A/B テストを実施します。

TensorFlow Lite と Firebase を使用してアプリにオンデバイスのテキスト分類を追加する - iOS Codelab

1. 概要

学習内容

必要なもの

このチュートリアルをどのように使用されますか？

Android アプリの作成に関するご経験について、満足度をお知らせください。

2. Firebase コンソールプロジェクトを作成する

プロジェクトに Firebase を追加する

3. サンプルプロジェクトを入手する

コードのダウンロード

Firebase を設定する

4. 感情分析モデルをトレーニングする

Colab で開く

5. モデルを Firebase ML にデプロイする

6. Firebase ML からモデルをダウンロードする

7. モデルをアプリに統合する

依存関係を追加する

テキスト分類器を初期化する

テキストを分類する

8. 最終的なアプリを実行する

9. Firebase のその他の機能を使用してアプリを強化する

10. 完了

学習した内容

次のステップ

詳細

質問がある場合

問題を報告する

TensorFlow Lite と Firebase を使用してアプリにオンデバイスのテキスト分類を追加する - iOS Codelab

1. 概要

学習内容

必要なもの

このチュートリアルをどのように使用されますか？

Android アプリの作成に関するご経験について、満足度をお知らせください。

2. Firebase コンソール プロジェクトを作成する

プロジェクトに Firebase を追加する

3. サンプル プロジェクトを入手する

コードのダウンロード

Firebase を設定する

4. 感情分析モデルをトレーニングする

Colab で開く

5. モデルを Firebase ML にデプロイする

6. Firebase ML からモデルをダウンロードする

7. モデルをアプリに統合する

依存関係を追加する

テキスト分類器を初期化する

テキストを分類する

8. 最終的なアプリを実行する

9. Firebase のその他の機能を使用してアプリを強化する

10. 完了

学習した内容

次のステップ

詳細

質問がある場合

問題を報告する

2. Firebase コンソールプロジェクトを作成する

3. サンプルプロジェクトを入手する