Etichetta le immagini con un modello personalizzato su Android

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

Esistono 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 da Google Play Services. Se selezioni la pipeline non in bundle, la tua app sarà più piccola. Consulta la tabella sottostante per ulteriori dettagli.

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

Nota: la versione non in bundle dell'etichettatura delle immagini con modelli personalizzati è attualmente offerta in versione beta, il che significa che potrebbe cambiare in modi incompatibili con le versioni precedenti e non è soggetta a SLA (accordo sul livello del servizio) o norme sul ritiro.

Esistono due modi per integrare un modello personalizzato: raggruppare il modello inserendolo nella cartella degli asset dell'app o scaricarlo dinamicamente da Firebase. La tabella seguente mette a confronto queste due opzioni.

Modello in bundle	Modello ospitato
Il modello fa parte dell'APK dell'app, che ne aumenta le dimensioni.	Il modello non fa parte dell'APK. L'hosting avviene tramite caricamento su Firebase Machine Learning.
Il modello è subito disponibile, anche quando il dispositivo Android è offline	Il modello viene scaricato on demand
Non è necessario un progetto Firebase	Richiede un progetto Firebase
Devi ripubblicare la tua app per aggiornare il modello	Esegui il push degli aggiornamenti del modello senza ripubblicare l'app
Nessun test A/B integrato	Semplici test A/B con Firebase Remote Config

Prova

• Consulta l'app di guida rapida di Vision per un esempio di utilizzo del modello in bundle e l'app di avvio rapido di AutoML per un esempio di utilizzo del modello ospitato.

Prima di iniziare

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

2. Aggiungi le dipendenze per le librerie Android ML Kit al file gradle a livello di app del modulo, che in genere è app/build.gradle. Scegli una delle seguenti dipendenze 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.2'
   }
   

   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 la tua app in modo che scarichi automaticamente la pipeline sul dispositivo dopo l'installazione dell'app dal Play Store. Per farlo, aggiungi la seguente dichiarazione al file AndroidManifest.xml dell'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 controllare esplicitamente la disponibilità della pipeline e richiedere il download tramite l'API ModuleInstallClient di Google Play Services.

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

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

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

   dependencies {
     // ...
     // Image labeling feature with model downloaded from Firebase
     implementation 'com.google.mlkit:image-labeling-custom:17.0.2'
     // 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 aggiungere Firebase al progetto Android se non l'hai ancora fatto. Questa operazione non è necessaria quando raccogli il modello.

1. Carica il modello

Configura l'origine di un 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/ dell'app. Potrebbe essere necessario creare prima la cartella facendo clic con il tasto destro del mouse sulla cartella app/ e poi facendo clic su Nuovo > Cartella > Cartella Asset.

2. Poi, aggiungi quanto segue al file build.gradle dell'app per assicurarti che Gradle non comprima 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 disponibile per ML Kit come asset non elaborato.

   Nota: a partire dalla versione 4.1 del plug-in Android per Gradle, il file .tflite verrà aggiunto per impostazione predefinita all'elenco noCompress e quanto riportato sopra non è più necessario.

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();

   Nota: le app destinate ad Android 11 (livello API 30) non possono più accedere ai file dallo spazio di archiviazione esterno a causa degli aggiornamenti dello spazio di archiviazione in Android 11.
   Nota: se hai un modello addestrato con AutoML Vision Edge in Firebase (non Google Cloud), quanto indicato sopra potrebbe non funzionare. Segui le istruzioni riportate nella guida alla migrazione.

Configura un'origine del modello ospitata da Firebase

Per utilizzare il modello ospitato in remoto, crea un oggetto RemoteModel mediante 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 è disponibile una versione più recente del modello, l'attività scaricherà il modello in modo asincrono da 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.

Configura l'etichettatore di immagini

Dopo aver configurato le origini del modello, crea un oggetto ImageLabeler da una di esse.

Sono disponibili le seguenti opzioni:

Opzioni
confidenceThreshold	Punteggio di affidabilità minimo delle etichette rilevate. Se non viene impostata, verrà utilizzata qualsiasi soglia del classificatore specificata dai metadati del modello. Se il modello non contiene metadati o se i metadati non specificano una soglia di classificazione, verrà utilizzata una soglia predefinita pari a 0,0.
maxResultCount	Numero massimo di etichette da restituire. Se non viene configurato, verrà utilizzato il valore predefinito 10.

Se hai solo un modello in bundle localmente, crea un etichettatore dal tuo 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 hai un modello ospitato in remoto, devi verificare che sia stato scaricato prima di eseguirlo. Puoi controllare lo stato dell'attività di download del modello utilizzando il metodo isModelDownloaded() del gestore modelli.

Anche se devi confermarlo solo prima di eseguire l'etichettatore, se hai sia un modello ospitato in remoto sia un modello in bundle localmente, potrebbe essere utile eseguire questo controllo quando crei un'istanza dell'etichettatore di immagini: crea un etichettatore dal modello remoto se è stato scaricato e dal modello locale negli altri casi.

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 hai solo un modello ospitato in remoto, devi disattivare le funzionalità correlate al modello, ad esempio disattivare o nascondere parte dell'interfaccia utente fino a quando non confermi che il modello è stato scaricato. Per farlo, collega un listener al metodo download() del gestore dei modelli:

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 un oggetto InputImage dall'immagine. L'etichettatore di immagini funziona più velocemente quando utilizzi Bitmap o, se usi l'API camera2, una media.Image YUV_420_888, opzione consigliata quando possibile.

Puoi creare un oggetto InputImage da origini diverse, illustrate di seguito.

Uso di un media.Image

Per creare un oggetto InputImage da un oggetto media.Image, ad esempio quando acquisisci un'immagine dalla fotocamera di un dispositivo, trasmetti l'oggetto media.Image e la rotazione dell'immagine a InputImage.fromMediaImage().

Se utilizzi la libreria FotocameraX, le classi OnImageCapturedListener e ImageAnalysis.Analyzer calcolano automaticamente il valore di rotazione.

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 della fotocamera che mostra il grado di rotazione dell'immagine, puoi calcolarlo in base al grado di rotazione del dispositivo e all'orientamento del sensore 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
}
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;
}

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

