Gerar interfaces de modelo usando metadados

Com os metadados do LiteRT, os desenvolvedores podem gerar código de wrapper para ativar a integração no Android. Para a maioria dos desenvolvedores, a interface gráfica do Android Studio ML Model Binding é a mais fácil de usar. Se você precisar de mais personalização ou estiver usando ferramentas de linha de comando, o LiteRT Codegen também estará disponível.

Usar a vinculação de modelo de ML do Android Studio

Para modelos LiteRT aprimorados com metadados, os desenvolvedores podem usar a vinculação de modelo de ML do Android Studio para configurar automaticamente as definições do projeto e gerar classes wrapper com base nos metadados do modelo. O código wrapper elimina a necessidade de interagir diretamente com ByteBuffer. Em vez disso, os desenvolvedores podem interagir com o modelo LiteRT usando objetos tipados, como Bitmap e Rect.

Importar um modelo LiteRT no Android Studio

  1. Clique com o botão direito do mouse no módulo em que você quer usar o modelo do TFLite ou clique em File, depois em New > Other > LiteRT Model

  2. Selecione o local do arquivo TFLite. A ferramenta vai configurar a dependência do módulo em seu nome com a vinculação de modelo de ML e todas as dependências inseridas automaticamente no arquivo build.gradle do módulo Android.

    Opcional: marque a segunda caixa de seleção para importar a GPU do TensorFlow se quiser usar a aceleração de GPU.

  3. Clique em Finish.

  4. A tela a seguir vai aparecer depois que a importação for concluída. Para começar a usar o modelo, selecione Kotlin ou Java, copie e cole o código na seção Sample Code. Para voltar a essa tela, clique duas vezes no modelo do TFLite no diretório ml do Android Studio.

Como acelerar a inferência de modelos

O ML Model Binding oferece aos desenvolvedores uma maneira de acelerar o código usando delegados e o número de linhas de execução.

Etapa 1. Verifique se o arquivo build.gradle do módulo contém a seguinte dependência:

    dependencies {
        ...
        // For the LiteRT GPU delegate, we need
        // 'com.google.ai.edge.litert:litert-gpu' version 1.*.
        implementation 'com.google.ai.edge.litert:litert-gpu:1.4.1'
    }

Etapa 2. Detecte se a GPU em execução no dispositivo é compatível com o delegado de GPU do TensorFlow. Se não for, execute o modelo usando várias linhas de execução da CPU:

Kotlin

    import org.tensorflow.lite.gpu.CompatibilityList
    import org.tensorflow.lite.gpu.GpuDelegate

    val compatList = CompatibilityList()

    val options = if(compatList.isDelegateSupportedOnThisDevice) {
        // if the device has a supported GPU, add the GPU delegate
        Model.Options.Builder().setDevice(Model.Device.GPU).build()
    } else {
        // if the GPU is not supported, run on 4 threads
        Model.Options.Builder().setNumThreads(4).build()
    }

    // Initialize the model as usual feeding in the options object
    val myModel = MyModel.newInstance(context, options)

    // Run inference per sample code

Java

    import org.tensorflow.lite.support.model.Model
    import org.tensorflow.lite.gpu.CompatibilityList;
    import org.tensorflow.lite.gpu.GpuDelegate;

    // Initialize interpreter with GPU delegate
    Model.Options options;
    CompatibilityList compatList = CompatibilityList();

    if(compatList.isDelegateSupportedOnThisDevice()){
        // if the device has a supported GPU, add the GPU delegate
        options = Model.Options.Builder().setDevice(Model.Device.GPU).build();
    } else {
        // if the GPU is not supported, run on 4 threads
        options = Model.Options.Builder().setNumThreads(4).build();
    }

    MyModel myModel = new MyModel.newInstance(context, options);

    // Run inference per sample code

Gerar interfaces de modelo com o gerador de código LiteRT

