Inferencia de TensorFlow Lite

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

El término inferencia se refiere al proceso de ejecutar un modelo de TensorFlow Lite en un dispositivo para hacer predicciones basadas en datos de entrada. Para realizar una inferencia con un modelo TensorFlow Lite, debe ejecutarlo a través de un intérprete . El intérprete de TensorFlow Lite está diseñado para ser ágil y rápido. El intérprete utiliza un orden de gráficos estático y un asignador de memoria personalizado (menos dinámico) para garantizar una carga, inicialización y latencia de ejecución mínimas.

Esta página describe cómo acceder al intérprete de TensorFlow Lite y realizar una inferencia usando C++, Java y Python, además de enlaces a otros recursos para cada plataforma admitida .

Conceptos importantes

La inferencia de TensorFlow Lite normalmente sigue los siguientes pasos:

  1. Cargando un modelo

    Debe cargar el modelo .tflite en la memoria, que contiene el gráfico de ejecución del modelo.

  2. Transformando datos

    Los datos de entrada sin procesar para el modelo generalmente no coinciden con el formato de datos de entrada esperado por el modelo. Por ejemplo, es posible que deba cambiar el tamaño de una imagen o cambiar el formato de la imagen para que sea compatible con el modelo.

  3. Inferencia en ejecución

    Este paso implica usar la API de TensorFlow Lite para ejecutar el modelo. Implica algunos pasos, como construir el intérprete y asignar tensores, como se describe en las siguientes secciones.

  4. Interpretación de salida

    Cuando recibe resultados de la inferencia del modelo, debe interpretar los tensores de una manera significativa que sea útil en su aplicación.

    Por ejemplo, un modelo podría devolver solo una lista de probabilidades. Depende de usted asignar las probabilidades a categorías relevantes y presentárselas a su usuario final.

Plataformas compatibles

Las API de inferencia de TensorFlow se proporcionan para las plataformas integradas/móviles más comunes, como Android , iOS y Linux , en varios lenguajes de programación.

En la mayoría de los casos, el diseño de la API refleja una preferencia por el rendimiento sobre la facilidad de uso. TensorFlow Lite está diseñado para una inferencia rápida en dispositivos pequeños, por lo que no debería sorprender que las API intenten evitar copias innecesarias a expensas de la comodidad. Del mismo modo, la coherencia con las API de TensorFlow no era un objetivo explícito y se esperaba cierta variación entre los idiomas.

En todas las bibliotecas, la API de TensorFlow Lite te permite cargar modelos, alimentar entradas y recuperar salidas de inferencia.

Plataforma Android

En Android, la inferencia de TensorFlow Lite se puede realizar mediante las API de Java o C++. Las API de Java brindan comodidad y se pueden usar directamente dentro de sus clases de actividad de Android. Las API de C++ ofrecen más flexibilidad y velocidad, pero pueden requerir la escritura de contenedores JNI para mover datos entre las capas de Java y C++.

Consulte a continuación para obtener detalles sobre el uso de C++ y Java , o siga el inicio rápido de Android para obtener un tutorial y un código de ejemplo.

Generador de código contenedor de Android TensorFlow Lite

Para el modelo TensorFlow Lite mejorado con metadatos , los desarrolladores pueden usar el generador de código contenedor de TensorFlow Lite Android para crear un código contenedor específico de la plataforma. El código contenedor elimina la necesidad de interactuar directamente con ByteBuffer en Android. En su lugar, los desarrolladores pueden interactuar con el modelo TensorFlow Lite con objetos escritos como Bitmap y Rect . Para obtener más información, consulte el generador de código de envoltura de Android de TensorFlow Lite .

Plataforma iOS

En iOS, TensorFlow Lite está disponible con bibliotecas nativas de iOS escritas en Swift y Objective-C . También puede usar la API de C directamente en los códigos de Objective-C.

Consulte a continuación para obtener detalles sobre el uso de Swift , Objective-C y la API de C, o siga el inicio rápido de iOS para obtener un tutorial y un código de ejemplo.

Plataforma Linux

En plataformas Linux (incluida Raspberry Pi ), puede ejecutar inferencias mediante las API de TensorFlow Lite disponibles en C++ y Python , como se muestra en las siguientes secciones.

