TFLite 기반 Android 앱에 Firebase 추가

1. 개요

cd824ecfd05a2822.png

Firebase ML을 사용하면 무선으로 모델을 배포할 수 있습니다. 이렇게 하면 앱 크기를 작게 유지하고 필요한 경우에만 ML 모델을 다운로드하거나, 여러 모델을 실험하거나, 전체 앱을 다시 게시할 필요 없이 ML 모델을 업데이트할 수 있습니다.

이 Codelab에서는 정적 TFLite 모델을 사용하는 Android 앱을 Firebase에서 동적으로 제공되는 모델을 사용하는 앱으로 변환합니다.

학습할 내용

  • TFLite 모델을 Firebase ML에 배포하고 앱에서 액세스
  • Firebase Analytics로 사용자 피드백을 추적하여 모델 정확성 측정
  • Firebase Performance를 통해 모델 성능 프로파일링
  • 배포된 여러 모델 중 원격 구성을 통해 로드할 모델 선택
  • Firebase A/B 테스팅을 통해 다양한 모델 실험

필요한 항목

  • 최신 Android 스튜디오 버전
  • 샘플 코드
  • Android 5.0 이상 및 Google Play 서비스 9.8 이상이 설치된 테스트 기기 또는 Google Play 서비스 9.8 이상이 설치된 에뮬레이터
  • 기기를 사용하는 경우 연결 케이블

이 튜토리얼을 어떻게 사용하실 계획인가요?

읽기만 할 계획입니다 읽은 다음 연습 활동을 완료할 계획입니다

Android 앱 빌드 경험은 어느 정도인가요?

초급 중급 고급

2. 샘플 코드 가져오기

명령줄에서 GitHub 저장소를 클론합니다.

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

git이 설치되어 있지 않으면 GitHub 페이지에서 또는 이 링크를 클릭하여 샘플 프로젝트를 다운로드할 수도 있습니다.

3. 시작 앱 가져오기

Android 스튜디오에서 샘플 코드 다운로드 ( File > Open > .../codelab-Digiclassifier-android/start)에서 codelab-digitclassifier-android 디렉터리 (android_studio_folder.png)를 선택합니다.

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

4. 시작 앱 실행

이제 프로젝트를 Android 스튜디오로 가져왔으므로 처음으로 앱을 실행할 수 있습니다. Android 기기를 연결하고 Android 스튜디오 툴바에서 Run ( 실행.png)을 클릭합니다.

기기에서 앱이 실행됩니다. 이 시점에서 숫자를 그리려고 하면 앱이 이를 인식할 수 있습니다.

6e36e1b947b395f2.png

5. Firebase Console 프로젝트 만들기

프로젝트에 Firebase 추가

  1. Firebase Console로 이동합니다.
  2. 프로젝트 추가를 선택합니다.
  3. 프로젝트 이름을 선택하거나 입력합니다.
  4. Firebase Console에서 나머지 설정 단계를 따른 다음 프로젝트 만들기 (또는 기존 Google 프로젝트를 사용하는 경우 Firebase 추가)를 클릭합니다.

6. Firebase 추가

  1. 새 프로젝트의 개요 화면에서 Android 아이콘을 클릭하여 설정 워크플로를 시작합니다.
  2. Codelab의 패키지 이름(org.tensorflow.lite.examples.digitclassifier)을 입력합니다.

앱에 google-services.json 파일 추가

패키지 이름을 등록하고 다음을 선택한 후 google-services.json 다운로드를 클릭하여 Firebase Android 구성 파일을 가져온 다음 google-services.json 파일을 프로젝트의 app 디렉터리에 복사합니다. 파일이 다운로드되면 콘솔에 표시된 다음 단계를 건너뛸 수 있습니다 (build-android-start 프로젝트에서 이미 완료되어 있음).

앱에 google-services 플러그인 추가

google-services 플러그인은 google-services.json 파일을 사용하여 Firebase를 사용하도록 애플리케이션을 구성합니다. 프로젝트의 app 디렉터리에 있는 build.gradle.kts 파일 상단의 plugins 블록에 다음 줄을 추가합니다.

