Ajouter des métadonnées aux modèles TensorFlow Lite

Les métadonnées TensorFlow Lite fournissent une norme pour la description des modèles. Les métadonnées sont une source importante de connaissances sur la fonction du modèle et sur ses informations d'entrée / sortie. Les métadonnées sont constituées

Tous les modèles d'images publiés sur TensorFlow Hub ont été renseignés avec des métadonnées.

Modèle avec format de métadonnées

model_with_metadata
Figure 1. Modèle TFLite avec métadonnées et fichiers associés.

Les métadonnées de modèle sont définies dans metadata_schema.fbs, un fichier FlatBuffer. Comme le montre la Figure 1, elle est stockée dans le champ metadata du schéma du modèle TFLite, sous le nom "TFLITE_METADATA". Certains modèles peuvent être associés à des fichiers, tels que des fichiers d'étiquettes de classification. Ces fichiers sont concaténés à la fin du fichier de modèle d'origine sous forme de fichier ZIP à l'aide du mode "append" (ajouter) ZipFile (mode 'a'). L'interpréteur TFLite peut utiliser le nouveau format de fichier de la même manière qu'auparavant. Pour en savoir plus, consultez la section Empaqueter les fichiers associés.

Consultez les instructions ci-dessous pour savoir comment renseigner, visualiser et lire les métadonnées.

Configurer les outils de métadonnées

Avant d'ajouter des métadonnées à votre modèle, vous devez configurer un environnement de programmation Python pour exécuter TensorFlow. Pour consulter un guide détaillé sur la configuration, cliquez ici.

Après avoir configuré l'environnement de programmation Python, vous devrez installer des outils supplémentaires:

pip install tflite-support

Les outils de métadonnées TensorFlow Lite sont compatibles avec Python 3.

Ajouter des métadonnées à l'aide de l'API Python Flatbuffers

Les métadonnées du modèle se composent de trois parties dans le schéma:

  1. Informations sur le modèle : description générale du modèle et éléments tels que les conditions de licence. Consultez ModelMetadata.
  2. Informations d'entrée : description des entrées et du prétraitement requis, comme la normalisation. Consultez SubGraphMetadata.input_tensor_metadata.
  3. Informations sur le résultat : description de la sortie et du post-traitement requis, telle que le mappage sur des étiquettes. Consultez SubGraphMetadata.output_tensor_metadata.

Étant donné que TensorFlow Lite n'accepte qu'un seul sous-graphe à ce stade, le générateur de code TensorFlow Lite et la fonctionnalité de liaison ML d'Android Studio utiliseront ModelMetadata.name et ModelMetadata.description, au lieu de SubGraphMetadata.name et SubGraphMetadata.description, lors de l'affichage des métadonnées et de la génération du code.

Types d'entrées / sorties compatibles

Les métadonnées d'entrée et de sortie TensorFlow Lite ne sont pas conçues pour des types de modèles spécifiques, mais pour des types d'entrée et de sortie. Peu importe la fonctionnalité fonctionnelle du modèle, tant que les types d'entrée et de sortie sont constitués des éléments suivants ou d'une combinaison des suivants, le modèle est compatible avec les métadonnées TensorFlow Lite:

  • Caractéristique : nombres qui sont des entiers non signés ou des float32.
  • Image : les métadonnées sont actuellement compatibles avec les images RVB et en nuances de gris.
  • Cadre de délimitation : cadre de délimitation de forme rectangulaire. Le schéma est compatible avec différents schémas de numérotation.

Empaqueter les fichiers associés

Les modèles TensorFlow Lite peuvent être livrés avec différents fichiers associés. Par exemple, les modèles de langage naturel comportent généralement des fichiers de vocabulaire qui mappent des éléments de mots à des ID de mot. Les modèles de classification peuvent comporter des fichiers d'étiquettes qui indiquent des catégories d'objets. Sans les fichiers associés (le cas échéant), un modèle ne fonctionnera pas correctement.

Les fichiers associés peuvent désormais être regroupés avec le modèle via la bibliothèque de métadonnées Python. Le nouveau modèle TensorFlow Lite devient un fichier ZIP contenant à la fois le modèle et les fichiers associés. Il peut être décompressé avec des outils ZIP courants. Ce nouveau format de modèle continue d'utiliser la même extension de fichier, .tflite. Il est compatible avec le framework et l'interpréteur TFLite existants. Pour en savoir plus, consultez la section Empaqueter les métadonnées et les fichiers associés dans le modèle.

