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

TensorFlow Lite と Firebase を使用してアプリにおすすめを追加する - Android Codelab

1. 概要

TensorFlow Lite と Firebase によるおすすめ機能の Codelab へようこそ。この Codelab では、TensorFlow Lite と Firebase を使用してレコメンデーションモデルをアプリにデプロイする方法を学びます。この Codelab は、こちらの TensorFlow Lite の例に基づいています。

おすすめを使用すると、アプリは機械学習を使用して、各ユーザーに最も関連性の高いコンテンツをインテリジェントに提供できます。多数の他のユーザーの全体的な行動でトレーニングされたモデルを使用して、過去のユーザーの行動を考慮して、そのユーザーが今後利用したいと思うアプリのコンテンツを提案します。

このチュートリアルでは、Firebase アナリティクスを使用してアプリのユーザーからデータを取得し、そのデータからレコメンデーション用の ML モデルを構築し、そのモデルを Android アプリで使用して推論を実行し、レコメンデーションを取得する方法について説明します。具体的には、ユーザーが過去に高く評価した映画のリストに基づき、視聴する可能性が高い映画を提案します。

学習内容

Firebase 向け Google アナリティクスを Android アプリに統合してユーザーの行動データを収集する
そのデータを Google BigQuery にエクスポートする
データを前処理して TF Lite レコメンデーションモデルをトレーニングする
TF Lite モデルを Firebase ML にデプロイし、アプリからアクセスする
モデルを使用してデバイス上の推論を実行し、ユーザーにおすすめを表示する

必要なもの

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

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

通読のみ

通読して演習を行う

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

初心者

中級者

上級者

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

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

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

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

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

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

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

新しいプロジェクトを作成する

Firebase コンソールに移動します。
[プロジェクトを追加] を選択します（最初に選択した場合は [プロジェクトを作成] を選択します）。
プロジェクト名を選択または入力し、[続行] をクリックします。
[このプロジェクトで Google アナリティクスを有効にする] が有効になっていることを確認します。
Firebase コンソールで残りの設定手順を行い、[プロジェクトを作成]（既存の Google プロジェクトを使用する場合は [Firebase を追加]）をクリックします。

5. Firebase を追加する

新しいプロジェクトの概要画面で、Android アイコンをクリックして設定ワークフローを起動します。
Codelab のパッケージ名（com.google.firebase.codelabs.recommendations）を入力します。
[アプリの登録] を選択します。

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

パッケージ名を追加して [登録] を選択したら、[google-services.json をダウンロード] をクリックして Firebase Android 構成ファイルを入手し、google-services.json ファイルをプロジェクトの app ディレクトリにコピーします。ファイルがダウンロードされたら、コンソールに表示される次のステップをスキップできます（build-android-start プロジェクトですでに実行されています）。

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

google-services プラグインは、google-services.json ファイルを使用して、Firebase を使用するようにアプリを構成します。プロジェクトの build.gradle.kts ファイルに次の行がすでに追加されているはずです（チェックして確認してください）。

app/build.grade.kts

plugins {
    id("com.google.gms.google-services")
}

build.grade.kts

plugins {
    id("com.google.gms.google-services") version "4.3.15" apply false
}

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

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

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

これで、プロジェクトを Android Studio にインポートし、JSON ファイルで google-services プラグインを設定できました。これで、アプリを初めて実行する準備ができました。Android デバイスを接続し、Android Studio ツールバーの [実行]（）をクリックします。

デバイスでアプリが起動するはずです。この時点で、映画のリストを含むタブ、[高評価の映画] タブ、[おすすめ] タブが表示される、機能するアプリが完成しています。映画のリストで映画をクリックすると、高評価リストに追加できます。Codelab の残りの手順を完了すると、[おすすめ] タブで映画のレコメンデーションを生成できるようになります。

7. アプリに Firebase 向け Google アナリティクスを追加する

このステップでは、Firebase Analytics をアプリに追加して、ユーザー行動データ（この場合は、ユーザーが気に入っている映画）を記録します。このデータは、今後のステップでレコメンデーションモデルをトレーニングするために集約して使用されます。

Firebase 部品構成表とアナリティクスの依存関係を追加する

Firebase アナリティクスをアプリに追加するには、次の依存関係が必要です。これらの依存関係は、app/build.gradle.kts ファイルにすでに含まれている必要があります（確認してください）。

app/build.grade.kts