Para modelos do LiteRT aprimorados com metadados, os desenvolvedores podem usar o gerador de código wrapper do Android LiteRT para criar um código wrapper específico da plataforma. O código wrapper elimina a necessidade de interagir diretamente com ByteBuffer. Em vez disso, os desenvolvedores podem interagir com o modelo do TensorFlow Lite usando objetos tipados, como Bitmap e Rect.

A utilidade do gerador de código depende da integridade da entrada de metadados do modelo LiteRT. Consulte a seção <Codegen usage> em campos relevantes em metadata_schema.fbs para saber como a ferramenta de geração de código analisa cada campo.

Gerar código de wrapper

Instale as seguintes ferramentas no terminal:

pip install tflite-support

Depois de concluído, o gerador de código pode ser usado com a seguinte sintaxe:

tflite_codegen --model=./model_with_metadata/mobilenet_v1_0.75_160_quantized.tflite \
    --package_name=org.tensorflow.lite.classify \
    --model_class_name=MyClassifierModel \
    --destination=./classify_wrapper

O código resultante vai estar no diretório de destino. Se você estiver usando o Google Colab ou outro ambiente remoto, talvez seja mais fácil compactar o resultado em um arquivo ZIP e fazer o download para seu projeto do Android Studio:

# Zip up the generated code
!zip -r classify_wrapper.zip classify_wrapper/

# Download the archive
from google.colab import files
files.download('classify_wrapper.zip')

Como usar o código gerado

Etapa 1: importar o código gerado

Descompacte o código gerado, se necessário, em uma estrutura de diretório. A raiz do código gerado é considerada SRC_ROOT.

Abra o projeto do Android Studio em que você quer usar o modelo LiteRT e importe o módulo gerado da seguinte forma: File -> New -> Import Module -> selecione SRC_ROOT

Usando o exemplo acima, o diretório e o módulo importado seriam chamados de classify_wrapper.

Etapa 2: atualizar o arquivo build.gradle do app

No módulo do app que vai consumir o módulo de biblioteca gerado:

Na seção "android", adicione o seguinte:

aaptOptions {
   noCompress "tflite"
}

Na seção de dependências, adicione o seguinte:

implementation project(":classify_wrapper")

Etapa 3: usar o modelo

// 1. Initialize the model
MyClassifierModel myImageClassifier = null;

try {
    myImageClassifier = new MyClassifierModel(this);
} catch (IOException io){
    // Error reading the model
}

if(null != myImageClassifier) {

    // 2. Set the input with a Bitmap called inputBitmap
    MyClassifierModel.Inputs inputs = myImageClassifier.createInputs();
    inputs.loadImage(inputBitmap));

    // 3. Run the model
    MyClassifierModel.Outputs outputs = myImageClassifier.run(inputs);

    // 4. Retrieve the result
    Map<String, Float> labeledProbability = outputs.getProbability();
}

Como acelerar a inferência de modelos

O código gerado oferece aos desenvolvedores uma maneira de acelerar o código usando delegados e o número de threads. Eles podem ser definidos ao inicializar o objeto do modelo, já que ele usa três parâmetros:

  • Context: contexto da atividade ou do serviço do Android
  • (Opcional) Device: delegado de aceleração do TFLite. Por exemplo: GPUDelegate
  • (Opcional) numThreads: número de linhas de execução usadas para executar o modelo. O padrão é um.

Por exemplo, para usar um delegado de GPU e até três linhas de execução, inicialize o modelo assim:

try {
    myImageClassifier = new MyClassifierModel(this, Model.Device.GPU, 3);
} catch (IOException io){
    // Error reading the model
}

Solução de problemas

Se você receber um erro "java.io.FileNotFoundException: This file can not be opened as a file descriptor; it is probably compressed", insira as seguintes linhas na seção "android" do módulo do app que vai usar o módulo da biblioteca:

aaptOptions {
   noCompress "tflite"
}