Ejecutar un modelo

Ejecutar un modelo de TensorFlow Lite implica algunos pasos simples:

  1. Cargue el modelo en la memoria.
  2. Cree un Interpreter basado en un modelo existente.
  3. Establecer valores de tensor de entrada. (Opcionalmente, cambie el tamaño de los tensores de entrada si no se desean los tamaños predefinidos).
  4. Invocar inferencia.
  5. Leer valores de tensor de salida.

Las siguientes secciones describen cómo se pueden realizar estos pasos en cada idioma.

Cargar y ejecutar un modelo en Java

Plataforma: Android

La API de Java para ejecutar una inferencia con TensorFlow Lite está diseñada principalmente para su uso con Android, por lo que está disponible como una dependencia de la biblioteca de Android: org.tensorflow:tensorflow-lite .

En Java, utilizará la clase Interpreter para cargar un modelo e impulsar la inferencia del modelo. En muchos casos, esta puede ser la única API que necesita.

Puede inicializar un Interpreter usando un archivo .tflite :

public Interpreter(@NotNull File modelFile);

O con un MappedByteBuffer :

public Interpreter(@NotNull MappedByteBuffer mappedByteBuffer);

En ambos casos, debe proporcionar un modelo de TensorFlow Lite válido o la API IllegalArgumentException . Si utiliza MappedByteBuffer para inicializar un Interpreter , debe permanecer sin cambios durante toda la vida útil del Interpreter .

La forma preferida de ejecutar la inferencia en un modelo es usar firmas: disponible para modelos convertidos a partir de Tensorflow 2.5

try (Interpreter interpreter = new Interpreter(file_of_tensorflowlite_model)) {
  Map<String, Object> inputs = new HashMap<>();
  inputs.put("input_1", input1);
  inputs.put("input_2", input2);
  Map<String, Object> outputs = new HashMap<>();
  outputs.put("output_1", output1);
  interpreter.runSignature(inputs, outputs, "mySignature");
}

El método runSignature toma tres argumentos:

  • Entradas : mapa de entradas desde el nombre de entrada en la firma hasta un objeto de entrada.

  • Salidas : mapa para el mapeo de salida desde el nombre de salida en la firma hasta los datos de salida.

  • Nombre de la firma [opcional]: Nombre de la firma (Se puede dejar en blanco si el modelo tiene firma única).

Otra forma de ejecutar una inferencia cuando el modelo no tiene firmas definidas. Simplemente llame a Interpreter.run() . Por ejemplo:

try (Interpreter interpreter = new Interpreter(file_of_a_tensorflowlite_model)) {
  interpreter.run(input, output);
}

El método run() toma solo una entrada y devuelve solo una salida. Entonces, si su modelo tiene múltiples entradas o múltiples salidas, en su lugar use:

interpreter.runForMultipleInputsOutputs(inputs, map_of_indices_to_outputs);

En este caso, cada entrada en las inputs corresponde a un tensor de entrada y map_of_indices_to_outputs asigna índices de tensores de salida a los datos de salida correspondientes.

En ambos casos, los índices de tensor deben corresponder a los valores que le dio a TensorFlow Lite Converter cuando creó el modelo. Tenga en cuenta que el orden de los tensores en input debe coincidir con el orden dado al convertidor TensorFlow Lite.

La clase Interpreter también proporciona funciones convenientes para obtener el índice de cualquier entrada o salida del modelo usando un nombre de operación:

public int getInputIndex(String opName);
public int getOutputIndex(String opName);

Si opName no es una operación válida en el modelo, arroja una IllegalArgumentException .

También tenga en cuenta que Interpreter posee recursos. Para evitar la fuga de memoria, los recursos deben ser liberados después de su uso por:

interpreter.close();

Para ver un proyecto de ejemplo con Java, consulte el ejemplo de clasificación de imágenes de Android .

Tipos de datos admitidos (en Java)

Para usar TensorFlow Lite, los tipos de datos de los tensores de entrada y salida deben ser uno de los siguientes tipos primitivos:

  • float
  • int
  • long
  • byte

