This repository provides TensorFlow / Keras implementations of different DeiT
[1] variants from Touvron et al. It also provides the TensorFlow / Keras models that have been
populated with the original DeiT pre-trained params available from [2]. These
models are not blackbox SavedModels i.e., they can be fully expanded into tf.keras.Model
objects and one can call all the utility functions on them (example: .summary()).
As of today, all the TensorFlow / Keras variants of the DeiT models listed here are available in this repository.
Refer to the "Using the models" section to get started. You can also follow along with this tutorial: https://keras.io/examples/vision/deit/.
Updates
- April 29, 2022: This project received the Google OSS Expert prize.
- April 22, 2022: This project won the #TFCommunitySpotlight award.
- Conversion
- Collection of pre-trained models (converted from PyTorch to TensorFlow)
- Results of the converted models
- How to use the models?
- Training with DeiT
- References
- Acknowledgements
TensorFlow / Keras implementations are available in vit/vit_models.py and vit/deit_models.py.
Conversion utilities are in convert.py.
Find the models on TF-Hub here: https://tfhub.dev/sayakpaul/collections/deit/1. You can fully inspect the architecture of the TF-Hub models like so:
import tensorflow as tf
model_gcs_path = "gs://tfhub-modules/sayakpaul/deit_tiny_patch16_224/1/uncompressed"
model = tf.keras.models.load_model(model_gcs_path)
dummy_inputs = tf.ones((2, 224, 224, 3))
_ = model(dummy_inputs)
print(model.summary(expand_nested=True))Results are on ImageNet-1k validation set (top-1 accuracy).
| model_name | top1_acc(%) | top5_acc(%) | orig_top1_acc(%) | orig_top5_acc(%) | |
|---|---|---|---|---|---|
| 0 | deit_tiny_patch16_224 | 72.136 | 91.128 | 72.2 | 91.1 |
| 1 | deit_tiny_distilled_patch16_224 | 74.522 | 91.896 | 74.5 | 91.9 |
| 2 | deit_small_patch16_224 | 79.828 | 94.954 | 79.9 | 95 |
| 3 | deit_small_distilled_patch16_224 | 81.172 | 95.414 | 81.2 | 95.4 |
| 4 | deit_base_patch16_224 | 81.798 | 95.592 | 81.8 | 95.6 |
| 5 | deit_base_patch16_384 | 82.894 | 96.234 | 82.9 | 96.2 |
| 6 | deit_base_distilled_patch16_224 | 83.326 | 96.496 | 83.4 | 96.5 |
| 7 | deit_base_distilled_patch16_384 | 85.238 | 97.172 | 85.2 | 97.2 |
Results can be verified with the code in i1k_eval. Original results were sourced from [2].
Pre-trained models:
- Off-the-shelf classification: Colab Notebook
- Fine-tuning: Colab Notebook
These models also output attention weights from each of the Transformer blocks. Refer to this notebook for more details. Additionally, the notebook shows how to visualize the attention maps for a given image.
Randomly initialized models:
from vit.model_configs import base_config
from vit.deit_models import ViTDistilled
import tensorflow as tf
distilled_tiny_tf_config = base_config.get_config(
name="deit_tiny_distilled_patch16_224"
)
deit_tiny_distilled_patch16_224 = ViTDistilled(distilled_tiny_tf_config)
dummy_inputs = tf.ones((2, 224, 224, 3))
_ = deit_tiny_distilled_patch16_224(dummy_inputs)
print(deit_tiny_distilled_patch16_224.summary(expand_nested=True))To initialize a network with say, 5 classes do:
with distilled_tiny_tf_config.unlocked():
distilled_tiny_tf_config.num_classes = 5
deit_tiny_distilled_patch16_224 = ViTDistilled(distilled_tiny_tf_config)To view different model configurations, refer to convert_all_models.py.
You can refer to the notebooks/deit-trainer.ipynb notebok to get a sense of how distillation
is actually performed using DeiT. Additionally, that notebook also provides code in case you
wanted to train a model from scratch instead of distillation.
[1] DeiT paper: https://arxiv.org/abs/2012.12877
[2] Official DeiT code: https://github.com/facebookresearch/deit
- Aritra Roy Gosthipaty who was instrumental in implementing
some parts of the core ViT module (
vit.vit_models) for another project. timmlibrary source code for the awesome codebase.- ML-GDE program for providing GCP credits that supported my experiments.