Android'de AutoML ile eğitilmiş bir model kullanarak resimleri etiketleme

AutoML Vision Edge'e özel API artık kullanılamıyor. Bunun yerine, artık bu modelleri yerel olarak destekleyen Custom Image Labeling API'yi kullanın. Şu anda bu API'yi kullanıyorsanız lütfen taşıma talimatlarımızı uygulayın.

AutoML Vision Edge'i kullanarak kendi modelinizi eğittikten sonra, resimleri etiketlemek için bu modeli uygulamanızda kullanabilirsiniz. AutoML Vision Edge'den eğitilen modelleri entegre etmenin iki yolu vardır: Modeli uygulamanızın öğe klasörüne koyarak paketleyebilir veya Firebase'den dinamik olarak indirebilirsiniz.

Model paketleme seçenekleri
Uygulamanızda paket halinde sunulur	Model, uygulamanızın APK'sının bir parçasıdır. Model, Android cihaz çevrimdışı olsa bile hemen kullanılabilir. Firebase projesine gerek yoktur.
Firebase ile barındırılır	Modeli Firebase Machine Learning'e yükleyerek barındırın. APK boyutunu küçültür. Model, istek üzerine indirilir. Uygulamanızı yeniden yayınlamadan model güncellemelerini gönderme Firebase Remote Config ile kolay A/B testi Firebase projesi gerekir.

Deneyin

• Bu API'nin örnek kullanımını görmek için örnek uygulamayı deneyin.

Başlamadan önce

1. Proje düzeyindeki build.gradle dosyanızda, Google'ın Maven deposunu hem buildscript hem de allprojects bölümlerinize eklediğinizden emin olun.

2. ML Kit Android kitaplıklarının bağımlılıklarını modülünüzün uygulama düzeyindeki gradle dosyasına (genellikle app/build.gradle) ekleyin: Bir modeli uygulamanızla paketlemek için:

    dependencies {
      // ...
      // Image labeling feature with bundled automl model
      implementation 'com.google.mlkit:image-labeling-automl:16.2.1'
    }
    

Firebase'den dinamik olarak model indirmek için linkFirebase bağımlılığını ekleyin:

    dependencies {
      // ...
      // Image labeling feature with automl model downloaded
      // from firebase
      implementation 'com.google.mlkit:image-labeling-automl:16.2.1'
      implementation 'com.google.mlkit:linkfirebase:16.0.1'
    }
    

3. Bir model indirmek istiyorsanız henüz yapmadıysanız Firebase'i Android projenize eklediğinizden emin olun. Modeli paketlediğinizde bu işlem gerekli değildir.

1. Modeli yükleme

Yerel model kaynağı yapılandırma

Modeli uygulamanızla paketlemek için:

1. Firebase konsolundan indirdiğiniz ZIP arşivinden modeli ve meta verilerini çıkarın. Dosyaları indirdiğiniz şekilde, değişiklik yapmadan (dosya adları dahil) kullanmanızı öneririz.

2. Modelinizi ve meta veri dosyalarını uygulama paketinize ekleyin:

a. Projenizde öğeler klasörü yoksa app/ klasörünü sağ tıklayıp New > Folder > Assets Folder'ı (Yeni > Klasör > Öğeler Klasörü) tıklayarak bir klasör oluşturun.

b. Model dosyalarını içerecek şekilde, öğeler klasörünün altında bir alt klasör oluşturun.

c. model.tflite, dict.txt ve manifest.json dosyalarını alt klasöre kopyalayın (üç dosyanın da aynı klasörde olması gerekir).

3. Gradle'ın uygulamayı derlerken model dosyasını sıkıştırmaması için uygulamanızın build.gradle dosyasına aşağıdakileri ekleyin:

    android {
        // ...
        aaptOptions {
            noCompress "tflite"
        }
    }
    

Model dosyası, uygulama paketine dahil edilir ve ML Kiti'nde ham öğe olarak kullanılabilir.

Not: Android Gradle eklentisinin 4.1 sürümünden itibaren .tflite, varsayılan olarak noCompress listesine eklenecek ve yukarıdaki işleme artık gerek kalmayacaktır.