implementation(platform("com.google.firebase:firebase-bom:32.0.0"))
implementation("com.google.firebase:firebase-analytics-ktx")

アプリで Firebase アナリティクスを設定する

LikedMoviesViewModel には、ユーザーがお気に入りに登録した映画を保存する関数が含まれています。ユーザーが新しい映画を気に入るたびに、分析ログイベントも送信して、その高評価を記録する必要があります。

ユーザーが映画の「高評価」をクリックしたときにアナリティクスイベントを登録するには、次のコードで onMovieLiked 関数を追加します。

LikedMoviesViewModel.kt

import com.google.firebase.analytics.FirebaseAnalytics
import com.google.firebase.analytics.ktx.analytics
import com.google.firebase.analytics.ktx.logEvent
import com.google.firebase.ktx.Firebase


class LikedMoviesViewModel internal constructor (application: Application) : AndroidViewModel(application) {

    ...

    fun onMovieLiked(movie: Movie) {
        movies.setLike(movie, true)
        logAnalyticsEvent(movie.id.toString())
    }
       
}

次のフィールドと関数を追加して、映画がユーザーの高評価リストに追加されたときにアナリティクスイベントをログに記録します。

LikedMoviesViewModel.kt

import com.google.firebase.analytics.FirebaseAnalytics
import com.google.firebase.analytics.ktx.analytics
import com.google.firebase.analytics.ktx.logEvent
import com.google.firebase.ktx.Firebase


class LikedMoviesViewModel internal constructor (application: Application) : AndroidViewModel(application) {
    ...
    private val firebaseAnalytics = Firebase.analytics

    ...

