Adicionar recomendações ao app com o TensorFlow Lite e o Firebase: codelab para Android

1. Visão geral

Este é o codelab Recomendações com o TensorFlow Lite e o Firebase. Neste codelab, você aprenderá a usar o TensorFlow Lite e o Firebase para implantar um modelo de recomendação no seu app. Este codelab é baseado neste exemplo do TensorFlow Lite.

As recomendações permitem que os apps usem aprendizado de máquina para exibir de maneira inteligente o conteúdo mais relevante para cada usuário. Eles consideram o comportamento anterior do usuário para sugerir conteúdo do app com o qual o usuário pode gostar de interagir no futuro usando um modelo treinado no comportamento agregado de um grande número de outros usuários.

Neste tutorial, mostramos como receber dados dos usuários do seu aplicativo com o Firebase Analytics, criar um modelo de machine learning para recomendações desses dados e usar esse modelo em um app Android para executar inferência e receber recomendações. Em particular, nossas recomendações sugerirão quais filmes um usuário provavelmente assistiria, dada a lista de filmes de que o usuário gostou anteriormente.

O que você vai aprender

  • Integrar o Firebase Analytics a um app Android para coletar dados de comportamento do usuário
  • Exportar os dados para o Google BigQuery
  • Pré-processar os dados e treinar um modelo de recomendações do TF Lite
  • Implante o modelo do TF Lite no Firebase ML e acesse-o pelo app
  • Executar na inferência do dispositivo usando o modelo para sugerir recomendações aos usuários

O que é necessário

  • Versão mais recente do Android Studio.
  • Exemplo de código.
  • Um dispositivo de teste com o Android 7 ou versão mais recente e o Google Play Services 9.8 ou mais recente ou um emulador com o Google Play Services 9.8 ou mais recente
  • Se estiver usando um dispositivo, um cabo de conexão.

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. Acessar o exemplo de código

Clone o repositório do GitHub na linha de comando.

$ git clone https://github.com/FirebaseExtended/codelab-contentrecommendation-android.git

3. Importar o app inicial

No Android Studio, selecione o diretório codelab-recommendations-android ( android_studio_folder.png) no download do exemplo de código (File > Open > .../codelab-recommendations-android/start).

O projeto inicial deve estar aberto no Android Studio.

4. Criar projeto do console do Firebase

Criar um novo projeto

  1. Acesse o Console do Firebase.
  2. Selecione Adicionar projeto ou Criar um projeto se for o primeiro.
  3. Selecione ou digite um nome de projeto e clique em Continuar.
  4. Certifique-se de que a opção "Ativar o Google Analytics para este projeto" está ativado.
  5. Siga as demais etapas de configuração no Console do Firebase e clique em Criar projeto (ou Adicionar Firebase, se estiver usando um projeto atual do Google).

5. Adicionar Firebase

  1. Na tela de visão geral do novo projeto, clique no ícone do Android para iniciar o fluxo de trabalho de configuração.
  2. Insira o nome do pacote do codelab: com.google.firebase.codelabs.recommendations
  3. Selecione Registrar app.

Adicionar o arquivo google-services.json ao app

Depois de adicionar o nome do pacote e selecionar "Registrar", clique em Fazer o download do google-services.json para receber o arquivo de configuração do Firebase para Android e copie o arquivo google-services.json para o diretório app do seu projeto. Depois de fazer o download do arquivo, você pode ignorar as próximas etapas mostradas no console (elas já foram feitas para você no projeto build-android-start).

Adicionar o plug-in google-services ao app

O plug-in google-services usa o arquivo google-services.json para configurar o aplicativo para usar o Firebase. As linhas a seguir já devem ter sido adicionadas aos arquivos build.gradle.kts do projeto (verifique para confirmar):

app/build.grade.kts (link em inglês)

plugins {
    id("com.google.gms.google-services")
}

build.grade.kts (link em inglês)

plugins {
    id("com.google.gms.google-services") version "4.3.15" apply false
}

Sincronizar seu projeto com arquivos do Gradle

Para garantir que todas as dependências estejam disponíveis para o app, sincronize o projeto com os arquivos do Gradle neste momento. Selecione Arquivo > Sync Project with Gradle Files na barra de ferramentas do Android Studio

6. Executar o app inicial

Agora que você importou o projeto para o Android Studio e configurou o plug-in google-services com o arquivo JSON, já pode executar o app pela primeira vez. Conecte o dispositivo Android e clique em Run ( executar.png) na barra de ferramentas do Android Studio.

