This repository is a codebase for modern image deep networks, which is used in our paper "Demystify Transformers & Convolutions in Modern Image Deep Networks". In this paper, we develop a unified architecture for different spatial token mixing paradigms, and make various comparisons and analyses for these "spatial token mixers".
Recently, a series of transformer-based vision backbones with novel spatial feature aggregation paradigms (spatial token mixer, STM) are proposed and report remarkable performance. However, network engineering techniques can also improve their performance significantly. Some works also argue simple STM can attain competitive performance with proper design. Hence, we aim to identify the real difference and performance gains among different STMs under a unified and optimized overall design (architecture and training recipes). Hence, we elaborate a unified architecture, upon which a series of STMs are fit into it for comparisons and analyses.
- Halo Attention, a local attention STM from HaloNet.
- Spatial Reduction Attention, a global attention STM from PVT.
- Shifted Window Attention, a local attention STM from Swin Transformer.
- Depth-Wise Convolution, which has been proven to be a simple yet effective STM by ConvNeXt.
- Deformable Convolution v3 (DCNv3, to be added), which is a recent dynamic convolution operator used in InternImage.
- [2022.12.30] The code for ImageNet-1k classification is released.
- [2022.12.30] The code for COCO object detection is released.
- [TODO] DCNv3 from InternImage will be supported.
- A unified architecture for spatial token mixers, which shows better performance compared with the original implementations.
- A re-implemented Halo-Attention (HaloNet) yields strong performance.
- Developing new spatial token mixers.
- Using the pretrained models for downstream tasks.
We suggest the python 3.8 environments with the following packages:
- torch>=1.7.0; torchvision>=0.8.0 (Follow official guide to install PyTorch, GPU version recommended)
- pytorch-image-models (
pip install timm=0.6.7) - pyyaml (
pip install pyyaml) - opencv-python (
pip install opencv-python) Packages with different versions may also work. We only test the aforementioned version.
ImageNet with the following folder structure, and you can extract ImageNet by this script.
│imagenet/
├──meta/
| ├──train.txt
│ ├──val.txt
├──train/
│ ├── n01440764
│ │ ├── n01440764_10026.JPEG
│ │ ├── n01440764_10027.JPEG
│ │ ├── ......
│ ├── ......
├──val/
│ ├── n01440764
│ │ ├── ILSVRC2012_val_00000293.JPEG
│ │ ├── ILSVRC2012_val_00002138.JPEG
│ │ ├── ......
│ ├── ......
You can refer to the models folder to create any stand-alone models, and then load them with the pre-trained weights. All the pre-trained weights can be found here.
| U-HaloNet | U-PVT | U-Swin Transformer | U-ConvNeXt | U-InternImage | |
|---|---|---|---|---|---|
| Micro (~4.5M) | 75.8% | Download | 72.8% | Download | 74.4% | Download | 75.1% | Download | 75.3% | Preparing |
| Tiny (~30M) | 83.0% | Download | 82.1% | Download | 82.3% | Download | 82.2% | Download | 83.3% | Preparing |
| Small (~50M) | 84.0% | Download | 83.2% | Download | 83.3% | Download | 83.1% | Download | 84.1% | Preparing |
| Base (~100M) | 84.6% | Download | 83.4% | Download | 83.7% | Download | 83.7% | Download | 84.5% | Preparing |
You can use the shell scripts in shell/eval to evaluate the model. The provided code works with slurm. If you are using a slurm-supported cluster to run the model, please modify the virtual partition and checkpoint path. For example, to evaluate HaloNet-Tiny on ImageNet-1k, you use the following command:
cd ./classification
sh ./shell/eval/eval.sh $MODEL_NAME$
The $MODEL_NAME$ for different models are listed as follows:
| U-HaloNet | U-PVT | U-Swin Transformer | U-ConvNeXt | U-InternImage | |
|---|---|---|---|---|---|
| Micro (~4.5M) | unified_halo_micro | unified_pvt_micro | unified_swin_micro | unified_convnext_micro | Organizing |
| Tiny (~30M) | unified_halo_tiny | unified_pvt_tiny | unified_swin_tiny | unified_convnext_tiny | Organizing |
| Small (~50M) | unified_halo_small | unified_pvt_small | unified_swin_small | unified_convnext_small | Organizing |
| Base (~100M) | unified_halo_base | unified_pvt_base | unified_swin_base | unified_convnext_base | Organizing |
Currently, this repository only supports ImageNet-1k training. ImageNet-21k training will be updated soon. You can use the shell scripts in shell/1k_pretrain to reproduce our results. For example, if you want to train HaloNet-Tiny, you can use the following command:
cd ./classification
sh ./shell/1k_pretrain/transformer.sh $MODEL_NAME$
Remember to modify the output directory and the virtual partition. The scripts also work with slurm, you can use PyTorch official DDP mechanism to launch the training with some modifications, refer to ConvNeXt for details.
Plese refer this guide the train and evaluate the models on object detection.
If you find our work or models useful, please consider citing our paper as follows:
@article{hu2022demystify,
title={Demystify Transformers \& Convolutions in Modern Image Deep Networks},
author={Hu, Xiaowei and Shi, Min and Wang, Weiyun and Wu, Sitong and Xing, Linjie and Wang, Wenhai and Zhu, Xizhou and Lu, Lewei and Zhou, Jie and Wang, Xiaogang and Qiao, Yu and Dai, Jifeng},
journal={arXiv preprint arXiv:2211.05781},
year={2022}
}
- A large part of our code is borrowed from Timm library (pytorch-image-models) and DeiT implementation (code).
- We partly refer to the unofficial HaloNet implementation of timm lib (code) and lucidrains (code) when re-producing Halo-attention.