    /**
     * Logs an event in Firebase Analytics that is used in aggregate to train the recommendations
     * model.
     */
    private fun logAnalyticsEvent(id: String) {
        firebaseAnalytics.logEvent(FirebaseAnalytics.Event.SELECT_ITEM) {
            param(FirebaseAnalytics.Param.ITEM_ID, id)
        }
    }

8. アナリティクスとの統合をテストする

このステップでは、アプリでアナリティクスイベントを生成し、Firebase コンソールに送信されていることを確認します。

アナリティクスのデバッグロギングを有効にする

Firebase Analytics は、ユーザーのバッテリー駆動時間を最大化するように設計されており、デバイス上でイベントを一括処理し、Firebase に送信するのはごくまれです。デバッグ目的で、この動作を無効にして、イベントがリアルタイムでロギングされるようにするには、シェルで次のコマンドを実行します。

ターミナル

adb shell setprop debug.firebase.analytics.app com.google.firebase.codelabs.recommendations

アナリティクスイベントが生成されていることを確認する

Android Studio で Logcat ウィンドウを開き、アプリからのロギングを確認します。
Logcat フィルタを文字列「Logging event」に設定します。
"select_item" がアナリティクスイベントは、アプリで映画を高く評価するたびに生成されます。

これで、Firebase Analytics がアプリに正常に統合されました。ユーザーがアプリを使用して映画に高評価を付けると、高評価が集計されて記録されます。この Codelab の残りの部分では、この集計データを使用してレコメンデーションモデルをトレーニングします。次の手順は省略可能です。Logcat で確認したアナリティクスイベントが Firebase コンソールにもストリーミングされるようにします。次のページに進んでいただいても構いません。

省略可: Firebase コンソールでアナリティクスイベントを確認する

Firebase コンソールに移動します。
[Analytics] で [DebugView] を選択する
Android Studio で [Run] を選択してアプリを起動し、高く評価したリストに映画を追加します。
Firebase コンソールの DebugView で、アプリに映画を追加したときにこれらのイベントがログに記録されていることを確認します。

9. アナリティクスのデータを BigQuery にエクスポートする

BigQuery は、大量のデータを検証して処理できる Google Cloud プロダクトです。このステップでは、Firebase コンソールプロジェクトを BigQuery に接続して、アプリで生成されたアナリティクスデータが BigQuery に自動的にエクスポートされるようにします。

BigQuery エクスポートを有効にする

Firebase コンソールに移動します。
[Project Overview] の横にある設定の歯車アイコンを選択し、[Project settings] を選択します。
[Integrations] タブを選択します。
BigQuery ブロック内の [Link]（または [Manage]）を選択します。
[Firebase と BigQuery のリンクについて] の手順で [次へ] を選択します。
[統合を設定] セクションで、スイッチをクリックして Google アナリティクスデータの送信を有効にし、[BigQuery にリンク] を選択します。

これで、Firebase コンソールプロジェクトから Firebase Analytics イベントデータを BigQuery に自動的に送信できるようになりました。この処理はそれ以上の操作なしで自動的に行われますが、BigQuery に分析データセットを作成する最初のエクスポートは 24 時間行われない場合があります。データセットが作成されると、Firebase は新しいアナリティクスイベントを BigQuery のイントラデイテーブルに継続的にエクスポートし、過去の日付のイベントをイベントテーブルにグループ化します。

レコメンデーションモデルをトレーニングするには、大量のデータが必要です。大量のデータを生成するアプリはまだないため、次のステップでは、サンプルデータセットを BigQuery にインポートして、このチュートリアルの残りの部分で使用します。

10. BigQuery を使用してモデルトレーニングデータを取得する

これで、Firebase コンソールを BigQuery にエクスポートするように接続できたので、しばらくするとアプリ解析イベントデータが BigQuery コンソールに自動的に表示されます。このチュートリアルで使用する初期データを取得するため、このステップでは、既存のサンプルデータセットを BigQuery コンソールにインポートして、おすすめモデルのトレーニングに使用します。

サンプルデータセットを BigQuery にインポートする

Google Cloud コンソールで BigQuery ダッシュボードに移動します。
メニューでプロジェクト名を選択します。
BigQuery の左側のナビゲーションの下部にあるプロジェクト名を選択して、詳細を表示します。
[データセットを作成] を選択してデータセット作成パネルを開きます。
[データセット ID] に「firebase_recommendations_dataset」と入力し、[データセットを作成] を選択します。
新しいデータセットが左側のメニューのプロジェクト名の下に表示されます。これをクリックします。
[テーブルを作成] を選択してテーブル作成パネルを開きます。
[テーブルの作成元] で [Google Cloud Storage] を選択します。
[GCS バケットからファイルを選択] フィールドに「gs://firebase-recommendations/recommendations-test/formatted_data_filtered.txt」と入力します。
[JSONL] を選択[ファイル形式] プルダウンを選択します。
「recommendations_table」と入力します。[Table name] に入力します。
[スキーマ] > [自動検出] > [スキーマと入力パラメータ] のチェックボックスをオンにします。
[テーブルを作成] を選択します。

サンプルデータセットを調べる

この時点で、必要に応じてスキーマを調べて、このデータセットをプレビューできます。

左側のメニューで [firebase-recommendations-dataset] を選択して、含まれているテーブルを開きます。
recommendations-table テーブルを選択して、テーブルスキーマを表示します。
[プレビュー] を選択すると、このテーブルに含まれる実際のアナリティクスイベントデータが表示されます。

サービスアカウントの認証情報を作成する

次に、Google Cloud コンソールプロジェクトでサービスアカウントの認証情報を作成します。この認証情報を、次のステップの Colab 環境で BigQuery データへのアクセスと読み込みに使用できます。

Google Cloud プロジェクトの課金が有効になっていることを確認します。
BigQuery API と BigQuery Storage API API を有効にします。<こちらをクリック>
[サービスアカウントキーの作成] ページに移動します。
[サービスアカウント] リストから [新しいサービスアカウント] を選択します。
[サービスアカウント名] フィールドに名前を入力します。
[役割] リストで、[プロジェクト] > [オーナー] を選択します。
[作成] をクリックします。キーを含む JSON ファイルがパソコンにダウンロードされます。

次のステップでは、Google Colab を使用してこのデータを前処理し、おすすめモデルをトレーニングします。

11. データの前処理とレコメンデーションモデルのトレーニング

この手順では、Colab ノートブックを使用して次の操作を行います。

BigQuery データを Colab ノートブックにインポートする
データを前処理してモデルのトレーニング用に準備する
アナリティクスデータでレコメンデーションモデルをトレーニングする
モデルを TF Lite モデルとしてエクスポートします。
モデルを Firebase コンソールにデプロイして、アプリで使用できるようにする

Colab トレーニングノートブックをリリースする前に、まず Firebase Model Management API を有効にして、Colab がトレーニング済みモデルを Firebase コンソールにデプロイできるようにします。

Firebase Model Management API を有効にする

ML モデルを保存するバケットを作成する

Firebase コンソールで [Storage] に移動し、[始める] をクリックします。

ダイアログに沿ってバケットを設定します。

Firebase ML API を有効にする

Google Cloud コンソールの Firebase ML API ページに移動し、[有効にする] をクリックします。

Colab ノートブックを使用してモデルをトレーニングし、デプロイする

次のリンクを使用して Colab ノートブックを開き、以下の手順に沿って操作します。Colab ノートブックの手順を完了すると、アプリに同期できる TF Lite モデルファイルが Firebase コンソールにデプロイされます。

Colab で開く

12. アプリにモデルをダウンロードする

このステップでは、先ほどトレーニングしたモデルを Firebase Machine Learning からダウンロードするようにアプリを変更します。

Firebase ML の依存関係を追加する

アプリで Firebase ML モデルを使用するには、次の依存関係が必要です。すでに追加されているはずです（確認）。

app/build.grade.kts

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

Firebase Model Manager API を使用してモデルをダウンロードする

次のコードを RecommendationClient.kt にコピーして、モデルのダウンロードが行われる条件を設定し、リモートモデルをアプリと同期するダウンロードタスクを作成します。

RecommendationClient.kt