O app será iniciado no dispositivo. Neste ponto, é possível ver um aplicativo em funcionamento que mostra uma guia com uma lista de filmes, uma guia "Filmes curtidos" e uma guia "Recomendações". Clique em um filme na lista para adicioná-lo à lista com "gostei". Depois de concluir as etapas restantes do codelab, vamos conseguir gerar recomendações de filmes na guia "Recomendações".

7. Adicionar o Firebase Analytics ao app

Nesta etapa, você adicionará o Firebase Analytics ao app para registrar dados de comportamento do usuário (nesse caso, de quais filmes ele gosta). Esses dados serão usados de forma agregada em etapas futuras para treinar o modelo de recomendações.

Adicionar uma dependência da Lista de materiais e do Analytics do Firebase

As dependências a seguir são necessárias para adicionar o Firebase Analytics ao seu app. Eles já devem estar incluídos no arquivo app/build.gradle.kts (verificar).

app/build.grade.kts (link em inglês)

implementation(platform("com.google.firebase:firebase-bom:32.0.0"))
implementation("com.google.firebase:firebase-analytics-ktx")

Configurar o Firebase Analytics no app

O LikedMoviesViewModel contém funções para armazenar os filmes de que o usuário gosta. Sempre que o usuário gosta de um novo filme, queremos enviar também um evento de registro do Analytics para registrar isso.

Adicione a função onMovieLiked com o código abaixo para registrar um evento de análise quando o usuário clica em um filme.

LikedMoviesViewModel.kt (link em inglês)

import com.google.firebase.analytics.FirebaseAnalytics
import com.google.firebase.analytics.ktx.analytics
import com.google.firebase.analytics.ktx.logEvent
import com.google.firebase.ktx.Firebase


class LikedMoviesViewModel internal constructor (application: Application) : AndroidViewModel(application) {

    ...

    fun onMovieLiked(movie: Movie) {
        movies.setLike(movie, true)
        logAnalyticsEvent(movie.id.toString())
    }
       
}

Adicione o campo e a função a seguir para registrar um evento do Analytics quando um filme for adicionado à lista "Gostei" do usuário.

LikedMoviesViewModel.kt (link em inglês)

import com.google.firebase.analytics.FirebaseAnalytics
import com.google.firebase.analytics.ktx.analytics
import com.google.firebase.analytics.ktx.logEvent
import com.google.firebase.ktx.Firebase


class LikedMoviesViewModel internal constructor (application: Application) : AndroidViewModel(application) {
    ...
    private val firebaseAnalytics = Firebase.analytics

    ...

    /**
     * Logs an event in Firebase Analytics that is used in aggregate to train the recommendations
     * model.
     */
    private fun logAnalyticsEvent(id: String) {
        firebaseAnalytics.logEvent(FirebaseAnalytics.Event.SELECT_ITEM) {
            param(FirebaseAnalytics.Param.ITEM_ID, id)
        }
    }

8. Testar sua integração com o Google Analytics

Nesta etapa, vamos gerar eventos do Analytics no app e verificar se eles estão sendo enviados para o Console do Firebase.

Ativar os registros de depuração do Analytics

O Firebase Analytics foi projetado para maximizar a duração da bateria do usuário e agrupa eventos no dispositivo e os envia ao Firebase apenas de vez em quando. Para fins de depuração, podemos desativar esse comportamento para conferir os eventos à medida que eles são registrados em tempo real. Para isso, basta executar o comando a seguir no shell.

Terminal

adb shell setprop debug.firebase.analytics.app com.google.firebase.codelabs.recommendations

Verificar se os eventos do Google Analytics foram gerados

  1. No Android Studio, abra a janela do Logcat para examinar a geração de registros do seu app.
  2. Defina o filtro do Logcat como a string "Logging event".
  3. Verifique se "select_item" Eventos de análise são emitidos sempre que você gosta de um filme no app.

Neste ponto, você integrou o Firebase Analytics ao seu aplicativo. À medida que os usuários usam seu app e gostam de filmes, as marcações "Gostei" são registradas de forma agregada. Usaremos esses dados agregados no restante deste codelab para treinar nosso modelo de recomendações. Esta é uma etapa opcional para que os mesmos eventos do Analytics que você viu no Logcat também sejam transmitidos para o Console do Firebase. Se quiser, pule para a próxima página.

Opcional: confirme eventos do Google Analytics no Console do Firebase

