Migracja na Androida

Aktualizowanie importów Gradle

Nowy pakiet SDK wymaga tylko 1 zależności dla każdego interfejsu ML Kit API. Nie musisz określać wspólnych bibliotek, takich jak firebase-ml-vision czy firebase-ml-natural-language. ML Kit używa przestrzeni nazw com.google.android.gms w przypadku bibliotek, które zależą od Usług Google Play.

Interfejsy Vision API

Modele połączone są dostarczane jako część aplikacji. Modele cienkie trzeba pobrać. Niektóre interfejsy API są dostępne w wersji połączonej i cienkiej, a inne tylko w jednej z nich:

Zaktualizuj zależności bibliotek ML Kit na Androida w pliku Gradle na poziomie modułu (aplikacji) (zwykle app/build.gradle) zgodnie z tabelami poniżej:

Modele połączone

Modele cienkie

AutoMLVision Edge

Interfejsy Natural Language API

Modele połączone są dostarczane jako część aplikacji. Modele cienkie trzeba pobrać:

Zaktualizuj zależności bibliotek ML Kit na Androida w pliku Gradle na poziomie modułu (aplikacji) (zwykle app/build.gradle) zgodnie z tabelami poniżej:

Modele połączone

Modele cienkie

Aktualizowanie nazw zajęć

Jeśli Twoja klasa znajduje się w tej tabeli, wprowadź wskazaną zmianę:

W przypadku innych klas postępuj zgodnie z tymi regułami:

• Usuń z nazwy klasy prefiks FirebaseVision.
• Usuń z nazwy klasy inne prefiksy, które zaczynają się od prefiksu Firebase.

Ponadto w nazwach pakietów zastąp prefiks com.google.firebase.ml prefiksem com.google.mlkit.

Aktualizowanie nazw metod

Wymagane zmiany w kodzie są minimalne:

• Zmieniono sposób tworzenia instancji detektora, skanera, etykietowania, tłumacza itp. Każda funkcja ma teraz własny punkt wejścia. Na przykład: BarcodeScanning, TextRecognition, ImageLabeling, Translation… Wywołania usługi Firebase getInstance() są zastępowane wywołaniami metody getClient() punktu wejścia funkcji.
• Usunięto domyślne tworzenie instancji TextRecognizer, ponieważ wprowadziliśmy dodatkowe biblioteki do rozpoznawania innych skryptów, takich jak chiński i koreański. Aby używać opcji domyślnych z modelem rozpoznawania tekstu w alfabecie łacińskim, zadeklaruj zależność od com.google.android.gms:play-services-mlkit-text-recognition i użyj TextRecognition.getClient(TextRecognizerOptions.DEFAULT_OPTIONS).
• Usunięto domyślne tworzenie instancji ImageLabeler i ObjectDetector, ponieważ wprowadziliśmy obsługę modeli niestandardowych w przypadku tych 2 funkcji. Aby na przykład używać opcji domyślnych z modelem podstawowym w ImageLabeling, zadeklaruj zależność od com.google.mlkit:image-labeling i użyj ImageLabeling.getClient(ImageLabelerOptions.DEFAULT_OPTIONS) w Javie.
• Wszystkie uchwyty (detektor, skaner, etykietowanie, tłumacz itp.) można zamknąć. Sprawdź, czy metoda close() jest wywoływana, gdy te obiekty nie będą już używane. Jeśli używasz ich w fragmencie lub AppCompatActivity, możesz to zrobić, wywołując LifecycleOwner.getLifecycle() w fragmencie lub AppCompatActivity, a następnie wywołując Lifecycle.addObserver.
• W celu zachowania spójności nazwy metod processImage() i detectInImage() w interfejsach Vision API zostały zmienione na process() .
• Interfejsy Natural Language API używają teraz terminu „tag języka” (zgodnie ze standardem BCP 47) zamiast „kodu języka”.
• Usunięto metody pobierania w klasach xxxOptions.
• Metoda getBitmap() w klasie InputImage(zastępująca FirebaseVisionImage) nie jest już obsługiwana w ramach interfejsu publicznego. Aby uzyskać bitmapę przekonwertowaną z różnych danych wejściowych, zapoznaj się z plikiem BitmapUtils.java w przykładzie szybkiego startu ML Kit.
• Usunięto FirebaseVisionImageMetadata. Możesz po prostu przekazać metadane obrazu, takie jak szerokość, wysokość, stopień obrotu i format, do metod konstrukcyjnych InputImages.

Oto kilka przykładów starych i nowych metod 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())
  

Oto kilka przykładów starych i nowych metod 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());
  

