Вы можете использовать ML Kit для выполнения вывода на устройстве с помощью модели TensorFlow Lite .
Для этого API требуется Android SDK уровня 16 (Jelly Bean) или новее.
Прежде чем начать
- Если вы еще этого не сделали, добавьте Firebase в свой Android-проект .
- Добавьте зависимости для библиотек 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' }
- Конвертируйте нужную модель TensorFlow в формат TensorFlow Lite. См . TOCO: TensorFlow Lite Optimizing Converter .
Хостинг или пакетирование вашей модели
Прежде чем использовать модель TensorFlow Lite для вывода в приложении, необходимо сделать её доступной для ML Kit. ML Kit может использовать модели TensorFlow Lite, размещённые удалённо с помощью Firebase, связанные с исполняемым файлом приложения или и то, и другое.
Разместив модель на Firebase, вы можете обновлять ее без выпуска новой версии приложения, а также использовать Remote Config и A/B Testing для динамического предоставления различных моделей различным группам пользователей.
Если вы решите предоставить модель, разместив её в Firebase и не включив её в пакет приложения, вы можете уменьшить размер загружаемого файла. Однако имейте в виду, что если модель не включена в пакет приложения, все функции, связанные с моделью, будут недоступны до тех пор, пока приложение не загрузит её в первый раз.
Объединив модель с приложением, вы можете гарантировать, что функции машинного обучения вашего приложения продолжат работать, даже если модель, размещенная в Firebase, недоступна.
Хост-модели на Firebase
Чтобы разместить модель TensorFlow Lite на Firebase:
- В разделе ML Kit консоли Firebase выберите вкладку Custom .
- Нажмите Добавить пользовательскую модель (или Добавить другую модель ).
- Укажите имя, которое будет использоваться для идентификации вашей модели в проекте Firebase, затем загрузите файл модели TensorFlow Lite (обычно заканчивающийся на
.tfliteили.lite). - В манифесте вашего приложения укажите, что требуется разрешение INTERNET:
<uses-permission android:name="android.permission.INTERNET" />
После добавления пользовательской модели в проект Firebase вы сможете ссылаться на неё в своих приложениях, используя указанное вами имя. Вы можете в любой момент загрузить новую модель TensorFlow Lite, и ваше приложение загрузит её и начнёт использовать после следующего перезапуска. Вы можете определить условия устройства, необходимые приложению для обновления модели (см. ниже).
Объедините модели с приложением
Чтобы связать модель TensorFlow Lite с приложением, скопируйте файл модели (обычно имеющий расширение .tflite или .lite ) в папку assets/ вашего приложения. (Возможно, сначала потребуется создать папку, щёлкнув правой кнопкой мыши по папке app/ , а затем выбрав «Создать» > «Папка» > «Папка Assets » .)
Затем добавьте следующее в файл build.gradle вашего приложения, чтобы Gradle не сжимал модели при сборке приложения:
android {
// ...
aaptOptions {
noCompress "tflite" // Your model's file extension: "tflite", "lite", etc.
}
}
Файл модели будет включен в пакет приложения и доступен ML Kit как необработанный ресурс.
Загрузить модель
Чтобы использовать модель TensorFlow Lite в приложении, сначала настройте в ML Kit места, где она будет доступна: удалённо с помощью Firebase, в локальном хранилище или в обоих вариантах. Если вы укажете и локальную, и удалённую модели, вы сможете использовать удалённую модель, если она доступна, и использовать локально хранящуюся модель, если удалённая модель недоступна.Настройте модель, размещенную в Firebase
Если вы разместили свою модель в Firebase, создайте объект FirebaseCustomRemoteModel , указав имя, которое вы присвоили модели при ее загрузке:
Java
FirebaseCustomRemoteModel remoteModel =
new FirebaseCustomRemoteModel.Builder("your_model").build();
Kotlin
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
val conditions = FirebaseModelDownloadConditions.Builder()
.requireWifi()
.build()
FirebaseModelManager.getInstance().download(remoteModel, conditions)
.addOnCompleteListener {
// Success.
}
Многие приложения запускают задачу загрузки в своем коде инициализации, но вы можете сделать это в любой момент до того, как вам понадобится использовать модель.
Настроить локальную модель
Если вы связали модель со своим приложением, создайте объект FirebaseCustomLocalModel , указав имя файла модели TensorFlow Lite:
Java
FirebaseCustomLocalModel localModel = new FirebaseCustomLocalModel.Builder()
.setAssetFilePath("your_model.tflite")
.build();
Kotlin
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
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
FirebaseModelManager.getInstance().isModelDownloaded(remoteModel)
.addOnSuccessListener { isDownloaded ->
val options =
if (isDownloaded) {
FirebaseModelInterpreterOptions.Builder(remoteModel).build()
} else {
FirebaseModelInterpreterOptions.Builder(localModel).build()
}
val interpreter = FirebaseModelInterpreter.getInstance(options)
}
Если у вас есть только удалённо размещённая модель, следует отключить связанные с ней функции (например, сделать её серой или скрыть часть пользовательского интерфейса) до подтверждения загрузки модели. Это можно сделать, добавив прослушиватель к методу 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
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, указав количество и размерность («форму») массивов, используемых вашей моделью.
Если вы не знаете форму и тип входных и выходных данных вашей модели, вы можете использовать интерпретатор Python TensorFlow Lite для проверки модели. Например:
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 x224x224x3 значений float , представляющий собой пакет из N трехканальных (RGB) изображений размером 224x224, и выдавать в качестве выходных данных список из 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
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
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
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
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
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 в локальном хранилище.
Теоретически это означает, что любой может скопировать вашу модель. Однако на практике большинство моделей настолько специфичны для конкретного приложения и запутаны оптимизациями, что риск аналогичен риску, возникающему при дизассемблировании и повторном использовании вашего кода конкурентами. Тем не менее, вам следует учитывать этот риск, прежде чем использовать пользовательскую модель в своём приложении.
На уровне API Android 21 (Lollipop) и более новых версиях модель загружается в каталог, исключенный из автоматического резервного копирования .
В Android API уровня 20 и старше модель загружается в каталог com.google.firebase.ml.custom.models во внутреннем хранилище приложения. Если вы включили резервное копирование файлов с помощью BackupAgent , вы можете исключить этот каталог.