Firebase Summit에서 발표된 모든 내용을 살펴보고 Firebase로 앱을 빠르게 개발하고 안심하고 앱을 실행하는 방법을 알아보세요. 자세히 알아보기

Android에서 ML Kit로 추론을 위해 TensorFlow Lite 모델 사용

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

ML Kit를 사용하여 TensorFlow Lite 모델로 기기 내 추론을 수행할 수 있습니다.

이 API에는 Android SDK 레벨 16(Jelly Bean) 이상이 필요합니다.

시작하기 전에

  1. 아직 Android 프로젝트에 Firebase를 추가 하지 않았다면 추가합니다.
  2. ML Kit Android 라이브러리에 대한 종속성을 모듈(앱 수준) Gradle 파일(일반적으로 app/build.gradle )에 추가합니다.
    apply plugin: 'com.android.application'
    apply plugin: 'com.google.gms.google-services'
    
    dependencies {
      // ...
    
      implementation 'com.google.firebase:firebase-ml-model-interpreter:22.0.3'
    }
    
  3. 사용하려는 TensorFlow 모델을 TensorFlow Lite 형식으로 변환합니다. TOCO: TensorFlow Lite 최적화 변환기 를 참조하십시오.

모델 호스팅 또는 번들링

앱에서 추론을 위해 TensorFlow Lite 모델을 사용하려면 먼저 모델을 ML Kit에서 사용할 수 있도록 설정해야 합니다. ML Kit는 Firebase를 사용하여 원격으로 호스팅되는 TensorFlow Lite 모델, 앱 바이너리와 함께 번들로 제공되는 모델 또는 둘 다를 사용할 수 있습니다.

Firebase에서 모델을 호스팅하면 새 앱 버전을 출시하지 않고도 모델을 업데이트할 수 있으며 원격 구성 및 A/B 테스팅을 사용하여 다양한 모델을 다양한 사용자에게 동적으로 제공할 수 있습니다.

모델을 Firebase와 함께 호스팅하여 제공하기만 하고 앱과 번들로 묶지 않도록 선택한 경우 앱의 초기 다운로드 크기를 줄일 수 있습니다. 그러나 모델이 앱과 함께 번들로 제공되지 않으면 앱에서 모델을 처음 다운로드할 때까지 모델 관련 기능을 사용할 수 없습니다.

모델을 앱과 번들로 묶으면 Firebase 호스팅 모델을 사용할 수 없을 때 앱의 ML 기능이 계속 작동하도록 할 수 있습니다.

Firebase에서 모델 호스팅

Firebase에서 TensorFlow Lite 모델을 호스팅하려면 다음 안내를 따르세요.

  1. Firebase 콘솔ML Kit 섹션에서 맞춤 탭을 클릭합니다.
  2. 사용자 지정 모델 추가 (또는 다른 모델 추가 )를 클릭합니다.
  3. Firebase 프로젝트에서 모델을 식별하는 데 사용할 이름을 지정한 다음 TensorFlow Lite 모델 파일(일반적으로 .tflite 또는 .lite 로 끝남)을 업로드합니다.
  4. 앱의 매니페스트에서 INTERNET 권한이 필요하다고 선언합니다.
    <uses-permission android:name="android.permission.INTERNET" />
    

Firebase 프로젝트에 맞춤 모델을 추가한 후 지정한 이름을 사용하여 앱에서 모델을 참조할 수 있습니다. 언제든지 새 TensorFlow Lite 모델을 업로드할 수 있으며 앱은 다음에 앱이 다시 시작될 때 새 모델을 다운로드하고 사용을 시작합니다. 앱이 모델 업데이트를 시도하는 데 필요한 장치 조건을 정의할 수 있습니다(아래 참조).

앱으로 모델 번들

TensorFlow Lite 모델을 앱과 번들로 묶으려면 모델 파일(일반적으로 .tflite 또는 .lite 로 끝남)을 앱의 assets/ 폴더에 복사합니다. ( app/ 폴더를 마우스 오른쪽 버튼으로 클릭한 다음 새로 만들기 > 폴더 > 자산 폴더 를 클릭하여 먼저 폴더를 만들어야 할 수도 있습니다.)

그런 다음 앱의 build.gradle 파일에 다음을 추가하여 앱을 빌드할 때 Gradle이 모델을 압축하지 않도록 합니다.

android {

    // ...

    aaptOptions {
        noCompress "tflite"  // Your model's file extension: "tflite", "lite", etc.
    }
}

모델 파일은 앱 패키지에 포함되며 ML Kit에서 원시 자산으로 사용할 수 있습니다.

모델 로드

