מיגרציה ל-Android

עדכון ייבוא של gradle

ערכת ה-SDK החדשה דורשת רק תלות אחת לכל ML Kit API. אין צורך לציין ספריות נפוצות כמו firebase-ml-vision או firebase-ml-natural-language. ‫ML Kit משתמש במרחב השמות com.google.android.gms לספריות שתלויות ב-Google Play Services.

Vision APIs

מודלים מקובצים מועברים כחלק מהאפליקציה. צריך להוריד מודלים רזים. חלק מה-API זמינים גם כחבילה וגם כ-API דק, ואחרים זמינים רק באחת מהצורות האלה:

מעדכנים את יחסי התלות של ספריות ML Kit Android בקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל app/build.gradle) בהתאם לטבלאות הבאות:

מודלים בחבילה

מודלים דקים

AutoMLVision Edge

ממשקי Natural Language API

מודלים מקובצים מועברים כחלק מהאפליקציה. צריך להוריד מודלים דקים:

מעדכנים את יחסי התלות של ספריות ML Kit Android בקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל app/build.gradle) בהתאם לטבלאות הבאות:

מודלים בחבילה

מודלים דקים

עדכון שמות הכיתות

אם הכיתה שלכם מופיעה בטבלה הזו, צריך לבצע את השינוי שמצוין:

לגבי מחלקות אחרות, צריך לפעול לפי הכללים הבאים:

• מסירים את הקידומת FirebaseVision משם הכיתה.
• מסירים מהשם של הכיתה קידומות אחרות שמתחילות בקידומת Firebase.

בנוסף, בשמות החבילות מחליפים את התחילית com.google.firebase.ml ב-com.google.mlkit.

עדכון שמות השיטות

יש שינויים קלים בקוד:

• השתנה אופן יצירת המופע של גלאי/סורק/תווית/מתרגם… לכל תכונה יש עכשיו נקודת כניסה משלה. לדוגמה: BarcodeScanning, ‏ TextRecognition, ‏ ImageLabeling, ‏ Translation… שיחות לשירות Firebase‏ getInstance() מוחלפות בשיחות לשיטת 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.
• אפשר לסגור את כל ה-handle (גלאי, סורק, מתייג, מתרגם וכו'). חשוב לוודא שהמערכת קוראת לשיטה close() כשהאובייקטים האלה לא ישמשו יותר. אם משתמשים בהם ב-Fragment או ב-AppCompatActivity, דרך קלה לעשות זאת היא לקרוא ל-LifecycleOwner.getLifecycle() ב-Fragment או ב-AppCompatActivity, ואז לקרוא ל-Lifecycle.addObserver.
• processImage() ו-detectInImage() ב-Vision API שינו את השם שלהם ל-process() כדי לשמור על עקביות.
• במקום 'קוד שפה', ממשקי Natural Language API משתמשים עכשיו במונח 'תג שפה' (כפי שמוגדר בתקן BCP 47).
• הוסרו שיטות Getter במחלקות xxxOptions.
• השיטה getBitmap()‎ במחלקה InputImage(במקום FirebaseVisionImage) לא נתמכת יותר כחלק מהממשק הציבורי. אפשר לעיין בBitmapUtils.java בדוגמה להפעלה מהירה של ML Kit כדי לקבל מפת סיביות שהומרה מקלטים שונים.
• הוסר FirebaseVisionImageMetadata. אפשר פשוט להעביר מטא-נתונים של תמונות, כמו רוחב, גובה, rotationDegrees ופורמט, לשיטות הבנייה של 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

סריקת ברקודים

ב-Barcode Scanning API, יש עכשיו שתי דרכים להעברת המודלים:

• באמצעות Google Play Services,‏ aka‏ 'thin' (מומלץ) – האפשרות הזו מקטינה את גודל האפליקציה, והמודל משותף בין האפליקציות. עם זאת, מפתחים יצטרכו לוודא שהמודל יורד לפני שהם משתמשים בו בפעם הראשונה.
• עם קובץ ה-APK של האפליקציה, כלומר 'בתוך החבילה' – כך גודל האפליקציה גדל, אבל המודל מוכן לשימוש מיידי.

שתי ההטמעות שונות מעט זו מזו, ובגרסה 'המאוגדת' יש כמה שיפורים לעומת הגרסה 'הדקה'. פרטים על ההבדלים האלה מופיעים בהנחיות לשימוש ב-Barcode Scanning API.

זיהוי פנים

יש שתי דרכים להעברת המודלים של Face Detection API:

• באמצעות Google Play Services,‏ aka‏ 'thin' (מומלץ) – האפשרות הזו מקטינה את גודל האפליקציה, והמודל משותף בין האפליקציות. עם זאת, מפתחים יצטרכו לוודא שהמודל יורד לפני שהם משתמשים בו בפעם הראשונה.
• עם חבילת ה-APK של האפליקציה, כלומר 'חבילה' – האפשרות הזו מגדילה את גודל ההורדה של האפליקציה, אבל המשמעות היא שאפשר להשתמש במודל באופן מיידי.

ההתנהגות של ההטמעות זהה.

תרגום

• ‫TranslateLanguage משתמש עכשיו בשמות קריאים לקבועים שלו (למשל, ENGLISH) במקום בתגי שפה (EN). בנוסף, הם עכשיו @StringDef במקום @IntDef, והערך של הקבוע הוא תג השפה התואם BCP 47.

• אם האפליקציה שלכם משתמשת באפשרות 'מצב המתנה של המכשיר' בתנאי ההורדה, חשוב לדעת שהאפשרות הזו הוסרה ואי אפשר להשתמש בה יותר. עדיין אפשר להשתמש באפשרות 'טעינת המכשיר'. אם רוצים התנהגות מורכבת יותר, אפשר לדחות את הקריאה ל-RemoteModelManager.download באמצעות לוגיקה משלכם.

AutoML Image Labeling

אם באפליקציה שלכם נעשה שימוש באפשרות 'מצב המתנה של המכשיר' כתנאי להורדה, חשוב לדעת שהאפשרות הזו הוסרה ואי אפשר להשתמש בה יותר. עדיין אפשר להשתמש באפשרות 'טעינת המכשיר'.

אם רוצים התנהגות מורכבת יותר, אפשר לדחות את הקריאה ל-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.
• אתם משתמשים רק בממשקי 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 {
  // …
}

• מחליפים את נתיב המחלקה של פלאגין Google Services Gradle בקובץ Gradle של הפרויקט (ברמת השורש) (build.gradle) בנתיב המחלקה של פלאגין 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.

קבלת עזרה

אם נתקלתם בבעיות, אתם יכולים לעיין בדף הקהילה שלנו, שבו מפורטים הערוצים שדרכם אפשר ליצור איתנו קשר.