Menambahkan Rekomendasi ke aplikasi Anda dengan TensorFlow Lite dan Firebase - Android Codelab

1. Ringkasan

Selamat datang di codelab Rekomendasi dengan TensorFlow Lite dan Firebase. Dalam codelab ini, Anda akan mempelajari cara menggunakan TensorFlow Lite dan Firebase untuk men-deploy model rekomendasi ke aplikasi Anda. Codelab ini didasarkan pada contoh TensorFlow Lite ini.

Rekomendasi memungkinkan aplikasi menggunakan machine learning untuk menyajikan konten yang paling relevan bagi setiap pengguna secara cerdas. Model mempertimbangkan perilaku pengguna di masa lalu untuk menyarankan konten aplikasi yang mungkin akan dilihat pengguna di masa mendatang menggunakan model yang dilatih berdasarkan perilaku agregat dari sejumlah besar pengguna lain.

Tutorial ini menunjukkan cara mendapatkan data dari pengguna aplikasi Anda dengan Firebase Analytics, membangun model machine learning untuk rekomendasi dari data tersebut, kemudian menggunakan model tersebut dalam aplikasi Android untuk menjalankan inferensi dan mendapatkan rekomendasi. Secara khusus, rekomendasi kami akan menyarankan film mana yang kemungkinan besar akan ditonton pengguna mengingat daftar film yang telah disukai pengguna sebelumnya.

Yang akan Anda pelajari

  • Mengintegrasikan Firebase Analytics ke dalam aplikasi Android untuk mengumpulkan data perilaku pengguna
  • Mengekspor data tersebut ke Google BigQuery
  • Lakukan pra-pemrosesan data dan latih model rekomendasi TF Lite
  • Men-deploy model TF Lite ke Firebase ML dan mengaksesnya dari aplikasi Anda
  • Jalankan di inferensi perangkat menggunakan model untuk menyarankan rekomendasi kepada pengguna

Yang Anda butuhkan

  • Versi Android Studio terbaru.
  • Kode contoh.
  • Perangkat pengujian dengan Android 7+ dan layanan Google Play 9.8 atau yang lebih baru, atau Emulator dengan layanan Google Play 9.8 atau yang lebih baru
  • Jika menggunakan perangkat, gunakan kabel koneksi.

Bagaimana Anda akan menggunakan tutorial ini?

Hanya membacanya Membacanya dan menyelesaikan latihan

Bagaimana penilaian Anda terhadap pengalaman membuat aplikasi Android?

Pemula Menengah Mahir

2. Mendapatkan kode contoh

Buat clone repositori GitHub dari command line.

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

3. Mengimpor aplikasi awal

Dari Android Studio, pilih direktori codelab-recommendations-android ( folder_android_studio_.png) dari download kode contoh (File > Open > .../codelab-recommendations-android/start).

Sekarang Anda seharusnya sudah membuka project awal di Android Studio.

4. Buat project Firebase console

Membuat project baru

  1. Buka Firebase console.
  2. Pilih Tambahkan project (atau Buat project jika ini yang pertama).
  3. Pilih atau masukkan Nama project, lalu klik Continue.
  4. Pastikan "Aktifkan Google Analytics untuk project ini" diaktifkan.
  5. Ikuti langkah-langkah penyiapan yang tersisa di Firebase console, lalu klik Buat project (atau Tambahkan Firebase, jika Anda menggunakan project Google yang sudah ada).

5. Tambahkan Firebase

  1. Dari layar ringkasan project baru Anda, klik ikon Android untuk meluncurkan alur kerja penyiapan.
  2. Masukkan nama paket codelab: com.google.firebase.codelabs.recommendations
  3. Pilih Register app.

Menambahkan file google-services.json ke aplikasi Anda

Setelah menambahkan nama paket dan memilih Register, klik Download google-services.json untuk mendapatkan file konfigurasi Android Firebase Anda, lalu salin file google-services.json ke direktori app di project Anda. Setelah file didownload, Anda dapat Lewati langkah berikutnya yang ditampilkan di konsol (langkah tersebut telah dilakukan untuk Anda di project build-android-start).

Menambahkan plugin google-services ke aplikasi

Plugin google-services menggunakan file google-services.json untuk mengonfigurasi aplikasi Anda agar menggunakan Firebase. Baris berikut seharusnya sudah ditambahkan ke file build.gradle.kts dalam project (centang untuk mengonfirmasi):

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
}

Menyinkronkan project dengan file gradle

Untuk memastikan bahwa semua dependensi tersedia untuk aplikasi, Anda harus menyinkronkan project dengan file gradle pada tahap ini. Pilih File > Sync Project with Gradle Files dari toolbar Android Studio.

