TensorFlow Lite 및 Firebase로 앱에 추천 추가하기 - Android Codelab

1. 개요

TensorFlow Lite 및 Firebase 추천 Codelab에 오신 것을 환영합니다. 이 Codelab에서는 TensorFlow Lite와 Firebase를 사용하여 앱에 추천 모델을 배포하는 방법을 알아봅니다. 이 Codelab은 이 TensorFlow Lite 를 기반으로 합니다.

추천 기능을 사용하면 앱에서 머신러닝을 사용해 각 사용자에게 가장 관련성 높은 콘텐츠를 지능적으로 제공할 수 있습니다. 많은 다른 사용자의 집계된 행동을 기반으로 학습된 모델을 사용하여 과거의 사용자 행동을 고려하여 사용자가 앞으로 상호작용하고 싶어할 만한 앱 콘텐츠를 추천합니다.

이 튜토리얼에서는 Firebase 애널리틱스로 앱 사용자로부터 데이터를 얻고, 해당 데이터의 추천을 위한 머신러닝 모델을 빌드한 다음, Android 앱에서 해당 모델을 사용하여 추론을 실행하고 추천을 받는 방법을 보여줍니다. 특히 Google의 추천에서는 사용자가 이전에 좋아요 표시한 영화 목록을 바탕으로 사용자가 시청할 가능성이 가장 높은 영화를 추천합니다.

학습할 내용

  • Firebase 애널리틱스를 Android 앱에 통합하여 사용자 행동 데이터 수집
  • 해당 데이터를 Google BigQuery로 내보내기
  • 데이터 전처리 및 TF Lite 추천 모델 학습
  • TF Lite 모델을 Firebase ML에 배포하고 앱에서 액세스
  • 모델을 사용하여 기기에서 추론을 실행하여 사용자에게 추천 항목 제안

필요한 항목

  • 최신 Android 스튜디오 버전
  • 샘플 코드
  • 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 스튜디오의 샘플 코드 다운로드 ( File > Open > .../codelab-recommendations-android/start)에서 codelab-recommendations-android 디렉터리 (android_studio_folder.png)를 선택합니다.

이제 Android 스튜디오에서 시작 프로젝트가 열려 있어야 합니다.

4. Firebase Console 프로젝트 만들기

새 프로젝트 만들기

  1. Firebase Console로 이동합니다.
  2. 프로젝트 추가 (또는 첫 번째 프로젝트인 경우 프로젝트 만들기)를 선택합니다.
  3. 프로젝트 이름을 선택하거나 입력하고 계속을 클릭합니다.
  4. '이 프로젝트에 Google 애널리틱스 사용 설정'이 사용 설정되어 있는지 확인합니다.
  5. Firebase Console에서 나머지 설정 단계를 따른 다음 프로젝트 만들기 (또는 기존 Google 프로젝트를 사용하는 경우 Firebase 추가)를 클릭합니다.

5. Firebase 추가

  1. 새 프로젝트의 개요 화면에서 Android 아이콘을 클릭하여 설정 워크플로를 시작합니다.
  2. Codelab의 패키지 이름(com.google.firebase.codelabs.recommendations)을 입력합니다.
  3. 앱 등록을 선택합니다.

앱에 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 파일과 동기화해야 합니다. Android 스튜디오 툴바에서 File > Sync Project with Gradle Files를 선택합니다.

6. 시작 앱 실행

이제 프로젝트를 Android 스튜디오로 가져오고 JSON 파일로 google-services 플러그인을 구성했으므로 앱을 처음으로 실행할 수 있습니다. Android 기기를 연결하고 Android 스튜디오 툴바에서 Run ( run.png)을 클릭합니다.

기기에서 앱이 실행됩니다. 이제 영화 목록, 좋아요 표시한 영화 탭, 추천 탭이 있는 탭을 표시하는 애플리케이션이 작동하는 것을 볼 수 있습니다. 영화 목록에서 영화를 클릭하여 '좋아요' 표시한 목록에 추가할 수 있습니다. Codelab의 나머지 단계를 완료하면 추천 탭에서 영화 추천을 생성할 수 있습니다.

7. 앱에 Firebase 애널리틱스 추가

이 단계에서는 Firebase 애널리틱스를 앱에 추가하여 사용자 행동 데이터 (이 경우 사용자가 좋아하는 영화)를 로깅합니다. 이 데이터는 이후 단계에서 추천 모델을 학습시키는 데 집계되어 사용됩니다.

Firebase 재료명세서 및 애널리틱스 종속 항목 추가

Firebase Analytics를 앱에 추가하려면 다음 종속 항목이 필요합니다. 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 Console로 전송되고 있는지 확인합니다.

애널리틱스 디버그 로깅 사용 설정