app/build.gradle.kts

id("com.google.gms.google-services")

그런 다음 프로젝트의 build.gradle.kts 파일에 있는 plugins 블록에 다음 줄을 추가합니다.

project/build.gradle.kts에서

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

프로젝트를 gradle 파일과 동기화

앱에서 모든 종속 항목을 사용할 수 있도록 하려면 이 시점에서 프로젝트를 Gradle 파일과 동기화해야 합니다. Android 스튜디오 툴바에서 File > Sync Project with Gradle Files를 선택합니다.

7. Firebase로 앱 실행

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

기기에서 앱이 실행됩니다. 이 시점에서 앱은 여전히 정상적으로 빌드됩니다.

8. Firebase ML에 모델 배포

Firebase ML에 모델을 배포하는 것이 유용한 두 가지 주요 이유는 다음과 같습니다.

  1. 앱 설치 크기를 작게 유지하고 필요한 경우에만 모델을 다운로드할 수 있습니다.
  2. 모델을 정기적으로 업데이트할 수 있으며 전체 앱과는 다른 출시 주기로 업데이트할 수 있습니다.

앱의 정적 모델을 Firebase에서 동적으로 다운로드한 모델로 바꾸려면 먼저 이 모델을 Firebase ML에 배포해야 합니다. 이 모델은 콘솔을 통해 또는 Firebase Admin SDK를 사용하여 프로그래매틱 방식으로 배포할 수 있습니다. 이 단계에서는 콘솔을 통해 배포합니다.

간단하게 설명하기 위해 이미 앱에 있는 TensorFlow Lite 모델을 사용하겠습니다. 먼저 Firebase Console을 열고 왼쪽 탐색 패널에서'머신러닝'을 클릭합니다. 이 페이지를 처음 여는 경우 '시작하기'를 클릭합니다. 그런 다음 '맞춤'으로 이동하여 '맞춤 모델 추가' 버튼을 클릭합니다.

메시지가 표시되면 mnist_v1와 같이 모델에 설명이 포함된 이름을 지정하고 start/app/src/main/assets/mnist.tflite 아래 Codelab 프로젝트 디렉터리에서 파일을 업로드합니다. 그런 다음 Android 프로젝트에서 이 TF Lite 모델 파일을 삭제할 수 있습니다.

3c3c50e6ef12b3b.png

9. Firebase ML에서 모델 다운로드

TFLite 모델은 비교적 커질 수 있으므로 원격 모델을 Firebase에서 앱으로 다운로드할 시점을 선택하는 것은 까다로울 수 있습니다. 모델이 하나의 기능에만 사용되고 사용자가 해당 기능을 사용하지 않는 경우 아무 이유 없이 상당량의 데이터가 다운로드되므로 앱이 실행될 때 즉시 모델을 로드하지 않는 것이 좋습니다. Wi-Fi에 연결되었을 때만 모델을 가져오는 것과 같은 다운로드 옵션을 설정할 수도 있습니다. 네트워크 연결 없이도 모델을 사용할 수 있도록 하려면 백업용으로 앱을 사용하지 않고 모델을 번들로 묶는 것이 중요합니다.

편의를 위해 기본 번들 모델을 삭제하고 앱이 시작될 때 항상 Firebase에서 모델을 다운로드합니다. 이렇게 하면 숫자 인식을 실행할 때 Firebase에서 제공하는 모델로 추론을 실행할 수 있습니다.

app/build.gradle.kts 파일에 Firebase 머신러닝 종속 항목을 추가합니다.

app/build.gradle.kts

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

그런 다음 Firebase에서 모델을 다운로드하는 로직을 추가합니다.

digitClassifier.initialize(loadModelFile())를 downloadModel("mnist_v1")로 대체하고 이 메서드를 구현합니다.