6. Menjalankan aplikasi awal

Setelah mengimpor project ke Android Studio dan mengonfigurasi plugin google-services dengan file JSON, Anda siap menjalankan aplikasi untuk pertama kalinya. Hubungkan perangkat Android, lalu klik Run ( eksekusi.png) di toolbar Android Studio.

Aplikasi akan diluncurkan di perangkat Anda. Pada tahap ini, Anda dapat melihat aplikasi berfungsi yang menampilkan tab dengan daftar film, tab Film yang disukai, dan tab Rekomendasi. Anda dapat mengklik film dalam daftar film untuk menambahkannya ke daftar yang Anda sukai. Setelah menyelesaikan langkah-langkah codelab yang tersisa, kita akan dapat membuat rekomendasi film di tab Rekomendasi.

7. Menambahkan Firebase Analytics ke aplikasi

Di langkah ini, Anda akan menambahkan Firebase Analytics ke aplikasi untuk mencatat data perilaku pengguna (dalam hal ini, film mana yang disukai pengguna). Data ini akan digunakan secara gabungan dalam langkah-langkah mendatang untuk melatih model rekomendasi.

Menambahkan dependensi Firebase Bill of Materials dan Analytics

Dependensi berikut diperlukan untuk menambahkan Firebase Analytics ke aplikasi Anda. Dependensi berikut seharusnya sudah disertakan dalam file app/build.gradle.kts (verifikasi).

app/build.grade.kts

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

Menyiapkan Firebase Analytics di aplikasi

LikedMoviesViewModel berisi fungsi untuk menyimpan film yang disukai pengguna. Setiap kali pengguna menyukai film baru, kita juga ingin mengirimkan peristiwa log Analytics untuk mencatat peristiwa semacam itu.

Tambahkan fungsi onmovieTypes dengan kode di bawah untuk mendaftarkan peristiwa analisis ketika pengguna mengklik tombol suka pada film.

MenyukaiFilmViewModel.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())
    }
       
}

Tambahkan kolom dan fungsi berikut untuk mencatat peristiwa Analytics saat film ditambahkan ke daftar Disukai pengguna.

MenyukaiFilmViewModel.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. Menguji integrasi Analytics Anda

Pada langkah ini, kita akan membuat peristiwa Analytics di aplikasi dan memverifikasi bahwa peristiwa tersebut dikirim ke Firebase Console.

Mengaktifkan Logging Debug Analytics

Firebase Analytics dirancang untuk memaksimalkan masa pakai baterai pengguna dan akan mengelompokkan peristiwa di perangkat dan hanya mengirimkannya ke Firebase sesekali. Untuk tujuan proses debug, kita dapat menonaktifkan perilaku ini untuk melihat peristiwa yang dicatat secara real time dengan menjalankan perintah berikut di shell.

Terminal

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

Memastikan peristiwa Analytics dibuat

  1. Di Android Studio, buka jendela Logcat untuk memeriksa logging dari aplikasi Anda.
  2. Tetapkan filter Logcat ke string "Logging event".
  3. Pastikan peristiwa Analytics "select_item" dimunculkan setiap kali Anda menyukai sebuah film di aplikasi.

Pada tahap ini, Anda telah berhasil mengintegrasikan Firebase Analytics ke dalam aplikasi. Saat pengguna menggunakan aplikasi Anda dan menyukai film, jumlah suka mereka akan dicatat secara gabungan. Kita akan menggunakan data gabungan ini di sisa codelab ini untuk melatih model rekomendasi. Berikut adalah langkah opsional untuk melihat peristiwa Analytics yang sama seperti yang Anda lihat di Logcat serta di-streaming ke Firebase console. Jangan ragu untuk langsung ke halaman berikutnya.

Opsional: Mengonfirmasi peristiwa Analytics di Firebase Console

  1. Buka Firebase console.
  2. Pilih DebugView di bagian Analytics
  3. Di Android Studio, pilih Run untuk meluncurkan aplikasi dan menambahkan beberapa film ke daftar Disukai.
  4. Di DebugView Firebase console, pastikan peristiwa ini dicatat saat Anda menambahkan film di aplikasi.

9. Mengekspor data Analytics ke BigQuery

Big Query adalah produk Google Cloud yang memungkinkan Anda memeriksa dan memproses data dalam jumlah besar. Pada langkah ini, Anda akan menghubungkan project Firebase Console ke BigQuery, sehingga data Analytics yang dihasilkan aplikasi Anda akan otomatis diekspor ke BigQuery.