4. Model manifest dosyasının yolunu belirterek LocalModel nesnesi oluşturun:

Kotlin

val localModel = AutoMLImageLabelerLocalModel.Builder()
        .setAssetFilePath("manifest.json")
        // or .setAbsoluteFilePath(absolute file path to manifest file)
        .build()

Java

AutoMLImageLabelerLocalModel localModel =
    new AutoMLImageLabelerLocalModel.Builder()
        .setAssetFilePath("manifest.json")
        // or .setAbsoluteFilePath(absolute file path to manifest file)
        .build();

Firebase'de barındırılan bir model kaynağını yapılandırma

Uzaktan barındırılan modeli kullanmak için bir RemoteModel nesnesi oluşturun ve yayınlarken modele atadığınız adı belirtin:

Kotlin

// Specify the name you assigned in the Firebase console.
val remoteModel =
    AutoMLImageLabelerRemoteModel.Builder("your_model_name").build()

Java

// Specify the name you assigned in the Firebase console.
AutoMLImageLabelerRemoteModel remoteModel =
    new AutoMLImageLabelerRemoteModel.Builder("your_model_name").build();

Ardından, indirme işlemine izin vermek istediğiniz koşulları belirterek model indirme görevini başlatın. Model cihazda yoksa veya modelin daha yeni bir sürümü mevcutsa görev, modeli Firebase'den eşzamansız olarak indirir:

Kotlin

val downloadConditions = DownloadConditions.Builder()
    .requireWifi()
    .build()
RemoteModelManager.getInstance().download(remoteModel, downloadConditions)
    .addOnSuccessListener {
        // Success.
    }

Java

DownloadConditions downloadConditions = new DownloadConditions.Builder()
        .requireWifi()
        .build();
RemoteModelManager.getInstance().download(remoteModel, downloadConditions)
        .addOnSuccessListener(new OnSuccessListener() {
            @Override
            public void onSuccess(@NonNull Task task) {
                // Success.
            }
        });

Birçok uygulama, indirme görevini başlatma kodunda başlatır ancak modeli kullanmanız gerekmeden önce herhangi bir noktada bunu yapabilirsiniz.

Modelinizden bir resim etiketleyici oluşturma

Model kaynaklarınızı yapılandırdıktan sonra bunlardan birinden ImageLabeler nesnesi oluşturun.

Yalnızca yerel olarak paketlenmiş bir modeliniz varsa AutoMLImageLabelerLocalModel nesnenizden bir etiketleyici oluşturun ve gerekli olmasını istediğiniz güven puanı eşiğini yapılandırın (Modelinizi değerlendirme bölümüne bakın):

Kotlin

val autoMLImageLabelerOptions = AutoMLImageLabelerOptions.Builder(localModel)
    .setConfidenceThreshold(0)  // Evaluate your model in the Firebase console
                                // to determine an appropriate value.
    .build()
val labeler = ImageLabeling.getClient(autoMLImageLabelerOptions)

Java

AutoMLImageLabelerOptions autoMLImageLabelerOptions =
        new AutoMLImageLabelerOptions.Builder(localModel)
                .setConfidenceThreshold(0.0f)  // Evaluate your model in the Firebase console
                                               // to determine an appropriate value.
                .build();
ImageLabeler labeler = ImageLabeling.getClient(autoMLImageLabelerOptions)

Uzaktan barındırılan bir modeliniz varsa çalıştırmadan önce indirilip indirilmediğini kontrol etmeniz gerekir. Model yöneticisinin isModelDownloaded() yöntemini kullanarak model indirme görevinin durumunu kontrol edebilirsiniz.

Bunu yalnızca etiketleyiciyi çalıştırmadan önce onaylamanız gerekir. Ancak hem uzaktan barındırılan bir modeliniz hem de yerel olarak paketlenmiş bir modeliniz varsa resim etiketleyiciyi örneklendirirken bu kontrolü yapmanız mantıklı olabilir: İndirilmişse uzak modelden, indirilmemişse yerel modelden bir etiketleyici oluşturun.

Kotlin

