Etichetta le immagini con un modello personalizzato su Android

Puoi utilizzare ML Kit per riconoscere le entità in un'immagine e etichettarle. Questa API supporta un'ampia gamma di modelli personalizzati di classificazione delle immagini. Non dimenticare di apporre Consulta la sezione Modelli personalizzati con ML Kit per indicazioni requisiti di compatibilità dei modelli, dove trovare i modelli preaddestrati, e su come addestrare i tuoi modelli.

Ci sono due modi per integrare l'etichettatura delle immagini con i modelli personalizzati: raggruppando la pipeline come parte della tua app o utilizzando una pipeline non in bundle che dipende su Google Play Services. Se selezioni la pipeline non in bundle, l'app verrà più piccoli. Consulta la tabella sottostante per ulteriori dettagli.

In bundleNon raggruppati
Nome libreriacom.google.mlkit:image-labeling-customcom.google.android.gms:play-services-mlkit-image-labeling-custom
ImplementazioneLa pipeline è collegata in modo statico alla tua app al momento della creazione.La pipeline viene scaricata in modo dinamico tramite Google Play Services.
Dimensioni appAumento delle dimensioni di circa 3,8 MB.Aumento delle dimensioni di circa 200 kB.
Tempo di inizializzazioneLa pipeline è disponibile immediatamente.Potrebbe essere necessario attendere il download della pipeline prima del primo utilizzo.
Fase del ciclo di vita delle APIDisponibilità generale (GA)Beta

Esistono due modi per integrare un modello personalizzato: raggruppa il modello mediante inserendolo nella cartella degli asset dell'app o scaricandolo in modo dinamico. da Firebase. La tabella seguente mette a confronto queste due opzioni.

Modello in bundle Modello ospitato
Il modello fa parte dell'APK della tua app, che ne aumenta le dimensioni. Il modello non fa parte dell'APK. È ospitata mediante caricamento su Firebase Machine Learning
Il modello è disponibile immediatamente, anche quando il dispositivo Android è offline Il modello viene scaricato on demand
Non è necessario un progetto Firebase Richiede un progetto Firebase
Devi pubblicare nuovamente l'app per aggiornare il modello Esegui il push degli aggiornamenti del modello senza ripubblicare l'app
Nessun test A/B integrato Test A/B semplici con Firebase Remote Config

Prova

Prima di iniziare

  1. Nel file build.gradle a livello di progetto, assicurati di includere Repository Maven di Google in buildscript e allprojects sezioni.

  2. Aggiungi le dipendenze per le librerie Android ML Kit agli file gradle a livello di app, che in genere è app/build.gradle. Scegli una delle le dipendenze seguenti in base alle tue esigenze:

    Per raggruppare la pipeline con la tua app:

    dependencies {
      // ...
      // Use this dependency to bundle the pipeline with your app
      implementation 'com.google.mlkit:image-labeling-custom:17.0.3'
    }
    

    Per l'utilizzo della pipeline in Google Play Services:

    dependencies {
      // ...
      // Use this dependency to use the dynamically downloaded pipeline in Google Play Services
      implementation 'com.google.android.gms:play-services-mlkit-image-labeling-custom:16.0.0-beta5'
    }
    
  3. Se scegli di utilizzare la pipeline in Google Play Services, puoi configurare l'app per scaricare automaticamente la pipeline sul dispositivo dopo la tua app sia installata dal Play Store. Per farlo, aggiungi quanto segue: dichiarazione al file AndroidManifest.xml della tua app:

    <application ...>
        ...
        <meta-data
            android:name="com.google.mlkit.vision.DEPENDENCIES"
            android:value="custom_ica" />
        <!-- To use multiple downloads: android:value="custom_ica,download2,download3" -->
    </application>
    

    Puoi anche verificare esplicitamente la disponibilità della pipeline e richiedere il download tramite L'API ModuleInstallaClient di Google Play Services.

    Se non abiliti i download di pipeline al momento dell'installazione o richiedi un download esplicito, la pipeline viene scaricata la prima volta che esegui l'etichettatore. Le tue richieste prima del completamento del download non producono risultati.

  4. Aggiungi la dipendenza linkFirebase se vuoi scaricare dinamicamente un modello di Firebase:

    Per scaricare dinamicamente un modello da Firebase, aggiungi linkFirebase della dipendenza:

    dependencies {
      // ...
      // Image labeling feature with model downloaded from Firebase
      implementation 'com.google.mlkit:image-labeling-custom:17.0.3'
      // Or use the dynamically downloaded pipeline in Google Play Services
      // implementation 'com.google.android.gms:play-services-mlkit-image-labeling-custom:16.0.0-beta5'
      implementation 'com.google.mlkit:linkfirebase:17.0.0'
    }
    
  5. Se vuoi scaricare un modello, assicurati di aggiungi Firebase al tuo progetto Android, se non l'hai ancora fatto. Questa operazione non è necessaria se includi il modello.

1. Carica il modello

Configura un'origine del modello locale