Les informations sur les fichiers associés peuvent être enregistrées dans les métadonnées. En fonction du type de fichier et de l'emplacement auquel il est associé (ModelMetadata, SubGraphMetadata et TensorMetadata), le générateur de code Android TensorFlow Lite peut appliquer automatiquement un pré-traitement/post-traitement à l'objet. Pour en savoir plus, consultez la section <Codegen usage> de chaque type de fichier associé dans le schéma.

Paramètres de normalisation et de quantification

La normalisation est une technique courante de prétraitement des données en machine learning. L'objectif de la normalisation est de remplacer les valeurs par une échelle commune, sans distorsion des différences entre les plages de valeurs.

La quantification de modèle est une technique qui permet de réduire la précision des représentations des pondérations et, éventuellement, des activations pour le stockage et le calcul.

En termes de prétraitement et de post-traitement, la normalisation et la quantification sont deux étapes indépendantes. Voici les informations détaillées relatives à cet incident.

Normalization Quantification

Exemple de valeurs de paramètres de l'image d'entrée dans MobileNet pour les modèles flottants et quantiques, respectivement.
Modèle à virgule flottante:
- moyenne: 127,5
- std: 127,5
Modèle quantique:
- moyenne: 127,5
- std: 127,5
Modèle à virgule flottante:
- zeroPoint: 0
- Échelle: 1,0
Modèle quantique:
- zeroPoint: 128,0
- scale:0.0078125f




Quand l'appeler ?


Entrées: si les données d'entrée sont normalisées lors de l'entraînement, les données d'entrée d'inférence doivent être normalisées en conséquence.
Sorties: les données de sortie ne seront pas normalisées en général.
Les modèles à virgule flottante ne nécessitent pas de quantification.
Le modèle quantifié peut nécessiter ou non une quantification avant/post-traitement. Cela dépend du type de données des Tensors d'entrée/de sortie.
- Tensors à virgule flottante: aucune quantification nécessaire avant/après le traitement. L'opération quantique et l'opération déquantique sont intégrées au graphe de modèle.
- Tensors int8/uint8 : une quantification est nécessaire avant/après le traitement.


Formule


normalized_input = (entrée - moyenne) / std
Quantifier les entrées :
q = f / scale + zeroPoint
Déquantifier les sorties:
f = (q - zeroPoint) * scale

Où se trouvent les paramètres
Compilé par le créateur du modèle et stocké dans les métadonnées du modèle, en tant que NormalizationOptions. Compilé automatiquement par le convertisseur TFLite et stocké dans le fichier de modèle tflite.
Comment obtenir les paramètres ? Via l'API MetadataExtractor[2] Via l'API Tensor TFLite[1] ou l'API MetadataExtractor[2]
Les modèles float et quantiques partagent-ils la même valeur ? Oui, les modèles à float et quantit ont les mêmes paramètres de normalisation. Non, le modèle float n’a pas besoin de quantification.
Le générateur de code TFLite ou la liaison ML d'Android Studio la génère-t-elle automatiquement lors du traitement des données ?
Oui

Oui

[1] API TensorFlow Lite Java et API TensorFlow Lite C++.
[2] La bibliothèque d'extracteurs de métadonnées

Lors du traitement des données d'image des modèles uint8, la normalisation et la quantification sont parfois ignorées. Cela est acceptable lorsque les valeurs en pixels sont comprises dans la plage [0, 255]. Toutefois, en général, vous devez toujours traiter les données conformément aux paramètres de normalisation et de quantification, le cas échéant.

Exemples

Vous trouverez des exemples sur la façon de renseigner les métadonnées pour différents types de modèles ici:

Classification d'images

Téléchargez le script ici, qui renseigne les métadonnées dans mobilenet_v1_0.75_160_quantized.tflite. Exécutez le script comme suit:

python ./metadata_writer_for_image_classifier.py \
    --model_file=./model_without_metadata/mobilenet_v1_0.75_160_quantized.tflite \
    --label_file=./model_without_metadata/labels.txt \
    --export_directory=model_with_metadata

