Cuando pasas una imagen al Kit de AA, este detecta hasta cinco objetos en la imagen, junto con la posición de cada uno de ellos. Cuando se detectan objetos en transmisiones de video por Internet, cada objeto tiene un ID único que puedes usar para seguirlo de fotograma a fotograma.
Puedes usar un modelo de clasificación de imágenes personalizado para clasificar los objetos que se detectan. Consulta Modelos personalizados con el kit de AA para obtener orientación sobre los requisitos de compatibilidad de los modelos, dónde encontrar modelos previamente entrenados y cómo entrenar tus propios modelos.
Hay dos formas de integrar un modelo personalizado. Para empaquetar el modelo, puedes colocarlo dentro de la carpeta de elementos de tu app o descargarlo de forma dinámica desde Firebase. En la siguiente tabla, se comparan las dos opciones.
Modelo incluido | Modelo alojado |
---|---|
El modelo es parte del APK de tu app y aumenta su tamaño. | El modelo no es parte de tu APK. Se aloja mediante la carga del aprendizaje automático de Firebase. |
El modelo está disponible de inmediato, incluso cuando el dispositivo Android está sin conexión | El modelo se descarga a pedido |
No se necesita un proyecto de Firebase | Se requiere un proyecto de Firebase. |
Debes volver a publicar tu app para actualizar el modelo | El modelo de envío se actualiza sin volver a publicar la app |
Sin pruebas A/B integradas | Pruebas A/B sencillas con Firebase Remote Config |
Probar
- Consulta la app de inicio rápido de Vision para ver un ejemplo de uso del modelo en paquete y la app de inicio rápido de Automl para ver un ejemplo de uso del modelo alojado.
- Consulta la app de muestra de material design para obtener una implementación de extremo a extremo de esta API.
Antes de comenzar
En tu archivo
build.gradle
de nivel de proyecto, asegúrate de incluir el repositorio Maven de Google en las seccionesbuildscript
yallprojects
.Agrega las dependencias para las bibliotecas de Android del Kit de AA al archivo Gradle a nivel de la app de tu módulo, que suele ser
app/build.gradle
:Para empaquetar un modelo con tu app, sigue estos pasos:
dependencies { // ... // Object detection & tracking feature with custom bundled model implementation 'com.google.mlkit:object-detection-custom:17.0.2' }
Para descargar un modelo de Firebase de forma dinámica, agrega la dependencia
linkFirebase
:dependencies { // ... // Object detection & tracking feature with model downloaded // from firebase implementation 'com.google.mlkit:object-detection-custom:17.0.2' implementation 'com.google.mlkit:linkfirebase:17.0.0' }
Si quieres descargar un modelo, asegúrate de agregar Firebase a tu proyecto de Android, en caso de que aún no lo hayas hecho. Esto no es obligatorio cuando se empaqueta un modelo.
1. Carga el modelo
Configura una fuente de modelo local
Para empaquetar el modelo con tu app, haz lo siguiente:
Copia el archivo del modelo (que suele terminar en
.tflite
o.lite
) a la carpetaassets/
de tu app. Es posible que primero debas crear la carpeta. Para ello, haz clic con el botón derecho en la carpetaapp/
y, luego, en Nuevo > Carpeta > Carpeta de elementos.Luego, agrega lo siguiente al archivo
build.gradle
de tu app para asegurarte de que Gradle no comprima el archivo del modelo cuando se compile la app:android { // ... aaptOptions { noCompress "tflite" // or noCompress "lite" } }
El archivo del modelo se incluirá en el paquete de la app y estará disponible para el Kit de AA como elemento sin procesar.
Crea un objeto
LocalModel
y especifica la ruta al archivo del modelo: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 una fuente de modelo alojada en Firebase
Para usar el modelo alojado de forma remota, crea un objeto CustomRemoteModel
mediante FirebaseModelSource
y especifica el nombre que le asignaste al modelo cuando lo publicaste:
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();
Luego, inicia la tarea de descarga del modelo y especifica las condiciones en las que deseas permitir la descarga. Si el modelo no está en el dispositivo o si hay una versión más reciente de este, la tarea descargará el modelo de Firebase de forma asíncrona:
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. } });
Muchas apps comienzan la tarea de descarga en su código de inicialización, pero puedes hacerlo en cualquier momento antes de usar el modelo.
2. Configura el detector de objetos
Después de configurar las fuentes de tu modelo, configura el detector de objetos para tu caso de uso con un objeto CustomObjectDetectorOptions
. Puedes cambiar las siguientes opciones de configuración:
Configuración del detector de objetos | |
---|---|
Modo de detección |
STREAM_MODE (predeterminado) | SINGLE_IMAGE_MODE
En En |
Detecta varios objetos y hazles seguimiento |
false (predeterminado) | true
Ya sea para detectar y hacer seguimiento de hasta cinco objetos o solo al más prominente (predeterminado). |
Clasificar objetos |
false (predeterminado) | true
Indica si se deben clasificar los objetos detectados o no con el modelo de clasificación personalizado proporcionado. Para usar tu modelo de clasificación personalizado, debes configurarlo como |
Umbral de confianza de la clasificación |
Puntuación de confianza mínima de las etiquetas detectadas. Si no se configura, se usará cualquier umbral de clasificador especificado por los metadatos del modelo. Si el modelo no contiene metadatos o estos no especifican un umbral de clasificador, se usará un umbral predeterminado de 0.0. |
Cantidad máxima de etiquetas por objeto |
Cantidad máxima de etiquetas por objeto que mostrará el detector. Si no la estableces, se usará el valor predeterminado de 10. |
La API de detección y seguimiento de objetos está optimizada para los siguientes dos casos prácticos principales:
- Detección y seguimiento en vivo del objeto más prominente en el visor de la cámara
- La detección de múltiples objetos de una imagen estática.
Si deseas configurar la API para estos casos de uso con un modelo empaquetado localmente, haz lo siguiente:
Kotlin
// Live detection and tracking val customObjectDetectorOptions = CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.STREAM_MODE) .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build() // Multiple object detection in static images val customObjectDetectorOptions = CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableMultipleObjects() .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build() val objectDetector = ObjectDetection.getClient(customObjectDetectorOptions)
Java
// Live detection and tracking CustomObjectDetectorOptions customObjectDetectorOptions = new CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.STREAM_MODE) .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build(); // Multiple object detection in static images CustomObjectDetectorOptions customObjectDetectorOptions = new CustomObjectDetectorOptions.Builder(localModel) .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableMultipleObjects() .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build(); ObjectDetector objectDetector = ObjectDetection.getClient(customObjectDetectorOptions);
Si tienes un modelo alojado de forma remota, comprueba si se descargó antes de ejecutarlo. Puedes verificar el estado de la tarea de descarga del modelo con el método isModelDownloaded()
del administrador del modelo.
Aunque solo tienes que confirmar esto antes de ejecutar el detector, si tienes un modelo alojado de forma remota y uno empaquetado localmente, tendría sentido realizar esta verificación cuando se crea una instancia del detector de imágenes: crea un detector desde el modelo remoto si se descargó o, en su defecto, desde el modelo local.
Kotlin
RemoteModelManager.getInstance().isModelDownloaded(remoteModel) .addOnSuccessListener { isDownloaded -> val optionsBuilder = if (isDownloaded) { CustomObjectDetectorOptions.Builder(remoteModel) } else { CustomObjectDetectorOptions.Builder(localModel) } val customObjectDetectorOptions = optionsBuilder .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build() val objectDetector = ObjectDetection.getClient(customObjectDetectorOptions) }
Java
RemoteModelManager.getInstance().isModelDownloaded(remoteModel) .addOnSuccessListener(new OnSuccessListener() { @Override public void onSuccess(Boolean isDownloaded) { CustomObjectDetectorOptions.Builder optionsBuilder; if (isDownloaded) { optionsBuilder = new CustomObjectDetectorOptions.Builder(remoteModel); } else { optionsBuilder = new CustomObjectDetectorOptions.Builder(localModel); } CustomObjectDetectorOptions customObjectDetectorOptions = optionsBuilder .setDetectorMode(CustomObjectDetectorOptions.SINGLE_IMAGE_MODE) .enableClassification() .setClassificationConfidenceThreshold(0.5f) .setMaxPerObjectLabelCount(3) .build(); ObjectDetector objectDetector = ObjectDetection.getClient(customObjectDetectorOptions); } });
Si solo tienes un modelo alojado de forma remota, debes inhabilitar la funcionalidad relacionada con el modelo, por ejemplo, oculta o inhabilita parte de tu IU, hasta que confirmes que el modelo se descargó. Puedes hacerlo si adjuntas un objeto de escucha
al método download()
del administrador de modelos:
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. } });
3. Prepara la imagen de entrada
Crea un objetoInputImage
a partir de tu imagen.
El detector de objetos se ejecuta directamente desde un Bitmap
, ByteBuffer
de NV21 o un media.Image
YUV_420_888. Se recomienda crear un InputImage
a partir de esas fuentes si tienes acceso directo a una de ellas. Si creas un InputImage
a partir de otras fuentes, nosotros controlaremos la conversión de forma interna por ti y es posible que sea menos eficiente.
Puedes crear un objeto InputImage
a partir de diferentes fuentes, que se explican a continuación.
Usa un media.Image
Para crear un objeto InputImage
a partir de un objeto media.Image
, como cuando capturas una imagen con la cámara de un dispositivo, pasa el objeto media.Image
y la rotación de la imagen a InputImage.fromMediaImage()
.
Si usas la biblioteca
CameraX, las clases OnImageCapturedListener
y
ImageAnalysis.Analyzer
calculan el valor de rotación
por ti.
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 // ... } } }
Si no usas una biblioteca de cámaras que te proporcione el grado de rotación de la imagen, puedes calcularla a partir del grado de rotación del dispositivo y la orientación del sensor de la cámara en el 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; }
Luego, pasa el objeto media.Image
y el
valor de grado de rotación a InputImage.fromMediaImage()
:
Kotlin
val image = InputImage.fromMediaImage(mediaImage, rotation)
Java
InputImage image = InputImage.fromMediaImage(mediaImage, rotation);
Usa un URI de archivo
Para crear un objeto InputImage
a partir de un URI de archivo, pasa el contexto de la app y el URI de archivo a InputImage.fromFilePath()
. Esto es útil cuando usas un intent ACTION_GET_CONTENT
para solicitarle al usuario que seleccione una imagen de su app de galería.
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(); }
Usa ByteBuffer
o ByteArray
Para crear un objeto InputImage
a partir de un objeto ByteBuffer
o ByteArray
, primero calcula el grado de rotación de la imagen como se describió anteriormente en la entrada media.Image
.
Luego, crea el objeto InputImage
con el búfer o el array, junto con la altura,
el ancho, el formato de codificación de color y el grado de rotación de la imagen:
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 );
Usa un Bitmap
Para crear un objeto InputImage
a partir de un objeto Bitmap
, realiza la siguiente declaración:
Kotlin
val image = InputImage.fromBitmap(bitmap, 0)
Java
InputImage image = InputImage.fromBitmap(bitmap, rotationDegree);
La imagen está representada por un objeto Bitmap
junto con los grados de rotación.
4. Ejecuta el detector de objetos
Kotlin
objectDetector .process(image) .addOnFailureListener(e -> {...}) .addOnSuccessListener(results -> { for (detectedObject in results) { // ... } });
Java
objectDetector .process(image) .addOnFailureListener(e -> {...}) .addOnSuccessListener(results -> { for (DetectedObject detectedObject : results) { // ... } });
5. Obtén información sobre los objetos etiquetados
Si la llamada a process()
se ejecuta correctamente, se pasa una lista de DetectedObject
al objeto de escucha que detecta el resultado correcto.
Cada DetectedObject
contiene las siguientes propiedades:
Cuadro delimitador | Es un Rect que indica la posición del objeto en la imagen. |
||||||
ID de seguimiento | Un número entero que identifica el objeto en las imágenes. Nulo en SINGLE_IMAGE_MODE. | ||||||
Etiquetas |
|
Kotlin
// The list of detected objects contains one item if multiple // object detection wasn't enabled. for (detectedObject in results) { val boundingBox = detectedObject.boundingBox val trackingId = detectedObject.trackingId for (label in detectedObject.labels) { val text = label.text val index = label.index val confidence = label.confidence } }
Java
// The list of detected objects contains one item if multiple // object detection wasn't enabled. for (DetectedObject detectedObject : results) { Rect boundingBox = detectedObject.getBoundingBox(); Integer trackingId = detectedObject.getTrackingId(); for (Label label : detectedObject.getLabels()) { String text = label.getText(); int index = label.getIndex(); float confidence = label.getConfidence(); } }
Garantizar una excelente experiencia del usuario
Para obtener la mejor experiencia del usuario, sigue estos lineamientos en tu app:
- La detección correcta de objetos depende de la complejidad visual del objeto. Para poder detectarse, es posible que los objetos con una pequeña cantidad de características visuales deban ocupar una parte más grande de la imagen. Debes proporcionar a los usuarios orientación sobre cómo capturar entradas que funcionen bien con el tipo de objetos que deseas detectar.
- Cuando usas la clasificación, si deseas detectar objetos que no se incluyen de forma clara en las categorías admitidas, implementa un manejo especial para objetos desconocidos.
Además, consulta la app de muestra de Material Design del Kit de AA y la colección de patrones para las funciones con tecnología de aprendizaje automático de Material Design.
Cómo mejorar el rendimiento
Si quieres usar la detección de objetos en una aplicación en tiempo real, sigue estos lineamientos para lograr la mejor velocidad de fotogramas:Cuando uses el modo de transmisión en una aplicación en tiempo real, no uses la detección de varios objetos, ya que la mayoría de los dispositivos no podrán producir velocidades de fotogramas adecuadas.
- Si usas la API de
Camera
ocamera2
, limita las llamadas al detector. Si hay un fotograma de video nuevo disponible mientras se ejecuta el detector, ignora ese fotograma. Consulta la claseVisionProcessorBase
de la app de ejemplo de la guía de inicio rápido para ver un ejemplo. - Si usas la API de
CameraX
, asegúrate de que la estrategia de contrapresión esté configurada en su valor predeterminadoImageAnalysis.STRATEGY_KEEP_ONLY_LATEST
. Esto garantiza que solo se entregará una imagen a la vez para su análisis. Si se producen más imágenes cuando el analizador está ocupado, se descartarán automáticamente y no se pondrán en cola para la entrega. Una vez que se cierra la imagen que se analiza mediante una llamada a ImageProxy.close(), se entrega la siguiente imagen más reciente. - Si usas la salida del detector para superponer gráficos en la imagen de entrada, primero obtén el resultado del ML Kit y, luego, procesa la imagen y la superposición en un solo paso. Esto se renderiza en la superficie de visualización
solo una vez por cada fotograma de entrada. Consulta las clases
CameraSourcePreview
yGraphicOverlay
en la app de ejemplo de la guía de inicio rápido para ver un ejemplo. - Si usas la API de Camera2, captura imágenes en formato
ImageFormat.YUV_420_888
. Si usas la API de Camera más antigua, captura imágenes en formatoImageFormat.NV21
.