Adicionar a classificação de texto no dispositivo ao seu app com o TensorFlow Lite e o Firebase: codelab para iOS

1. Visão geral

Observação:este codelab usa a biblioteca do TensorFlow Lite. É recomendável que todo o novo código use a ferramenta Google AI Edge Lite RT library.

Este é o codelab "Classificação de texto com o TensorFlow Lite e o Firebase". Neste codelab, você vai aprender a usar o TensorFlow Lite e o Firebase para treinar e implantar um modelo de classificação de texto no seu app. Este codelab é baseado neste exemplo do TensorFlow Lite.

A classificação de texto é o processo de atribuir tags ou categorias a um texto de acordo com o conteúdo. É uma das tarefas fundamentais no processamento de linguagem natural (PLN), com amplas aplicações, como análise de sentimento, rotulação de tópicos, detecção de spam e detecção de intenção.

A análise de sentimento é a interpretação e classificação de emoções (positivas, negativas e neutras) em dados de texto usando técnicas de análise de texto. A análise de sentimento permite que as empresas identifiquem o sentimento dos clientes em relação a produtos, marcas ou serviços em conversas on-line e feedback.

Este tutorial mostra como criar um modelo de aprendizado de máquina para análise de sentimento, classificando o texto como positivo ou negativo. Esse é um exemplo de classificação binária (ou de duas classes), um tipo importante e amplamente aplicável de problema de machine learning.

O que você vai aprender

• Treinar um modelo de análise de sentimento do TF Lite com o TF Lite Model Maker
• Implantar modelos do TF Lite no Firebase ML e acessá-los no app
• Acompanhar o feedback dos usuários para medir a precisão do modelo com o Firebase Analytics
• Gerar um perfil do desempenho do modelo por meio do Monitoramento de desempenho do Firebase
• Selecione qual dos vários modelos implantados é carregado pela Configuração remota
• Teste modelos diferentes com o Teste A/B do Firebase

Pré-requisitos

• Xcode 11 (ou mais recente)
• CocoaPods 1.9.1 (ou mais recente)

Como você usará este tutorial?

Apenas leitura Leitura e exercícios

Como você classificaria sua experiência com a criação de apps Android?

Iniciante Intermediário Proficiente

2. Criar projeto do console do Firebase

Adicionar o Firebase ao projeto

5. Acesse o Console do Firebase.
6. Selecione Criar novo projeto e nomeie o projeto como "Firebase ML iOS Codelab".

3. Fazer o download do projeto de exemplo

Faça o download do código

Comece clonando o projeto de exemplo e executando pod update no diretório do projeto:

git clone https://github.com/FirebaseExtended/codelab-textclassification-ios.git
cd codelab-textclassification-ios
pod install --repo-update

Se o git não estiver instalado, você também pode fazer o download do projeto de exemplo na página do GitHub ou clicando neste link. Depois de fazer o download do projeto, execute-o no Xcode e teste a classificação de texto para ter uma ideia de como ele funciona.

Configurar o Firebase

Siga a documentação para criar um novo projeto do Firebase. Depois de criar o projeto, faça o download do arquivo GoogleService-Info.plist dele no Console do Firebase e arraste-o para a raiz do projeto do Xcode.

Adicione o Firebase ao seu Podfile e execute a instalação do pod.

pod 'FirebaseMLModelDownloader', '9.3.0-beta'

No método didFinishLaunchingWithOptions do AppDelegate, importe o Firebase na parte de cima do arquivo

import FirebaseCore

E adicione uma chamada para configurar o Firebase.

FirebaseApp.configure()

Execute o projeto novamente para garantir que o app esteja configurado corretamente e não apresente falhas na inicialização.

4. Treinar um modelo de análise de sentimento

Vamos usar o TensorFlow Lite Model Maker para treinar um modelo de classificação de texto e prever o sentimento de um determinado texto.

Esta etapa é apresentada como um notebook Python que pode ser aberto no Google Colab.

Abrir no Colab

Depois de concluir esta etapa, você terá um modelo de análise de sentimento do TensorFlow Lite pronto para implantação em um app para dispositivos móveis.

5. Implantar um modelo no Firebase ML

