Guía de clasificación de texto para Android

La tarea Clasificador de texto de MediaPipe te permite clasificar texto en un conjunto de categorías definidas, como opiniones positivas o negativas. Las categorías se determinan, el modelo que usas y cómo se entrenó. En estas instrucciones, se muestra cómo usar el clasificador de texto con las apps para Android.

Puedes ver la tarea en acción en la demostración. Para obtener más información sobre las capacidades, los modelos y las opciones de configuración de esta tarea, consulta la Descripción general.

Ejemplo de código

El código de ejemplo de Text Classifier proporciona una implementación simple de esta tarea para tu referencia. Este código te ayudará a probar esta tarea y comenzar a compilar tu propia app de clasificación de texto. Puedes explorar el código de ejemplo del clasificador de texto en GitHub.

Descarga el código

En las siguientes instrucciones, se muestra cómo crear una copia local del código de ejemplo con la herramienta de línea de comandos de control de versión de git.

Para descargar el código de ejemplo, haz lo siguiente:

  1. Usa el siguiente comando para clonar el repositorio de Git:
    git clone https://github.com/google-ai-edge/mediapipe-samples
    
  2. De manera opcional, configura tu instancia de Git para que use un proceso de confirmación de compra disperso, de modo que solo tengas los archivos para la app de ejemplo de Text Classifier:
    cd mediapipe
    git sparse-checkout init --cone
    git sparse-checkout set examples/text_classification/android
    
    .

Para obtener instrucciones para configurar y ejecutar un ejemplo con Android Studio, consulta las instrucciones de configuración de código de ejemplo en la Guía de configuración para Android.

Componentes clave

Los siguientes archivos contienen el código fundamental para la app de ejemplo de clasificación de texto:

Configuración

En esta sección, se describen los pasos clave para configurar tu entorno de desarrollo y los proyectos de código específicamente para usar el clasificador de texto. Si quieres obtener información general sobre cómo configurar tu entorno de desarrollo para usar MediaPipe Tasks, incluidos los requisitos de la versión de la plataforma, consulta la Guía de configuración para Android.

Dependencias

El clasificador de texto usa las bibliotecas com.google.mediapipe:tasks-text. Agrega esta dependencia al archivo build.gradle de tu proyecto de desarrollo de apps para Android. Puedes importar las dependencias requeridas con el siguiente código:

dependencies {
    implementation 'com.google.mediapipe:tasks-text:latest.release'
}

Modelo

La tarea del clasificador de texto de MediaPipe requiere un modelo entrenado que sea compatible con esta tarea. Si deseas obtener más información sobre los modelos entrenados disponibles para el clasificador de texto, consulta la descripción general de la tarea en la sección Modelos.

Selecciona y descarga un modelo, y almacénalo dentro del directorio assets del proyecto:

<dev-project-root>/src/main/assets

Usa el método BaseOptions.Builder.setModelAssetPath() para especificar la ruta del modelo que se usará. Para ver un ejemplo de código, consulta la siguiente sección.

Crea la tarea

Usa una de las funciones TextClassifier.createFrom...() del clasificador de texto a fin de preparar la tarea para ejecutar inferencias. Puedes usar la función createFromFile() con una ruta relativa o absoluta al archivo del modelo entrenado. En el siguiente ejemplo de código, se demuestra el uso de la función TextClassifier.createFromOptions(). Para obtener más información sobre las opciones de configuración disponibles, consulta Opciones de configuración.

En el siguiente código, se muestra la compilación y configuración de esta tarea.

// no directory path required if model file is in src/main/assets:
String currentModel = "text_classifier_model.tflite";

fun initClassifier() {
    val baseOptionsBuilder = BaseOptions.builder()
        .setModelAssetPath(currentModel)
    try {
        val baseOptions = baseOptionsBuilder.build()
        val optionsBuilder = TextClassifier.TextClassifierOptions.builder()
            .setBaseOptions(baseOptions)
        val options = optionsBuilder.build()
        textClassifier = TextClassifier.createFromOptions(context, options)
    } catch (e: IllegalStateException) { // exception handling
    }
}