Mengaktifkan ekspor BigQuery

  1. Buka Firebase console.
  2. Pilih ikon roda gigi Settings di samping Project Overview, lalu pilih Project settings
  3. Pilih tab Integrations.
  4. Pilih Link (atau Manage) di dalam blok BigQuery.
  5. Pilih Next di langkah About Linking Firebase to BigQuery.
  6. Di bagian Konfigurasi integrasi, klik tombol untuk mengaktifkan pengiriman data Google Analytics, lalu pilih Tautkan ke BigQuery.

Anda sekarang telah mengaktifkan project Firebase console untuk otomatis mengirim data peristiwa Firebase Analytics ke Big Query. Hal ini terjadi secara otomatis tanpa interaksi lebih lanjut. Namun, ekspor pertama yang membuat set data analisis di BigQuery mungkin tidak terjadi selama 24 jam. Setelah set data dibuat, Firebase akan terus mengekspor peristiwa Analytics baru ke BigQuery ke dalam tabel intrahari, dan mengelompokkan peristiwa dari hari-hari sebelumnya di tabel peristiwa.

Melatih model rekomendasi memerlukan banyak data. Karena kita belum memiliki aplikasi yang menghasilkan data dalam jumlah besar, pada langkah berikutnya kita akan mengimpor contoh set data ke BigQuery untuk digunakan selama sisa tutorial ini.

10. Menggunakan BigQuery untuk mendapatkan data pelatihan model

Setelah menghubungkan Firebase Console untuk mengekspor ke BigQuery, data peristiwa analisis aplikasi akan otomatis muncul di konsol BigQuery setelah beberapa waktu. Guna mendapatkan beberapa data awal untuk tujuan tutorial ini, pada langkah ini kita akan mengimpor sampel {i>dataset<i} yang ada ke konsol BigQuery Anda untuk digunakan untuk melatih model rekomendasi kami.

Mengimpor contoh set data ke BigQuery

  1. Buka dasbor BigQuery di Konsol Google Cloud.
  2. Pilih nama project Anda di menu.
  3. Pilih nama project Anda di bagian bawah navigasi sebelah kiri BigQuery untuk melihat detailnya.
  4. Pilih Create dataset untuk membuka panel pembuatan set data.
  5. Masukkan 'firebase_recommendations_dataset' untuk ID Set Data, lalu pilih Buat set data.
  6. {i>Dataset<i} baru akan muncul di menu kiri di bawah nama project. Klik ikon tersebut.
  7. Pilih Create table untuk membuka panel pembuatan tabel.
  8. Untuk Create table from pilih 'Google Cloud Storage'.
  9. Di kolom Select file from GCS bucket, masukkan ‘gs://firebase-recommendations/recommendations-test/formatted_data_filtered.txt'.
  10. Pilih 'JSONL' di drop-down File format.
  11. Masukkan 'recommendations_table' untuk Nama tabel.
  12. Centang kotak di bagian Skema > Deteksi otomatis > Skema dan parameter input
  13. Pilih Create table

Mempelajari contoh set data

Pada tahap ini, Anda dapat secara opsional menjelajahi skema dan melihat pratinjau {i>dataset<i} ini.

  1. Pilih firebase-recommendations-dataset di menu kiri untuk meluaskan tabel yang ada di dalamnya.
  2. Pilih tabel recommendations-table untuk melihat skema tabel.
  3. Pilih Pratinjau untuk melihat data peristiwa Analytics sebenarnya yang ada di tabel ini.

Membuat kredensial akun layanan

Sekarang, kita akan membuat kredensial akun layanan di project konsol Google Cloud yang dapat digunakan di lingkungan Colab pada langkah berikut untuk mengakses dan memuat data BigQuery.

  1. Pastikan penagihan telah diaktifkan untuk project Google Cloud Anda.
  2. Mengaktifkan BigQuery dan BigQuery Storage API API. < klik di sini>
  3. Buka halaman Create Service Account Key.
  4. Dari daftar Service account, pilih New service account.
  5. Di kolom Nama akun layanan, masukkan nama.
  6. Dari daftar Role, pilih Project > Owner.
  7. Klik Create. File JSON yang berisi kunci Anda didownload ke komputer Anda.

Pada langkah berikutnya, kami akan menggunakan Google Colab untuk melakukan prapemrosesan data ini dan melatih model rekomendasi kami.

11. Melakukan prapemrosesan data dan melatih model rekomendasi

Pada langkah ini, kita akan menggunakan notebook Colab untuk melakukan langkah-langkah berikut:

  1. mengimpor data BigQuery ke notebook Colab
  2. melakukan prapemrosesan data untuk mempersiapkannya untuk pelatihan model
  3. melatih model rekomendasi pada data analisis
  4. mengekspor model sebagai model TF lite
  5. men-deploy model ke Firebase Console agar kita dapat menggunakannya di aplikasi

