Repository files navigation

About |Documentation |Tutorial |Gallery |Paper

Mimicry is a lightweight PyTorch library aimed towards the reproducibility of GAN research.

Comparing GANs is often difficult - mild differences in implementations and evaluation methodologies can result in huge performance differences. Mimicry aims to resolve this by providing: (a) Standardized implementations of popular GANs that closely reproduce reported scores; (b) Baseline scores of GANs trained and evaluated under thesame conditions; (c) A framework for researchers to focus onimplementation of GANs without rewriting most of GAN training boilerplate code, with support for multiple GAN evaluation metrics.

We provide a model zoo and set ofbaselines to benchmark different GANs of the same model size trained under the same conditions, using multiple metrics. To ensurereproducibility, we verify scores of our implemented models against reported scores in literature.

The library can be installed with:

pip install git+https://github.com/kwotsin/mimicry.git

See alsosetup information for more.

Training a popular GAN likeSNGAN thatreproduces reported scores can be done as simply as:

importtorchimporttorch.optimasoptimimporttorch_mimicryasmmcfromtorch_mimicry.netsimportsngan# Data handling objectsdevice=torch.device('cuda:0'iftorch.cuda.is_available()else"cpu")dataset=mmc.datasets.load_dataset(root='./datasets',name='cifar10')dataloader=torch.utils.data.DataLoader(dataset,batch_size=64,shuffle=True,num_workers=4)# Define models and optimizersnetG=sngan.SNGANGenerator32().to(device)netD=sngan.SNGANDiscriminator32().to(device)optD=optim.Adam(netD.parameters(),2e-4,betas=(0.0,0.9))optG=optim.Adam(netG.parameters(),2e-4,betas=(0.0,0.9))# Start trainingtrainer=mmc.training.Trainer(netD=netD,netG=netG,optD=optD,optG=optG,n_dis=5,num_steps=100000,lr_decay='linear',dataloader=dataloader,log_dir='./log/example',device=device)trainer.train()# Evaluate fidmmc.metrics.evaluate(metric='fid',log_dir='./log/example',netG=netG,dataset='cifar10',num_real_samples=50000,num_fake_samples=50000,evaluate_step=100000,device=device)

Example outputs:

>>> INFO: [Epoch 1/127][Global Step: 10/100000]| D(G(z)): 0.5941| D(x): 0.9303| errD: 1.4052| errG: -0.6671| lr_D: 0.0002| lr_G: 0.0002| (0.4550 sec/idx)^CINFO: Saving checkpoints from keyboard interrupt...INFO: Training Ended

Tensorboard visualizations:

tensorboard --logdir=./log/example

See further details inexample script, as well as a detailedtutorial on implementing a custom GAN from scratch.

• Evaluating a pre-trained generator model
• Evaluation using custom datasets
• Implementing, training and evaluating a custom GAN

For a fair comparison, we train all models under the same training conditions for each dataset, each implemented using ResNet backbones of the same architectural capacity. We train our models with the Adam optimizer using the popular hyperparameters (β₁, β₂) = (0.0, 0.9). n_dis represents the number of discriminator update steps per generator update step, and n_iter is simply the number of training iterations.

*Conditional GAN scores are only reported for labelled datasets.

*Inception Score can be a poor indicator of GAN performance, as it does not measure diversity and is not domain agnostic. This is why certain datasets with only a single class (e.g. CelebA and LSUN-Bedroom) will perform poorly when using this metric.

Paper |Dataset

Paper |Dataset

Paper |Dataset

Paper |Dataset

Paper |Dataset

Paper |Dataset

To verify our implementations, we reproduce reported scores in literature by re-implementing the models with the same architecture, training them under the same conditions and evaluate them on CIFAR-10 using the exact same methodology for computing FID.

As FID produces highly biased estimates (where using larger samples lead to a lower score), we reproduce the scores using the same sample sizes, where n_real and n_fake refers to the number of real and fake images used respectively for computing FID.

^† Best FID was reported at 53K steps, but we find our score can improve till 100K steps to achieve 23.13 ± 0.13.

If you have found this work useful, please consider citingour work:

@article{lee2020mimicry,    title={Mimicry: Towards the Reproducibility of GAN Research},    author={Kwot Sin Lee and Christopher Town},    booktitle={CVPR Workshop on AI for Content Creation},    year={2020},}

For citingInfoMax-GAN:

@InProceedings{Lee_2021_WACV,    author    = {Lee, Kwot Sin and Tran, Ngoc-Trung and Cheung, Ngai-Man},    title     = {InfoMax-GAN: Improved Adversarial Image Generation via Information Maximization and Contrastive Learning},    booktitle = {Proceedings of the IEEE/CVF Winter Conference on Applications of Computer Vision (WACV)},    month     = {January},    year      = {2021},    pages     = {3942-3952}}

[1] Spectral Normalization for Generative Adversarial Networks

[2] cGANs with Projection Discriminator

[3] Self-Supervised GANs via Auxiliary Rotation Loss

[4] A Large-Scale Study on Regularization and Normalization in GANs

[5] InfoMax-GAN: Improved Adversarial Image Generation via Information Maximization and Contrastive Learning

[6] GANs Trained by a Two Time-Scale Update Rule Converge to a Local Nash Equilibrium