Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

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

1. 概要

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

テキスト分類とは、テキストの内容に応じてタグやカテゴリを割り当てるプロセスです。感情分析、トピックのラベリング、スパム検出、インテント検出など、幅広い用途で活用できる自然言語処理（NLP）の基本的なタスクの 1 つです。

感情分析とは、テキスト分析の手法を使用して、テキストデータ内の感情（ポジティブ、ネガティブ、ニュートラル）を解釈して分類することです。感情分析により、企業はオンラインでの会話やフィードバックで、プロダクト、ブランド、サービスに対する顧客の感情を把握できます。

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

学習内容

TF Lite Model Maker を使用して TF Lite 感情分析モデルをトレーニングする
TF Lite モデルを Firebase ML にデプロイし、アプリからアクセスする
TF Lite タスクライブラリを使用して 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 のツールバーで [Run]（）をクリックします。

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

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

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

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

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

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

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

パッケージ名を追加して [Register] を選択したら、[**Download 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 のツールバーで [Run]（）をクリックします。

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

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

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

このステップは、Google Colab で開くことができる Python ノートブックとして示されています。[Runtime > Run all ] を選択すると、ノートブック全体を一度に実行できます。

Colab で開く

このステップを完了すると、モバイルアプリにデプロイできる TensorFlow Lite 感情分析モデルが作成されます。

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

Firebase ML にモデルをデプロイすると、主に次の 2 つのメリットがあります。

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

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

まず、[Firebase Console] を開き、左側のナビゲーションパネルで [Machine Learning] をクリックします。初めて開く場合は、[使ってみる] をクリックします。[Custom] に移動し、[Add model] ボタンをクリックします。

プロンプトが表示されたら、モデルに 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 タスクライブラリを使用すると、わずか数行のコードで TensorFlow Lite モデルをアプリに統合できます。Firebase からダウンロードした TensorFlow Lite モデルを使用して NLClassifier インスタンスを初期化します。次に、これを使用してアプリユーザーからのテキスト入力を分類し、結果を UI に表示します。

依存関係を追加する

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

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] を選択します。

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

次に、タスクライブラリの 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 のツールバーで [Run]（）をクリックします。

入力した映画レビューの感情を正しく予測できるはずです。

img/text-classification-result.png

13. Firebase のその他の機能でアプリを強化する

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

Firebase Performance Monitoring - ユーザーのデバイスで実行されているモデルの推論速度を測定します。
Firebase 向け Google アナリティクス - ユーザーの反応を測定して、本番環境でのモデルのパフォーマンスを測定します。
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 コンソールプロジェクトを作成する