Pour insérer des métadonnées pour d'autres modèles de classification d'images, ajoutez les spécifications de modèle comme celle-ci dans le script. Le reste de ce guide met en évidence certaines sections clés de l'exemple de classification d'images pour illustrer les éléments clés.

Présentation détaillée de l'exemple de classification d'images

Informations relatives au modèle

Les métadonnées commencent par créer des informations de modèle:

from tflite_support import flatbuffers
from tflite_support import metadata as _metadata
from tflite_support import metadata_schema_py_generated as _metadata_fb

""" ... """
"""Creates the metadata for an image classifier."""

# Creates model info.
model_meta = _metadata_fb.ModelMetadataT()
model_meta.name = "MobileNetV1 image classifier"
model_meta.description = ("Identify the most prominent object in the "
                          "image from a set of 1,001 categories such as "
                          "trees, animals, food, vehicles, person etc.")
model_meta.version = "v1"
model_meta.author = "TensorFlow"
model_meta.license = ("Apache License. Version 2.0 "
                      "http://www.apache.org/licenses/LICENSE-2.0.")

Informations d'entrée / de sortie

Cette section vous explique comment décrire la signature d'entrée et de sortie de votre modèle. Ces métadonnées peuvent être utilisées par les générateurs de code automatiques pour créer du code de prétraitement et de post-traitement. Pour créer des informations d'entrée ou de sortie pour un Tensor, procédez comme suit:

# Creates input info.
input_meta = _metadata_fb.TensorMetadataT()

# Creates output info.
output_meta = _metadata_fb.TensorMetadataT()

Saisie d'image

L'image est un type d'entrée courant pour le machine learning. Les métadonnées TensorFlow Lite sont compatibles avec les informations telles que l'espace colorimétrique et les informations de prétraitement telles que la normalisation. La dimension de l'image ne nécessite pas de spécification manuelle, car elle est déjà fournie par la forme du Tensor d'entrée et peut être déduite automatiquement.

input_meta.name = "image"
input_meta.description = (
    "Input image to be classified. The expected image is {0} x {1}, with "
    "three channels (red, blue, and green) per pixel. Each value in the "
    "tensor is a single byte between 0 and 255.".format(160, 160))
input_meta.content = _metadata_fb.ContentT()
input_meta.content.contentProperties = _metadata_fb.ImagePropertiesT()
input_meta.content.contentProperties.colorSpace = (
    _metadata_fb.ColorSpaceType.RGB)
input_meta.content.contentPropertiesType = (
    _metadata_fb.ContentProperties.ImageProperties)
input_normalization = _metadata_fb.ProcessUnitT()
input_normalization.optionsType = (
    _metadata_fb.ProcessUnitOptions.NormalizationOptions)
input_normalization.options = _metadata_fb.NormalizationOptionsT()
input_normalization.options.mean = [127.5]
input_normalization.options.std = [127.5]
input_meta.processUnits = [input_normalization]
input_stats = _metadata_fb.StatsT()
input_stats.max = [255]
input_stats.min = [0]
input_meta.stats = input_stats

Sortie d'étiquette

L'étiquette peut être mappée à un Tensor de sortie via un fichier associé à l'aide de TENSOR_AXIS_LABELS.

# Creates output info.
output_meta = _metadata_fb.TensorMetadataT()
output_meta.name = "probability"
output_meta.description = "Probabilities of the 1001 labels respectively."
output_meta.content = _metadata_fb.ContentT()
output_meta.content.content_properties = _metadata_fb.FeaturePropertiesT()
output_meta.content.contentPropertiesType = (
    _metadata_fb.ContentProperties.FeatureProperties)
output_stats = _metadata_fb.StatsT()
output_stats.max = [1.0]
output_stats.min = [0.0]
output_meta.stats = output_stats
label_file = _metadata_fb.AssociatedFileT()
label_file.name = os.path.basename("your_path_to_label_file")
label_file.description = "Labels for objects that the model can recognize."
label_file.type = _metadata_fb.AssociatedFileType.TENSOR_AXIS_LABELS
output_meta.associatedFiles = [label_file]

Créer les FlatBuffers de métadonnées

Le code suivant combine les informations du modèle avec les informations d'entrée et de sortie:

# Creates subgraph info.
subgraph = _metadata_fb.SubGraphMetadataT()
subgraph.inputTensorMetadata = [input_meta]
subgraph.outputTensorMetadata = [output_meta]
model_meta.subgraphMetadata = [subgraph]

b = flatbuffers.Builder(0)
b.Finish(
    model_meta.Pack(b),
    _metadata.MetadataPopulator.METADATA_FILE_IDENTIFIER)
metadata_buf = b.Output()

Empaqueter les métadonnées et les fichiers associés dans le modèle

Une fois les métadonnées Flatbuffers créées, les métadonnées et le fichier d'étiquettes sont écrites dans le fichier TFLite via la méthode populate:

populator = _metadata.MetadataPopulator.with_model_file(model_file)
populator.load_metadata_buffer(metadata_buf)
populator.load_associated_files(["your_path_to_label_file"])
populator.populate()

Vous pouvez empaqueter autant de fichiers associés que vous le souhaitez dans le modèle via load_associated_files. Cependant, il est nécessaire d'empaqueter au moins ces fichiers documentés dans les métadonnées. Dans cet exemple, la compression du fichier d'étiquettes est obligatoire.

Visualiser les métadonnées

Vous pouvez utiliser Netron pour visualiser vos métadonnées, ou les lire à partir d'un modèle TensorFlow Lite au format JSON à l'aide de MetadataDisplayer:

displayer = _metadata.MetadataDisplayer.with_model_file(export_model_path)
export_json_file = os.path.join(FLAGS.export_directory,
                                os.path.splitext(model_basename)[0] + ".json")
json_file = displayer.get_metadata_json()
# Optional: write out the metadata as a json file
with open(export_json_file, "w") as f:
  f.write(json_file)

Android Studio permet également d'afficher des métadonnées via la fonctionnalité de liaison ML d'Android Studio.

Gestion des versions des métadonnées

Les versions du schéma de métadonnées sont gérées à la fois par le numéro de gestion sémantique des versions, qui suit les modifications du fichier de schéma, et par l'identification du fichier Flatbuffers, qui indique la véritable compatibilité des versions.

Le numéro de gestion sémantique des versions

La version du schéma de métadonnées est assurée par le numéro de gestion sémantique des versions, tel que MAJOR.MINOR.PATCH. Il suit les modifications de schéma conformément aux règles décrites ici. Consultez l'historique des champs ajouté après la version 1.0.0.

Identification du fichier Flatbuffers

La gestion sémantique des versions garantit la compatibilité si vous respectez les règles, mais elle n'implique pas la véritable incompatibilité. Augmenter le nombre MAJEUR ne signifie pas nécessairement que la rétrocompatibilité est rompue. Par conséquent, nous utilisons l'identification de fichier Flatbuffers, file_identifier, pour indiquer la véritable compatibilité du schéma de métadonnées. L'identifiant de fichier comporte exactement 4 caractères. Il est fixé à un certain schéma de métadonnées et n'est pas susceptible de changer par les utilisateurs. Si la rétrocompatibilité du schéma de métadonnées doit être rompue pour une raison quelconque, "file_identifier" passera, par exemple, de "M001" à "M002". File_identifier devrait être modifié beaucoup moins souvent que "metadata_version".

Version minimale requise de l'analyseur de métadonnées

La version minimale de l'analyseur de métadonnées nécessaire est la version minimale de l'analyseur de métadonnées (le code généré par Flatbuffers) capable de lire l'intégralité des Flatbuffers. Il s'agit en fait du numéro de version le plus élevé parmi les versions de tous les champs renseignés et de la version compatible la plus petite indiquée par l'identifiant de fichier. La version minimale nécessaire de l'analyseur de métadonnées est automatiquement renseignée par MetadataPopulator lorsque les métadonnées sont insérées dans un modèle TFLite. Pour en savoir plus sur l'utilisation de la version minimale nécessaire de l'analyseur de métadonnées, consultez la page sur l'extracteur de métadonnées.

Lire les métadonnées à partir des modèles

La bibliothèque d'extracteurs de métadonnées est un outil pratique pour lire les métadonnées et les fichiers associés d'un modèle sur différentes plates-formes (consultez les versions Java et C++). Vous pouvez créer votre propre outil d'extraction de métadonnées dans d'autres langages à l'aide de la bibliothèque Flatbuffers.

