1. Ikhtisar
|
|
Selamat datang di Rekomendasi dengan codelab 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 pembelajaran mesin untuk secara cerdas menyajikan konten yang paling relevan bagi setiap pengguna. Mereka memperhitungkan perilaku pengguna di masa lalu untuk menyarankan konten aplikasi yang mungkin ingin berinteraksi dengan pengguna di masa depan dengan 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, membuat model machine learning untuk mendapatkan rekomendasi dari data tersebut, lalu menggunakan model tersebut di aplikasi Android untuk menjalankan inferensi dan mendapatkan rekomendasi. Secara khusus, rekomendasi kami akan menyarankan film mana yang kemungkinan besar akan ditonton pengguna berdasarkan daftar film yang disukai pengguna sebelumnya.
Apa yang akan Anda pelajari
- Integrasikan Firebase Analytics ke dalam aplikasi Android untuk mengumpulkan data perilaku pengguna
- Ekspor data tersebut ke Google Big Query
- Pra-proses data dan latih model rekomendasi TF Lite
- Terapkan model TF Lite ke Firebase ML dan akses dari aplikasi Anda
- Jalankan inferensi perangkat menggunakan model untuk menyarankan rekomendasi kepada pengguna
Apa yang Anda perlukan
- Versi Android Studio terbaru.
- Kode sampel.
- Perangkat uji dengan Android 7+ dan layanan Google Play 9.8 atau lebih baru, atau Emulator dengan layanan Google Play 9.8 atau lebih baru
- Jika menggunakan perangkat, kabel koneksi.
Bagaimana Anda akan menggunakan tutorial ini?
Bagaimana menilai pengalaman Anda dalam membuat aplikasi Android?
2. Dapatkan kode contoh
Kloning repositori GitHub dari baris perintah.
$ git clone https://github.com/FirebaseExtended/codelab-contentrecommendation-android.git
3. Impor aplikasi pemula
Dari Android Studio, pilih direktori codelab-recommendations-android ( 
) dari unduhan kode contoh ( File > Open > .../codelab-recommendations-android/start).
Anda sekarang seharusnya sudah membuka proyek awal di Android Studio.
4. Buat proyek konsol Firebase
Buat proyek baru
- Buka konsol Firebase .
- Pilih Tambahkan proyek (atau Buat proyek jika itu yang pertama).
- Pilih atau masukkan nama Proyek dan klik Lanjutkan .
- Pastikan "Aktifkan Google Analytics untuk proyek ini" diaktifkan.
- Ikuti langkah penyiapan selanjutnya di Firebase console, lalu klik Buat proyek (atau Tambahkan Firebase, jika Anda menggunakan proyek Google yang sudah ada).
5. Tambahkan Firebase
- Dari layar ikhtisar proyek baru Anda, klik ikon Android untuk meluncurkan alur kerja penyiapan.
- Masukkan nama paket codelab:
com.google.firebase.codelabs.recommendations - Pilih Daftarkan aplikasi .
Tambahkan file google-services.json ke aplikasi Anda
Setelah menambahkan nama paket dan memilih Daftar, klik Unduh google-services.json untuk mendapatkan file konfigurasi Firebase Android Anda, lalu salin file google-services.json ke direktori app di proyek Anda. Setelah file diunduh, Anda dapat Lewati langkah selanjutnya yang ditampilkan di konsol (langkah tersebut telah dilakukan untuk Anda di proyek build-android-start).
Tambahkan plugin layanan Google ke aplikasi Anda
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 di proyek (periksa 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
}
Sinkronkan proyek Anda dengan file gradle
Untuk memastikan bahwa semua dependensi tersedia untuk aplikasi Anda, Anda harus menyinkronkan proyek Anda dengan file gradle pada saat ini. Pilih File > Sinkronkan Proyek dengan File Gradle dari toolbar Android Studio.
6. Jalankan aplikasi starter
Sekarang setelah Anda mengimpor proyek ke Android Studio dan mengonfigurasi plugin google-services dengan file JSON, Anda siap menjalankan aplikasi untuk pertama kalinya. Hubungkan perangkat Android Anda, dan klik Jalankan ( 
)di bilah alat Android Studio.
Aplikasi ini akan diluncurkan di perangkat Anda. Pada titik ini, Anda dapat melihat aplikasi berfungsi yang menampilkan tab dengan daftar film, tab Film yang disukai, dan tab Rekomendasi. Anda dapat mengeklik film di daftar film untuk menambahkannya ke daftar kesukaan Anda. Setelah menyelesaikan langkah-langkah codelab selanjutnya, kita akan dapat membuat rekomendasi film di tab Rekomendasi.
7. Tambahkan Firebase Analytics ke aplikasi
Pada 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 agregat pada langkah-langkah selanjutnya untuk melatih model rekomendasi.
Tambahkan ketergantungan Firebase Bill of Materials dan Analytics
Dependensi berikut diperlukan untuk menambahkan Firebase Analytics ke aplikasi Anda. Mereka 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")
Siapkan Firebase Analytics di aplikasi
LikedMoviesViewModel berisi fungsi untuk menyimpan film yang disukai pengguna. Setiap kali pengguna menyukai film baru, kami juga ingin mengirimkan peristiwa log analitik untuk mencatat suka tersebut.
Tambahkan fungsi onMovieLiked dengan kode di bawah ini untuk mendaftarkan peristiwa analitik ketika pengguna mengklik suka pada film.
MenyukaiMoviesViewModel.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 bidang dan fungsi berikut untuk mencatat peristiwa Analytics ketika film ditambahkan ke daftar Disukai pengguna.
MenyukaiMoviesViewModel.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. Uji integrasi Analytics Anda
Pada langkah ini, kami akan membuat peristiwa Analytics di aplikasi dan memverifikasi bahwa peristiwa tersebut dikirim ke Firebase Console.
Aktifkan Pencatatan 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 debugging, 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
Verifikasi bahwa peristiwa Analytics dibuat
- Di Android studio, buka jendela Logcat untuk memeriksa logging dari aplikasi Anda.
- Setel filter Logcat ke string "Logging event".
- Verifikasi bahwa peristiwa Analytics "select_item" dikeluarkan setiap kali Anda menyukai film di aplikasi.
Sampai di sini, Anda telah berhasil mengintegrasikan Firebase Analytics ke dalam aplikasi Anda. Saat pengguna menggunakan aplikasi Anda dan menyukai film, jumlah suka mereka akan dicatat secara agregat. Kami akan menggunakan data gabungan ini di sisa codelab ini untuk melatih model rekomendasi kami. Berikut ini adalah langkah opsional untuk melihat peristiwa Analytics yang sama dengan yang Anda lihat di Logcat juga dialirkan ke Firebase console. Jangan ragu untuk melompat ke halaman berikutnya.
Opsional: Konfirmasikan peristiwa Analytics di Firebase Console
- Buka konsol Firebase .
- Pilih DebugView di bagian Analytics
- Di Android Studio, pilih Jalankan untuk meluncurkan aplikasi dan menambahkan beberapa film ke daftar Kesukaan Anda.
- Di DebugView Firebase console, verifikasi bahwa peristiwa ini dicatat dalam log saat Anda menambahkan film di aplikasi.
9. Ekspor data Analytics ke Big Query
Big Query adalah produk Google Cloud yang memungkinkan Anda memeriksa dan memproses data dalam jumlah besar. Pada langkah ini, Anda akan menghubungkan proyek Firebase Console ke Big Query sehingga data Analytics yang dihasilkan oleh aplikasi Anda secara otomatis diekspor ke Big Query.
Aktifkan ekspor Big Query
- Buka konsol Firebase .
- Pilih ikon roda gigi Pengaturan di samping Ikhtisar Proyek , lalu pilih Pengaturan proyek
- Pilih tab Integrasi .
- Pilih Tautan (atau Kelola ) di dalam blok BigQuery .
- Pilih Berikutnya di langkah Tentang Menautkan Firebase ke BigQuery .
- Di bagian Konfigurasikan integrasi , klik tombol untuk mengaktifkan pengiriman data Google Analytics dan pilih Tautkan ke BigQuery .
Anda kini telah mengaktifkan proyek Firebase console untuk mengirim data peristiwa Firebase Analytics secara otomatis ke Big Query. Hal ini terjadi secara otomatis tanpa interaksi lebih lanjut, namun ekspor pertama yang membuat set data analisis di BigQuery mungkin tidak akan terjadi dalam waktu 24 jam. Setelah set data dibuat, Firebase terus mengekspor peristiwa Analytics baru ke Big Query ke dalam tabel intraday, dan mengelompokkan peristiwa dari hari-hari sebelumnya dalam 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 kumpulan data ke BigQuery untuk digunakan pada sisa tutorial ini.
10. Gunakan BigQuery untuk mendapatkan data pelatihan model
Sekarang setelah kami menghubungkan Firebase Console untuk mengekspor ke BigQuery, data peristiwa analisis aplikasi kami akan otomatis muncul di konsol BigQuery setelah beberapa waktu. Untuk mendapatkan beberapa data awal untuk keperluan tutorial ini, pada langkah ini kami akan mengimpor contoh kumpulan data yang ada ke konsol BigQuery Anda untuk digunakan dalam melatih model rekomendasi kami.
Impor kumpulan data sampel ke BigQuery
- Buka dasbor BigQuery di konsol cloud Google.
- Pilih nama proyek Anda di menu.
- Pilih nama proyek Anda di bagian bawah navigasi kiri BigQuery untuk melihat detailnya.
- Pilih Buat himpunan data untuk membuka panel pembuatan himpunan data.
- Masukkan 'firebase_recommendations_dataset' untuk ID Set Data dan pilih Buat set data .
- Kumpulan data baru akan muncul di menu sebelah kiri di bawah nama proyek. Klik itu.
- Pilih Buat tabel untuk membuka panel pembuatan tabel.
- Untuk Buat tabel dari pilih 'Google Cloud Storage'.
- Di kolom Pilih file dari bucket GCS , masukkan 'gs://firebase-recommendations/recommendations-test/formatted_data_filtered.txt'.
- Pilih 'JSONL' di menu tarik-turun Format file .
- Masukkan 'recommendations_table' untuk nama Tabel .
- Centang kotak di bawah Skema > Deteksi otomatis > Skema dan parameter masukan
- Pilih Buat tabel
Jelajahi kumpulan data sampel
Pada titik ini, Anda dapat menjelajahi skema dan melihat pratinjau kumpulan data ini secara opsional.
- Pilih firebase-recommendations-dataset di menu sebelah kiri untuk memperluas tabel di dalamnya.
- Pilih tabel tabel rekomendasi untuk melihat skema tabel.
- Pilih Pratinjau untuk melihat data peristiwa Analytics aktual yang terdapat dalam tabel ini.
Buat kredensial akun layanan
Sekarang, kita akan membuat kredensial akun layanan di proyek konsol Google Cloud yang dapat kita gunakan di lingkungan Colab pada langkah berikut untuk mengakses dan memuat data BigQuery.
- Pastikan penagihan diaktifkan untuk project Google Cloud Anda.
- Aktifkan API BigQuery dan BigQuery Storage API. < klik di sini >
- Buka halaman Buat Kunci Akun Layanan .
- Dari daftar Akun layanan , pilih Akun layanan baru .
- Di bidang Nama akun layanan , masukkan nama.
- Dari daftar Peran , pilih Proyek > Pemilik .
- Klik Buat . File JSON yang berisi unduhan kunci Anda ke komputer Anda.
Pada langkah berikutnya, kami akan menggunakan Google Colab untuk memproses data ini terlebih dahulu dan melatih model rekomendasi kami.
11. Praproses data dan model rekomendasi pelatihan
Pada langkah ini, kita akan menggunakan notebook Colab untuk melakukan langkah-langkah berikut:
- impor data BigQuery ke notebook Colab
- memproses data terlebih dahulu untuk mempersiapkannya untuk pelatihan model
- melatih model rekomendasi pada data analitik
- ekspor model sebagai model TF lite
- menerapkan model ke Firebase Console sehingga kita dapat menggunakannya di aplikasi kita
Sebelum meluncurkan notebook pelatihan Colab, pertama-tama kami akan mengaktifkan Firebase Model Management API sehingga Colab dapat menerapkan model terlatih ke Firebase console kami.
Aktifkan Firebase Model Management API
Buat keranjang untuk menyimpan model ML Anda
Di Firebase Console Anda, buka Penyimpanan dan klik Mulai. 
Ikuti dialog untuk menyiapkan keranjang Anda.
Aktifkan Firebase ML API
Buka halaman Firebase ML API di Google Cloud Console dan klik Aktifkan.
Gunakan notebook Colab untuk melatih dan menerapkan model
Buka buku catatan colab menggunakan tautan 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 kami sinkronkan ke aplikasi kami.
Buka di Colab
12. Unduh model di aplikasi Anda
Pada langkah ini, kita akan memodifikasi aplikasi untuk mendownload model yang baru saja kita latih dari Firebase Machine Learning.
Tambahkan ketergantungan Firebase ML
Dependensi berikut diperlukan untuk menggunakan model Firebase Machine Learning di aplikasi Anda. Seharusnya sudah ditambahkan (verifikasi).
app/build.grade.kts
implementation("com.google.firebase:firebase-ml-modeldownloader:24.1.2")
Unduh model dengan Firebase Model Manager API
Salin kode di bawah ini ke RekomendasiClient.kt untuk mengatur kondisi di mana pengunduhan model terjadi dan membuat tugas pengunduhan untuk menyinkronkan model jarak jauh ke aplikasi kita.
RekomendasiKlien.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. Integrasikan model rekomendasi Tensorflow Lite di aplikasi Anda
Runtime Tensorflow Lite memungkinkan Anda menggunakan model di aplikasi untuk menghasilkan rekomendasi. Pada langkah sebelumnya kita menginisialisasi penerjemah TFlite dengan file model yang kita unduh. Pada langkah ini, pertama-tama kita akan memuat kamus dan label untuk menemani model kita pada langkah inferensi, kemudian kita akan menambahkan pra-pemrosesan untuk menghasilkan masukan ke model kita dan pasca-pemrosesan di mana kita akan mengekstrak hasil dari inferensi kita. .
Muat Kamus dan Label
Label yang digunakan untuk menghasilkan kandidat rekomendasi berdasarkan model rekomendasi tercantum dalam file sortir_movie_vocab.json di folder res/assets. Salin kode berikut untuk memuat kandidat ini.
RekomendasiKlien.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, kami mengubah bentuk data masukan agar sesuai dengan yang diharapkan model kami. Di sini, kami mengisi panjang input dengan nilai placeholder jika kami belum menghasilkan banyak suka dari pengguna. Salin kode di bawah ini:
RekomendasiKlien.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
}
}
Jalankan juru bahasa untuk menghasilkan rekomendasi
Di sini kita menggunakan model yang kita unduh pada langkah sebelumnya untuk menjalankan inferensi pada masukan yang telah diproses sebelumnya. Kami menetapkan jenis input dan output untuk model kami dan menjalankan inferensi untuk menghasilkan rekomendasi film kami. Salin kode berikut ke aplikasi Anda.
RekomendasiKlien.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()
}
}
}
Menerapkan Pasca-pemrosesan
Terakhir, pada langkah ini kami memproses keluaran dari model kami, memilih hasil dengan keyakinan tertinggi dan menghapus nilai yang terkandung (film yang sudah disukai pengguna). Salin kode berikut ke aplikasi Anda.
RekomendasiKlien.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 diunduh secara otomatis dan mulai menghasilkan rekomendasi!
14. Selamat!
Anda telah membuat fitur rekomendasi ke dalam aplikasi Anda menggunakan TensorFlow Lite dan Firebase. Perlu diperhatikan bahwa teknik dan pipeline yang ditampilkan dalam codelab ini dapat digeneralisasikan dan juga digunakan untuk menyajikan jenis rekomendasi lainnya.
Apa yang telah kami bahas
- FirebaseML
- Analisis Firebase
- Ekspor peristiwa analisis ke BigQuery
- Peristiwa analisis pra-proses
- Latih rekomendasi model TensorFlow
- Ekspor model dan terapkan ke Firebase Console
- Sajikan rekomendasi film dalam suatu aplikasi
Langkah selanjutnya
- Terapkan rekomendasi Firebase ML di aplikasi Anda.