Package: tfimm
TensorFlow Image ModelsIntroductionUsageModelsProfilingLicenseContactIntroductionTensorFlow Image Models (tfimm) is a collection of image models with pretrained
weights, obtained by porting architectures fromtimmto TensorFlow. The hope is
that the number of available architectures will grow over time. For now, it contains
vision transformers (ViT, DeiT, CaiT, PVT and Swin Transformers), MLP-Mixer models
(MLP-Mixer, ResMLP, gMLP, PoolFormer and ConvMixer), various ResNet flavours (ResNet,
ResNeXt, ECA-ResNet, SE-ResNet), the EfficientNet family (including AdvProp,
NoisyStudent, Edge-TPU, V2 and Lite versions), MobileNet-V2, VGG, as well as the recent
ConvNeXt.tfimmhas now expanded beyond classification and also includes Segment
Anything.This work would not have been possible wihout Ross Wightman'stimmlibrary and the
work on PyTorch/TensorFlow interoperability in HuggingFace'stransformerrepository.
I tried to make sure all source material is acknowledged. Please let me know if I have
missed something.UsageInstallationThe package can be installed viapip,pipinstalltfimmTo load pretrained weights,timmneeds to be installed separately.Creating modelsTo load pretrained models useimporttfimmmodel=tfimm.create_model("vit_tiny_patch16_224",pretrained="timm")We can list available models with pretrained weights viaimporttfimmprint(tfimm.list_models(pretrained="timm"))Most models are pretrained on ImageNet or ImageNet-21k. If we want to use them for other
tasks we need to change the number of classes in the classifier or remove the
classifier altogether. We can do this by setting thenb_classesparameter increate_model. Ifnb_classes=0, the model will have no classification layer. Ifnb_classesis set to a value different from the default model config, the
classification layer will be randomly initialized, while all other weights will be
copied from the pretrained model.The preprocessing function for each model can be created viaimporttensorflowastfimporttfimmpreprocess=tfimm.create_preprocessing("vit_tiny_patch16_224",dtype="float32")img=tf.ones((1,224,224,3),dtype="uint8")img_preprocessed=preprocess(img)Saving and loading modelsAll models are subclassed fromtf.keras.Model(they arenotfunctional models).
They can still be saved and loaded using theSavedModelformat.>>> import tesnorflow as tf
>>> import tfimm
>>> model = tfimm.create_model("vit_tiny_patch16_224")
>>> type(model)
<class 'tfimm.architectures.vit.ViT'>
>>> model.save("/tmp/my_model")
>>> loaded_model = tf.keras.models.load_model("/tmp/my_model")
>>> type(loaded_model)
<class 'tfimm.architectures.vit.ViT'>For this to work, thetfimmlibrary needs to be imported before the model is loaded,
since during the import process,tfimmis registering custom models with Keras.
Otherwise, we obtain the following output>>> import tensorflow as tf
>>> loaded_model = tf.keras.models.load_model("/tmp/my_model")
>>> type(loaded_model)
<class 'keras.saving.saved_model.load.Custom>ViT'>ModelsThe following architectures are currently available:CaiT (vision transformer)[github]Going deeper with Image Transformers[arXiv:2103.17239]DeiT (vision transformer)[github]Training data-efficient image transformers & distillation through attention.[arXiv:2012.12877]ViT (vision transformer)[github]An Image is Worth 16x16 Words: Transformers for Image Recognition at Scale.[arXiv:2010.11929]How to train your ViT? Data, Augmentation, and Regularization in Vision
Transformers.[arXiv:2106.10270]Includes models trained with the SAM optimizer: Sharpness-Aware Minimization for
Efficiently Improving Generalization.[arXiv:2010.01412]Includes models from: ImageNet-21K Pretraining for the Masses[arXiv:2104.10972][github]Swin Transformer[github]Swin Transformer: Hierarchical Vision Transformer using Shifted Windows.[arXiv:2103.14030]Tensorflow code adapted fromSwin-Transformer-TFMLP-Mixer and friendsMLP-Mixer: An all-MLP Architecture for Vision[arXiv:2105.01601]ResMLP: Feedforward networks for image classification...[arXiv:2105.03404]Pay Attention to MLPs (gMLP)[arXiv:2105.08050]ConvMixer[github]Patches Are All You Need?[ICLR 2022 submission]EfficientNet familyEfficientNet: Rethinking Model Scaling for Convolutional Neural Networks[arXiv:1905.11946]Adversarial Examples Improve Image Recognition[arXiv:1911.09665]Self-training with Noisy Student improves ImageNet classification[arXiv:1911.04252]EfficientNet-EdgeTPU[Blog]EfficientNet-Lite[Blog]EfficientNetV2: Smaller Models and Faster Training[arXiv:2104.00298]MobileNet-V2MobileNetV2: Inverted Residuals and Linear Bottlenecks[arXiv:1801.04381]Pyramid Vision Transformer[github]Pyramid Vision Transformer: A Versatile Backbone for Dense Prediction without
Convolutions.[arXiv:2102.12122]PVTv2: Improved Baselines with Pyramid Vision Transformer[arXiv:2106.13797]ConvNeXt[github]A ConvNet for the 2020s.[arXiv:2201.03545]PoolFormer[github]PoolFormer: MetaFormer is Actually What You Need for Vision.[arXiv:2111.11418]Pooling-based Vision Transformers (PiT)Rethinking Spatial Dimensions of Vision Transformers.[arXiv:2103.16302]ResNet, ResNeXt, ECA-ResNet, SE-ResNet and friendsDeep Residual Learning for Image Recognition.[arXiv:1512.03385]Exploring the Limits of Weakly Supervised Pretraining.[arXiv:1805.00932]Billion-scale Semi-Supervised Learning for Image Classification.[arXiv:1905.00546]ECA-Net: Efficient Channel Attention for Deep Convolutional Neural Networks.[arXiv1910.03151]Revisiting ResNets.[arXiv:2103.07579]Making Convolutional Networks Shift-Invariant Again. (anti-aliasing layer)[arXiv:1904.11486]Squeeze-and-Excitation Networks.[arXiv:1709.01507]Big Transfer (BiT): General Visual Representation Learning[arXiv:1912.11370]Knowledge distillation: A good teacher is patient and consistent[arXiv:2106:05237]Segment Anything Model (SAM)[github]Segment Anything[arXiv:2304.02643]ProfilingTo understand how big each of the models is, I have done some profiling to measuremaximum batch size that fits in GPU memory andthroughput in images/second
for both inference and backpropagation on K80 and V100 GPUs. For V100, measurements
were done for bothfloat32and mixed precision.The results can be found in theresults/profiling_{k80, v100}.csvfiles.For backpropagation, we use as loss the mean of model outputsdefbackprop():withtf.GradientTape()astape:output=model(x,training=True)loss=tf.reduce_mean(output)grads=tape.gradient(loss,model.trainable_variables)optimizer.apply_gradients(zip(grads,model.trainable_variables))LicenseThis repository is released under the Apache 2.0 license as found in theLICENSEfile.ContactAll things related totfimmcan be discussed viaSlack.