Firebase Analytics는 사용자의 배터리 수명을 극대화하도록 설계되었으며, 기기에서 이벤트를 일괄 처리하고 가끔씩만 Firebase로 전송합니다. 디버깅을 위해 셸에서 다음 명령어를 실행하여 이 동작을 비활성화하여 이벤트가 실시간으로 로깅되는 것을 확인할 수 있습니다.

터미널

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

애널리틱스 이벤트가 생성되었는지 확인하기

  1. Android 스튜디오에서 Logcat 창을 열어 앱의 로깅을 살펴봅니다.
  2. Logcat 필터를 문자열 'Logging event'로 설정합니다.
  3. 앱에서 영화를 좋아할 때마다 'select_item' 애널리틱스 이벤트를 내보내는지 확인합니다.

이제 Firebase 애널리틱스를 앱에 성공적으로 통합했습니다. 사용자가 앱을 사용하거나 영화를 좋아하면 좋아요가 합산되어 기록됩니다. 이 Codelab의 나머지 부분에서 이 합산 데이터를 사용하여 추천 모델을 학습시킬 것입니다. 다음 단계는 Logcat에서 본 것과 동일한 애널리틱스 이벤트를 Firebase Console로 스트리밍하는 것을 볼 수 있는 선택적 단계입니다. 다음 페이지로 건너뛰어도 됩니다.

선택사항: Firebase Console에서 애널리틱스 이벤트 확인

  1. Firebase Console로 이동합니다.
  2. 애널리틱스에서 DebugView를 선택합니다.
  3. Android 스튜디오에서 Run을 선택하여 앱을 실행하고 좋아하는 영화 목록에 영화를 추가합니다.
  4. 앱에 영화를 추가할 때 Firebase Console의 DebugView에서 이러한 이벤트가 로깅되는지 확인합니다.

9. BigQuery로 애널리틱스 데이터 내보내기

BigQuery는 대량의 데이터를 검사하고 처리할 수 있는 Google Cloud 제품입니다. 이 단계에서는 앱에서 생성한 애널리틱스 데이터가 자동으로 BigQuery로 내보내지도록 Firebase Console 프로젝트를 BigQuery에 연결합니다.

BigQuery 내보내기 사용 설정하기

  1. Firebase Console로 이동합니다.
  2. 프로젝트 개요 옆에 있는 설정 톱니바퀴 아이콘을 선택한 다음 프로젝트 설정을 선택합니다.
  3. Integrations 탭을 선택합니다.
  4. BigQuery 블록 내에서 연결 (또는 관리)을 선택합니다.
  5. Firebase를 BigQuery에 연결 정보 단계에서 다음을 선택합니다.
  6. 통합 구성 섹션에서 Google 애널리틱스 데이터 전송을 사용 설정하는 스위치를 클릭하고 BigQuery에 연결을 선택합니다.

이제 Firebase 애널리틱스 이벤트 데이터를 BigQuery에 자동으로 전송하도록 Firebase Console 프로젝트를 사용 설정했습니다. 이 작업은 추가 상호작용 없이 자동으로 실행되지만 BigQuery에서 분석 데이터 세트를 만드는 첫 번째 내보내기는 24시간 동안 실행되지 않을 수 있습니다. 데이터 세트가 만들어진 후 Firebase는 새로운 애널리틱스 이벤트를 BigQuery로 계속 일중 테이블로 내보내고 지난 날짜의 이벤트를 이벤트 테이블에서 그룹화합니다.

추천 모델을 학습시키려면 많은 데이터가 필요합니다. 아직 대량의 데이터를 생성하는 앱이 없으므로 다음 단계에서는 이 튜토리얼의 나머지 부분에서 사용할 샘플 데이터 세트를 BigQuery로 가져옵니다.

10. BigQuery를 사용하여 모델 학습 데이터 가져오기

이제 Firebase Console을 연결하여 BigQuery로 내보내므로 앱 애널리틱스 이벤트 데이터가 시간이 지나면 BigQuery 콘솔에 자동으로 표시됩니다. 이 튜토리얼에서 사용할 초기 데이터를 가져오기 위해 이 단계에서는 추천 모델을 학습시키는 데 사용할 기존 샘플 데이터 세트를 BigQuery 콘솔로 가져옵니다.