Per raggruppare il modello con la tua app:

  1. Copia il file del modello (che di solito termina con .tflite o .lite) nella cartella assets/. (Potresti dover prima creare la cartella facendo clic con il tasto destro del mouse sulla cartella app/, poi facendo clic Nuovo > Cartella > nella cartella Asset.

  2. Poi, aggiungi quanto segue al file build.gradle dell'app per assicurarti Gradle non comprime il file del modello durante la creazione dell'app:

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

    Il file del modello sarà incluso nel pacchetto dell'app e sarà disponibile per ML Kit come asset non elaborato.

  3. Crea l'oggetto LocalModel, specificando il percorso del file del modello:

    Kotlin

    val localModel = LocalModel.Builder()
            .setAssetFilePath("model.tflite")
            // or .setAbsoluteFilePath(absolute file path to model file)
            // or .setUri(URI to model file)
            .build()

    Java

    LocalModel localModel =
        new LocalModel.Builder()
            .setAssetFilePath("model.tflite")
            // or .setAbsoluteFilePath(absolute file path to model file)
            // or .setUri(URI to model file)
            .build();

Configura l'origine di un modello ospitata da Firebase

Per utilizzare il modello ospitato in remoto, crea un oggetto RemoteModel FirebaseModelSource, specificando il nome assegnato al modello quando lo hai pubblicato:

Kotlin

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

Java

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

Poi, avvia l'attività di download del modello, specificando le condizioni in cui vuoi consentire il download. Se il modello non è presente sul dispositivo o se una versione più recente del modello, l'attività scaricherà in modo asincrono modello di Firebase:

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

Molte app avviano l'attività di download nel codice di inizializzazione, ma puoi farlo in qualsiasi momento, prima di utilizzare il modello.

Configurare l'etichettatore delle immagini

Dopo aver configurato le origini del modello, crea un oggetto ImageLabeler da uno di questi.

Sono disponibili le seguenti opzioni:

Opzioni
confidenceThreshold

Punteggio di confidenza minimo delle etichette rilevate. Se non viene configurato, qualsiasi valore verrà usata la soglia del classificatore specificata dai metadati del modello. Se il modello non contiene metadati o se i metadati non contengono specifica una soglia di classificazione, la soglia predefinita di 0,0 sarà in uso.

maxResultCount

Numero massimo di etichette da restituire. Se non è impostato, il valore predefinito 10.

Se hai solo un modello in bundle locale, crea un etichettatore dalla tua Oggetto LocalModel:

Kotlin

val customImageLabelerOptions = CustomImageLabelerOptions.Builder(localModel)
    .setConfidenceThreshold(0.5f)
    .setMaxResultCount(5)
    .build()
val labeler = ImageLabeling.getClient(customImageLabelerOptions)

Java

CustomImageLabelerOptions customImageLabelerOptions =
        new CustomImageLabelerOptions.Builder(localModel)
            .setConfidenceThreshold(0.5f)
            .setMaxResultCount(5)
            .build();
ImageLabeler labeler = ImageLabeling.getClient(customImageLabelerOptions);

Se utilizzi un modello ospitato in remoto, dovrai verificare che sia stato scaricato prima di eseguirlo. Puoi controllare lo stato del download del modello utilizzando il metodo isModelDownloaded() del gestore del modello.

Anche se devi solo confermare prima di eseguire l'etichettatore, se sia un modello ospitato in remoto sia uno in bundle locale, potrebbe di eseguire questo controllo quando si crea un'istanza dell'etichettatore delle immagini: etichettatore dal modello remoto, se è stato scaricato, e dall'etichetta modello di machine learning.

Kotlin

RemoteModelManager.getInstance().isModelDownloaded(remoteModel)
    .addOnSuccessListener { isDownloaded ->
    val optionsBuilder =
        if (isDownloaded) {
            CustomImageLabelerOptions.Builder(remoteModel)
        } else {
            CustomImageLabelerOptions.Builder(localModel)
        }
    val options = optionsBuilder
                  .setConfidenceThreshold(0.5f)
                  .setMaxResultCount(5)
                  .build()
    val labeler = ImageLabeling.getClient(options)
}

Java

RemoteModelManager.getInstance().isModelDownloaded(remoteModel)
        .addOnSuccessListener(new OnSuccessListener() {
            @Override
            public void onSuccess(Boolean isDownloaded) {
                CustomImageLabelerOptions.Builder optionsBuilder;
                if (isDownloaded) {
                    optionsBuilder = new CustomImageLabelerOptions.Builder(remoteModel);
                } else {
                    optionsBuilder = new CustomImageLabelerOptions.Builder(localModel);
                }
                CustomImageLabelerOptions options = optionsBuilder
                    .setConfidenceThreshold(0.5f)
                    .setMaxResultCount(5)
                    .build();
                ImageLabeler labeler = ImageLabeling.getClient(options);
            }
        });

Se disponi solo di un modello ospitato in remoto, devi disattivare le relative funzionalità, ad esempio rendere non selezionabile o nascondere parte dell'interfaccia utente, fino a quando confermi che il modello è stato scaricato. Puoi farlo collegando un listener al metodo download() del gestore del modello:

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. Prepara l'immagine di input

Quindi, per ogni immagine da etichettare, crea una InputImage. un oggetto dall'immagine. Lo strumento di etichettatura delle immagini è più veloce quando usi un'istruzione Bitmap oppure, se usi l'API camera2, un YUV_420_888 media.Image, che sono consigliati quando possibile.

Puoi creare una InputImage da diverse origini, ciascuna è spiegata di seguito.

Utilizzo di un media.Image

Per creare una InputImage da un oggetto media.Image, ad esempio quando acquisisci un'immagine da un fotocamera del dispositivo, passa l'oggetto media.Image e la rotazione in InputImage.fromMediaImage().

Se utilizzi nella libreria di CameraX, OnImageCapturedListener e ImageAnalysis.Analyzer classi calcolano il valore di rotazione per te.

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
          // ...
        }
    }
}