Implantar um modelo no Firebase ML é útil por dois motivos principais:

1. Podemos manter o tamanho de instalação do app pequeno e fazer o download do modelo apenas se necessário
2. O modelo pode ser atualizado regularmente e com um ciclo de lançamento diferente do app inteiro.

O modelo pode ser implantado pelo console ou de maneira programática usando o SDK Admin do Firebase. Nesta etapa, vamos implantar pelo console.

Primeiro, abra o Console do Firebase e clique em "Machine Learning" no painel de navegação à esquerda. Clique em "Começar". se estiver abrindo pela primeira vez. Em seguida, navegue até "Personalizado" e clique no botão "Adicionar modelo".

Quando solicitado, nomeie o modelo como sentiment_analysis e faça o upload do arquivo que você transferiu por download do Colab na etapa anterior.

Observação:se você tiver um pipeline para treinar novamente seu modelo de maneira contínua, automatize o processo de upload para o Firebase usando a API Firebase ML Model Management.

6. Baixar o modelo do Firebase ML

Escolher quando fazer o download do modelo remoto do Firebase no seu app pode ser complicado, já que os modelos do TFLite podem ficar relativamente grandes. O ideal é evitar o carregamento do modelo imediatamente após a inicialização do app, já que se o modelo for usado para apenas um recurso e o usuário nunca usar esse recurso, uma quantidade significativa de dados será baixada sem motivo. Também é possível definir opções de download, como buscar apenas modelos quando conectado ao Wi-Fi. Para garantir que o modelo esteja disponível mesmo sem uma conexão de rede, é importante agrupá-lo sem o app como backup.

Para simplificar, vamos remover o modelo agrupado padrão e sempre fazer o download de um modelo do Firebase quando o app for iniciado pela primeira vez. Dessa forma, ao executar a análise de sentimento, você pode ter certeza de que a inferência está sendo executada com o modelo fornecido pelo Firebase.

Na parte de cima de ModelLoader.swift, importe o módulo do Firebase.

import FirebaseCore
import FirebaseMLModelDownloader

Em seguida, implemente os métodos a seguir.

static func downloadModel(named name: String,
                          completion: @escaping (CustomModel?, DownloadError?) -> Void) {
  guard FirebaseApp.app() != nil else {
    completion(nil, .firebaseNotInitialized)
    return
  }
  guard success == nil && failure == nil else {
    completion(nil, .downloadInProgress)
    return
  }
  let conditions = ModelDownloadConditions(allowsCellularAccess: false)
  ModelDownloader.modelDownloader().getModel(name: name, downloadType: .localModelUpdateInBackground, conditions: conditions) { result in
          switch (result) {
          case .success(let customModel):
                  // Download complete.
                  // The CustomModel object contains the local path of the model file,
                  // which you can use to instantiate a TensorFlow Lite classifier.
                  return completion(customModel, nil)
          case .failure(let error):
              // Download was unsuccessful. Notify error message.
            completion(nil, .downloadFailed(underlyingError: error))
          }
  }
}

No viewDidLoad do ViewController.swift, substitua a chamada para loadModel() pelo novo método de download de modelo.

// Download the model from Firebase
print("Fetching model...")
ModelLoader.downloadModel(named: "sentiment_analysis") { (customModel, error) in
  guard let customModel = customModel else {
    if let error = error {
      print(error)
    }
    return
  }

  print("Model download complete")

  // TODO: Initialize an NLClassifier from the downloaded model
}

Execute o app novamente. Após alguns segundos, você verá um registro no Xcode indicando que o download do modelo remoto foi concluído. Tente digitar algum texto e confirme se o comportamento do app não mudou.

Observação: o nome do modelo aqui precisa ser o mesmo especificado ao fazer o upload do modelo para o Firebase na etapa anterior.

7. Integrar o modelo ao app

A Tensorflow Lite Task Library ajuda a integrar modelos do TensorFlow Lite ao app com apenas algumas linhas de código. Vamos inicializar uma instância do TFLNLClassifier usando o modelo do TensorFlow Lite transferido por download do Firebase. Em seguida, vamos usá-lo para classificar a entrada de texto dos usuários do app e mostrar o resultado na interface.