RemoteModelManager.getInstance().isModelDownloaded(remoteModel)
    .addOnSuccessListener { isDownloaded -> 
    val optionsBuilder =
        if (isDownloaded) {
            AutoMLImageLabelerOptions.Builder(remoteModel)
        } else {
            AutoMLImageLabelerOptions.Builder(localModel)
        }
    // Evaluate your model in the Firebase console to determine an appropriate threshold.
    val options = optionsBuilder.setConfidenceThreshold(0.0f).build()
    val labeler = ImageLabeling.getClient(options)
}

Java

RemoteModelManager.getInstance().isModelDownloaded(remoteModel)
        .addOnSuccessListener(new OnSuccessListener() {
            @Override
            public void onSuccess(Boolean isDownloaded) {
                AutoMLImageLabelerOptions.Builder optionsBuilder;
                if (isDownloaded) {
                    optionsBuilder = new AutoMLImageLabelerOptions.Builder(remoteModel);
                } else {
                    optionsBuilder = new AutoMLImageLabelerOptions.Builder(localModel);
                }
                AutoMLImageLabelerOptions options = optionsBuilder
                        .setConfidenceThreshold(0.0f)  // Evaluate your model in the Firebase console
                                                       // to determine an appropriate threshold.
                        .build();

                ImageLabeler labeler = ImageLabeling.getClient(options);
            }
        });

Yalnızca uzaktan barındırılan bir modeliniz varsa modelin indirildiğini onaylayana kadar modelle ilgili işlevleri (ör. kullanıcı arayüzünüzün bir kısmını devre dışı bırakma veya gizleme) devre dışı bırakmanız gerekir. Bunu, model yöneticisinin download() yöntemine bir dinleyici ekleyerek yapabilirsiniz:

Kotlin

RemoteModelManager.getInstance().download(remoteModel, conditions)
    .addOnSuccessListener {
        // Download complete. Depending on your app, you could enable the ML
        // feature, or switch from the local model to the remote model, etc.
    }

Java

RemoteModelManager.getInstance().download(remoteModel, conditions)
        .addOnSuccessListener(new OnSuccessListener() {
            @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.
            }
        });

2. Giriş görüntüsünü hazırlama

Ardından, etiketlemek istediğiniz her resim için resminizden bir InputImage nesnesi oluşturun. Resim etiketleyici, Bitmap veya camera2 API'yi kullanıyorsanız YUV_420_888 media.Image kullandığınızda en hızlı şekilde çalışır. Mümkün olduğunda bu biçimlerin kullanılması önerilir.

Farklı kaynaklardan InputImage nesnesi oluşturabilirsiniz. Bu kaynakların her biri aşağıda açıklanmıştır.

media.Image kullanma

Bir media.Image nesnesinden InputImage nesnesi oluşturmak için (ör. bir cihazın kamerasından görüntü yakaladığınızda) media.Image nesnesini ve görüntünün dönüşünü InputImage.fromMediaImage() değerine iletin.

CameraX kitaplığını kullanıyorsanız OnImageCapturedListener ve ImageAnalysis.Analyzer sınıfları, rotasyon değerini sizin için hesaplar.

Kotlin

private class YourImageAnalyzer : ImageAnalysis.Analyzer {

    override fun analyze(imageProxy: ImageProxy) {
        val mediaImage = imageProxy.image
        if (mediaImage != null) {
            val image = InputImage.fromMediaImage(mediaImage, imageProxy.imageInfo.rotationDegrees)
            // Pass image to an ML Kit Vision API
            // ...
        }
    }
}

Java

private class YourAnalyzer implements ImageAnalysis.Analyzer {

    @Override
    public void analyze(ImageProxy imageProxy) {
        Image mediaImage = imageProxy.getImage();
        if (mediaImage != null) {
          InputImage image =
                InputImage.fromMediaImage(mediaImage, imageProxy.getImageInfo().getRotationDegrees());
          // Pass image to an ML Kit Vision API
          // ...
        }
    }
}

Görüntünün dönüş derecesini veren bir kamera kitaplığı kullanmıyorsanız bu değeri cihazın dönüş derecesinden ve cihazdaki kamera sensörünün yönünden hesaplayabilirsiniz:

Kotlin

private val ORIENTATIONS = SparseIntArray()