MainActivity.kt

  private fun downloadModel(modelName: String): Task<CustomModel> {
    val conditions = CustomModelDownloadConditions.Builder()
    .requireWifi()
    .build()
    return FirebaseModelDownloader.getInstance()
        .getModel(modelName, DownloadType.LOCAL_MODEL, conditions)
        .addOnCompleteListener {
          val model = it.result
          if (model == null) {
            showToast("Failed to get model file.")
          } else {
            showToast("Downloaded remote model: $modelName")
            digitClassifier.initialize(model)
          }
        }
      .addOnFailureListener {
        showToast("Model download failed for $modelName, please check your connection.")
      }
  }

앱을 다시 실행하고 숫자 분류기에 숫자를 그립니다. 다운로드가 완료되면 원격 모델이 다운로드되었다는 토스트 메시지와 새 모델이 사용되고 있음을 나타내는 로그가 표시됩니다.

10. 사용자 피드백 및 전환을 추적하여 모델 정확성 측정

Firebase용 Google 애널리틱스를 사용하면 사용자가 애플리케이션을 통해 이동하는 방식, 사용자가 성공하는 부분, 중단했다가 돌아오는 지점 등을 파악할 수 있습니다. 또한 애플리케이션에서 가장 많이 사용되는 부분을 이해하는 데 사용할 수 있습니다.

모델 예측에 대한 사용자 피드백을 추적하여 모델의 정확성을 측정합니다. 사용자가 '예'를 클릭하면 예상 검색어가 정확하다는 의미입니다.

애널리틱스 이벤트를 로깅하여 모델의 정확성을 추적할 수 있습니다. 먼저 종속 항목에 애널리틱스를 추가해야 프로젝트에서 애널리틱스를 사용할 수 있습니다.

Firebase 애널리틱스 종속 항목 추가

app/build.gradle.kts

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

이벤트 기록

그런 다음 onCreate 함수에서 correct_inference 이벤트를 Firebase에 로깅하도록 온클릭 리스너를 설정합니다.

MainActivity.kt (onCreate)

// Setup YES button
yesButton?.setOnClickListener {
  Firebase.analytics.logEvent("correct_inference", null)
}

앱을 다시 실행하고 숫자를 그립니다. 'Yes' 버튼을 몇 번 눌러 추론이 정확했다는 의견을 보냅니다.

디버그 분석

일반적으로 앱에서 기록하는 이벤트는 약 1시간에 걸쳐 묶은 후 함께 업로드됩니다. 이 방법을 사용하면 최종 사용자 기기에서 배터리를 절약하고 네트워크 데이터 사용량을 줄일 수 있습니다. 그러나 분석 구현을 검증하고 DebugView 보고서에서 분석을 보려면 개발 기기에서 디버그 모드를 사용 설정하여 이벤트를 최소한의 지연으로 업로드할 수 있습니다.

Android 기기에서 애널리틱스 디버그 모드를 사용 설정하려면 다음 명령어를 실행합니다.

adb shell setprop debug.firebase.analytics.app org.tensorflow.lite.examples.digitclassifier

앱을 다시 실행하고 숫자를 그립니다. 'Yes' 버튼을 몇 번 눌러 추론이 정확했다는 의견을 보냅니다. 이제 Firebase Console의 디버그 보기를 통해 거의 실시간으로 로그 이벤트를 볼 수 있습니다. 왼쪽 탐색 메뉴에서 애널리틱스 > DebugView를 클릭합니다.

5276199a086721fd.png

11. 모델의 성능 분석

Firebase Performance Monitoring은 iOS, Android, 웹 앱의 성능 특성을 파악하는 데 도움이 되는 서비스입니다.

Performance Monitoring SDK를 사용하여 앱에서 성능 데이터를 수집한 다음 Firebase Console에서 해당 데이터를 검토하고 분석합니다. Performance Monitoring을 사용하면 앱 성능을 개선할 수 있는 여지와 시점을 파악하여 성능 문제를 해결할 수 있습니다.

여기서는 추론 주위에 성능 트레이스를 추가하고