Adicionar a dependência

Acesse o Podfile do app e adicione a TensorFlow Lite Task Library (Text) nas dependências do app. Adicione a dependência na declaração target 'TextClassification'.

pod 'TensorFlowLiteTaskText', '~> 0.2.0'

Execute pod install para instalar a nova dependência.

Inicializar um classificador de texto

Em seguida, carregaremos o modelo de análise de sentimento transferido do Firebase usando o NLClassifier da Biblioteca de tarefas.

ViewController.swift (em inglês)

Vamos declarar uma variável de instância TFLNLClassifier. Na parte de cima do arquivo, importe a nova dependência:

import TensorFlowLiteTaskText

Encontre este comentário acima do método que modificamos na última etapa:

// TODO: Add a TFLNLClassifier property.

Substitua o TODO pelo seguinte código:

private var classifier: TFLNLClassifier?

Inicialize a variável textClassifier com o modelo de análise de sentimento transferido por download do Firebase. Encontre este comentário que adicionamos na última etapa:

// TODO: Initialize an NLClassifier from the downloaded model

Substitua TODO por este código:

let options = TFLNLClassifierOptions()
self.classifier = TFLNLClassifier.nlClassifier(modelPath: customModel.path, options: options)

Classificar texto

Depois que a instância classifier for configurada, será possível executar a análise de sentimento com uma única chamada de método.

ViewController.swift (em inglês)

No método classify(text:), encontre o comentário TODO:

// TODO: Run sentiment analysis on the input text

Substitua o comentário por este código:

guard let classifier = self.classifier else { return }

// Classify the text
let classifierResults = classifier.classify(text: text)

// Append the results to the list of results
let result = ClassificationResult(text: text, results: classifierResults)
results.append(result)

8. Executar o app final

Você integrou o modelo de análise de sentimento ao app. Vamos testá-lo. Conecte seu dispositivo iOS e clique em Executar ( ) na barra de ferramentas do Xcode.

O aplicativo deve ser capaz de prever corretamente o sentimento da crítica de filme que você inserir.

9. Melhorar o app com mais recursos do Firebase

Além de hospedar seus modelos TFLite, o Firebase oferece vários outros recursos para potencializar seus casos de uso de machine learning:

• O Monitoramento de desempenho do Firebase para medir a velocidade de inferência do seu modelo em execução nos dispositivo.
• Firebase Analytics para medir a performance do seu modelo na produção, avaliando a reação do usuário.
• Teste A/B do Firebase para testar várias versões do seu modelo
• Você se lembra de que treinamos duas versões do nosso modelo TFLite? Os testes A/B são uma boa maneira de descobrir qual versão tem melhor desempenho na produção.

Para saber mais sobre como aproveitar esses recursos no seu app, confira os codelabs abaixo:

• Adicionar o Firebase ao seu app Android com TFLite
• Adicionar o Firebase ao seu app iOS com tecnologia TFLite

10. Parabéns!

Neste codelab, você aprendeu a treinar um modelo do TFLite de análise de sentimento e implantá-lo no seu app para dispositivos móveis usando o Firebase. Para saber mais sobre o TFLite e o Firebase, confira outros exemplos do TFLite e os guias de primeiros passos do Firebase.

O que vimos

• TensorFlow Lite
• Firebase ML

Próximas etapas

• Meça a velocidade de inferência do modelo com o Monitoramento de desempenho do Firebase.
• Implante o modelo do Colab diretamente no Firebase usando a API Firebase ML Model Management.
• Adicione um mecanismo para permitir que os usuários enviem feedback sobre o resultado da previsão e use o Firebase Analytics para acompanhar o feedback dos usuários.
• Faça testes A/B com o modelo Average Word Vector e o modelo MobileBERT usando o Teste A/B do Firebase.

Saiba mais

• Documentação do Machine Learning do Firebase
• Documentação do TensorFlow Lite
• Medir a performance do app com o Firebase
• Modelos de Teste A/B com o Firebase

Perguntas?

• Stack Overflow "firebase-machine-learning"

Informar problemas

• Problemas do GitHub