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 in bundle che dipende da Google Play Services. Se selezioni la pipeline in bundle, la tua app sarà di dimensioni inferiori. Consulta la tabella sottostante per ulteriori dettagli.

	In bundle	Non raggruppati
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 dinamicamente tramite Google Play Services.
Dimensioni app	Aumento di circa 3,8 MB.	Aumento 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 dell'API	Disponibilità generale (GA)	Beta

Nota: la versione non abbinata dell'etichettatura delle immagini con i modelli personalizzati è attualmente offerta in versione beta, il che significa che potrebbe cambiare in modo incompatibile 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 oppure scaricarlo in modo dinamico da Firebase. Nella tabella che segue vengono messe a confronto queste due opzioni.

Modello in bundle	Modello in hosting
Il modello fa parte dell'APK della tua app, che aumenta le sue dimensioni.	Il modello non fa parte dell'APK. È ospitato tramite il 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
Per aggiornare il modello, devi ripubblicare l'app	Esegui il push degli aggiornamenti del modello senza ripubblicare l'app
Nessun test A/B integrato	Facile test A/B con Firebase Remote Config

Prova subito

• Consultate l'app della guida rapida di Vision per un esempio di utilizzo del modello in bundle e l'app Guida rapida 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 nelle sezioni buildscript e allprojects.

2. Aggiungi le dipendenze per le librerie Android di ML Kit al file gradle a livello di app del tuo 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.1'
   }
   

   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-beta4'
   }
   

3. Se scegli di utilizzare la pipeline in Google Play Services, puoi configurarla per scaricare automaticamente la pipeline sul dispositivo dopo l'installazione da Play Store. Per farlo, aggiungi la seguente 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 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 il download esplicito, la pipeline viene scaricata la prima volta che esegui l'etichettatore. Le richieste effettuate prima del completamento del download non generano alcun risultato.

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

   Per scaricare in modo dinamico un modello da Firebase, aggiungi la linkFirebasedipendenza:

   dependencies {
     // ...
     // Image labeling feature with model downloaded from Firebase
     implementation 'com.google.mlkit:image-labeling-custom:17.0.1'
     // Or use the dynamically downloaded pipeline in Google Play Services
     // implementation 'com.google.android.gms:play-services-mlkit-image-labeling-custom:16.0.0-beta4'
     implementation 'com.google.mlkit:linkfirebase:17.0.0'
   }
   

5. Se vuoi scaricare un modello, assicurati di aggiungere Firebase al tuo progetto Android, se non l'hai ancora fatto. Questa operazione non è necessaria quando raggruppa il modello.

1. Carica il modello

Configura un'origine modello locale

Per raggruppare il modello con la tua app:

1. Copia il file del modello (che in genere 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/, quindi facendo clic su Nuovo > Cartella > Cartella asset.

2. Quindi, aggiungi quanto segue al file build.gradle dell'app per assicurarti che Gradle non comprima il file modello durante la creazione dell'app:

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

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

   Nota: a partire dalla versione 4.1 del plug-in Android per Gradle, i file .tflite verranno aggiunti all'elenco noCompress per impostazione predefinita e il precedente 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 da dispositivi di archiviazione esterna a causa degli aggiornamenti dello spazio di archiviazione di Android 11.
   Nota: se un modello è stato addestrato con AutoML Vision Edge in Firebase (non Google Cloud), sopra riportato potrebbe non funzionare. Segui le istruzioni della guida alla migrazione.

Configura un'origine modello ospitata da Firebase

Per utilizzare il modello ospitato da remoto, crea un oggetto RemoteModel FirebaseModelSource, specificando il nome assegnato al modello al momento della pubblicazione:

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

Avvia l'attività di download del modello, specificando le condizioni in base alle quali vuoi consentire il download. Se il modello non è sul dispositivo o se è disponibile una versione più recente del modello, l'attività scaricherà in modo asincrono il modello 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 proprio codice di inizializzazione, tuttavia è possibile farlo in qualsiasi momento prima di dover utilizzare il modello.

Configura l'etichettatore di immagini

Dopo aver configurato le origini dei modelli, crea un oggetto ImageLabeler da una di queste.

Sono disponibili le seguenti opzioni:

Opzioni
confidenceThreshold	Punteggio di confidenza minimo delle etichette rilevate. Se non viene impostata, verrà utilizzata qualsiasi soglia di classificazione 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 di 0,0.
maxResultCount	Numero massimo di etichette da restituire. Se non viene impostato, verrà utilizzato il valore predefinito 10.

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

Sebbene sia necessario confermare questa operazione solo prima di eseguire l'etichettatore, se hai un modello ospitato in remoto e un modello con bundle in locale, potrebbe essere utile eseguire questo controllo creando un'istanza dell'etichettatore di immagini: crea un etichettatore dal modello remoto, se 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 la funzionalità relativa al modello, ad esempio in grigio o nascondere parte della tua interfaccia utente fino a quando non confermi il download del modello. Puoi farlo aggiungendo un listener al metodo download() del gestore di 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 che vuoi etichettare, crea un oggetto InputImage dall'immagine. L'etichettatore di immagini viene eseguito più velocemente quando utilizzi un Bitmap oppure, se utilizzi l'API camera2, un YUV_420_888 media.Image, che è consigliato quando possibile.

Puoi creare un oggetto InputImage da diverse origini, ognuno dei quali è spiegato di seguito.

media.Image

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

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

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 libreria delle videocamere che ti dà il grado di rotazione dell'immagine, puoi calcolarla in base al grado di rotazione e all'orientamento del sensore della videocamera del 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);

usando 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(). Questa operazione è utile quando utilizzi un intento ACTION_GET_CONTENT per richiedere all'utente di selezionare un'immagine dalla sua 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();
}

ByteBuffer o ByteArray

Per creare un oggetto InputImage da un elemento ByteBuffer o ByteArray, innanzitutto calcola il grado di rotazione delle immagini 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 dei colori 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

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 insieme ai 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 al termine dell'utilizzo, ad esempio aggiungendo un elemento OnCompleteListener al metodo Task restituito dal metodo process. Guarda la classe VisionProcessorBase nell'app di esempio della guida rapida per un esempio.

4. Informazioni sulle entità etichettate

Se l'operazione di etichettatura delle immagini ha esito positivo, viene trasmesso un elenco di oggetti ImageLabel al listener riuscito. Ogni oggetto ImageLabel rappresenta un elemento etichettato nell'immagine. Puoi ottenere la descrizione testuale di ogni etichetta (se disponibile nei metadati del file modello TensorFlow Lite), il punteggio di affidabilità e l'indice. 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 non compatibile con il ML Kit, riceverai un MlKitException con il codice di errore MlKitException#INVALID_ARGUMENT e alcuni dettagli sul motivo per cui non è compatibile. Per ulteriori 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 migliori frequenze di fotogrammi:

• Se utilizzi l'API Camera o camera2, limita le chiamate all'etichettatore di immagini. Se è disponibile un nuovo frame video mentre l'etichettatore di immagini è in esecuzione, elimina il frame. Guarda la classe 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. In questo modo, verrà fornita una sola immagine alla volta per l'analisi. Se vengono generate più immagini quando lo strumento di analisi è occupato, verranno eliminate automaticamente e non saranno messe in coda per la pubblicazione. Una volta che l'immagine analizzata viene chiusa chiamando ImageProxy.close(), verrà pubblicata l'ultima immagine successiva.
• Se utilizzi l'output dell'etichettatrice delle immagini per sovrapporre la grafica all'immagine di input, ottieni innanzitutto il risultato di ML Kit, quindi visualizza l'immagine e l'overlay in un solo passaggio. Questo viene visualizzato nella superficie di visualizzazione una sola volta per ogni frame di input. Guarda un esempio delle classi CameraSourcePreview e GraphicOverlay nell'app di esempio della guida rapida.
• Se utilizzi l'API Camera2, acquisisci le immagini nel formato ImageFormat.YUV_420_888. Se utilizzi la versione precedente dell'API Camera, acquisisci le immagini in formato ImageFormat.NV21.