init {
    ORIENTATIONS.append(Surface.ROTATION_0, 0)
    ORIENTATIONS.append(Surface.ROTATION_90, 90)
    ORIENTATIONS.append(Surface.ROTATION_180, 180)
    ORIENTATIONS.append(Surface.ROTATION_270, 270)
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
@Throws(CameraAccessException::class)
private fun getRotationCompensation(cameraId: String, activity: Activity, isFrontFacing: Boolean): Int {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    val deviceRotation = activity.windowManager.defaultDisplay.rotation
    var rotationCompensation = ORIENTATIONS.get(deviceRotation)

    // Get the device's sensor orientation.
    val cameraManager = activity.getSystemService(CAMERA_SERVICE) as CameraManager
    val sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION)!!

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360
    }
    return rotationCompensation
}
MLKitVisionImage.kt

Java

private static final SparseIntArray ORIENTATIONS = new SparseIntArray();
static {
    ORIENTATIONS.append(Surface.ROTATION_0, 0);
    ORIENTATIONS.append(Surface.ROTATION_90, 90);
    ORIENTATIONS.append(Surface.ROTATION_180, 180);
    ORIENTATIONS.append(Surface.ROTATION_270, 270);
}

/**
 * Get the angle by which an image must be rotated given the device's current
 * orientation.
 */
@RequiresApi(api = Build.VERSION_CODES.LOLLIPOP)
private int getRotationCompensation(String cameraId, Activity activity, boolean isFrontFacing)
        throws CameraAccessException {
    // Get the device's current rotation relative to its "native" orientation.
    // Then, from the ORIENTATIONS table, look up the angle the image must be
    // rotated to compensate for the device's rotation.
    int deviceRotation = activity.getWindowManager().getDefaultDisplay().getRotation();
    int rotationCompensation = ORIENTATIONS.get(deviceRotation);

    // Get the device's sensor orientation.
    CameraManager cameraManager = (CameraManager) activity.getSystemService(CAMERA_SERVICE);
    int sensorOrientation = cameraManager
            .getCameraCharacteristics(cameraId)
            .get(CameraCharacteristics.SENSOR_ORIENTATION);

    if (isFrontFacing) {
        rotationCompensation = (sensorOrientation + rotationCompensation) % 360;
    } else { // back-facing
        rotationCompensation = (sensorOrientation - rotationCompensation + 360) % 360;
    }
    return rotationCompensation;
}

Ardından media.Image nesnesini ve dönüş derecesi değerini InputImage.fromMediaImage()'e iletin:

Kotlin

val image = InputImage.fromMediaImage(mediaImage, rotation)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromMediaImage(mediaImage, rotation);

Dosya URI'si kullanma

Bir dosya URI'sinden InputImage nesnesi oluşturmak için uygulama bağlamını ve dosya URI'sini InputImage.fromFilePath() yöntemine iletin. Bu, kullanıcının galeri uygulamasından bir resim seçmesini istemek için ACTION_GET_CONTENT intent'ini kullandığınızda yararlı olur.

Kotlin

val image: InputImage
try {
    image = InputImage.fromFilePath(context, uri)
} catch (e: IOException) {
    e.printStackTrace()
}
MLKitVisionImage.kt

Java

InputImage image;
try {
    image = InputImage.fromFilePath(context, uri);
} catch (IOException e) {
    e.printStackTrace();
}

ByteBuffer veya ByteArray kullanma

ByteBuffer veya ByteArray nesnesinden InputImage nesnesi oluşturmak için önce media.Image girişi için daha önce açıklandığı şekilde resim döndürme derecesini hesaplayın. Ardından, arabellek veya diziyle birlikte resmin yüksekliği, genişliği, renk kodlama biçimi ve dönüş derecesini içeren InputImage nesnesini oluşturun:

Kotlin