Los tipos String también son compatibles, pero están codificados de manera diferente a los tipos primitivos. En particular, la forma de un tensor de cuerda dicta el número y la disposición de las cuerdas en el tensor, siendo cada elemento en sí mismo una cuerda de longitud variable. En este sentido, el tamaño (en bytes) del Tensor no se puede calcular solo a partir de la forma y el tipo y, en consecuencia, las cadenas no se pueden proporcionar como un solo argumento ByteBuffer plano.

Si se utilizan otros tipos de datos, incluidos los tipos en caja como Integer y Float , se generará una IllegalArgumentException .

Entradas

Cada entrada debe ser una matriz o una matriz multidimensional de los tipos primitivos admitidos, o un ByteBuffer sin procesar del tamaño adecuado. Si la entrada es una matriz o una matriz multidimensional, el tensor de entrada asociado se redimensionará implícitamente a las dimensiones de la matriz en el momento de la inferencia. Si la entrada es un ByteBuffer, la persona que llama primero debe cambiar manualmente el tamaño del tensor de entrada asociado (a través de Interpreter.resizeInput() ) antes de ejecutar la inferencia.

Cuando use ByteBuffer , prefiera usar búferes de bytes directos, ya que esto permite que el Interpreter evite copias innecesarias. Si ByteBuffer es un búfer de bytes directo, su orden debe ser ByteOrder.nativeOrder() . Una vez que se utiliza para una inferencia de modelo, debe permanecer sin cambios hasta que finalice la inferencia de modelo.

Salidas

Cada salida debe ser una matriz o una matriz multidimensional de los tipos primitivos admitidos, o un ByteBuffer del tamaño adecuado. Tenga en cuenta que algunos modelos tienen salidas dinámicas, donde la forma de los tensores de salida puede variar según la entrada. No existe una forma sencilla de manejar esto con la API de inferencia de Java existente, pero las extensiones planificadas lo harán posible.

Cargue y ejecute un modelo en Swift

Plataforma: iOS

La API de Swift está disponible en TensorFlowLiteSwift Pod de Cocoapods.

Primero, debe importar el módulo TensorFlowLite .

import TensorFlowLite
// Getting model path
guard
  let modelPath = Bundle.main.path(forResource: "model", ofType: "tflite")
else {
  // Error handling...
}

do {
  // Initialize an interpreter with the model.
  let interpreter = try Interpreter(modelPath: modelPath)

  // Allocate memory for the model's input `Tensor`s.
  try interpreter.allocateTensors()

  let inputData: Data  // Should be initialized

  // input data preparation...

  // Copy the input data to the input `Tensor`.
  try self.interpreter.copy(inputData, toInputAt: 0)

  // Run inference by invoking the `Interpreter`.
  try self.interpreter.invoke()

  // Get the output `Tensor`
  let outputTensor = try self.interpreter.output(at: 0)

  // Copy output to `Data` to process the inference results.
  let outputSize = outputTensor.shape.dimensions.reduce(1, {x, y in x * y})
  let outputData =
        UnsafeMutableBufferPointer<Float32>.allocate(capacity: outputSize)
  outputTensor.data.copyBytes(to: outputData)

  if (error != nil) { /* Error handling... */ }
} catch error {
  // Error handling...
}

Cargue y ejecute un modelo en Objective-C

Plataforma: iOS

La API de Objective-C está disponible en TensorFlowLiteObjC Pod de Cocoapods.

Primero, debe importar el módulo TensorFlowLite .

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

// Initialize an interpreter with the model.
TFLInterpreter *interpreter = [[TFLInterpreter alloc] initWithModelPath:modelPath
                                                                  error:&error];
if (error != nil) { /* Error handling... */ }

// Allocate memory for the model's input `TFLTensor`s.
[interpreter allocateTensorsWithError:&error];
if (error != nil) { /* Error handling... */ }

NSMutableData *inputData;  // Should be initialized
// input data preparation...

// Get the input `TFLTensor`
TFLTensor *inputTensor = [interpreter inputTensorAtIndex:0 error:&error];
if (error != nil) { /* Error handling... */ }

// Copy the input data to the input `TFLTensor`.
[inputTensor copyData:inputData error:&error];
if (error != nil) { /* Error handling... */ }

