Миграция для Android

Обновление импорта Gradle

Новый SDK требует только одну зависимость для каждого API ML Kit. Вам не нужно указывать распространённые библиотеки, такие как firebase-ml-vision или firebase-ml-natural-language . ML Kit использует пространство имён com.google.android.gms для библиотек, зависящих от сервисов Google Play.

API-интерфейсы Vision

Связанные модели поставляются как часть вашего приложения. Тонкие модели необходимо загрузить. Некоторые API доступны как в связанной, так и в тонкой форме, другие — только в одной из этих форм:

Обновите зависимости для библиотек ML Kit Android в файле Gradle вашего модуля (уровня приложения) (обычно app/build.gradle ) в соответствии со следующими таблицами:

Модели в комплекте

Худые модели

AutoMLVision Edge

API естественного языка

Модели в комплекте поставляются вместе с заявкой. Тонкие модели необходимо загрузить:

Обновите зависимости для библиотек ML Kit Android в файле Gradle вашего модуля (уровня приложения) (обычно app/build.gradle ) в соответствии со следующими таблицами:

Модели в комплекте

Худые модели

Обновить имена классов

Если ваш класс присутствует в этой таблице, внесите указанные изменения:

Для других классов следуйте следующим правилам:

• Удалите префикс FirebaseVision из имени класса.
• Удалите из имени класса другие префиксы, начинающиеся с префикса Firebase .

Также в названиях пакетов замените префикс com.google.firebase.ml на com.google.mlkit .

Обновить имена методов

Изменения кода минимальны:

• Изменена реализация детектора/сканера/маркировщика/транслятора… Теперь у каждой функции есть своя точка входа. Например: BarcodeScanning, TextRecognition, ImageLabeling, Translation… Вызовы метода getInstance() сервиса Firebase заменены вызовами метода getClient() точки входа функции.
• Удален экземпляр TextRecognizer по умолчанию, поскольку мы добавили дополнительные библиотеки для распознавания других письменностей, таких как китайская и корейская. Чтобы использовать параметры по умолчанию с моделью распознавания текста на латинице, объявите зависимость от com.google.android.gms:play-services-mlkit-text-recognition и используйте TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS) .
• Создание экземпляров по умолчанию для ImageLabeler и ObjectDetector было удалено, поскольку мы добавили поддержку пользовательских моделей для этих двух функций. Например, чтобы использовать параметры по умолчанию с базовой моделью в ImageLabeling, объявите зависимость от com.google.mlkit:image-labeling и используйте ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) в Java.
• Все обработчики (детектор/сканер/маркировщик/транслятор…) можно закрыть. Убедитесь, что метод close() вызывается, когда эти объекты больше не будут использоваться. Если вы используете их во фрагменте или AppCompatActivity, один из простых способов сделать это — вызвать LifecycleOwner.getLifecycle() во фрагменте или AppCompatActivity, а затем вызвать Lifecycle.addObserver.
• processImage() и detectInImage() в API Vision были переименованы в process() для обеспечения единообразия.
• API естественного языка теперь используют термин «языковой тег» (согласно определению стандарта BCP 47 ) вместо «языкового кода».
• Методы получения в классах xxxOptions были удалены.
• Метод getBitmap() в классе InputImage (заменяющий FirebaseVisionImage ) больше не поддерживается в качестве части открытого интерфейса. Чтобы преобразовать растровые изображения из различных входных данных, обратитесь к файлу BitmapUtils.java в кратком руководстве по ML Kit .
• FirebaseVisionImageMetadata удалены, теперь вы можете просто передавать метаданные изображения, такие как ширина, высота, угол поворота и формат, в методы построения InputImages.

Вот несколько примеров старых и новых методов Kotlin:

// Construct image labeler with base model and default options.
val imageLabeler = FirebaseVision.getInstance().onDeviceImageLabeler

// Construct object detector with base model and default options.
val objectDetector = FirebaseVision.getInstance().onDeviceObjectDetector

// Construct face detector with given options
val faceDetector = FirebaseVision.getInstance().getVisionFaceDetector(options)