  1. Acesse o Console do Firebase.
  2. Selecione DebugView no Google Analytics.
  3. No Android Studio, selecione Run para iniciar o app e adicionar alguns filmes à lista "Gostei".
  4. No DebugView do Console do Firebase, verifique se esses eventos estão sendo registrados à medida que você adiciona filmes ao app.

9. Exportar dados do Google Analytics para o BigQuery

O BigQuery é um produto do Google Cloud que permite analisar e processar grandes quantidades de dados. Nesta etapa, você conectará seu projeto do console do Firebase ao BigQuery para que os dados do Google Analytics gerados pelo seu aplicativo sejam exportados automaticamente para o BigQuery.

Ativar a exportação do BigQuery

  1. Acesse o Console do Firebase.
  2. Selecione o ícone de engrenagem ao lado de Visão geral do projeto e selecione Configurações do projeto.
  3. Selecione a guia Integrações.
  4. Selecione Vincular (ou Gerenciar) dentro do bloco BigQuery.
  5. Selecione Próxima na etapa Sobre a vinculação do Firebase ao BigQuery.
  6. Na seção Configurar integração, clique na chave para ativar o envio de dados do Google Analytics e selecione Vincular ao BigQuery.

Você ativou seu projeto do Console do Firebase para enviar automaticamente dados de eventos do Firebase Analytics ao BigQuery. Isso acontece automaticamente sem outras interações. No entanto, a primeira exportação que cria o conjunto de dados de análise no BigQuery pode levar 24 horas. Depois que o conjunto de dados é criado, o Firebase exporta continuamente novos eventos do Google Analytics para o BigQuery para a tabela intradiária e agrupa os eventos dos dias anteriores na tabela de eventos.

O treinamento de um modelo de recomendações requer muitos dados. Como ainda não temos um aplicativo que gere grandes quantidades de dados, na próxima etapa importaremos um conjunto de dados de amostra no BigQuery para usar no restante deste tutorial.

10. Usar o BigQuery para receber dados de treinamento de modelo

Agora que conectamos o console do Firebase para exportar para o BigQuery, os dados de eventos de análise de aplicativos serão exibidos automaticamente no console do BigQuery depois de algum tempo. Para conseguir alguns dados iniciais para a finalidade deste tutorial, nesta etapa vamos importar um conjunto de dados de amostra para o console do BigQuery a ser usado para treinar nosso modelo de recomendações.

Importar um conjunto de dados de amostra para o BigQuery

  1. Acesse o painel do BigQuery no console do Google Cloud.
  2. Selecione o nome do projeto no menu.
  3. Selecione o nome do seu projeto na parte de baixo da navegação à esquerda do BigQuery para conferir os detalhes.
  4. Selecione Criar conjunto de dados para abrir o painel de criação do conjunto de dados.
  5. Insira "firebase_recommendations_dataset". como ID do conjunto de dados e selecione Criar conjunto de dados.
  6. O novo conjunto de dados será exibido no menu à esquerda abaixo do nome do projeto. Clique nele.
  7. Selecione Criar tabela para abrir o painel de criação da tabela.
  8. Em Criar tabela de, selecione "Google Cloud Storage".
  9. No campo Selecionar arquivo do bucket do GCS, insira "gs://firebase-recommendations/recommendations-test/formatted_data_filtered.txt".
  10. Selecione "JSONL" no menu suspenso Formato do arquivo.
  11. Insira "recommendations_table" para o Nome da tabela.
  12. Marque a caixa em Esquema > Detectar automaticamente > parâmetros de esquema e entrada
  13. Selecione Criar tabela.

analisar um conjunto de dados de amostra

Neste ponto, você tem a opção de explorar o esquema e visualizar esse conjunto de dados.

  1. Selecione firebase-recommendations-dataset no menu à esquerda para expandir as tabelas contidas nele.
  2. Selecione a tabela recommendations-table para ver o esquema da tabela.
  3. Selecione Visualizar para conferir os dados reais de eventos do Google Analytics que essa tabela contém.

Criar credenciais de conta de serviço

Agora, vamos criar credenciais de conta de serviço no projeto do console do Google Cloud que podem ser usadas no ambiente do Colab na etapa a seguir para acessar e carregar dados do BigQuery.