이것이 중요한 이유는 딥 러닝에 사용되는 더 큰 모델이 더 정확할 수 있지만 응답을 반환하는 데 시간이 더 오래 걸릴 수 있기 때문입니다. 이 실험에서는 정확성과 속도 사이의 적절한 균형을 찾고자 합니다.

Firebase 성능 종속 항목 추가

project/build.gradle.kts에서

plugins {
  // ...

  // Add the dependency for the Performance Monitoring plugin
  id("com.google.firebase.firebase-perf") version "1.4.2" apply false
}

app/build.gradle.kts

plugins {
  // ...

  // Add the Performance Monitoring plugin
  id("com.google.firebase.firebase-perf")
}

// ...

dependencies {
  // ...

  // Add the dependency for the Performance Monitoring library
  implementation("com.google.firebase:firebase-perf")
}

커스텀 트레이스 추가

setupDigitClassifier() 함수에서 새 downloadTrace를 만들고 모델을 다운로드하기 직전에 시작합니다. 그런 다음 트레이스를 중지하는 onsuccess 리스너를 추가합니다.

classifyDrawing() 함수에서 새textTrace를 만들고 분류 직전에 시작합니다. 그런 다음 onsuccess 리스너에서 트레이스를 중지합니다.

MainActivity.kt

class MainActivity : AppCompatActivity() {
  // ...
  
  private val firebasePerformance = FirebasePerformance.getInstance()
  
  // ...

  private fun setupDigitClassifier() {
    // Add these lines to create and start the trace
    val downloadTrace = firebasePerformance.newTrace("download_model")
    downloadTrace.start()
    downloadModel("mnist_v1")
      // Add these lines to stop the trace on success
      .addOnSuccessListener {
        downloadTrace.stop()
      }
  }

// ...

  private fun classifyDrawing() {
    val bitmap = drawView?.getBitmap()

    if ((bitmap != null) && (digitClassifier.isInitialized)) {
      // Add these lines to create and start the trace
      val classifyTrace = firebasePerformance.newTrace("classify")
      classifyTrace.start()
      digitClassifier
        .classifyAsync(bitmap)
        .addOnSuccessListener { resultText -> 
          // Add this line to stop the trace on success
          classifyTrace.stop()
          predictedTextView?.text = resultText
        }
        .addOnFailureListener { e ->
          predictedTextView?.text = getString(
            R.string.tfe_dc_classification_error_message,
            e.localizedMessage
          )
          Log.e(TAG, "Error classifying drawing.", e)
        }
    }
  }

성능 이벤트의 로그 메시지 보기

