- Linux
- Python 3
- CPU or NVIDIA GPU + CUDA CuDNN
Please refer to our README for the installation, dataset preparations, and the evaluation (FID and mIoU).
Below we show the full pipeline for compressing pix2pix, cycleGAN and GauGAN models. We provide pre-trained models after some steps. You could use the pretrained models to skip some steps.
In fact, several steps including "Train a MobileNet Teacher Model", "Pre-distillation", and "Fine-tuning the Best Model" may be omitted from the whole pipeline. Please check fast_gan_compression.md for our improved pipeline Fast GAN Compression. For more details about the differences between GAN Compression and Fast GAN Compression, please refer to Section 4.1 Pipelines of our paper.
We will show the whole pipeline on edges2shoes-r
dataset. You could change the dataset name to other datasets (map2sat
and cityscapes
).
Train a MobileNet-style teacher model from scratch.
bash scripts/pix2pix/edges2shoes-r/train_mobile.sh
We provide a pre-trained teacher for each dataset. You could download the pre-trained model by
python scripts/download_model.py --model pix2pix --task edges2shoes-r --stage mobile
and test the model by
bash scripts/pix2pix/edges2shoes-r/test_mobile.sh
(Optional) Distill and prune the original MobileNet-style model to make the model compact.
bash scripts/pix2pix/edges2shoes-r/distill.sh
You could test the distilled model by
bash scripts/pix2pix/edges2shoes-r/test_distill.sh
Train a "once-for-all" network from a pre-trained student model to search for the efficient architectures.
bash scripts/pix2pix/edges2shoes-r/train_supernet.sh
Evaluate all the candidate sub-networks given a specific configuration
bash scripts/pix2pix/edges2shoes-r/search.sh
The search result will be stored in the python pickle
form. The pickle file is a python list
object that stores all the candidate sub-networks information, whose element is a python dict
object in the form of
{'config_str': $config_str, 'macs': $macs, 'fid'/'mIoU': $fid_or_mIoU}
such as
{'config_str': '32_32_48_32_48_48_16_16', 'macs': 4993843200, 'fid': 25.224261423597483}
'config_str'
is a channel configuration description to identify a specific subnet within the "once-for-all" network.
To accelerate the search process, you may need to want to search the sub-networks on multiple GPUs. You could manually split the search space with search.py. All you need to do is add additional arguments --num_splits
and --split
. For example, if you need to search the sub-networks with 2 GPUs, you could use the following commands:
-
On the first GPU:
python search.py --dataroot database/edges2shoes-r \ --restore_G_path logs/pix2pix/edges2shoes-r/supernet/checkpoints/latest_net_G.pth \ --output_path logs/pix2pix/edges2shoes-r/supernet/pkls/result0.pkl \ --ngf 48 --batch_size 32 \ --config_set channels-48 \ --real_stat_path real_stat/edges2shoes-r_B.npz \ --num_splits 2 --split 0
-
On the second GPU:
python search.py --dataroot database/edges2shoes-r \ --restore_G_path logs/pix2pix/edges2shoes-r/supernet/checkpoints/latest_net_G.pth \ --output_path logs/pix2pix/edges2shoes-r/supernet/pkls/result1.pkl \ --ngf 48 --batch_size 32 \ --config_set channels-48 \ --real_stat_path real_stat/edges2shoes-r_B.npz \ --num_splits 2 --split 1 --gpu_ids 1
Then you could merge the search results with merge.py
python merge.py --input_dir logs/pix2pix/edges2shoes-r/supernet/pkls \
--output_path logs/cycle_gan/horse2zebra/supernet
You could use our auxiliary script select_arch.py to select the architecture you want.
python select_arch.py --macs 5.7e9 --fid 30 \ # macs <= 5.7e9(10x), fid >= 30
--pkl_path logs/pix2pix/edges2shoes-r/supernet/result.pkl
(Optional) Fine-tune a specific subnet within the pre-trained "once-for-all" network. To further improve the performance of your chosen subnet, you may need to fine-tune the subnet. For example, if you want to fine-tune a subnet within the "once-for-all" network with 'config_str': 32_32_48_32_48_48_16_16
, use the following command:
bash scripts/pix2pix/edges2shoes-r/finetune.sh 32_32_48_32_48_48_16_16
Extract a subnet from the "once-for-all" network. We provide a code export.py to extract a specific subnet according to a configuration description. For example, if the config_str
of your chosen subnet is 32_32_48_32_48_48_16_16
, then you can export the model by this command:
bash scripts/pix2pix/edges2shoes-r/export.sh 32_32_48_32_48_48_16_16
For the Cityscapes dataset, you need to specify additional options to support mIoU evaluation while training. Please refer to the scripts in scripts/pix2pix/cityscapes for more details.
The whole pipeline is almost identical to pix2pix. We will show the pipeline on horse2zebra
dataset.
Train a MobileNet-style teacher model from scratch.
bash scripts/cycle_gan/horse2zebra/train_mobile.sh
We provide a pre-trained teacher model for each dataset. You could download the model using
python scripts/download_model.py --model cycle_gan --task horse2zebra --stage mobile
and test the model by
bash scripts/cycle_gan/horse2zebra/test_mobile.sh
(Optional) Distill and prune the MobileNet-style model to make the model compact.
bash scripts/cycle_gan/horse2zebra/distill.sh
You could test the distilled model by
bash scripts/cycle_gan/horse2zebra/test_distill.sh
Train a "once-for-all" network from a pre-trained student model to search for the efficient architectures.
bash scripts/cycle_gan/horse2zebra/train_supernet.sh
Evaluate all the candidate sub-networks given a specific configuration
bash scripts/cycle_gan/horse2zebra/search.sh
To support multi-GPU search, you could manually split the search space with additional arguments --num_splits
and --split
and merge them with merge.py, which is the same as pix2pix.
You could also use our auxiliary script select_arch.py to select the architecture you want. The usage is the same as pix2pix.
(Optional) Fine-tune a specific subnet within the pre-trained "once-for-all" network. For example, if you want to fine-tune a subnet within the "once-for-all" network with 'config_str': 32_32_48_32_48_48_16_16
, try the following command:
bash scripts/cycle_gan/horse2zebra/finetune.sh 16_16_32_16_32_32_16_16
During our experiments, we observe that fine-tuning the model on horse2zebra increases FID. You may skip the fine-tuning.
Extract a subnet from the supernet. We provide a code export.py to extract a specific subnet according to a configuration description. For example, if the config_str
of your chosen subnet is 16_16_32_16_32_32_16_16
, then you can export the model by this command:
bash scripts/cycle_gan/horse2zebra/export.sh 16_16_32_16_32_32_16_16
The whole pipeline is almost identical to the above two. We will show the pipeline on cityscapes
dataset.
Train a MobileNet-style teacher model from scratch.
bash scripts/gaugan/cityscapes/train_mobile.sh
We provide a pre-trained teacher model for each dataset. You could download the model using
python scripts/download_model.py --model gaugan --task cityscapes --stage mobile
and test the model by
bash scripts/gaugan/cityscapes/test_mobile.sh
(Optional) Distill and prune the MobileNet-style model to make the model compact.
bash scripts/gaugan/cityscapes/distill.sh
You could test the distilled model by
bash scripts/gaugan/cityscapes/test_distill.sh
Train a "once-for-all" network from a pre-trained student model to search for the efficient architectures.
bash scripts/gaugan/cityscapes/train_supernet.sh
Evaluate all the candidate sub-networks given a specific configuration (e.g., MACs and FID).
bash scripts/gaugan/cityscapes/search.sh
To support multi-GPU search, you could manually split the search space with additional arguments --num_splits
and --split
and merge them with merge.py, which is the same as pix2pix.
You could also use our auxiliary script select_arch.py to select the architecture you want. The usage is the same as pix2pix.
(Optional) Fine-tune a specific subnet within the pre-trained "once-for-all" network. For example, if you want to fine-tune a subnet within the "once-for-all" network with 'config_str': 32_32_48_32_48_48_16_16
, try the following command:
bash scripts/gaugan/cityscapes/finetune.sh 32_40_40_32_40_24_32_24
Extract a subnet from the supernet. We provide a code export.py to extract a specific subnet according to a configuration description. For example, if the config_str
of your chosen subnet is 32_40_40_32_40_24_32_24
, then you can export the model by this command:
bash scripts/gaugan/cityscapes/export.sh 32_40_40_32_40_24_32_24