  1. Verifique se a cobrança está ativada para o seu projeto do Google Cloud.
  2. Ative as APIs BigQuery e BigQuery Storage. < clique aqui>
  3. Acesse a página Criar chave da conta de serviço.
  4. Na lista Conta de serviço, selecione Nova conta de serviço.
  5. No campo Nome da conta de serviço, insira um nome.
  6. Na lista Papel, selecione Projeto > Proprietário.
  7. Clique em Criar. O download de um arquivo JSON com sua chave é feito no seu computador.

Na próxima etapa, vamos usar o Google Colab para pré-processar esses dados e treinar nosso modelo de recomendações.

11. Pré-processar dados e treinar o modelo de recomendações

Nesta etapa, vamos usar um bloco do Colab para realizar as seguintes etapas:

  1. importar os dados do BigQuery para o bloco do Colab
  2. pré-processar os dados para prepará-los para o treinamento do modelo
  3. treinar o modelo de recomendações com os dados de análise
  4. exportar o modelo como um modelo do TF Lite
  5. implantar o modelo no console do Firebase para que possamos usá-lo no app

Antes de lançarmos o notebook de treinamento do Colab, vamos ativar a API Firebase Model Management para que o Colab possa implantar o modelo treinado no console do Firebase.

Ativar a API Firebase Model Management

Crie um bucket para armazenar seus modelos de ML

No Console do Firebase, acesse "Armazenamento" e clique em "Começar". fbbea78f0eb3dc9f.png

Siga a caixa de diálogo para configurar o bucket.

19517c0d6d2aa14d.png

Ativar a API Firebase ML

Acesse a página da API Firebase ML no console do Google Cloud e clique em "Ativar".

Usar o bloco do Colab para treinar e implantar o modelo

Abra o notebook do Colab usando o link a seguir e conclua as etapas. Depois de concluir as etapas no bloco do Colab, você terá um arquivo de modelo do TF Lite implantado no console do Firebase que podemos sincronizar com nosso aplicativo.

Abrir no Colab

12. Fazer o download do modelo no app

Nesta etapa, modificaremos nosso app para fazer o download do modelo que acabamos de treinar no Firebase Machine Learning.

Adicionar dependência do Firebase ML

A dependência a seguir é necessária para usar modelos de machine learning do Firebase no seu app. Ele já deve ter sido adicionado (verificar).

app/build.grade.kts (link em inglês)

implementation("com.google.firebase:firebase-ml-modeldownloader:24.1.2")

Faça o download do modelo com a API Firebase Model Manager

Copie o código abaixo em RecommendationClient.kt para configurar as condições em que o download do modelo ocorre e crie uma tarefa de download para sincronizar o modelo remoto com o app.

RecommendationClient.kt (link em inglês)

    private fun downloadModel(modelName: String) {
        val conditions = CustomModelDownloadConditions.Builder()
            .requireWifi()
            .build()
        FirebaseModelDownloader.getInstance()
            .getModel(modelName, DownloadType.LOCAL_MODEL, conditions)
            .addOnCompleteListener {
                if (!it.isSuccessful) {
                    showToast(context, "Failed to get model file.")
                } else {
                    showToast(context, "Downloaded remote model: $modelName")
                    GlobalScope.launch { initializeInterpreter(it.result) }
                }
            }
            .addOnFailureListener {
                showToast(context, "Model download failed for recommendations, please check your connection.")
            }
    }

13. Integrar o modelo de recomendação do Tensorflow Lite ao seu app

O ambiente de execução do Tensorflow Lite permite que você use seu modelo no app para gerar recomendações. Na etapa anterior, inicializamos um intérprete do TFlite com o arquivo de modelo baixado. Nesta etapa, primeiro carregaremos um dicionário e rótulos para acompanhar nosso modelo na etapa de inferência. Em seguida, adicionaremos o pré-processamento para gerar as entradas ao modelo e o pós-processamento para extrair os resultados da inferência.

Carregar dicionário e rótulos

Os rótulos usados para gerar os candidatos à recomendação pelo modelo de recomendações estão listados no arquivo sorted_movie_vocab.json na pasta res/assets. Copie o código a seguir para carregar esses candidatos.

RecommendationClient.kt (link em inglês)