앱에서 TensorFlow Lite 모델을 사용하려면 먼저 Firebase를 사용하여 원격으로, 로컬 저장소에서 또는 둘 다에서 모델을 사용할 수 있는 위치로 ML Kit를 구성합니다. 로컬 모델과 원격 모델을 모두 지정하는 경우 원격 모델이 있는 경우 원격 모델을 사용할 수 있고 원격 모델을 사용할 수 없는 경우 로컬에 저장된 모델로 대체할 수 있습니다.

Firebase 호스팅 모델 구성

Firebase로 모델을 호스팅한 경우 업로드할 때 모델에 할당한 이름을 지정하여 FirebaseCustomRemoteModel 객체를 생성합니다.

Java

FirebaseCustomRemoteModel remoteModel =
        new FirebaseCustomRemoteModel.Builder("your_model").build();

Kotlin+KTX

val remoteModel = FirebaseCustomRemoteModel.Builder("your_model").build()

그런 다음 다운로드를 허용할 조건을 지정하여 모델 다운로드 작업을 시작합니다. 모델이 기기에 없거나 최신 버전의 모델을 사용할 수 있는 경우 작업은 Firebase에서 모델을 비동기식으로 다운로드합니다.

Java

FirebaseModelDownloadConditions conditions = new FirebaseModelDownloadConditions.Builder()
        .requireWifi()
        .build();
FirebaseModelManager.getInstance().download(remoteModel, conditions)
        .addOnCompleteListener(new OnCompleteListener<Void>() {
            @Override
            public void onComplete(@NonNull Task<Void> task) {
                // Success.
            }
        });

Kotlin+KTX

val conditions = FirebaseModelDownloadConditions.Builder()
    .requireWifi()
    .build()
FirebaseModelManager.getInstance().download(remoteModel, conditions)
    .addOnCompleteListener {
        // Success.
    }

많은 앱이 초기화 코드에서 다운로드 작업을 시작하지만 모델을 사용하기 전에 언제든지 시작할 수 있습니다.

로컬 모델 구성

모델을 앱과 번들로 묶은 경우 TensorFlow Lite 모델의 파일 ​​이름을 지정하여 FirebaseCustomLocalModel 객체를 생성합니다.

Java

FirebaseCustomLocalModel localModel = new FirebaseCustomLocalModel.Builder()
        .setAssetFilePath("your_model.tflite")
        .build();

Kotlin+KTX

val localModel = FirebaseCustomLocalModel.Builder()
    .setAssetFilePath("your_model.tflite")
    .build()

모델에서 인터프리터 만들기

모델 소스를 구성한 후 그 중 하나에서 FirebaseModelInterpreter 객체를 만듭니다.

로컬 번들 모델만 있는 경우 FirebaseCustomLocalModel 객체에서 인터프리터를 생성하기만 하면 됩니다.

Java

FirebaseModelInterpreter interpreter;
try {
    FirebaseModelInterpreterOptions options =
            new FirebaseModelInterpreterOptions.Builder(localModel).build();
    interpreter = FirebaseModelInterpreter.getInstance(options);
} catch (FirebaseMLException e) {
    // ...
}

Kotlin+KTX

val options = FirebaseModelInterpreterOptions.Builder(localModel).build()
val interpreter = FirebaseModelInterpreter.getInstance(options)

원격으로 호스트되는 모델이 있는 경우 실행하기 전에 다운로드되었는지 확인해야 합니다. 모델 관리자의 isModelDownloaded() 메서드를 사용하여 모델 다운로드 작업의 상태를 확인할 수 있습니다.

인터프리터를 실행하기 전에 이를 확인하기만 하면 되지만 원격 호스팅 모델과 로컬 번들 모델이 모두 있는 경우 모델 인터프리터를 인스턴스화할 때 이 검사를 수행하는 것이 합리적일 수 있습니다. 다운로드되었으며 그렇지 않은 경우 로컬 모델에서 다운로드되었습니다.

Java

FirebaseModelManager.getInstance().isModelDownloaded(remoteModel)
        .addOnSuccessListener(new OnSuccessListener<Boolean>() {
            @Override
            public void onSuccess(Boolean isDownloaded) {
                FirebaseModelInterpreterOptions options;
                if (isDownloaded) {
                    options = new FirebaseModelInterpreterOptions.Builder(remoteModel).build();
                } else {
                    options = new FirebaseModelInterpreterOptions.Builder(localModel).build();
                }
                FirebaseModelInterpreter interpreter = FirebaseModelInterpreter.getInstance(options);
                // ...
            }
        });

Kotlin+KTX