Se non utilizzi una raccolta di videocamere che fornisce il grado di rotazione dell'immagine, può calcolarlo in base al grado di rotazione e all'orientamento della fotocamera nel dispositivo:

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
}

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;
}

Quindi, passa l'oggetto media.Image e valore del grado di rotazione su InputImage.fromMediaImage():

Kotlin

val image = InputImage.fromMediaImage(mediaImage, rotation)

Java

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

Utilizzo di un URI del file

Per creare una InputImage da un URI file, passa il contesto dell'app e l'URI del file a InputImage.fromFilePath(). È utile quando utilizza un intent ACTION_GET_CONTENT per chiedere all'utente di selezionare un'immagine dall'app Galleria.

Kotlin

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

Java

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

Con ByteBuffer o ByteArray

Per creare una InputImage oggetto da un valore ByteBuffer o ByteArray, prima calcola l'immagine grado di rotazione come descritto in precedenza per l'input media.Image. Quindi, crea l'oggetto InputImage con il buffer o l'array, insieme al campo altezza, larghezza, formato di codifica del colore e grado di rotazione:

Kotlin

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

Java

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

Utilizzo di un Bitmap

Per creare una InputImage oggetto da un oggetto Bitmap, effettua la seguente dichiarazione:

Kotlin

val image = InputImage.fromBitmap(bitmap, 0)

Java

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

L'immagine è rappresentata da un oggetto Bitmap e da un grado di rotazione.

3. Esegui l'etichettatore delle immagini

Per etichettare gli oggetti in un'immagine, passa l'oggetto image all'elemento ImageLabeler process().

Kotlin

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

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
                // ...
            }
        });

4. Recuperare informazioni sulle entità etichettate

Se l'operazione di etichettatura delle immagini ha esito positivo, viene visualizzato un elenco di ImageLabel vengono passati al listener di eventi riuscito. Ogni oggetto ImageLabel rappresenta un elemento etichettato nell'immagine. Puoi visualizzare il testo di ogni etichetta descrizione (se disponibile nei metadati del file del modello TensorFlow Lite), punteggio di confidenza e indice. Ad esempio:

Kotlin

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

Java

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

Suggerimenti per migliorare il rendimento in tempo reale

Se vuoi etichettare le immagini in un'applicazione in tempo reale, segui questi passaggi: linee guida per ottenere le migliori frequenze fotogrammi:

  • Se utilizzi Camera oppure API camera2, limitare le chiamate all'etichettatore delle immagini. Se viene pubblicato un nuovo video diventa disponibile mentre l'etichettatore delle immagini è in esecuzione, rilascia il frame. Consulta le VisionProcessorBase nell'app di esempio della guida rapida per un esempio.
  • Se utilizzi l'API CameraX, assicurati che la strategia di contropressione sia impostata sul valore predefinito ImageAnalysis.STRATEGY_KEEP_ONLY_LATEST. Ciò garantisce che verrà pubblicata una sola immagine alla volta per l'analisi. Se vengono visualizzate altre immagini generati quando l'analizzatore è occupato, verranno eliminati automaticamente e non verranno messi in coda la distribuzione dei contenuti. Dopo aver chiuso l'immagine da analizzare richiamando ImageProxy.close(), verrà pubblicata l'immagine successiva più recente.
  • Se utilizzi l'output dello strumento di etichettatura delle immagini per sovrapporre gli elementi grafici l'immagine di input, occorre prima ottenere il risultato da ML Kit, quindi eseguire il rendering dell'immagine e la sovrapposizione in un solo passaggio. Viene visualizzata sulla superficie di visualizzazione solo una volta per ogni frame di input. Consulta le CameraSourcePreview e GraphicOverlay nell'app di esempio della guida rapida per un esempio.
  • Se utilizzi l'API Camera2, acquisisci le immagini in Formato ImageFormat.YUV_420_888. Se usi l'API Camera precedente, acquisisci le immagini in Formato ImageFormat.NV21.