Zmiany dotyczące interfejsu API

Skanowanie kodów kreskowych

W przypadku interfejsu Barcode Scanning API modele można teraz dostarczać na 2 sposoby:

• Za pomocą Usług Google Play, czyli „cienki” (zalecane) – zmniejsza to rozmiar aplikacji, a model jest współdzielony między aplikacjami. Deweloperzy będą jednak musieli się upewnić, że model został pobrany przed pierwszym użyciem.
• W pliku APK aplikacji, czyli „połączony” – zwiększa to rozmiar aplikacji, ale oznacza, że model jest od razu gotowy do użycia.

Te 2 implementacje różnią się nieco od siebie, a wersja „połączona” ma kilka ulepszeń w porównaniu z wersją „cienką”. Szczegółowe informacje o tych różnicach znajdziesz w wytycznych dotyczących interfejsu Barcode Scanning API.

Wykrywanie twarzy

W przypadku interfejsu Face Detection API modele można dostarczać na 2 sposoby:

• Za pomocą Usług Google Play, czyli „cienki” (zalecane) – zmniejsza to rozmiar aplikacji, a model jest współdzielony między aplikacjami. Deweloperzy będą jednak musieli się upewnić, że model został pobrany przed pierwszym użyciem.
• W pliku APK aplikacji, czyli „połączony” – zwiększa to rozmiar pobrania aplikacji, ale oznacza, że model jest od razu gotowy do użycia.

Działanie implementacji jest takie samo.

Tłumaczenie

• TranslateLanguage używa teraz czytelnych nazw stałych (np. ENGLISH) zamiast tagów języka (EN). Są one też teraz @StringDef, a nie @IntDef, a wartość stałej to pasujący tag języka BCP 47.

• Jeśli Twoja aplikacja używa opcji warunku pobierania „urządzenie jest bezczynne”, pamiętaj, że ta opcja została usunięta i nie można jej już używać. Nadal możesz używać opcji „urządzenie się ładuje”. Jeśli chcesz uzyskać bardziej złożone działanie, możesz opóźnić wywołanie RemoteModelManager.download za pomocą własnej logiki.

AutoML Image Labeling

Jeśli Twoja aplikacja używa opcji warunku pobierania „urządzenie jest bezczynne”, pamiętaj, że ta opcja została usunięta i nie można jej już używać. Nadal możesz używać opcji „urządzenie się ładuje”.

Jeśli chcesz uzyskać bardziej złożone działanie, możesz opóźnić wywołanie RemoteModelManager.download za pomocą własnej logiki.

Wykrywanie i śledzenie obiektów

Jeśli Twoja aplikacja używa wykrywania obiektów z klasyfikacją przybliżoną, pamiętaj, że nowy pakiet SDK zmienił sposób zwracania kategorii klasyfikacji wykrytych obiektów.

Kategoria klasyfikacji jest zwracana jako instancja DetectedObject.Label zamiast liczby całkowitej. Wszystkie możliwe kategorie klasyfikatora przybliżonego są zawarte w klasie PredefinedCategory.

Oto przykład starego i nowego kodu 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) {
    ...
}

Oto przykład starego i nowego kodu 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) {
    ...
}

Kategoria „nieznana” została usunięta. Gdy wiarygodność klasyfikacji obiektu jest niska, nie zwracamy żadnej etykiety.

Usuwanie zależności Firebase (opcjonalnie)

Ten krok ma zastosowanie tylko wtedy, gdy są spełnione te warunki:

• Firebase ML Kit to jedyny komponent Firebase, którego używasz.
• Używasz tylko interfejsów API na urządzeniu.
• Nie używasz udostępniania modeli.

W takim przypadku po migracji możesz usunąć zależności Firebase. Aby to zrobić:

• Usuń plik konfiguracyjny Firebase, usuwając plik konfiguracyjny google-services.json w katalogu modułu (na poziomie aplikacji) swojej aplikacji.
• Zastąp wtyczkę Gradle usług Google w pliku Gradle modułu (na poziomie aplikacji) (zwykle app/build.gradle) wtyczką 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 {
  // …
}

• Zastąp ścieżkę klasy wtyczki Gradle usług Google w pliku Gradle projektu (na poziomie głównym) (build.gradle) ścieżką klasy wtyczki 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'
  }
}

Usuń aplikację w Firebase w konsoli Firebase zgodnie z instrukcjami na stronie pomocy Firebase.

Uzyskiwanie pomocy

Jeśli napotkasz jakieś problemy, zajrzyj na stronę społeczności, na której znajdziesz informacje o kanałach, za pomocą których możesz się z nami skontaktować.