    /** Load recommendation candidate list.  */
    private suspend fun loadCandidateList() {
        return withContext(Dispatchers.IO) {
            val collection = MovieRepository.getInstance(context).getContent()
            for (item in collection) {
                candidates[item.id] = item
            }
            Log.v(TAG, "Candidate list loaded.")
        }
    }

Implementar o pré-processamento

Na etapa de pré-processamento, mudamos a forma dos dados de entrada para corresponder ao que nosso modelo espera. Aqui, preenchemos o comprimento da entrada com um valor de marcador se ainda não tivermos gerado muitas curtidas do usuário. Copie o código abaixo:

RecommendationClient.kt (link em inglês)

    /** Given a list of selected items, preprocess to get tflite input.  */
    @Synchronized
    private suspend fun preprocess(selectedMovies: List<Movie>): IntArray {
        return withContext(Dispatchers.Default) {
            val inputContext = IntArray(config.inputLength)
            for (i in 0 until config.inputLength) {
                if (i < selectedMovies.size) {
                    val (id) = selectedMovies[i]
                    inputContext[i] = id
                } else {
                    // Padding input.
                    inputContext[i] = config.pad
                }
            }
            inputContext
        }
    }


Executar um intérprete para gerar recomendações

Aqui, usamos o modelo baixado em uma etapa anterior para executar a inferência na entrada pré-processada. Definimos o tipo de entrada e saída para o nosso modelo e executamos a inferência para gerar nossas recomendações de filmes. Copie o código a seguir no seu app.

RecommendationClient.kt (link em inglês)

    /** Given a list of selected items, and returns the recommendation results.  */
    @Synchronized
    suspend fun recommend(selectedMovies: List<Movie>): List<Result> {
        return withContext(Dispatchers.Default) {
            val inputs = arrayOf<Any>(preprocess(selectedMovies))

            // Run inference.
            val outputIds = IntArray(config.outputLength)
            val confidences = FloatArray(config.outputLength)
            val outputs: MutableMap<Int, Any> = HashMap()
            outputs[config.outputIdsIndex] = outputIds
            outputs[config.outputScoresIndex] = confidences
            tflite?.let {
                it.runForMultipleInputsOutputs(inputs, outputs)
                postprocess(outputIds, confidences, selectedMovies)
            } ?: run {
                Log.e(TAG, "No tflite interpreter loaded")
                emptyList()
            }
        }
    }



Implementar o pós-processamento

Por fim, nesta etapa, pós-processamos a saída do nosso modelo, selecionando os resultados com maior confiança e removendo os valores contidos (filmes que o usuário já gostou). Copie o código a seguir no seu app.

RecommendationClient.kt (link em inglês)

    /** Postprocess to gets results from tflite inference.  */
    @Synchronized
    private suspend fun postprocess(
        outputIds: IntArray, confidences: FloatArray, selectedMovies: List<Movie>
    ): List<Result> {
        return withContext(Dispatchers.Default) {
            val results = ArrayList<Result>()

            // Add recommendation results. Filter null or contained items.
            for (i in outputIds.indices) {
                if (results.size >= config.topK) {
                    Log.v(TAG, String.format("Selected top K: %d. Ignore the rest.", config.topK))
                    break
                }
                val id = outputIds[i]
                val item = candidates[id]
                if (item == null) {
                    Log.v(TAG, String.format("Inference output[%d]. Id: %s is null", i, id))
                    continue
                }
                if (selectedMovies.contains(item)) {
                    Log.v(TAG, String.format("Inference output[%d]. Id: %s is contained", i, id))
                    continue
                }
                val result = Result(
                    id, item,
                    confidences[i]
                )
                results.add(result)
                Log.v(TAG, String.format("Inference output[%d]. Result: %s", i, result))
            }
            results
        }
    }


Teste seu app.

Execute o app novamente. Conforme você seleciona alguns filmes, o download do novo modelo é automático e as recomendações começam a ser geradas.

14. Parabéns!

Você criou um recurso de recomendações no app usando o TensorFlow Lite e o Firebase. As técnicas e o pipeline mostrados neste codelab podem ser generalizados e usados para atender a outros tipos de recomendações.

O que vimos

  • Firebase ML
  • Firebase Analytics
  • Exportar eventos de análise para o BigQuery
  • Pré-processar eventos de análise
  • Treinar o modelo do TensorFlow de recomendações
  • Exportar modelo e implantar no Console do Firebase
  • Exibir recomendações de filmes em um app

Próximas etapas

  • Implemente as recomendações do Firebase ML no seu app.

Saiba mais

Perguntas?

Informar problemas