BigQuery로 샘플 데이터 세트 가져오기

  1. Google Cloud 콘솔에서 BigQuery 대시보드로 이동합니다.
  2. 메뉴에서 프로젝트 이름을 선택합니다.
  3. BigQuery 왼쪽 탐색 메뉴 하단에서 프로젝트 이름을 선택하여 세부정보를 확인합니다.
  4. 데이터 세트 만들기를 선택하여 데이터 세트 만들기 패널을 엽니다.
  5. 데이터 세트 ID로 'firebase_recommendations_dataset'를 입력하고 데이터 세트 만들기를 선택합니다.
  6. 새 데이터 세트가 왼쪽 메뉴의 프로젝트 이름 아래에 표시됩니다. 클릭합니다.
  7. 테이블 만들기를 선택하여 테이블 만들기 패널을 엽니다.
  8. 다음 항목으로 테이블 만들기에서 'Google Cloud Storage'를 선택합니다.
  9. GCS 버킷에서 파일 선택 필드에 'gs://firebase-recommendations/recommendations-test/formatted_data_filtered.txt'를 입력합니다.
  10. 파일 형식 드롭다운에서 'JSONL'을 선택합니다.
  11. 테이블 이름으로 'recommendations_table'을 입력합니다.
  12. 스키마 > 자동 감지 > 스키마 및 입력 매개변수에서 체크박스를 선택합니다.
  13. 테이블 만들기를 선택합니다.

샘플 데이터 세트 살펴보기

이 시점에서 선택적으로 스키마를 탐색하고 이 데이터 세트를 미리 볼 수 있습니다.

  1. 왼쪽 메뉴에서 firebase-recommendations-dataset를 선택하여 포함된 테이블을 펼칩니다.
  2. recommendations-table 테이블을 선택하여 테이블 스키마를 확인합니다.
  3. 미리보기를 선택하여 이 표에 포함된 실제 애널리틱스 이벤트 데이터를 확인합니다.

서비스 계정 사용자 인증 정보 만들기

이제 다음 단계에서 Colab 환경에서 BigQuery 데이터에 액세스하고 로드하는 데 사용할 수 있는 서비스 계정 사용자 인증 정보를 Google Cloud 콘솔 프로젝트에 만들어 보겠습니다.

  1. Google Cloud 프로젝트에 결제가 사용 설정되어 있는지 확인합니다.
  2. BigQuery 및 BigQuery Storage API API를 사용 설정합니다. < 여기를 클릭>
  3. 서비스 계정 키 만들기 페이지로 이동합니다.
  4. 서비스 계정 목록에서 새 서비스 계정을 선택합니다.
  5. 서비스 계정 이름 필드에 이름을 입력합니다.
  6. 역할 목록에서 프로젝트 > 소유자를 선택합니다.
  7. 만들기를 클릭합니다. 키가 포함된 JSON 파일이 컴퓨터에 다운로드됩니다.

다음 단계에서는 Google Colab을 사용하여 이 데이터를 사전 처리하고 추천 모델을 학습시킵니다.

11. 데이터 전처리 및 추천 모델 학습

이 단계에서는 Colab 노트북을 사용하여 다음 단계를 수행합니다.

  1. Colab 노트북으로 BigQuery 데이터 가져오기
  2. 데이터를 전처리하여 모델 학습을 위해 준비
  3. 분석 데이터를 기반으로 추천 모델을 학습시킴
  4. 모델을 TF Lite 모델로 내보내기
  5. 모델을 Firebase Console에 배포하여 앱에서 사용할 수 있도록 합니다.

Colab 학습 노트북을 출시하기 전에 Colab에서 학습된 모델을 Firebase Console에 배포할 수 있도록 먼저 Firebase Model Management API를 사용 설정합니다.

Firebase Model Management API 사용 설정

ML 모델을 저장할 버킷 만들기

Firebase Console에서 Storage로 이동하여 '시작하기'를 클릭합니다. fbbea78f0eb3dc9f.png

안내에 따라 버킷을 설정합니다.

19517c0d6d2aa14d.png

Firebase ML API 사용 설정

Google Cloud 콘솔에서 Firebase ML API 페이지로 이동하여 '사용 설정'을 클릭합니다.

Colab 노트북을 사용하여 모델 학습 및 배포

다음 링크를 사용하여 Colab 노트북을 열고 단계를 완료하세요. Colab 노트북에서 단계를 완료하면 Firebase Console에 TF Lite 모델 파일이 배포되어 앱에 동기화할 수 있게 됩니다.

Colab에서 열기

12. 앱에 모델 다운로드

이 단계에서는 Firebase 머신러닝에서 방금 학습시킨 모델을 다운로드하도록 앱을 수정합니다.

Firebase ML 종속 항목 추가

앱에서 Firebase 머신러닝 모델을 사용하려면 다음 종속 항목이 필요합니다. 종속 항목은 이미 추가되어 있어야 합니다 (확인).

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 Console에 배포
  • 앱에서 영화 추천 제공

다음 단계

  • 앱에 Firebase ML 추천을 구현합니다.

자세히 알아보기

질문이 있으신가요?

문제 신고