  1. 앱의 AndroidManifest.xml 파일에 다음과 같이 <meta-data> 요소를 추가하여 빌드 시 Performance Monitoring에 디버그 로깅을 사용 설정합니다.

AndroidManifest.xml

<application>
    <meta-data
      android:name="firebase_performance_logcat_enabled"
      android:value="true" />
</application>
  1. 로그 메시지에 오류 메시지가 있는지 확인합니다.
  2. Performance Monitoring은 로그 메시지에 FirebasePerformance로 태그를 지정합니다. logcat 필터링을 사용하면 다음 명령어를 실행하여 기간 trace 및 HTTP/S 네트워크 요청 로깅을 구체적으로 확인할 수 있습니다.
adb logcat -s FirebasePerformance
  1. Performance Monitoring에서 성능 이벤트를 로깅 중임을 나타내는 다음 유형의 로그를 확인합니다.
  • Logging TraceMetric
  • Logging NetworkRequestMetric

12. Firebase ML에 두 번째 모델 배포

더 나은 모델 아키텍처가 적용된 모델이나 더 크거나 업데이트된 데이터 세트로 학습된 모델 등 새로운 버전의 모델을 떠올릴 때 현재 모델을 새 버전으로 바꾸고 싶은 유혹을 느낄 수 있습니다. 하지만 테스트에서 좋은 성능을 보인 모델도 프로덕션에서 동일한 성능을 발휘하는 것은 아닙니다. 따라서 프로덕션 환경에서 A/B 테스트를 진행하여 원래 모델과 새 모델을 비교해 보겠습니다.

Firebase Model Management API 사용 설정

이 단계에서는 Firebase Model Management API를 사용 설정하여 Python 코드를 사용하여 TensorFlow Lite 모델의 새 버전을 배포합니다.

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

Firebase Console에서 스토리지로 이동하여 시작하기를 클릭합니다. fbbea78f0eb3dc9f.png

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

19517c0d6d2aa14d.png

Firebase ML API 사용 설정

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

2414fd5cced6c984.png메시지가 표시되면 Digit Classifier 앱을 선택합니다.

새 모델 학습 및 Firebase ML에 게시

이제 더 큰 데이터 세트를 사용하여 모델의 새 버전을 학습시키고 Firebase Admin SDK를 사용하여 학습 노트북에서 직접 프로그래매틱 방식으로 배포합니다.

서비스 계정의 비공개 키 다운로드

Firebase Admin SDK를 사용하려면 먼저 서비스 계정을 만들어야 합니다. 이 링크를 클릭하여 Firebase Console의 서비스 계정 패널을 열고 버튼을 클릭하여 Firebase Admin SDK의 새 서비스 계정을 만듭니다. 메시지가 나타나면 새 비공개 키 생성 버튼을 클릭합니다. 서비스 계정 키를 사용하여 Colab 노트북에서 요청을 인증합니다.

C3b95de1e5508516.png

이제 새 모델을 학습시키고 배포할 수 있습니다.

  1. 이 Colab 노트북을 열고 내 Drive에 사본을 만듭니다.
  2. 왼쪽에 있는 재생 버튼을 클릭하여 첫 번째 셀인 '개선된 TensorFlow Lite 모델 학습'을 실행합니다. 새 모델을 학습시키며 다소 시간이 걸릴 수 있습니다.
  3. 두 번째 셀을 실행하면 파일 업로드 프롬프트가 생성됩니다. 서비스 계정을 만들 때 Firebase Console에서 다운로드한 json 파일을 업로드합니다.

71e847c6a85423b3.png

  1. 마지막 두 셀을 실행합니다.

Colab 노트북을 실행하면 Firebase Console에 두 번째 모델이 표시됩니다. 두 번째 모델의 이름이 mnist_v2인지 확인합니다.

C316683bb4d75d57.png

13. 원격 구성을 통해 모델 선택

이제 두 개의 개별 모델이 있으므로 런타임에 다운로드할 모델을 선택하기 위한 매개변수를 추가하겠습니다. 클라이언트가 수신하는 매개변수 값에 따라 클라이언트가 다운로드하는 모델이 결정됩니다.

Firebase Console에서 구성 규칙 추가

먼저 Firebase Console을 열고 왼쪽 탐색 메뉴에서 원격 구성 버튼을 클릭합니다. 그런 다음 '매개변수 추가' 버튼을 클릭합니다.

새 매개변수의 이름을 model_name로 지정하고 기본값 "mnist_v1"을 지정합니다. 모델 이름을 원격 구성 매개변수에 넣으면 테스트할 모델마다 새 매개변수를 추가하지 않고도 여러 모델을 테스트할 수 있습니다. 변경사항 게시를 클릭하여 업데이트를 적용합니다.

2949cb95c7214ca4.png

Firebase RemoteConfig 종속 항목 추가

app/build.gradle.kts

implementation("com.google.firebase:firebase-config-ktx")

Firebase 원격 구성 구성

MainActivity.kt

  private fun configureRemoteConfig() {
    remoteConfig = Firebase.remoteConfig
    val configSettings = remoteConfigSettings {
      minimumFetchIntervalInSeconds = 3600
    }
    remoteConfig.setConfigSettingsAsync(configSettings)
  }

구성 요청 및 사용

구성 가져오기 요청을 만들고 완료 핸들러를 추가하여 구성 매개변수를 선택하여 사용합니다.

MainActivity.kt

