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

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

1. 概要

テキスト分類結果.png

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

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

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

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

学習内容

TF Lite Model Maker で TF Lite 感情分析モデルをトレーニングする
TF Lite モデルを Firebase ML にデプロイしてアプリからアクセスする
TF Lite Task Library を使用して TF Lite 感情分析モデルをアプリに統合する

必要なもの

Android Studio の最新バージョン。
サンプルコード。
Android 5.0 以降および Google Play 開発者サービス 9.8 以降を搭載したテストデバイス、または Google Play 開発者サービス 9.8 以降を搭載したエミュレータ
デバイスを使用する場合は接続ケーブル。

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

通読のみ

通読して演習を行う

Android アプリ作成のご経験についてお答えください。

初心者

中級者

上級者

2. サンプルコードを取得する

コマンドラインから GitHub リポジトリのクローンを作成します。

$ git clone https://github.com/FirebaseExtended/codelab-textclassification-android.git

git がインストールされていない場合は、GitHub ページから、またはこちらのリンクをクリックして、サンプルプロジェクトをダウンロードすることもできます。

3. スターターアプリをインポートする

Android Studio で、サンプルコードのダウンロードから codelab-textclassification-android-master ディレクトリ（）を選択します（[File] > [Open] > .../codelab-textclassification-android-master/start）。

Android Studio で開始プロジェクトが開かれているはずです。

4. スターターアプリを実行する

これで Android Studio にプロジェクトがインポートされたので、アプリを初めて実行する準備が整いました。Android デバイスを接続し、Android Studio ツールバーの [実行]（）をクリックします。

デバイスでアプリが起動するはずです。含まれているのは、次のステップでテキスト分類モデルを簡単に統合してテストできるシンプルな UI のみです。この時点で感情を予測しようとすると、アプリは一部のダミーの結果のみを返します。

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

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

Firebase コンソールに移動します。
[プロジェクトを追加] を選択します。
プロジェクト名を選択または入力します。
Firebase コンソールで残りの設定手順を実施した後、[プロジェクトを作成]（既存の Google プロジェクトを使用する場合は [Firebase を追加]）をクリックします。

6. アプリに Firebase を追加する

新しいプロジェクトの概要画面で、Android アイコンをクリックして設定ワークフローを起動します。
Codelab のパッケージ名（org.tensorflow.lite.codelabs.textclassification）を入力します。

アプリに google-services.json ファイルを追加する

パッケージ名を追加して [登録] を選択したら、[google-services.json をダウンロード] をクリックして Firebase Android 構成ファイルを取得し、google-services.json ファイルをプロジェクトの *app* ディレクトリにコピーします。

アプリに google-services プラグインを追加する

Firebase コンソールの指示に沿って build.gradle.kts ファイルを更新し、アプリに Firebase を追加します。

google-services プラグインは、google-services.json ファイルを使用して、Firebase を使用するようにアプリケーションを構成します。

プロジェクトと Gradle ファイルを同期する

すべての依存関係がアプリで使用可能であることを確認するには、この時点でプロジェクトを Gradle ファイルと同期する必要があります。Android Studio のツールバーで、[File] > [Sync Project with Gradle Files] を選択します。

7. Firebase でアプリを実行する

JSON ファイルで google-services プラグインを構成したので、Firebase でアプリを実行する準備ができました。Android デバイスを接続し、Android Studio ツールバーの [実行]（実行.png ）をクリックします。

デバイスでアプリが起動するはずです。この時点で、アプリは正常にビルドされるはずです。

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

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