FirebaseModelManager.getInstance().isModelDownloaded(remoteModel)
    .addOnSuccessListener { isDownloaded -> 
    val options =
        if (isDownloaded) {
            FirebaseModelInterpreterOptions.Builder(remoteModel).build()
        } else {
            FirebaseModelInterpreterOptions.Builder(localModel).build()
        }
    val interpreter = FirebaseModelInterpreter.getInstance(options)
}

원격으로 호스팅되는 모델만 있는 경우 모델이 다운로드되었음을 확인할 때까지 모델 관련 기능(예: UI 일부를 회색으로 표시하거나 숨기기)을 비활성화해야 합니다. 모델 관리자의 download() 메서드에 리스너를 연결하면 됩니다.

Java

FirebaseModelManager.getInstance().download(remoteModel, conditions)
        .addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void v) {
              // Download complete. Depending on your app, you could enable
              // the ML feature, or switch from the local model to the remote
              // model, etc.
            }
        });

Kotlin+KTX

FirebaseModelManager.getInstance().download(remoteModel, conditions)
    .addOnCompleteListener {
        // Download complete. Depending on your app, you could enable the ML
        // feature, or switch from the local model to the remote model, etc.
    }

모델의 입력 및 출력 지정

다음으로 모델 인터프리터의 입력 및 출력 형식을 구성합니다.

TensorFlow Lite 모델은 입력으로 하나 이상의 다차원 배열을 출력으로 생성합니다. 이러한 배열에는 byte , int , long 또는 float 값이 포함됩니다. 모델에서 사용하는 배열의 수와 차원("모양")으로 ML Kit를 구성해야 합니다.

모델 입력 및 출력의 모양과 데이터 유형을 모르는 경우 TensorFlow Lite Python 인터프리터를 사용하여 모델을 검사할 수 있습니다. 예를 들어:

import tensorflow as tf

interpreter = tf.lite.Interpreter(model_path="my_model.tflite")
interpreter.allocate_tensors()

# Print input shape and type
print(interpreter.get_input_details()[0]['shape'])  # Example: [1 224 224 3]
print(interpreter.get_input_details()[0]['dtype'])  # Example: <class 'numpy.float32'>

# Print output shape and type
print(interpreter.get_output_details()[0]['shape'])  # Example: [1 1000]
print(interpreter.get_output_details()[0]['dtype'])  # Example: <class 'numpy.float32'>

모델의 입력 및 출력 형식을 결정한 후에는 FirebaseModelInputOutputOptions 객체를 만들어 앱의 모델 인터프리터를 구성할 수 있습니다.

예를 들어, 부동 소수점 이미지 분류 모델은 N 224x224 3채널(RGB) 이미지의 배치를 나타내는 N x224x224x3 float 배열을 입력으로 사용하고 출력으로 1000 float 값 목록을 생성할 수 있습니다. 이미지가 모델이 예측하는 1000개 범주 중 하나의 구성원일 확률입니다.

이러한 모델의 경우 아래와 같이 모델 인터프리터의 입력 및 출력을 구성합니다.

Java

FirebaseModelInputOutputOptions inputOutputOptions =
        new FirebaseModelInputOutputOptions.Builder()
                .setInputFormat(0, FirebaseModelDataType.FLOAT32, new int[]{1, 224, 224, 3})
                .setOutputFormat(0, FirebaseModelDataType.FLOAT32, new int[]{1, 5})
                .build();

Kotlin+KTX

val inputOutputOptions = FirebaseModelInputOutputOptions.Builder()
        .setInputFormat(0, FirebaseModelDataType.FLOAT32, intArrayOf(1, 224, 224, 3))
        .setOutputFormat(0, FirebaseModelDataType.FLOAT32, intArrayOf(1, 5))
        .build()

입력 데이터에 대한 추론 수행

마지막으로 모델을 사용하여 추론을 수행하려면 입력 데이터를 가져오고 모델에 적합한 모양의 입력 배열을 얻는 데 필요한 데이터에 대한 변환을 수행합니다.

예를 들어 입력 모양이 [1 224 224 3] 부동 소수점 값인 이미지 분류 모델이 있는 경우 다음 예제와 같이 Bitmap 객체에서 입력 배열을 생성할 수 있습니다.

Java

Bitmap bitmap = getYourInputImage();
bitmap = Bitmap.createScaledBitmap(bitmap, 224, 224, true);