 private fun setupDigitClassifier() {
    configureRemoteConfig()
    remoteConfig.fetchAndActivate()
      .addOnCompleteListener { task ->
        if (task.isSuccessful) {
          val modelName = remoteConfig.getString("model_name")
          val downloadTrace = firebasePerformance.newTrace("download_model")
          downloadTrace.start()
          downloadModel(modelName)
            .addOnSuccessListener {
              downloadTrace.stop()
            }
        } else {
          showToast("Failed to fetch model name.")
        }
      }
  }

원격 구성 테스트

  1. 98205811bbed9d74.pngRun 버튼을 클릭합니다.
  2. mnist_v1 모델이 다운로드되었다는 토스트 메시지가 표시되는지 확인합니다.
  3. Firebase Console로 돌아가서 기본값을 mnist_v2로 변경하고 변경사항 게시를 선택하여 업데이트를 적용합니다.
  4. 앱을 다시 시작하고 이번에 mnist_v2 모델이 다운로드되었다는 토스트 메시지가 표시되는지 확인합니다.

14. A/B 테스트 모델 효과

Firebase A/B 테스팅을 사용하면 제품 및 마케팅 실험을 쉽게 실행, 분석, 확장하여 앱 환경을 최적화할 수 있습니다. 마지막으로, Firebase에서 기본 제공하는 A/B 테스팅 동작을 사용하여 두 모델 중 성능이 더 우수한 모델을 확인할 수 있습니다.

Firebase Console에서 애널리틱스 -> 이벤트로 이동합니다. correct_inference 이벤트가 표시되면 '전환 이벤트'로 표시하고, 표시되지 않으면 '애널리틱스 -> 전환 이벤트'로 이동하여 '새 전환 이벤트 만들기'를 클릭하고 correct_inference.를 해제합니다.

이제 'Firebase Console의 원격 구성'으로 이동하여 방금 추가한 'model_name' 매개변수의 더보기 옵션 메뉴에서 'A/B 테스트' 버튼을 선택합니다.

fad5ea36969d2aeb.png

다음 메뉴에서 기본 이름을 그대로 사용합니다.

D7c006669ace6e40.png

드롭다운에서 앱을 선택하고 타겟팅 기준을 활성 사용자의 50% 로 변경합니다.

cb72dcc7d2666bd3.png

이전에 correct_inference 이벤트를 전환으로 설정할 수 있었던 경우 이 이벤트를 추적할 기본 측정항목으로 사용합니다. 이벤트가 애널리틱스에 표시될 때까지 기다리고 싶지 않다면 correct_inference manually를 추가하세요.

1ac9c94fb3159271.png

마지막으로 대안 화면에서 mnist_v1를 사용하도록 통제 그룹 대안을 설정하고 mnist_v2를 사용하도록 대안 A 그룹을 설정합니다.

E4510434f8da31b6.png

오른쪽 하단의 검토 버튼을 클릭합니다.

축하합니다. 별도의 두 모델에 대한 A/B 테스트를 만들었습니다. A/B 테스트는 현재 초안 상태이며 '실험 시작' 버튼을 클릭하여 언제든지 시작할 수 있습니다.

A/B 테스트에 대한 자세한 내용은 A/B 테스트 문서를 참조하세요.

15. 수고하셨습니다.

이 Codelab에서는 앱에서 정적으로 번들된 tflite 애셋을 Firebase에서 동적으로 로드된 TFLite 모델로 바꾸는 방법을 배웠습니다. TFLite 및 Firebase에 대해 자세히 알아보려면 다른 TFLite 샘플과 Firebase 시작 가이드를 살펴보세요.

학습한 내용

  • TensorFlow Lite
  • Firebase ML
  • Firebase 애널리틱스
  • Firebase Performance Monitoring
  • Firebase 원격 구성
  • Firebase A/B 테스팅

다음 단계

  • 앱에 Firebase ML 배포를 구현합니다.

자세히 알아보기

질문이 있으신가요?

문제 신고