clovaai/tunit
Rethinking the Truly Unsupervised Image-to-Image Translation - Official PyTorch Implementation
repo name | clovaai/tunit |
repo link | https://github.com/clovaai/tunit |
homepage | |
language | Python |
size (curr.) | 8460 kB |
stars (curr.) | 190 |
created | 2020-06-14 |
license | Other |
Rethinking the Truly Unsupervised Image-to-Image Translation
Each image is generated with the source image in the left and the average style vector of each cluster. The network is trained under fully unsupervised manner.
Official pytorch implementation of “Rethinking the Truly Unsupervised Image-to-Image Translation”
Rethinking the Truly Unsupervised Image-to-Image Translation
Kyungjune Baek1*, Yunjey Choi2, Youngjung Uh2, Jaejun Yoo3, Hyunjung Shim1
* Work done during his internship at Clova AI Research
1 Yonsei University
2 Clova AI Research, NAVER Corp.
3 EPFLAbsract Every recent image-to-image translation model uses either image-level (i.e. input-output pairs) or set-level (i.e. domain labels) supervision at minimum. However, even the set-level supervision can be a serious bottleneck for data collection in practice. In this paper, we tackle image-to-image translation in a fully unsupervised setting, i.e., neither paired images nor domain labels. To this end, we propose the truly unsupervised image-to-image translation(TUNIT) that simultaneously learns to separate image domains via an information-theoretic approach and generate corresponding images using the estimated domain labels. Experimental results on various datasets show that the proposed method successfully separates domains and translates images across those domains. Our model outperforms existing set-level supervised methods under a semi-supervised setting, where a subset of domain labels is provided.
Requirement
Library
pip install -r requirements.txt
* pytorch==1.1.0 or 1.2.0
* tqdm
* opencv-python
* scipy
* sklearn
* matplotlib
* pillow
* tensorboardX
Dataset
- This repo. utilizes the variant of “ImageFolder”.
- Download : AFHQ (StarGANv2) / AnimalFaces (FUNIT)
- Example directory hierarchy (AFHQ, AnimalFaces):
Project
|--- tunit
| |--- main.py
| |--- train
| |--- train_unsupervised.py
| |--- ...
|
|--- data
|--- afhq
|--- train
|--- test
|--- animal_faces
|--- n02085620
|--- n02085782
|--- ...
Then, call --data_path='../data'
Hardware
- This source code is mainly tested on V100 and P40.
How to Run (Quick Start)
After setting the dataset directory, the code can be easily run by the scripts below.
Train on local
Supervised
python main.py --gpu $GPU_TO_USE --p_semi 1.0 --dataset animal_faces --data_path='../data'
Semi-supervised
python main.py --gpu $GPU_TO_USE --p_semi 0.5 --dataset animal_faces --data_path='../data'
Unsupervised
python main.py --gpu $GPU_TO_USE --p_semi 0.0 --dataset animal_faces --data_path='../data'
Test on local
python main.py --gpu $GPU_TO_USE --validation --load_model $DIR_TO_LOAD --dataset animal_faces
Monitoring
tensorboard --logdir=$DIR/events --port=$PORT
Actual example
Train
python main.py --gpu 0 --dataset animal_faces --output_k 10 --data_path '../data' --p_semi 0.0
python main.py --gpu 0 --dataset afhq_cat --output_k 10 --data_path '../data' --p_semi 0.2
python main.py --gpu 1 --dataset animal_faces --data_path '../data' --p_semi 1.0
python main.py --gpu 0,1 --dataset summer2winter --output_k 2 --data_path '../data' --p_semi 0.0 --img_size 256 --batch_size 16 --ddp
Test
python main.py --gpu 0 --dataset animal_faces --output_k 10 --data_path '../data' --validation --load_model GAN_20190101_101010
python main.py --gpu 1 --dataset afhq_cat --output_k 10 --data_path '../data' --validation --load_model GAN_20190101_101010
python main.py --gpu 2 --dataset summer2winter --output_k 2 --data_path '../data' --validation --load_model GAN_20190101_101010
Monitoring - open terminal at ./tunit/logs
tensorboard --logdir=./GAN_20200101_101010/events
Pretrained Model
Download
- Download folders to load, then place the folder under ‘logs’.
Project
|--- tunit
| |--- main.py
| |--- logs
| |--- animalFaces10_0_00
| |--- checkpoint.txt
| |--- model_4568.ckpt
| |--- train
| |--- train_unsupervised.py
| |--- ...
Then, RUN
python main.py --gpu 0 --dataset animal_faces --output_k 10 --img_size 128 --data_path $DATAPATH --validation --load_model animalFaces10_0_00 --p_semi 0.0
How to run
AFHQ Cat
python main.py --gpu 0 --dataset afhq_cat --output_k 10 --img_size 128 --data_path $DATAPATH --validation --load_model afhq_cat_128
python main.py --gpu 0 --dataset afhq_cat --output_k 10 --img_size 256 --data_path $DATAPATH --validation --load_model afhq_cat_256
AFHQ Dog
python main.py --gpu 0 --dataset afhq_dog --output_k 10 --img_size 128 --data_path $DATAPATH --validation --load_model afhq_dog_128
python main.py --gpu 0 --dataset afhq_dog --output_k 10 --img_size 256 --data_path $DATAPATH --validation --load_model afhq_dog_256
AFHQ Wild
python main.py --gpu 0 --dataset afhq_wild --output_k 10 --img_size 128 --data_path $DATAPATH --validation --load_model afhq_wild_128
python main.py --gpu 0 --dataset afhq_wild --output_k 10 --img_size 256 --data_path $DATAPATH --validation --load_model afhq_wild_256
AnimalFaces-10
python main.py --gpu 0 --dataset animal_faces --output_k 10 --img_size 128 --data_path $DATAPATH --validation --load_model animalFaces10_0_00 --p_semi 0.0
python main.py --gpu 0 --dataset animal_faces --output_k 10 --img_size 128 --data_path $DATAPATH --validation --load_model animalFaces10_0_20 --p_semi 0.2
Explanation for codes
The validation generates 200 images per args.iters iterations. To reduce the number of images, please adjust the validation frequency. The checkpoint file is saved per ((args.epochs//10) * args.iters) iterations. Or comment out validation.py#L81 to validation.py#L162.
- For more classes on AnimalFaces, change the list at main.py#L227 then, set args.output_k to len(args.att_to_use)
- ex) args.att_to_use = [i for i in range(100)] then, run: python main.py –output_k 100 …
Arguments
- batch_size, img_size, data_path and p_semi are frequently speified.
- Please refer “help” of the arguments in main.py.
Code Structure
- main.py
- Execute main.py to run the codes.
- The script builds networks, optimizers and data loaders, and manages the checkpoint files.
- datasets
- custom_dataset.py
- Basically, it is the same as ImageFolder but contains remap procedure of class numbers.
- datasetgetter.py
- Returns dataset instance of the dataset specified by args.dataset.
- The instance returns original image, transformed image and its ground truth label.
- custom_dataset.py
- models
- blocks.py
- Blocks for building networks.
- This code is based on FUNIT repos.
- guidingNet.py
- Definition of guiding network.
- discriminator.py
- Definition of discriminator.
- The architecture is based on StarGANv2, but it contains two residual blocks for each resolution.
- generator.py
- Definition of generator.
- It consists of decoder, content encoder and MLP for AdaIN.
- This code is from FUNIT repos.
- blocks.py
- train
- train_unsupervised.py
- It is called by setting –p_semi to 0.0
- This mode does not utilize the labels at all.
- train_supervised.py
- It is called by setting –p_semi to 1.0
- This mode fully utilizes the labels.
- train_semisupervised.py
- It is called by setting –p_semi between 0.0 to 1.0.
- This mode utilizes (–p_semi * 100)% labels.
- train_unsupervised.py
- validation
- cluster_eval.py
- eval_metrics.py
- These two scripts contain the functions for evaluating the classification performance.
- These are from IIC repos.
- plot_tsne.py (can be removed)
- For plotting t-SNE.
- validation.py
- Generate fake samples and calculate FID.
- tools
- utils.py
- Functions and class for logger, make folders, averageMeter and add logs.
- ops.py
- Queue operation and loss functions.
- utils.py
- resrc
- For image files of README.md
You can change the adversarial loss by modifying calc_adv_loss in ops.py. For the different strategy of training, please refer the files in train.
Results
Each image is generated with the source image in left and the average vector of reference images. The network is trained under fully unsupervised manner.
License
TUNIT is distributed under MIT unless the header specifies another license.
Copyright (c) 2020-present NAVER Corp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORTd OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
The pretrained models is covered by Creative Commons BY-NC 4.0 license by NAVER Corporation. You can use, copy, tranform and build upon the material for non-commercial purposes as long as you give appropriate credit by citing our paper, and indicate if changes were made.
Citation
If you find this work useful for your research, please cite our paper:
@article{baek2020tunit,
title={Rethinking the Truly Unsupervised Image-to-Image Translation},
author={Kyungjune Baek and Yunjey Choi and Youngjung Uh and Jaejun Yoo and Hyunjung Shim},
journal={arXiv preprint arXiv:2006.06500},
year={2020}
}