Lire les métadonnées en Java

Pour utiliser la bibliothèque d'extracteurs de métadonnées dans votre application Android, nous vous recommandons d'utiliser l'AAR de métadonnées TensorFlow Lite hébergée sur MavenCentral. Il contient la classe MetadataExtractor, ainsi que les liaisons Java FlatBuffers pour le schéma de métadonnées et le schéma de modèle.

Vous pouvez spécifier ce paramètre dans vos dépendances build.gradle comme suit:

dependencies {
    implementation 'org.tensorflow:tensorflow-lite-metadata:0.1.0'
}

Pour utiliser des instantanés nocturnes, assurez-vous d'avoir ajouté le dépôt d'instantanés Sonatype.

Vous pouvez initialiser un objet MetadataExtractor avec un ByteBuffer qui pointe vers le modèle:

public MetadataExtractor(ByteBuffer buffer);

Le ByteBuffer doit rester inchangé pendant toute la durée de vie de l'objet MetadataExtractor. L'initialisation peut échouer si l'identifiant de fichier Flatbuffers des métadonnées du modèle ne correspond pas à celui de l'analyseur de métadonnées. Pour en savoir plus, consultez la section Gestion des versions des métadonnées.

Avec les identifiants de fichier correspondants, l'extracteur de métadonnées lit correctement les métadonnées générées à partir de tous les schémas passés et futurs en raison du mécanisme de rétrocompatibilité et de transfert des Flatbuffers. Toutefois, les champs des futurs schémas ne peuvent pas être extraits par d'anciens extracteurs de métadonnées. La version minimale de l'analyseur nécessaire des métadonnées indique la version minimale de l'analyseur de métadonnées pouvant lire les FlatBuffers de métadonnées dans leur intégralité. Vous pouvez utiliser la méthode suivante pour vérifier si la condition minimale de version de l'analyseur est remplie:

public final boolean isMinimumParserVersionSatisfied();

La transmission d'un modèle sans métadonnées est autorisée. Toutefois, appeler des méthodes qui lisent des métadonnées entraîne des erreurs d'exécution. Vous pouvez vérifier si un modèle possède des métadonnées en appelant la méthode hasMetadata:

public boolean hasMetadata();

MetadataExtractor fournit des fonctions pratiques pour obtenir les métadonnées des Tensors d'entrée/de sortie. Par exemple :

public int getInputTensorCount();
public TensorMetadata getInputTensorMetadata(int inputIndex);
public QuantizationParams getInputTensorQuantizationParams(int inputIndex);
public int[] getInputTensorShape(int inputIndex);
public int getoutputTensorCount();
public TensorMetadata getoutputTensorMetadata(int inputIndex);
public QuantizationParams getoutputTensorQuantizationParams(int inputIndex);
public int[] getoutputTensorShape(int inputIndex);

Bien que le schéma de modèle TensorFlow Lite accepte plusieurs sous-graphes, l'interpréteur TFLite n'en accepte actuellement qu'un seul. Par conséquent, MetadataExtractor omet l'index de sous-graphique en tant qu'argument d'entrée dans ses méthodes.

Lire les fichiers associés des modèles

Le modèle TensorFlow Lite avec les métadonnées et les fichiers associés est essentiellement un fichier ZIP qui peut être décompressé avec les outils ZIP courants pour obtenir les fichiers associés. Par exemple, vous pouvez décompresser mobilenet_v1_0.75_160_quantized et extraire le fichier d'étiquettes du modèle comme suit:

$ unzip mobilenet_v1_0.75_160_quantized_1_metadata_1.tflite
Archive:  mobilenet_v1_0.75_160_quantized_1_metadata_1.tflite
 extracting: labels.txt

Vous pouvez également lire les fichiers associés via la bibliothèque Metadata Extractor.

En Java, transmettez le nom du fichier à la méthode MetadataExtractor.getAssociatedFile:

public InputStream getAssociatedFile(String fileName);

De même, en C++, vous pouvez effectuer cette opération à l'aide de la méthode ModelMetadataExtractor::GetAssociatedFile:

tflite::support::StatusOr<absl::string_view> GetAssociatedFile(
      const std::string& filename) const;