    private fun downloadModel(modelName: String) {
        val conditions = CustomModelDownloadConditions.Builder()
            .requireWifi()
            .build()
        FirebaseModelDownloader.getInstance()
            .getModel(modelName, DownloadType.LOCAL_MODEL, conditions)
            .addOnCompleteListener {
                if (!it.isSuccessful) {
                    showToast(context, "Failed to get model file.")
                } else {
                    showToast(context, "Downloaded remote model: $modelName")
                    GlobalScope.launch { initializeInterpreter(it.result) }
                }
            }
            .addOnFailureListener {
                showToast(context, "Model download failed for recommendations, please check your connection.")
            }
    }

13. Tensorflow Lite レコメンデーションモデルをアプリに統合する

Tensorflow Lite ランタイムを使用すると、アプリでモデルを使用してレコメンデーションを生成できます。前の手順では、ダウンロードしたモデルファイルを使用して TFlite インタープリタを初期化しました。このステップでは、まず推論ステップでモデルに付随する辞書とラベルを読み込みます。次に、モデルへの入力を生成する前処理と、推論から結果を抽出する後処理を追加します。

辞書とラベルを読み込む

レコメンデーションモデルによるレコメンデーション候補の生成に使用されるラベルは、res/assets フォルダの sorted_movie_vocab.json ファイルに記載されています。次のコードをコピーして、これらの候補を読み込みます。

RecommendationClient.kt

    /** Load recommendation candidate list.  */
    private suspend fun loadCandidateList() {
        return withContext(Dispatchers.IO) {
            val collection = MovieRepository.getInstance(context).getContent()
            for (item in collection) {
                candidates[item.id] = item
            }
            Log.v(TAG, "Candidate list loaded.")
        }
    }

前処理の実装

前処理のステップでは、モデルの想定と一致するように入力データの形式を変更します。ここでは、ユーザーの高評価がまだ十分に生成されていない場合は、入力の長さをプレースホルダ値で埋めます。以下のコードをコピーします。

RecommendationClient.kt

    /** Given a list of selected items, preprocess to get tflite input.  */
    @Synchronized
    private suspend fun preprocess(selectedMovies: List<Movie>): IntArray {
        return withContext(Dispatchers.Default) {
            val inputContext = IntArray(config.inputLength)
            for (i in 0 until config.inputLength) {
                if (i < selectedMovies.size) {
                    val (id) = selectedMovies[i]
                    inputContext[i] = id
                } else {
                    // Padding input.
                    inputContext[i] = config.pad
                }
            }
            inputContext
        }
    }

インタープリタを実行して推奨事項を生成する

ここでは、前のステップでダウンロードしたモデルを使用して、前処理済みの入力に対して推論を実行します。モデルの入力と出力のタイプを設定し、推論を実行して映画のレコメンデーションを生成します。次のコードをアプリにコピーします。

RecommendationClient.kt

    /** Given a list of selected items, and returns the recommendation results.  */
    @Synchronized
    suspend fun recommend(selectedMovies: List<Movie>): List<Result> {
        return withContext(Dispatchers.Default) {
            val inputs = arrayOf<Any>(preprocess(selectedMovies))

            // Run inference.
            val outputIds = IntArray(config.outputLength)
            val confidences = FloatArray(config.outputLength)
            val outputs: MutableMap<Int, Any> = HashMap()
            outputs[config.outputIdsIndex] = outputIds
            outputs[config.outputScoresIndex] = confidences
            tflite?.let {
                it.runForMultipleInputsOutputs(inputs, outputs)
                postprocess(outputIds, confidences, selectedMovies)
            } ?: run {
                Log.e(TAG, "No tflite interpreter loaded")
                emptyList()
            }
        }
    }

ポスト処理を実装する

最後に、モデルからの出力を後処理して、信頼度が最も高い結果を選択し、含まれる値（ユーザーがすでに高く評価している映画）を削除します。アプリに次のコードをコピーします。

RecommendationClient.kt