Puedes ver un ejemplo de cómo crear una tarea en la función initClassifier() de ejemplo de código TextClassifierHelper.

Opciones de configuración

Esta tarea incluye las siguientes opciones de configuración para apps para Android:

Nombre de la opción Descripción Rango de valores Valor predeterminado
displayNamesLocale Configura el idioma de las etiquetas que se usarán para los nombres visibles proporcionados en los metadatos del modelo de la tarea, si están disponibles. El valor predeterminado es en para inglés. Puedes agregar etiquetas localizadas a los metadatos de un modelo personalizado con la API de Metadata Writer de TensorFlow Lite Código de configuración regional en
maxResults Configura la cantidad máxima opcional de resultados de clasificación con puntuación más alta que se mostrarán. Si es inferior a 0, se devolverán todos los resultados disponibles. Cualquier número positivo -1
scoreThreshold Establece el umbral de puntuación de predicción que anula el proporcionado en los metadatos del modelo (si corresponde). Se rechazarán los resultados inferiores a este valor. Cualquier número de punto flotante No establecida
categoryAllowlist Establece la lista opcional de nombres de categorías permitidas. Si no está vacío, se filtrarán los resultados de clasificación cuyo nombre de categoría no esté en este conjunto. Los nombres de categorías duplicados o desconocidos se ignoran. Esta opción es mutuamente excluyente con categoryDenylist, y el uso de ambos da como resultado un error. Cualquier cadena No establecida
categoryDenylist Establece la lista opcional de nombres de categorías que no están permitidas. Si no está vacío, se filtrarán los resultados de clasificación cuyo nombre de categoría se encuentre en este conjunto. Los nombres de categorías duplicados o desconocidos se ignoran. Esta opción es mutuamente exclusiva con categoryAllowlist, y el uso de ambas da como resultado un error. Cualquier cadena No establecida

Preparar los datos

El clasificador de texto funciona con datos de texto (String). Esta tarea controla el procesamiento previo de la entrada de datos, incluida la asignación de token y el procesamiento previo del tensor.

Todo el procesamiento previo se controla dentro de la función classify(). No es necesario realizar un procesamiento previo adicional del texto de entrada con anticipación.

String inputText = "The input text to be classified.";

Ejecuta la tarea

El clasificador de texto usa la función TextClassifier.classify() para ejecutar inferencias. Usa un subproceso de ejecución separado para ejecutar la clasificación y, así, evitar bloquear el subproceso de interfaz de usuario de Android con tu app.

En el siguiente código, se muestra cómo ejecutar el procesamiento con el modelo de tarea por medio de un subproceso de ejecución separado.

    fun classify(text: String) {
        executor = ScheduledThreadPoolExecutor(1)

        executor.execute {
            val results = textClassifier.classify(text)
            listener.onResult(results)
        }
    }

Puedes ver un ejemplo de cómo ejecutar una tarea en el ejemplo de código con la función classify() de la clase TextClassifierHelper.

Cómo controlar y mostrar los resultados

El clasificador de texto genera una TextClassifierResult que contiene la lista de categorías posibles para el texto de entrada. Las categorías se definen según el modelo que utilices, por lo que, si quieres diferentes categorías, elige un modelo diferente o vuelve a entrenar uno existente.

A continuación, se muestra un ejemplo de los datos de salida de esta tarea:

TextClassificationResult:
  Classification #0 (single classification head):
    ClassificationEntry #0:
      Category #0:
        category name: "positive"
        score: 0.8904
        index: 0
      Category #1:
        category name: "negative"
        score: 0.1096
        index: 1

Este resultado se obtiene ejecutando el BERT-classifier en el texto de entrada: "an imperfect but overall entertaining mystery".

Puedes ver un ejemplo de cómo mostrar los resultados en la clase de ejemplo de código ResultsAdapter y la clase interna ViewHolder.