Kotlin

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

Java

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

Utilizzare l'URI di un file

Per creare un oggetto InputImage da un URI del file, passa il contesto dell'app e l'URI del file a InputImage.fromFilePath(). Questo è utile quando utilizzi un intent ACTION_GET_CONTENT per richiedere all'utente di selezionare un'immagine dall'app Galleria.

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

Con ByteBuffer o ByteArray

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

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

Uso di un Bitmap

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

Kotlin

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

Java

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

L'immagine è rappresentata da un oggetto Bitmap con gradi di rotazione.

3. Esegui l'etichettatore di immagini

Per etichettare gli oggetti in un'immagine, passa l'oggetto image al metodo process() di ImageLabeler.

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

Nota: se utilizzi l'API CameraX, assicurati di chiudere ImageProxy quando finisci di utilizzarlo, ad esempio, aggiungendo OnCompleteListener all'API Task restituita dal metodo process. Consulta la classe VisionProcessorBase nell'app di esempio della guida rapida per un esempio.

4. Recuperare informazioni sulle entità etichettate

Se l'operazione di etichettatura dell'immagine ha esito positivo, un elenco di oggetti ImageLabel viene trasmesso al listener di esito positivo. Ogni oggetto ImageLabel rappresenta un elemento etichettato nell'immagine. Puoi ottenere la descrizione testuale, il punteggio di affidabilità e l'indice di ogni etichetta, se disponibile nei metadati del file del modello TensorFlow Lite. Ad esempio:

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

Nota: se utilizzi un modello TensorFlow Lite incompatibile con ML Kit, riceverai un MlKitException con il codice di errore MlKitException#INVALID_ARGUMENT e alcuni dettagli sul motivo per cui non è compatibile. Per maggiori dettagli, consulta i Requisiti di compatibilità dei modelli personalizzati.

Suggerimenti per migliorare il rendimento in tempo reale

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

• Se utilizzi l'API Camera o camera2, limita le chiamate all'etichettatore di immagini. Se diventa disponibile un nuovo frame video mentre è in esecuzione l'etichettatore di immagini, rilascialo. Per un esempio, consulta la classe VisionProcessorBase nell'app di esempio della guida rapida.
• 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à inviata per l'analisi una sola immagine alla volta. Se vengono prodotte più immagini quando l'analizzatore è occupato, queste verranno eliminate automaticamente e non verranno inserite nella coda per l'invio. Dopo aver chiuso l'immagine analizzata chiamando ImageProxy.close(), verrà pubblicata la successiva immagine più recente.
• Se utilizzi l'output dell'etichettatore di immagini per sovrapporre gli elementi grafici all'immagine di input, recupera prima il risultato da ML Kit, quindi esegui il rendering dell'immagine e dell'overlay in un solo passaggio. Il rendering viene eseguito sulla piattaforma di visualizzazione una sola volta per ogni frame di input. Per un esempio, consulta le classi CameraSourcePreview e GraphicOverlay nell'app di esempio della guida rapida.
• Se utilizzi l'API Camera2, acquisisci le immagini in formato ImageFormat.YUV_420_888. Se utilizzi l'API Camera precedente, acquisisci le immagini in formato ImageFormat.NV21.