val image = InputImage.fromByteBuffer(
        byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt
// Or:
val image = InputImage.fromByteArray(
        byteArray,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromByteBuffer(byteBuffer,
        /* image width */ 480,
        /* image height */ 360,
        rotationDegrees,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);
MLKitVisionImage.java
// Or:
InputImage image = InputImage.fromByteArray(
        byteArray,
        /* image width */480,
        /* image height */360,
        rotation,
        InputImage.IMAGE_FORMAT_NV21 // or IMAGE_FORMAT_YV12
);
MLKitVisionImage.java

Bitmap kullanma

Bir Bitmap nesnesinden InputImage nesnesi oluşturmak için aşağıdaki bildirimi yapın:

Kotlin

val image = InputImage.fromBitmap(bitmap, 0)
MLKitVisionImage.kt

Java

InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);
MLKitVisionImage.java

Resim, dönüş dereceleriyle birlikte bir Bitmap nesnesiyle temsil edilir.

3. Resim etiketleyiciyi çalıştırma

Bir resimdeki nesneleri etiketlemek için image nesnesini ImageLabeler öğesinin process() yöntemine iletin.

Kotlin

labeler.process(image)
        .addOnSuccessListener { labels ->
            // Task completed successfully
            // ...
        }
        .addOnFailureListener { e ->
            // Task failed with an exception
            // ...
        }
ImageLabelingActivity.kt

Java

labeler.process(image)
        .addOnSuccessListener(new OnSuccessListener<List<ImageLabel>>() {
            @Override
            public void onSuccess(List<ImageLabel> labels) {
                // Task completed successfully
                // ...
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Task failed with an exception
                // ...
            }
        });
ImageLabelingActivity.java

Not: CameraX API'sini kullanıyorsanız işiniz bittiğinde ImageProxy nesnesini kapattığınızdan emin olun. Örneğin, process yönteminden döndürülen Task nesnesine bir OnCompleteListener ekleyebilirsiniz. Örnek için hızlı başlangıç örnek uygulamasındaki VisionProcessorBase sınıfına bakın.

4. Etiketli nesneler hakkında bilgi edinme

Resim etiketleme işlemi başarılı olursa başarı dinleyicisine bir ImageLabel nesnesi listesi iletilir. Her ImageLabel nesnesi, resimde etiketlenen bir şeyi temsil eder. Her etiketin metin açıklamasını, eşleşmenin güven puanını ve eşleşmenin dizinini alabilirsiniz. Örneğin:

Kotlin

for (label in labels) {
    val text = label.text
    val confidence = label.confidence
    val index = label.index
}
ImageLabelingActivity.kt

Java

for (ImageLabel label : labels) {
    String text = label.getText();
    float confidence = label.getConfidence();
    int index = label.getIndex();
}
ImageLabelingActivity.java

Gerçek zamanlı performansı iyileştirmeye yönelik ipuçları

Gerçek zamanlı bir uygulamadaki resimleri etiketlemek istiyorsanız en iyi kare hızlarını elde etmek için aşağıdaki yönergeleri uygulayın:

• Camera veya camera2 API'sini kullanıyorsanız resim etiketleyiciye yapılan çağrıları kısıtlayın. Resim etiketleyici çalışırken yeni bir video karesi kullanılabilir hale gelirse kareyi silin. Örnek için hızlı başlangıç örnek uygulamasındaki VisionProcessorBase sınıfına bakın.
• CameraX API'sini kullanıyorsanız geri basınç stratejisinin varsayılan değeri olan ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST değerine ayarlandığından emin olun. Bu sayede, analiz için aynı anda yalnızca bir resim gönderilir. Analizör meşgulken daha fazla görüntü üretilirse bunlar otomatik olarak silinir ve yayınlanmak üzere sıraya alınmaz. Analiz edilen görüntü ImageProxy.close() çağrılarak kapatıldıktan sonra bir sonraki en yeni görüntü yayınlanır.
• Giriş resminin üzerine grafik yerleştirmek için resim etiketleyicinin çıkışını kullanıyorsanız önce ML Kit'ten sonucu alın, ardından resmi ve yer paylaşımını tek bir adımda oluşturun. Bu, her giriş karesi için yalnızca bir kez görüntüleme yüzeyine oluşturulur. Örnek için hızlı başlangıç örnek uygulamasındaki CameraSourcePreview ve GraphicOverlay sınıflarına bakın.
• Camera2 API'yi kullanıyorsanız görüntüleri ImageFormat.YUV_420_888 biçiminde yakalayın. Eski Camera API'yi kullanıyorsanız görüntüleri ImageFormat.NV21 biçiminde yakalayın.