// Construct image labeler with local AutoML model
val localModel =
    FirebaseAutoMLLocalModel.Builder()
      .setAssetFilePath("automl/manifest.json")
      .build()
val autoMLImageLabeler =
    FirebaseVision.getInstance()
      .getOnDeviceAutoMLImageLabeler(
          FirebaseVisionOnDeviceAutoMLImageLabelerOptions.Builder(localModel)
            .setConfidenceThreshold(0.3F)
            .build()
    )

// Construct image labeler with base model and default options.
val imageLabeler = ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS)
// Optional: add life cycle observer
lifecycle.addObserver(imageLabeler)

// Construct object detector with base model and default options.
val objectDetector = ObjectDetection.getClient(ObjectDetectorOptions.DEFAULT_OPTIONS)

// Construct face detector with given options
val faceDetector = FaceDetection.getClient(options)

// Construct image labeler with local AutoML model
val localModel =
  LocalModel.Builder()
    .setAssetManifestFilePath("automl/manifest.json")
    .build()
val autoMLImageLabeler =
  ImageLabeling.getClient(
    CustomImageLabelerOptions.Builder(localModel)
    .setConfidenceThreshold(0.3F).build())
  

Вот несколько примеров старых и новых методов Java:

// Construct image labeler with base model and default options.
FirebaseVisionImageLabeler imagelLabeler =
     FirebaseVision.getInstance().getOnDeviceImageLabeler();

// Construct object detector with base model and default options.
FirebaseVisionObjectDetector objectDetector =
     FirebaseVision.getInstance().getOnDeviceObjectDetector();

// Construct face detector with given options
FirebaseVisionFaceDetector faceDetector =
     FirebaseVision.getInstance().getVisionFaceDetector(options);

// Construct image labeler with local AutoML model
FirebaseAutoMLLocalModel localModel =
    new FirebaseAutoMLLocalModel.Builder()
      .setAssetFilePath("automl/manifest.json")
      .build();
FirebaseVisionImageLabeler autoMLImageLabeler =
    FirebaseVision.getInstance()
      .getOnDeviceAutoMLImageLabeler(
          FirebaseVisionOnDeviceAutoMLImageLabelerOptions.Builder(localModel)
            .setConfidenceThreshold(0.3F)
            .build());

// Construct image labeler with base model and default options.
ImageLabeler imageLabeler = ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS);
// Optional: add life cycle observer
getLifecycle().addObserver(imageLabeler);

// Construct object detector with base model and default options.
ObjectDetector objectDetector = ObjectDetection.getClient(ObjectDetectorOptions.DEFAULT_OPTIONS);

// Construct face detector with given options
FaceDetector faceDetector = FaceDetection.getClient(options);

// Construct image labeler with local AutoML model
LocalModel localModel =
  new LocalModel.Builder()
    .setAssetManifestFilePath("automl/manifest.json")
    .build();
ImageLabeler autoMLImageLabeler =
  ImageLabeling.getClient(
    new CustomImageLabelerOptions.Builder(localModel)
    .setConfidenceThreshold(0.3F).build());
  

Изменения, специфичные для API

Сканирование штрих-кода

Для API сканирования штрихкодов теперь есть два способа доставки моделей:

• Через сервисы Google Play (также известные как «тонкие») (рекомендуется) — это уменьшает размер приложения и позволяет использовать модель совместно с другими приложениями. Однако разработчикам необходимо убедиться, что модель загружена перед первым использованием.
• С APK вашего приложения, также известным как «связанный» — это увеличивает размер приложения, но означает, что модель готова к использованию немедленно.

Эти две реализации немного отличаются: «комплектная» версия имеет ряд улучшений по сравнению с «тонкой». Подробности этих различий можно найти в руководстве по API сканирования штрихкодов .

Распознавание лиц

Для API распознавания лиц модели могут быть доставлены двумя способами:

• Через сервисы Google Play (также известные как «тонкие») (рекомендуется) — это уменьшает размер приложения и позволяет использовать модель совместно с другими приложениями. Однако разработчикам необходимо убедиться, что модель загружена перед первым использованием.
• С APK вашего приложения, также известным как «связанный» — это увеличивает размер загружаемого приложения, но означает, что модель готова к использованию немедленно.