    /** Postprocess to gets results from tflite inference.  */
    @Synchronized
    private suspend fun postprocess(
        outputIds: IntArray, confidences: FloatArray, selectedMovies: List<Movie>
    ): List<Result> {
        return withContext(Dispatchers.Default) {
            val results = ArrayList<Result>()

            // Add recommendation results. Filter null or contained items.
            for (i in outputIds.indices) {
                if (results.size >= config.topK) {
                    Log.v(TAG, String.format("Selected top K: %d. Ignore the rest.", config.topK))
                    break
                }
                val id = outputIds[i]
                val item = candidates[id]
                if (item == null) {
                    Log.v(TAG, String.format("Inference output[%d]. Id: %s is null", i, id))
                    continue
                }
                if (selectedMovies.contains(item)) {
                    Log.v(TAG, String.format("Inference output[%d]. Id: %s is contained", i, id))
                    continue
                }
                val result = Result(
                    id, item,
                    confidences[i]
                )
                results.add(result)
                Log.v(TAG, String.format("Inference output[%d]. Result: %s", i, result))
            }
            results
        }
    }

アプリをテストする

アプリを再実行します。映画をいくつか選択すると、新しいモデルが自動的にダウンロードされ、おすすめの生成が開始されます。

14. 完了

TensorFlow Lite と Firebase を使用して、アプリにおすすめ機能を構築しました。この Codelab で説明する手法とパイプラインは一般化でき、他のタイプのおすすめコンテンツの提供にも使用できます。

学習した内容

Firebase ML
Firebase アナリティクス
アナリティクスイベントを BigQuery にエクスポートする
アナリティクスイベントを事前処理する
レコメンデーション TensorFlow モデルのトレーニング
モデルをエクスポートして Firebase コンソールにデプロイする
アプリで映画のおすすめを提供する

次のステップ

Firebase ML の推奨事項をアプリに実装します。

TensorFlow Lite と Firebase を使用してアプリにおすすめを追加する - Android Codelab

1. 概要

学習内容

必要なもの

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

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

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

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

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

新しいプロジェクトを作成する

5. Firebase を追加する

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

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

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

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

7. アプリに Firebase 向け Google アナリティクスを追加する

Firebase 部品構成表とアナリティクスの依存関係を追加する

8. アナリティクスとの統合をテストする

アナリティクスのデバッグ ロギングを有効にする

アナリティクス イベントが生成されていることを確認する

省略可: Firebase コンソールでアナリティクス イベントを確認する

9. アナリティクスのデータを BigQuery にエクスポートする

BigQuery エクスポートを有効にする

10. BigQuery を使用してモデル トレーニング データを取得する

サンプル データセットを BigQuery にインポートする

サンプル データセットを調べる

サービス アカウントの認証情報を作成する

11. データの前処理とレコメンデーション モデルのトレーニング

Firebase Model Management API を有効にする

ML モデルを保存するバケットを作成する

Firebase ML API を有効にする

Colab ノートブックを使用してモデルをトレーニングし、デプロイする

Colab で開く

12. アプリにモデルをダウンロードする

Firebase ML の依存関係を追加する

Firebase Model Manager API を使用してモデルをダウンロードする

13. Tensorflow Lite レコメンデーション モデルをアプリに統合する

辞書とラベルを読み込む

前処理の実装

インタープリタを実行して推奨事項を生成する

ポスト処理を実装する

アプリをテストする

14. 完了

学習した内容

次のステップ

詳細

質問がある場合

問題を報告する

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

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

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

アナリティクスのデバッグロギングを有効にする

アナリティクスイベントが生成されていることを確認する

省略可: Firebase コンソールでアナリティクスイベントを確認する

10. BigQuery を使用してモデルトレーニングデータを取得する

サンプルデータセットを BigQuery にインポートする

サンプルデータセットを調べる

サービスアカウントの認証情報を作成する

11. データの前処理とレコメンデーションモデルのトレーニング

13. Tensorflow Lite レコメンデーションモデルをアプリに統合する