// Run inference by invoking the `TFLInterpreter`.
[interpreter invokeWithError:&error];
if (error != nil) { /* Error handling... */ }

// Get the output `TFLTensor`
TFLTensor *outputTensor = [interpreter outputTensorAtIndex:0 error:&error];
if (error != nil) { /* Error handling... */ }

// Copy output to `NSData` to process the inference results.
NSData *outputData = [outputTensor dataWithError:&error];
if (error != nil) { /* Error handling... */ }

Usando C API en código Objective-C

Actualmente, la API de Objective-C no admite delegados. Para usar delegados con código Objective-C, debe llamar directamente a la API de C subyacente.

#include "tensorflow/lite/c/c_api.h"
TfLiteModel* model = TfLiteModelCreateFromFile([modelPath UTF8String]);
TfLiteInterpreterOptions* options = TfLiteInterpreterOptionsCreate();

// Create the interpreter.
TfLiteInterpreter* interpreter = TfLiteInterpreterCreate(model, options);

// Allocate tensors and populate the input tensor data.
TfLiteInterpreterAllocateTensors(interpreter);
TfLiteTensor* input_tensor =
    TfLiteInterpreterGetInputTensor(interpreter, 0);
TfLiteTensorCopyFromBuffer(input_tensor, input.data(),
                           input.size() * sizeof(float));

// Execute inference.
TfLiteInterpreterInvoke(interpreter);

// Extract the output tensor data.
const TfLiteTensor* output_tensor =
    TfLiteInterpreterGetOutputTensor(interpreter, 0);
TfLiteTensorCopyToBuffer(output_tensor, output.data(),
                         output.size() * sizeof(float));

// Dispose of the model and interpreter objects.
TfLiteInterpreterDelete(interpreter);
TfLiteInterpreterOptionsDelete(options);
TfLiteModelDelete(model);

Cargue y ejecute un modelo en C++

Plataformas: Android, iOS y Linux

En C++, el modelo se almacena en la clase FlatBufferModel . Encapsula un modelo de TensorFlow Lite y puede compilarlo de dos maneras diferentes, según dónde esté almacenado el modelo:

class FlatBufferModel {
  // Build a model based on a file. Return a nullptr in case of failure.
  static std::unique_ptr<FlatBufferModel> BuildFromFile(
      const char* filename,
      ErrorReporter* error_reporter);

  // Build a model based on a pre-loaded flatbuffer. The caller retains
  // ownership of the buffer and should keep it alive until the returned object
  // is destroyed. Return a nullptr in case of failure.
  static std::unique_ptr<FlatBufferModel> BuildFromBuffer(
      const char* buffer,
      size_t buffer_size,
      ErrorReporter* error_reporter);
};

Ahora que tiene el modelo como un objeto FlatBufferModel , puede ejecutarlo con un Interpreter . Un solo FlatBufferModel puede ser utilizado simultáneamente por más de un Interpreter .

Las partes importantes de la API de Interpreter se muestran en el fragmento de código a continuación. Se debe notar que:

  • Los tensores se representan mediante números enteros para evitar comparaciones de cadenas (y cualquier dependencia fija de las bibliotecas de cadenas).
  • No se debe acceder a un intérprete desde subprocesos concurrentes.
  • La asignación de memoria para los tensores de entrada y salida debe activarse llamando a AllocateTensors() justo después de cambiar el tamaño de los tensores.

El uso más simple de TensorFlow Lite con C++ se ve así:

// Load the model
std::unique_ptr<tflite::FlatBufferModel> model =
    tflite::FlatBufferModel::BuildFromFile(filename);

// Build the interpreter
tflite::ops::builtin::BuiltinOpResolver resolver;
std::unique_ptr<tflite::Interpreter> interpreter;
tflite::InterpreterBuilder(*model, resolver)(&interpreter);

// Resize input tensors, if desired.
interpreter->AllocateTensors();

float* input = interpreter->typed_input_tensor<float>(0);
// Fill `input`.

interpreter->Invoke();

float* output = interpreter->typed_output_tensor<float>(0);

Para obtener más código de ejemplo, consulte minimal.cc y label_image.cc .

Cargue y ejecute un modelo en Python

