Guía de clasificación de texto para iOS

La tarea Clasificador de texto te permite clasificar texto en un conjunto de categorías definidas, como opiniones positivas o negativas. Las categorías se determinan según el modelo que uses y cómo se entrenó. En estas instrucciones, se muestra cómo usar el clasificador de texto en apps para iOS. La muestra de código que se describe en estas instrucciones está disponible en GitHub.

Puedes ver esta tarea en acción en esta demostración web. Para obtener más información sobre las funciones, 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 MediaPipe Tasks es una implementación básica de una app de clasificación de texto para iOS.

Puedes usar la app como punto de partida de tu propia app para iOS o consultarla cuando modifiques una app existente. Puedes consultar 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 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/ios/
    

Después de crear una versión local del código de ejemplo, puedes instalar la biblioteca de tareas de MediaPipe, abrir el proyecto con Xcode y ejecutar la app. Para obtener instrucciones, consulta la Guía de configuración para iOS.

Componentes clave

Los siguientes archivos contienen el código fundamental para la aplicación de ejemplo de clasificador 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 a fin de usar Text Classifier. Si quieres obtener información general sobre cómo configurar tu entorno de desarrollo para usar tareas de MediaPipe, incluidos los requisitos de la versión de la plataforma, consulta la Guía de configuración para iOS.

Dependencias

El clasificador de texto usa la biblioteca MediaPipeTasksText, que se debe instalar con CocoaPods. La biblioteca es compatible con las apps de Swift y Objective-C, y no requiere ninguna configuración adicional específica de un lenguaje.

Si quieres obtener instrucciones para instalar CocoaPods en macOS, consulta la guía de instalación de CocoaPods. Si quieres obtener instrucciones para crear un Podfile con los Pods necesarios para tu app, consulta Usa CocoaPods.

Agrega el Pod MediaPipeTasksText en el Podfile con el siguiente código:

target 'MyTextClassifierApp' do
  use_frameworks!
  pod 'MediaPipeTasksText'
end

Si la app incluye objetivos de prueba de unidades, consulta la Guía de configuración para iOS y obtén información adicional sobre la configuración de tu Podfile.

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 agrégalo al directorio de tu proyecto con Xcode. Para obtener instrucciones sobre cómo agregar archivos al proyecto de Xcode, consulta Cómo administrar archivos y carpetas en tu proyecto de Xcode.

Usa la propiedad BaseOptions.modelAssetPath para especificar la ruta de acceso al modelo en tu paquete de aplicación. Para ver un ejemplo de código, consulta la siguiente sección.

Crea la tarea

Puedes crear la tarea del clasificador de texto llamando a uno de sus inicializadores. El inicializador TextClassifier(options:) establece valores para las opciones de configuración.

Si no necesitas un clasificador de texto que se inicialice con opciones de configuración personalizadas, puedes usar el inicializador TextClassifier(modelPath:) para crear un clasificador con las opciones predeterminadas. Para obtener más información sobre las opciones de configuración, consulta Descripción general de la configuración.

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

Swift

import MediaPipeTasksText

let modelPath = Bundle.main.path(forResource: "model",
                                      ofType: "tflite")

let options = TextClassifierOptions()
options.baseOptions.modelAssetPath = modelPath
options.scoreThreshold = 0.6

let textClassifier = try TextClassifier(options: options)

Objective‑C

@import MediaPipeTasksText;

NSString *modelPath = [[NSBundle mainBundle] pathForResource:@"model"
                                                      ofType:@"tflite"];

MPPTextClassifierOptions *options = [[MPPTextClassifierOptions alloc] init];
options.baseOptions.modelAssetPath = modelPath;
options.scoreThreshold = 0.6;

MPPTextClassifier *textClassifier =
      [[MPPTextClassifier alloc] initWithOptions:options error:nil];

Opciones de configuración

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

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

Text Classifier funciona con datos de texto. 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(text:). No es necesario realizar un procesamiento previo adicional del texto de entrada con anticipación.

Swift

let text = "The input text to be classified."

Objective‑C

NSString *text = @"The input text to be classified.";

Ejecuta la tarea

Para ejecutar el clasificador de texto, usa el método classify(text:). El clasificador de texto muestra las categorías posibles para el texto de entrada.

Swift

let result = try textClassifier.classify(text: text)

Objective‑C

MPPTextClassifierResult *result = [textClassifier classifyText:text
                                                          error:nil];

Nota: La tarea bloquea el subproceso actual hasta que termina de ejecutar la inferencia en el texto. Para evitar bloquear el subproceso actual, ejecuta el procesamiento en un subproceso en segundo plano con los frameworks Dispatch o NSOperation de iOS.

Cómo controlar y mostrar los resultados

Cuando se ejecuta la inferencia, la tarea Clasificador de texto muestra un objeto TextClassifierResult que contiene la lista de categorías posibles para el texto de entrada. Las categorías se definen según el modelo que uses, 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".

El archivo ViewController.swift en el código de ejemplo demuestra cómo mostrar los resultados de detección que muestra la tarea.