このステップは、Google Colab で開くことができる Python ノートブックとして示されています。[ランタイム >Run all: すべてのノートブックを一度に実行します。

Colab で開く

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

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

Firebase ML へのモデルのデプロイは、主に次の 2 つの理由で有用です。

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

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

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

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

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

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

簡素化のため、デフォルトのバンドルモデルを削除し、アプリが初めて起動したときに常に Firebase からモデルをダウンロードします。これにより、感情分析を実行するときに、Firebase から提供されるモデルで推論が実行されていることを確認できます。

app/build.gradle.kts ファイルに Firebase Machine Learning の依存関係を追加します。

app/build.gradle.kts

次のコメントを見つけます。

// TODO 1: Add Firebase ML dependency

次に、次のパラメータを追加します。

implementation(platform("com.google.firebase:firebase-bom:32.0.0"))
implementation("com.google.firebase:firebase-ml-modeldownloader:24.1.2")

Android Studio でプロジェクトの同期を求められたら、[Sync Now] を選択します。

次に、Firebase からモデルをダウンロードするためのコードを追加します。

MainActivity.java

このコメントを検索:

// TODO 2: Implement a method to download TFLite model from Firebase

次を追加します。

  /** Download model from Firebase ML. */
  private synchronized void downloadModel(String modelName) {
      CustomModelDownloadConditions conditions = new CustomModelDownloadConditions.Builder()
            .requireWifi()
            .build();
      FirebaseModelDownloader.getInstance()
              .getModel("sentiment_analysis", DownloadType.LOCAL_MODEL, conditions)
              .addOnSuccessListener(model -> {
                  try {
                      // TODO 6: Initialize a TextClassifier with the downloaded model

                      predictButton.setEnabled(true);
                  } catch (IOException e) {
                      Log.e(TAG, "Failed to initialize the model. ", e);
                      Toast.makeText(
                              MainActivity.this,
                              "Model initialization failed.",
                              Toast.LENGTH_LONG)
                              .show();
                      predictButton.setEnabled(false);
                  }
              })
              .addOnFailureListener(e -> {
                      Log.e(TAG, "Failed to download the model. ", e);
                      Toast.makeText(
                              MainActivity.this,
                              "Model download failed, please check your connection.",
                              Toast.LENGTH_LONG)
                              .show();

                      }
              );

}

次に、アクティビティの onCreate メソッドで downloadModel メソッドを呼び出します。

MainActivity.java

このコメントを検索:

// TODO 3: Call the method to download TFLite model

次に、次のパラメータを追加します。

downloadModel("sentiment_analysis");

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

Tensorflow Lite Task Library を使用すると、数行のコードで TensorFlow Lite モデルをアプリに統合できます。Firebase からダウンロードした TensorFlow Lite モデルを使用して NLClassifier インスタンスを初期化します。その後、これを使用してアプリユーザーからのテキスト入力を分類し、結果を UI に表示します。

依存関係を追加する

アプリの Gradle ファイルに移動し、アプリの依存関係に TensorFlow Lite タスクライブラリ（Text）を追加します。

app/build.gradle

このコメントを検索:

// TODO 4: Add TFLite Task API (Text) dependency

次に、次のパラメータを追加します。

implementation("org.tensorflow:tensorflow-lite-task-text:0.3.0")

Android Studio でプロジェクトの同期を求められたら、[Sync Now] を選択します。

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

次に、Task Library の NLClassifier を使用して、Firebase からダウンロードした感情分析モデルを読み込みます。

MainActivity.java

NLClassifier インスタンス変数を宣言しましょう。次のコメントを見つけます。

// TODO 5: Define a NLClassifier variable

次に、次のパラメータを追加します。

private NLClassifier textClassifier;

Firebase からダウンロードした感情分析モデルを使用して textClassifier 変数を初期化します。次のコメントを見つけます。

// TODO 6: Initialize a TextClassifier with the downloaded model

次を追加します。

textClassifier = NLClassifier.createFromFile(model.getFile());

テキストの分類

textClassifier インスタンスを設定したら、1 回のメソッド呼び出しで感情分析を実行できます。

MainActivity.java

このコメントを検索:

// TODO 7: Run sentiment analysis on the input text

次に、次のパラメータを追加します。

List<Category> results = textClassifier.classify(text);

後処理を実装する

最後に、モデルの出力をわかりやすいテキストに変換して画面に表示します。

MainActivity.java

次のコメントを見つけます。

// TODO 8: Convert the result to a human-readable text

ダミーの結果テキストを生成するコードを削除します。

String textToShow = "Dummy classification result.\n";

次を追加します。

String textToShow = "Input: " + text + "\nOutput:\n";
for (int i = 0; i < results.size(); i++) {
  Category result = results.get(i);
  textToShow += String.format("    %s: %s\n", result.getLabel(),
                              result.getScore());
}
textToShow += "---------\n";

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

感情分析モデルをアプリに統合したので、テストしてみましょう。Android デバイスを接続して、Android Studio ツールバーの実行アイコン（）をクリックします。

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

img/text-classification-result.png

13. より多くの Firebase 機能でアプリをパワーアップ

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

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

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

14. 完了

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

学習した内容

TensorFlow Lite
Firebase ML

次のステップ

Firebase Performance Monitoring を使用してモデルの推論速度を測定します。
Firebase ML Model Management API を介して、Colab から Firebase に直接モデルをデプロイする。
ユーザーが予測結果に関するフィードバックを提供できるメカニズムを追加し、Firebase 向け Google アナリティクスを使用してユーザーのフィードバックを追跡します。
Firebase A/B Testing を使用して、Average Word Vector モデルと MobileBERT モデルの A/B テストを実施します。

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

1. 概要

学習内容

必要なもの

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

Android アプリ作成のご経験についてお答えください。

2. サンプルコードを取得する

3. スターターアプリをインポートする

4. スターターアプリを実行する

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

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

6. アプリに Firebase を追加する

アプリに google-services.json ファイルを追加する

アプリに google-services プラグインを追加する

プロジェクトと Gradle ファイルを同期する

7. Firebase でアプリを実行する

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

Colab で開く

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

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

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

依存関係を追加する

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

テキストの分類

後処理を実装する

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

13. より多くの Firebase 機能でアプリをパワーアップ

14. 完了

学習した内容

次のステップ

詳細

質問がある場合

問題を報告する

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

1. 概要

学習内容

必要なもの

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

Android アプリ作成のご経験についてお答えください。

2. サンプルコードを取得する

3. スターター アプリをインポートする

4. スターター アプリを実行する

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

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

6. アプリに Firebase を追加する

アプリに google-services.json ファイルを追加する

アプリに google-services プラグインを追加する

プロジェクトと Gradle ファイルを同期する

7. Firebase でアプリを実行する

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

Colab で開く

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

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

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

依存関係を追加する

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

テキストの分類

後処理を実装する

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

13. より多くの Firebase 機能でアプリをパワーアップ

14. 完了

学習した内容

次のステップ

詳細

質問がある場合

問題を報告する

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

3. スターターアプリをインポートする

4. スターターアプリを実行する

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