Installer l'API Tensorflow Object Detection (TOD)

Acquis d'apprentissage visés :
- Savoir initialiser ton espace de travail pour la détection d'objets utilisant l'API TOD
- Savoir installer l'API TOD et les composants requis

Type d'activité : 🛠️ [setup]
Durée prévue    : 60 minutes (dépend du débit internet et des ressources CPU & RAM de ton ordinateur).

Prérequis

Plan de l’activité

L’installation de l’API proposée comporte 5 étapes :

  1. Initialiser ton espace de travail
  2. Télécharger et installer le dépôt tensorflow/models
  3. Installer les outils protobuf
  4. Installer le package object_detection
  5. Tester l’installation de l’API TOD

Dans toute la suite le prompt du terminal sera noté (tf2) user@host $ : le préfixe (tf2) est là pour bien rappeler que le travail d’installation de l'API TOD se fait dans l'Environnement Virtuel Python tf2 que tu auras créé au préalable (cf les Prérequis).

1. Créé et initialise ton espace de travail

La première étape consiste à créer le répertoire de travail tod_tf2, qui sera le dossier racine du projet dans lequel seront créés tous les fichiers, et à te positionner dans ce répertoire :

(tf2) user@host $ cd <quelque_part>   # choisis le répertoire où créer `tod_tf2`, par exemple "cd ~/catkins_ws"
(tf2) user@host $ mkdir tod_tf2
(tf2) user@host $ cd tod_tf2/

📥 Ensuite, tu clones le dépôt github cjlux/tod_tf2_tools.git et tu copies les fichiers *.py et *.ipynb du dossier tod_tf2_tools dans le dossier tod_tf2 :

# From tod_tf2/
(tf2) user@host $ git clone https://github.com/cjlux/tod_tf2_tools.git
(tf2) user@host $ cp tod_tf2_tools/*.py .
(tf2) user@host $ cp tod_tf2_tools/*.ipynb .

2. Télécharge et installe le dépôt tensorflow/models

📥 Télécharge le ZIP du dépôt github tensorflow/models (~ 35 Mio) dans le dossier /tmp puis dézippe son contenu dans le dossier tod_tf2 :

(tf2) user@host $ wget https://github.com/tensorflow/models/archive/refs/heads/master.zip -P /tmp
(tf2) user@host $ cd ~/catkin_ws/tod_tf2       # adapte au besoin si le chemin d'accès à tod_tf2 est différent
(tf2) user@host $ unzip /tmp/master.zip        # dézipe l'archive dans le dossier tod_tf2
(tf2) user@host $ mv models-master/ models     # renomme models-master en models
(tf2) user@host $ rm /tmp/master.zip           # efface le zip dans /tmp qui ne sert plus

L’API TOD est dans le dossier models/research/object_detection :

(tf2) user@host $ tree -d models -L 2   # arbre du dossier models sur 2 niveaux
models
├── community
├── official
│   ...
├── orbit
│   ...
└── research
    ...    
    ├── object_detection
    ...

📥 Complète ton installation avec quelques paquets Python utiles pour le travail avec l'API TOD :

(tf2) user@host $ conda install cython contextlib2 pillow lxml
(tf2) user@host $ pip install labelimg rospkg

Mets à jour la variable d’environnement PYTHONPATH en ajoutant à la fin de ton fichier ~/.bashrc les deux lignes :

export TOD_ROOT="<chemin absolu du dossier tod_tf2>"
export PYTHONPATH=$TOD_ROOT/models:$TOD_ROOT/models/research:$PYTHONPATH

remplace "<chemin absolu du dossier tod_tf2>" par le chemin absolu du dossier tod_tf2 sur ta machine (en général c’est : /home/<logname>/catkin_ws/todtf2).

user@host $ conda activate tf2
(tf2) user@host $

3. Installe les outils protobuf

L’API native TOD utilise des fichiers *.proto pour la configuration des modèles et le stockage des paramètres d’entraînement. Ces fichiers doivent être traduits en fichiers *.py afin que l’API Python puisse fonctionner correctement :

(tf2) user@host $ sudo apt install protobuf-compiler

# From tod_tf2
(tf2) user@host $ cd models/research/
(tf2) user@host $ protoc object_detection/protos/*.proto  --python_out=.

Cette commande travaille de façon muette.

4. Installe le module object_detection

Pour finir l’installation, place-toi dans le dossier models/research/ et tape les commandes :

(tf2) user@host $ cd ~/catkin_ws/tod_tf2       # adapte au besoin si le chemin d'accès à tod_tf2 est différent
(tf2) user@host $ cd models/research/
# From tod_tf2/models/research/
(tf2) user@host $ cp object_detection/packages/tf2/setup.py .
(tf2) user@host $ python setup.py build
(tf2) user@host $ pip install .

5. Teste l’installation de l’API TOD

Pour tester ton installation de l’API TOD, place-toi dans le dossier models/research/ et tape la commande :

# From within tod_tf2/models/research/
(tf2) user@host $ python object_detection/builders/model_builder_tf2_test.py

Le programme déroule toute une série de tests qui peuvent durer “un certain temsp…” et doit se terminer par un OK sans faire apparaître d’erreur :

...
[       OK ] ModelBuilderTF2Test.test_invalid_second_stage_batch_size
[ RUN      ] ModelBuilderTF2Test.test_session
[  SKIPPED ] ModelBuilderTF2Test.test_session
[ RUN      ] ModelBuilderTF2Test.test_unknown_faster_rcnn_feature_extractor
INFO:tensorflow:time(__main__.ModelBuilderTF2Test.test_unknown_faster_rcnn_feature_extractor): 0.0s
I1026 22:28:48.083127 140638063505792 test_util.py:2188] time(__main__.ModelBuilderTF2Test.test_unknown_faster_rcnn_feature_extractor): 0.0s
[       OK ] ModelBuilderTF2Test.test_unknown_faster_rcnn_feature_extractor
[ RUN      ] ModelBuilderTF2Test.test_unknown_meta_architecture
INFO:tensorflow:time(__main__.ModelBuilderTF2Test.test_unknown_meta_architecture): 0.0s
I1026 22:28:48.083944 140638063505792 test_util.py:2188] time(__main__.ModelBuilderTF2Test.test_unknown_meta_architecture): 0.0s
[       OK ] ModelBuilderTF2Test.test_unknown_meta_architecture
[ RUN      ] ModelBuilderTF2Test.test_unknown_ssd_feature_extractor
INFO:tensorflow:time(__main__.ModelBuilderTF2Test.test_unknown_ssd_feature_extractor): 0.0s
I1026 22:28:48.085861 140638063505792 test_util.py:2188] time(__main__.ModelBuilderTF2Test.test_unknown_ssd_feature_extractor): 0.0s
[       OK ] ModelBuilderTF2Test.test_unknown_ssd_feature_extractor
----------------------------------------------------------------------
Ran 24 tests in 58.669s

OK (skipped=1)

L’absence de message d’erreur valide l’installation de l'API TOD sur ta machine.

Compléments…

Pour finir, tu peux vérifier l’installation de l'_API TOD_en utilisant le notebook IPython object_detection_tutorial.ipynb présent dans le dossier tod_tf2.
(note : c’est une copie du notebook original tod_tf2/models/research/object_detection/colab_tutorials/object_detection_tutorial.ipynb dans lequelle on a enlevé les cellules d’installation de l'API_TOD et quelques autres cellules qui peuvent générer des erreurs…).