Sebelum meluncurkan notebook pelatihan Colab, kita akan mengaktifkan Firebase Model Management API terlebih dahulu agar Colab dapat men-deploy model yang dilatih ke Firebase console kami.

Aktifkan Firebase Model Management API

Membuat bucket untuk menyimpan model ML Anda

Di Firebase Console, buka Storage, lalu klik Mulai. fbbea78f0eb3dc9f.pngS

Ikuti dialog untuk menyiapkan bucket Anda.

19517c0d6d2aa14d.png

Aktifkan Firebase ML API

Buka halaman Firebase ML API di Konsol Google Cloud, lalu klik Aktifkan.

Gunakan notebook Colab untuk melatih dan men-deploy model

Buka notebook colab menggunakan link berikut dan selesaikan langkah-langkah di dalamnya. Setelah menyelesaikan langkah-langkah di notebook Colab, Anda akan memiliki file model TF lite yang di-deploy ke Firebase console yang dapat disinkronkan ke aplikasi kita.

Buka di Colab

12. Mendownload model di aplikasi Anda

Pada langkah ini, kita akan memodifikasi aplikasi untuk mendownload model yang baru saja dilatih dari Firebase Machine Learning.

Menambahkan dependensi Firebase ML

Dependensi berikut diperlukan untuk menggunakan model Firebase Machine Learning di aplikasi Anda. Dependensi berikut seharusnya sudah ditambahkan (verifikasi).

app/build.grade.kts

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

Mendownload model dengan Firebase Model Manager API

Salin kode di bawah ke RecommendationClient.kt untuk menyiapkan kondisi saat download model terjadi dan buat tugas download untuk menyinkronkan model jarak jauh ke aplikasi kita.

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. Mengintegrasikan model rekomendasi Tensorflow Lite di aplikasi Anda

Dengan runtime Tensorflow Lite, Anda dapat menggunakan model di aplikasi untuk membuat rekomendasi. Pada langkah sebelumnya, kita melakukan inisialisasi penafsir TFlite dengan file model yang telah kita download. Pada langkah ini, kita akan memuat kamus dan label terlebih dahulu untuk menyertai model dalam langkah inferensi, lalu menambahkan pra-pemrosesan untuk menghasilkan input ke model dan pasca-pemrosesan, tempat kita akan mengekstrak hasilnya dari inferensi.

Memuat Kamus dan Label

Label yang digunakan untuk membuat kandidat rekomendasi oleh model rekomendasi tercantum dalam file sorted_movie_vocab.json di folder res/assets. Salin kode berikut untuk memuat kandidat ini.

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

Menerapkan Pra-pemrosesan

Pada langkah pra-pemrosesan, kita mengubah bentuk data input agar sesuai dengan yang diharapkan oleh model. Di sini, kita menambahkan panjang input dengan nilai placeholder jika belum menghasilkan banyak suka pengguna. Salin kode di bawah ini:

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

Menjalankan penafsir untuk membuat rekomendasi

Di sini kita menggunakan model yang didownload pada langkah sebelumnya untuk menjalankan inferensi pada input yang telah diproses sebelumnya. Kita menetapkan jenis input dan output untuk model dan menjalankan inferensi untuk menghasilkan rekomendasi film. Salin kode berikut ke dalam aplikasi Anda.

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

Mengimplementasikan Pasca-pemrosesan

Terakhir, pada langkah ini, kita akan melakukan pascapemrosesan terhadap output dari model, yang memilih hasil dengan tingkat keyakinan tertinggi dan menghapus nilai yang ada (film yang telah disukai pengguna). Salin kode berikut ke dalam aplikasi Anda.

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

Uji aplikasi Anda!

Jalankan kembali aplikasi Anda. Saat Anda memilih beberapa film, model baru akan otomatis didownload dan mulai menghasilkan rekomendasi.

14. Selamat!

Anda telah membangun fitur rekomendasi ke dalam aplikasi menggunakan TensorFlow Lite dan Firebase. Perhatikan bahwa teknik dan pipeline yang ditampilkan dalam codelab ini dapat digeneralisasi dan digunakan untuk memberikan jenis rekomendasi lainnya juga.

Yang telah kita bahas

  • Firebase ML
  • Firebase Analytics
  • Mengekspor peristiwa analisis ke BigQuery
  • Melakukan prapemrosesan peristiwa analisis
  • Melatih model TensorFlow
  • Mengekspor model dan men-deploy ke Firebase Console
  • Menyajikan rekomendasi film dalam aplikasi

Langkah Berikutnya

  • Terapkan rekomendasi Firebase ML di aplikasi Anda.

Pelajari Lebih Lanjut

Ada Pertanyaan?

Melaporkan Masalah