مهاجرت برای اندروید

این راهنما نحوه مهاجرت از ML Kit به Firebase برای اندروید را توضیح می‌دهد.

به‌روزرسانی ایمپورت‌های گرادل

کیت توسعه نرم‌افزار ML Kit فقط برای هر API کیت ML به یک وابستگی نیاز دارد. نیازی به مشخص کردن کتابخانه‌های رایج مانند firebase-ml-vision یا firebase-ml-natural-language نیست. کیت ML از فضای نام com.google.android.gms برای کتابخانه‌هایی که به سرویس‌های Google Play وابسته هستند استفاده می‌کند.

رابط‌های برنامه‌نویسی کاربردی بینایی

مدل‌های بسته‌بندی‌شده به عنوان بخشی از برنامه شما ارائه می‌شوند. مدل‌های Thin باید دانلود شوند. برخی از APIها هم به صورت بسته‌بندی‌شده و هم به صورت Thin در دسترس هستند، برخی دیگر فقط به یکی از این دو شکل:

وابستگی‌های کتابخانه‌های اندروید ML Kit را در فایل Gradle ماژول (سطح برنامه) خود (معمولاً app/build.gradle.kts ) طبق جداول زیر به‌روزرسانی کنید:

مدل‌های بسته‌ای

مدل‌های نازک

لبه AutoMLVision

API های زبان طبیعی

مدل‌های بسته‌بندی‌شده به عنوان بخشی از درخواست شما ارائه می‌شوند. مدل‌های نازک باید دانلود شوند:

وابستگی‌های کتابخانه‌های اندروید ML Kit را در فایل Gradle ماژول (سطح برنامه) خود (معمولاً app/build.gradle.kts ) طبق جداول زیر به‌روزرسانی کنید:

مدل‌های بسته‌ای

مدل‌های نازک

به‌روزرسانی نام کلاس‌ها

اگر کلاس شما در این جدول وجود دارد، تغییر مشخص شده را اعمال کنید:

برای سایر کلاس‌ها، این قوانین را دنبال کنید:

• پیشوند FirebaseVision را از نام کلاس حذف کنید.
• پیشوندهای دیگری که با پیشوند Firebase شروع می‌شوند را از نام کلاس حذف کنید.

همچنین، در نام بسته‌ها، پیشوند com.google.firebase.ml را با com.google.mlkit جایگزین کنید.

نام متدها را به‌روزرسانی کنید

تغییرات کد حداقلی هستند:

• نمونه‌سازی Detector/scanner/labeler/translator... تغییر کرده است. اکنون هر ویژگی نقطه ورود خاص خود را دارد. برای مثال: 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) در جاوا استفاده کنید.
• همه دستگیره‌ها (detector/scanner/labeler/translator...) قابل بستن هستند. مطمئن شوید که متد close() زمانی فراخوانی می‌شود که دیگر از آن اشیاء استفاده نمی‌شود. اگر از آنها در یک Fragment یا AppCompatActivity استفاده می‌کنید، یک راه برای انجام این کار فراخوانی LifecycleOwner.getLifecycle() در Fragment یا AppCompatActivity و سپس فراخوانی Lifecycle.addObserver است.
• processImage() و detectInImage() در رابط‌های برنامه‌نویسی Vision برای سازگاری بیشتر به process() تغییر نام داده‌اند.
• رابط‌های برنامه‌نویسی کاربردی زبان طبیعی (NLP) اکنون به جای «کد زبان» از اصطلاح «برچسب زبان» (مطابق تعریف استاندارد BCP 47 ) استفاده می‌کنند.
• متدهای Getter در کلاس‌های xxxOptions حذف شده‌اند.
• متد getBitmap() در کلاس InputImage (جایگزین FirebaseVisionImage ) دیگر به عنوان بخشی از رابط عمومی پشتیبانی نمی‌شود. برای دریافت تبدیل بیت‌مپ از ورودی‌های مختلف، به نمونه شروع سریع BitmapUtils.java در ML Kit مراجعه کنید.
• FirebaseVisionImageMetadata حذف شده است، شما می‌توانید به سادگی متادیتای تصویر مانند width ، height ، rotationDegrees و format به متدهای ساخت InputImage ارسال کنید.

در اینجا چند نمونه از متدهای قدیمی و جدید کاتلین آورده شده است:

// 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 lifecycle 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())
  

در اینجا چند نمونه از متدهای قدیمی و جدید جاوا آورده شده است:

// 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 lifecycle 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 اسکن بارکد، اکنون دو روش برای تحویل مدل‌ها وجود دارد:

• از طریق سرویس‌های گوگل پلی که به آن «thin» هم می‌گویند (توصیه می‌شود) - این کار حجم برنامه را کاهش می‌دهد و مدل بین برنامه‌ها به اشتراک گذاشته می‌شود. با این حال، توسعه‌دهندگان باید قبل از اولین استفاده از مدل، از دانلود آن اطمینان حاصل کنند.
• با فایل APK برنامه شما که به آن "bundled" هم می‌گویند - این کار حجم برنامه را افزایش می‌دهد اما به این معنی است که مدل بلافاصله قابل استفاده است.

این دو پیاده‌سازی کمی متفاوت هستند، و نسخه «بسته‌ای» نسبت به نسخه «نازک» پیشرفت‌های زیادی دارد. جزئیات این تفاوت‌ها را می‌توانید در دستورالعمل‌های API اسکن بارکد بیابید.

تشخیص چهره

برای API تشخیص چهره، دو روش برای ارائه مدل‌ها وجود دارد:

• از طریق سرویس‌های گوگل پلی که به آن «thin» هم می‌گویند (توصیه می‌شود) - این کار حجم برنامه را کاهش می‌دهد و مدل بین برنامه‌ها به اشتراک گذاشته می‌شود. با این حال، توسعه‌دهندگان باید قبل از اولین استفاده از مدل، از دانلود آن اطمینان حاصل کنند.
• با فایل APK برنامه شما که به آن «بسته‌ای» هم می‌گویند - این کار حجم دانلود برنامه را افزایش می‌دهد اما به این معنی است که مدل بلافاصله قابل استفاده است.

رفتار پیاده‌سازی‌ها یکسان است.

ترجمه

• TranslateLanguage اکنون به جای برچسب‌های زبان ( EN ) از نام‌های خوانا برای ثابت‌های خود (مثلاً ENGLISH ) استفاده می‌کند. همچنین اکنون آنها به جای @IntDef ، @StringDef هستند و مقدار ثابت ، برچسب زبان منطبق BCP 47 است.

برچسب‌گذاری خودکار تصویر (AutoML) (منسوخ شده)

دانلود مدل‌های سفارشی برای برچسب‌گذاری تصویر با استفاده از AutoML منسوخ شده است و در ۱۵ ژوئن ۲۰۲۷ لغو خواهد شد. شما باید از Cloud Storage برای میزبانی مدل‌ها استفاده کنید و منطق دانلود را به برنامه خود اضافه کنید تا مدل‌ها را دانلود کنید. برای جزئیات بیشتر، به راهنمای مهاجرت Firebase ML به Cloud Storage مراجعه کنید.

تشخیص و ردیابی اشیا

اگر برنامه شما از تشخیص شیء با طبقه‌بندی تقریبی استفاده می‌کند، توجه داشته باشید که SDK جدید نحوه‌ی بازگرداندن دسته‌بندی برای اشیاء شناسایی‌شده را تغییر داده است.

دسته بندی به عنوان نمونه ای از DetectedObject.Label به جای یک عدد صحیح برگردانده می شود. تمام دسته بندی های ممکن برای طبقه بندی کننده تقریبی در کلاس PredefinedCategory گنجانده شده اند.

در اینجا مثالی از کد قدیمی و جدید کاتلین آورده شده است:

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) {
    ...
}

در اینجا مثالی از کد جاوا قدیمی و جدید آورده شده است:

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 را حذف کنید. این مراحل را دنبال کنید:

• فایل پیکربندی Firebase را با حذف فایل پیکربندی google-services.json در دایرکتوری module (app-level) برنامه خود، حذف کنید.
• افزونه‌ی Google Services Gradle را در فایل Gradle ماژول (سطح برنامه) خود (معمولاً app/build.gradle.kts ) با افزونه‌ی Strict Version Matcher جایگزین کنید:

plugins {
  id("com.android.application")
  id("com.google.gms.google-services")
}

android {
  // …
}

plugins {
  id("com.android.application")
  id("com.google.android.gms.strict-version-matcher-plugin")
}

android {
  // …
}

• مسیر کلاس افزونه Google Services Gradle را در فایل Gradle پروژه (سطح ریشه) خود ( build.gradle.kts ) با مسیر مربوط به افزونه Strict Version Matcher جایگزین کنید:

buildscript {
  dependencies {
    // ...

    classpath("com.google.gms:google-services:4.3.3")
  }
}

buildscript {
  dependencies {
    // ...
    classpath("com.google.android.gms:strict-version-matcher-plugin:1.2.1")
  }
}

طبق دستورالعمل‌های موجود در سایت پشتیبانی Firebase، برنامه Firebase خود را در کنسول Firebase حذف کنید.

دریافت کمک

اگر با هرگونه مشکلی مواجه شدید، لطفاً به صفحه انجمن ما مراجعه کنید، جایی که کانال‌های موجود برای ارتباط با ما را شرح داده‌ایم.