Awesome

(Generic) EfficientNets for PyTorch

-- **NOTE** This repo is not being maintained --

Please use timm instead. It includes all of these model definitions (compatible weights) and much much more.

A 'generic' implementation of EfficientNet, MixNet, MobileNetV3, etc. that covers most of the compute/parameter efficient architectures derived from the MobileNet V1/V2 block sequence, including those found via automated neural architecture search.

All models are implemented by GenEfficientNet or MobileNetV3 classes, with string based architecture definitions to configure the block layouts (idea from here)

What's New

Aug 19, 2020

• Add updated PyTorch trained EfficientNet-B3 weights trained by myself with timm (82.1 top-1)
• Add PyTorch trained EfficientNet-Lite0 contributed by @hal-314 (75.5 top-1)
• Update ONNX and Caffe2 export / utility scripts to work with latest PyTorch / ONNX
• ONNX runtime based validation script added
• activations (mostly) brought in sync with timm equivalents

April 5, 2020

• Add some newly trained MobileNet-V2 models trained with latest h-params, rand augment. They compare quite favourably to EfficientNet-Lite
  • 3.5M param MobileNet-V2 100 @ 73%
  • 4.5M param MobileNet-V2 110d @ 75%
  • 6.1M param MobileNet-V2 140 @ 76.5%
  • 5.8M param MobileNet-V2 120d @ 77.3%

March 23, 2020

• Add EfficientNet-Lite models w/ weights ported from Tensorflow TPU
• Add PyTorch trained MobileNet-V3 Large weights with 75.77% top-1
• IMPORTANT CHANGE (if training from scratch) - weight init changed to better match Tensorflow impl, set fix_group_fanout=False in initialize_weight_goog for old behavior

Feb 12, 2020

• Add EfficientNet-L2 and B0-B7 NoisyStudent weights ported from Tensorflow TPU
• Port new EfficientNet-B8 (RandAugment) weights from TF TPU, these are different than the B8 AdvProp, different input normalization.
• Add RandAugment PyTorch trained EfficientNet-ES (EdgeTPU-Small) weights with 78.1 top-1. Trained by Andrew Lavin

Jan 22, 2020