int batchNum = 0;
float[][][][] input = new float[1][224][224][3];
for (int x = 0; x < 224; x++) {
    for (int y = 0; y < 224; y++) {
        int pixel = bitmap.getPixel(x, y);
        // Normalize channel values to [-1.0, 1.0]. This requirement varies by
        // model. For example, some models might require values to be normalized
        // to the range [0.0, 1.0] instead.
        input[batchNum][x][y][0] = (Color.red(pixel) - 127) / 128.0f;
        input[batchNum][x][y][1] = (Color.green(pixel) - 127) / 128.0f;
        input[batchNum][x][y][2] = (Color.blue(pixel) - 127) / 128.0f;
    }
}

Kotlin+KTX

val bitmap = Bitmap.createScaledBitmap(yourInputImage, 224, 224, true)

val batchNum = 0
val input = Array(1) { Array(224) { Array(224) { FloatArray(3) } } }
for (x in 0..223) {
    for (y in 0..223) {
        val pixel = bitmap.getPixel(x, y)
        // Normalize channel values to [-1.0, 1.0]. This requirement varies by
        // model. For example, some models might require values to be normalized
        // to the range [0.0, 1.0] instead.
        input[batchNum][x][y][0] = (Color.red(pixel) - 127) / 255.0f
        input[batchNum][x][y][1] = (Color.green(pixel) - 127) / 255.0f
        input[batchNum][x][y][2] = (Color.blue(pixel) - 127) / 255.0f
    }
}

그런 다음 입력 데이터로 FirebaseModelInputs 객체를 만들고 이 객체와 모델의 입력 및 출력 사양을 모델 인터프리터run 메서드에 전달합니다.

Java

FirebaseModelInputs inputs = new FirebaseModelInputs.Builder()
        .add(input)  // add() as many input arrays as your model requires
        .build();
firebaseInterpreter.run(inputs, inputOutputOptions)
        .addOnSuccessListener(
                new OnSuccessListener<FirebaseModelOutputs>() {
                    @Override
                    public void onSuccess(FirebaseModelOutputs result) {
                        // ...
                    }
                })
        .addOnFailureListener(
                new OnFailureListener() {
                    @Override
                    public void onFailure(@NonNull Exception e) {
                        // Task failed with an exception
                        // ...
                    }
                });

Kotlin+KTX

val inputs = FirebaseModelInputs.Builder()
        .add(input) // add() as many input arrays as your model requires
        .build()
firebaseInterpreter.run(inputs, inputOutputOptions)
        .addOnSuccessListener { result ->
            // ...
        }
        .addOnFailureListener { e ->
            // Task failed with an exception
            // ...
        }

호출이 성공하면 성공 리스너에 전달된 객체의 getOutput() 메서드를 호출하여 출력을 얻을 수 있습니다. 예를 들어:

Java

float[][] output = result.getOutput(0);
float[] probabilities = output[0];

Kotlin+KTX

val output = result.getOutput<Array<FloatArray>>(0)
val probabilities = output[0]

출력을 사용하는 방법은 사용 중인 모델에 따라 다릅니다.

예를 들어 분류를 수행하는 경우 다음 단계로 결과의 인덱스를 해당 레이블이 나타내는 레이블에 매핑할 수 있습니다.

Java

BufferedReader reader = new BufferedReader(
        new InputStreamReader(getAssets().open("retrained_labels.txt")));
for (int i = 0; i < probabilities.length; i++) {
    String label = reader.readLine();
    Log.i("MLKit", String.format("%s: %1.4f", label, probabilities[i]));
}

Kotlin+KTX

val reader = BufferedReader(
        InputStreamReader(assets.open("retrained_labels.txt")))
for (i in probabilities.indices) {
    val label = reader.readLine()
    Log.i("MLKit", String.format("%s: %1.4f", label, probabilities[i]))
}

부록: 모델 보안

TensorFlow Lite 모델을 ML Kit에서 사용할 수 있도록 하는 방법에 관계없이 ML Kit는 표준 직렬화된 protobuf 형식으로 로컬 저장소에 저장합니다.

이론적으로 이것은 누구나 모델을 복사할 수 있음을 의미합니다. 그러나 실제로 대부분의 모델은 애플리케이션에 따라 다르고 최적화로 인해 난독화되어 경쟁업체가 코드를 분해하고 재사용하는 것과 유사한 위험이 있습니다. 그럼에도 불구하고 앱에서 사용자 지정 모델을 사용하기 전에 이러한 위험을 알고 있어야 합니다.

Android API 레벨 21(Lollipop) 이상에서는 자동 백업에서 제외된 디렉터리에 모델을 다운로드합니다.

Android API 레벨 20 이하에서 모델은 앱 전용 내부 저장소의 com.google.firebase.ml.custom.models 라는 디렉토리에 다운로드됩니다. BackupAgent 를 사용하여 파일 백업을 활성화한 경우 이 디렉터리를 제외하도록 선택할 수 있습니다.