Plataforma: Linux

La API de Python para ejecutar una inferencia se proporciona en el módulo tf.lite . De lo cual, en su mayoría solo necesita tf.lite.Interpreter para cargar un modelo y ejecutar una inferencia.

El siguiente ejemplo muestra cómo usar el intérprete de Python para cargar un archivo .tflite y ejecutar la inferencia con datos de entrada aleatorios:

Se recomienda este ejemplo si está convirtiendo desde un modelo guardado con un SignatureDef definido. Disponible a partir de TensorFlow 2.5

class TestModel(tf.Module):
  def __init__(self):
    super(TestModel, self).__init__()

  @tf.function(input_signature=[tf.TensorSpec(shape=[1, 10], dtype=tf.float32)])
  def add(self, x):
    '''
    Simple method that accepts single input 'x' and returns 'x' + 4.
    '''
    # Name the output 'result' for convenience.
    return {'result' : x + 4}


SAVED_MODEL_PATH = 'content/saved_models/test_variable'
TFLITE_FILE_PATH = 'content/test_variable.tflite'

# Save the model
module = TestModel()
# You can omit the signatures argument and a default signature name will be
# created with name 'serving_default'.
tf.saved_model.save(
    module, SAVED_MODEL_PATH,
    signatures={'my_signature':module.add.get_concrete_function()})

# Convert the model using TFLiteConverter
converter = tf.lite.TFLiteConverter.from_saved_model(SAVED_MODEL_PATH)
tflite_model = converter.convert()
with open(TFLITE_FILE_PATH, 'wb') as f:
  f.write(tflite_model)

# Load the TFLite model in TFLite Interpreter
interpreter = tf.lite.Interpreter(TFLITE_FILE_PATH)
# There is only 1 signature defined in the model,
# so it will return it by default.
# If there are multiple signatures then we can pass the name.
my_signature = interpreter.get_signature_runner()

# my_signature is callable with input as arguments.
output = my_signature(x=tf.constant([1.0], shape=(1,10), dtype=tf.float32))
# 'output' is dictionary with all outputs from the inference.
# In this case we have single output 'result'.
print(output['result'])

Otro ejemplo si el modelo no tiene definido SignatureDefs.

import numpy as np
import tensorflow as tf

# Load the TFLite model and allocate tensors.
interpreter = tf.lite.Interpreter(model_path="converted_model.tflite")
interpreter.allocate_tensors()

# Get input and output tensors.
input_details = interpreter.get_input_details()
output_details = interpreter.get_output_details()

# Test the model on random input data.
input_shape = input_details[0]['shape']
input_data = np.array(np.random.random_sample(input_shape), dtype=np.float32)
interpreter.set_tensor(input_details[0]['index'], input_data)

interpreter.invoke()

# The function `get_tensor()` returns a copy of the tensor data.
# Use `tensor()` in order to get a pointer to the tensor.
output_data = interpreter.get_tensor(output_details[0]['index'])
print(output_data)

Como alternativa a cargar el modelo como un archivo .tflite , puede combinar su código con la API Python de TensorFlow Lite Converter ( tf.lite.TFLiteConverter ), lo que le permite convertir su modelo TensorFlow al formato TensorFlow Lite y luego ejecutar inferencia:

import numpy as np
import tensorflow as tf

img = tf.placeholder(name="img", dtype=tf.float32, shape=(1, 64, 64, 3))
const = tf.constant([1., 2., 3.]) + tf.constant([1., 4., 4.])
val = img + const
out = tf.identity(val, name="out")

# Convert to TF Lite format
with tf.Session() as sess:
  converter = tf.lite.TFLiteConverter.from_session(sess, [img], [out])
  tflite_model = converter.convert()

# Load the TFLite model and allocate tensors.
interpreter = tf.lite.Interpreter(model_content=tflite_model)
interpreter.allocate_tensors()

# Continue to get tensors and so forth, as shown above...

Para obtener más código de muestra de Python, consulte label_image.py .

Operaciones admitidas

TensorFlow Lite admite un subconjunto de operaciones de TensorFlow con algunas limitaciones. Para ver la lista completa de operaciones y limitaciones, consulte la página TF Lite Ops .