Поведение реализаций одинаково.

Перевод

• TranslateLanguage теперь использует читаемые имена для своих констант (например, ENGLISH ) вместо языковых тегов ( EN ). Они также теперь @StringDef вместо @IntDef, а значением константы является соответствующий языковой тег BCP 47 .

• Если ваше приложение использует опцию загрузки при бездействии устройства, учтите, что она удалена и больше не может использоваться. Вы по-прежнему можете использовать опцию зарядки устройства. Если вам требуется более сложное поведение, вы можете отложить вызов RemoteModelManager.download выполнив собственную логику.

Маркировка изображений AutoML

Если ваше приложение использует опцию загрузки «устройство в режиме ожидания», имейте в виду, что она удалена и больше не может быть использована. Вы по-прежнему можете использовать опцию «устройство заряжается».

Если вам требуется более сложное поведение, вы можете отложить вызов RemoteModelManager.download в соответствии со своей собственной логикой.

Обнаружение и отслеживание объектов

Если ваше приложение использует обнаружение объектов с грубой классификацией, учтите, что в новом SDK изменился способ возврата категории классификации для обнаруженных объектов.

Категория классификации возвращается как экземпляр DetectedObject.Label а не как целое число. Все возможные категории для грубого классификатора включены в класс PredefinedCategory .

Вот пример старого и нового кода Kotlin:

if (object.classificationCategory == FirebaseVisionObject.CATEGORY_FOOD) {
    ...
}

if (!object.labels.isEmpty() && object.labels[0].text == PredefinedCategory.FOOD) {
    ...
}
// or
if (!object.labels.isEmpty() && object.labels[0].index == PredefinedCategory.FOOD_INDEX) {
    ...
}

Вот пример старого и нового кода Java:

if (object.getClassificationCategory() == FirebaseVisionObject.CATEGORY_FOOD) {
    ...
}

if (!object.getLabels().isEmpty()
    && object.getLabels().get(0).getText().equals(PredefinedCategory.FOOD)) {
    ...
}
// or
if (!object.getLabels().isEmpty()
    && object.getLabels().get(0).getIndex() == PredefinedCategory.FOOD_INDEX) {
    ...
}

Категория «неизвестно» удалена. Если достоверность классификации объекта низкая, мы просто не возвращаем метку.

Удалить зависимости Firebase (необязательно)

Этот шаг применим только при соблюдении следующих условий:

• Firebase ML Kit — единственный компонент Firebase, который вы используете.
• Вы используете только API на устройстве.
• Вы не используете модель подачи.

В этом случае вы можете удалить зависимости Firebase после миграции. Выполните следующие действия:

• Удалите файл конфигурации Firebase, удалив файл конфигурации google-services.json в каталоге модуля (уровня приложения) вашего приложения.
• Замените плагин Google Services Gradle в файле Gradle вашего модуля (уровня приложения) (обычно app/build.gradle) на плагин Strict Version Matcher:

apply plugin: 'com.android.application'
apply plugin: 'com.google.gms.google-services'  // Google Services plugin

android {
  // …
}

apply plugin: 'com.android.application'
apply plugin: 'com.google.android.gms.strict-version-matcher-plugin'

android {
  // …
}

• Замените classpath плагина Google Services Gradle в файле Gradle вашего проекта (корневого уровня) (build.gradle) на classpath для плагина Strict Version Matcher:

buildscript {
  dependencies {
    // ...

    classpath 'com.google.gms:google-services:4.3.3'  // Google Services plugin
  }
}

buildscript {
  dependencies {
    // ...

    classpath 'com.google.android.gms:strict-version-matcher-plugin:1.2.1'
  }
}

Удалите приложение Firebase в консоли Firebase, следуя инструкциям на сайте поддержки Firebase.

Получение помощи

Если у вас возникнут какие-либо проблемы, посетите страницу нашего сообщества , где мы описываем доступные каналы связи с нами.