• Update weights for EfficientNet B0, B2, B3 and MixNet-XL with latest RandAugment trained weights. Trained with (https://github.com/rwightman/pytorch-image-models)
• Fix torchscript compatibility for PyTorch 1.4, add torchscript support for MixedConv2d using ModuleDict
• Test models, torchscript, onnx export with PyTorch 1.4 -- no issues

Nov 22, 2019

• New top-1 high! Ported official TF EfficientNet AdvProp (https://arxiv.org/abs/1911.09665) weights and B8 model spec. Created a new set of ap models since they use a different preprocessing (Inception mean/std) from the original EfficientNet base/AA/RA weights.

Nov 15, 2019

• Ported official TF MobileNet-V3 float32 large/small/minimalistic weights
• Modifications to MobileNet-V3 model and components to support some additional config needed for differences between TF MobileNet-V3 and mine

Oct 30, 2019

• Many of the models will now work with torch.jit.script, MixNet being the biggest exception
• Improved interface for enabling torchscript or ONNX export compatible modes (via config)
• Add JIT optimized mem-efficient Swish/Mish autograd.fn in addition to memory-efficient autgrad.fn
• Activation factory to select best version of activation by name or override one globally
• Add pretrained checkpoint load helper that handles input conv and classifier changes

Oct 27, 2019

• Add CondConv EfficientNet variants ported from https://github.com/tensorflow/tpu/tree/master/models/official/efficientnet/condconv
• Add RandAug weights for TF EfficientNet B5 and B7 from https://github.com/tensorflow/tpu/tree/master/models/official/efficientnet
• Bring over MixNet-XL model and depth scaling algo from my pytorch-image-models code base
• Switch activations and global pooling to modules
• Add memory-efficient Swish/Mish impl
• Add as_sequential() method to all models and allow as an argument in entrypoint fns
• Move MobileNetV3 into own file since it has a different head
• Remove ChamNet, MobileNet V2/V1 since they will likely never be used here

Models

Implemented models include:

• EfficientNet NoisyStudent (B0-B7, L2) (https://arxiv.org/abs/1911.04252)
• EfficientNet AdvProp (B0-B8) (https://arxiv.org/abs/1911.09665)
• EfficientNet (B0-B8) (https://arxiv.org/abs/1905.11946)
• EfficientNet-EdgeTPU (S, M, L) (https://ai.googleblog.com/2019/08/efficientnet-edgetpu-creating.html)
• EfficientNet-CondConv (https://arxiv.org/abs/1904.04971)
• EfficientNet-Lite (https://github.com/tensorflow/tpu/tree/master/models/official/efficientnet/lite)
• MixNet (https://arxiv.org/abs/1907.09595)
• MNASNet B1, A1 (Squeeze-Excite), and Small (https://arxiv.org/abs/1807.11626)
• MobileNet-V3 (https://arxiv.org/abs/1905.02244)
• FBNet-C (https://arxiv.org/abs/1812.03443)
• Single-Path NAS (https://arxiv.org/abs/1904.02877)

I originally implemented and trained some these models with code here, this repository contains just the GenEfficientNet models, validation, and associated ONNX/Caffe2 export code.

Pretrained

I've managed to train several of the models to accuracies close to or above the originating papers and official impl. My training code is here: https://github.com/rwightman/pytorch-image-models

More pretrained models to come...

Ported Weights

The weights ported from Tensorflow checkpoints for the EfficientNet models do pretty much match accuracy in Tensorflow once a SAME convolution padding equivalent is added, and the same crop factors, image scaling, etc (see table) are used via cmd line args.

IMPORTANT:

• Tensorflow ported weights for EfficientNet AdvProp (AP), EfficientNet EdgeTPU, EfficientNet-CondConv, EfficientNet-Lite, and MobileNet-V3 models use Inception style (0.5, 0.5, 0.5) for mean and std.
• Enabling the Tensorflow preprocessing pipeline with --tf-preprocessing at validation time will improve scores by 0.1-0.5%, very close to original TF impl.

To run validation for tf_efficientnet_b5: python validate.py /path/to/imagenet/validation/ --model tf_efficientnet_b5 -b 64 --img-size 456 --crop-pct 0.934 --interpolation bicubic

To run validation w/ TF preprocessing for tf_efficientnet_b5: python validate.py /path/to/imagenet/validation/ --model tf_efficientnet_b5 -b 64 --img-size 456 --tf-preprocessing

To run validation for a model with Inception preprocessing, ie EfficientNet-B8 AdvProp: python validate.py /path/to/imagenet/validation/ --model tf_efficientnet_b8_ap -b 48 --num-gpu 2 --img-size 672 --crop-pct 0.954 --mean 0.5 --std 0.5

*tfp models validated with tf-preprocessing pipeline

Google tf and tflite weights ported from official Tensorflow repositories

• https://github.com/tensorflow/tpu/tree/master/models/official/mnasnet
• https://github.com/tensorflow/tpu/tree/master/models/official/efficientnet
• https://github.com/tensorflow/models/tree/master/research/slim/nets/mobilenet

Usage

Environment

All development and testing has been done in Conda Python 3 environments on Linux x86-64 systems, specifically Python 3.6.x, 3.7.x, 3.8.x.

Users have reported that a Python 3 Anaconda install in Windows works. I have not verified this myself.

PyTorch versions 1.4, 1.5, 1.6 have been tested with this code.

I've tried to keep the dependencies minimal, the setup is as per the PyTorch default install instructions for Conda:

conda create -n torch-env
conda activate torch-env
conda install -c pytorch pytorch torchvision cudatoolkit=10.2

PyTorch Hub

Models can be accessed via the PyTorch Hub API

>>> torch.hub.list('rwightman/gen-efficientnet-pytorch')
['efficientnet_b0', ...]
>>> model = torch.hub.load('rwightman/gen-efficientnet-pytorch', 'efficientnet_b0', pretrained=True)
>>> model.eval()
>>> output = model(torch.randn(1,3,224,224))

Pip

This package can be installed via pip.

Install (after conda env/install):

pip install geffnet

Eval use:

>>> import geffnet
>>> m = geffnet.create_model('mobilenetv3_large_100', pretrained=True)
>>> m.eval()

Train use:

>>> import geffnet
>>> # models can also be created by using the entrypoint directly
>>> m = geffnet.efficientnet_b2(pretrained=True, drop_rate=0.25, drop_connect_rate=0.2)
>>> m.train()

Create in a nn.Sequential container, for fast.ai, etc:

>>> import geffnet
>>> m = geffnet.mixnet_l(pretrained=True, drop_rate=0.25, drop_connect_rate=0.2, as_sequential=True)

Exporting

Scripts are included to

• export models to ONNX (onnx_export.py)
• optimized ONNX graph (onnx_optimize.py or onnx_validate.py w/ --onnx-output-opt arg)
• validate with ONNX runtime (onnx_validate.py)
• convert ONNX model to Caffe2 (onnx_to_caffe.py)
• validate in Caffe2 (caffe2_validate.py)
• benchmark in Caffe2 w/ FLOPs, parameters output (caffe2_benchmark.py)

As an example, to export the MobileNet-V3 pretrained model and then run an Imagenet validation:

python onnx_export.py --model mobilenetv3_large_100 ./mobilenetv3_100.onnx
python onnx_validate.py /imagenet/validation/ --onnx-input ./mobilenetv3_100.onnx 

These scripts were tested to be working as of PyTorch 1.6 and ONNX 1.7 w/ ONNX runtime 1.4. Caffe2 compatible export now requires additional args mentioned in the export script (not needed in earlier versions).

Export Notes

1. The TF ported weights with the 'SAME' conv padding activated cannot be exported to ONNX unless _EXPORTABLE flag in config.py is set to True. Use config.set_exportable(True) as in the onnx_export.py script.
2. TF ported models with 'SAME' padding will have the padding fixed at export time to the resolution used for export. Even though dynamic padding is supported in opset >= 11, I can't get it working.
3. ONNX optimize facility doesn't work reliably in PyTorch 1.6 / ONNX 1.7. Fortunately, the onnxruntime based inference is working very well now and includes on the fly optimization.
4. ONNX / Caffe2 export/import frequently breaks with different PyTorch and ONNX version releases. Please check their respective issue trackers before filing issues here.