Bringing-Old-Photos-Back-to-Life README

The project's README from github.com/microsoft/Bringing-Old-Photos-Back-to-Life. As one markdown file: README.md.

Old Photo Restoration (Official PyTorch Implementation)

Project Page | Paper (CVPR version) | Paper (Journal version) | Pretrained Model | Colab Demo | Replicate Demo & Docker Image :fire:

Bringing Old Photos Back to Life, CVPR2020 (Oral)

Old Photo Restoration via Deep Latent Space Translation, TPAMI 2022

Ziyu Wan1, Bo Zhang2, Dongdong Chen3, Pan Zhang4, Dong Chen2, Jing Liao1, Fang Wen2
1City University of Hong Kong, 2Microsoft Research Asia, 3Microsoft Cloud AI, 4USTC

:sparkles: News

2022.3.31: Our new work regarding old film restoration will be published in CVPR 2022. For more details, please refer to the project website and github repo.

The framework now supports the restoration of high-resolution input.

Training code is available and welcome to have a try and learn the training details.

You can now play with our Colab and try it on your photos.

Requirement

The code is tested on Ubuntu with Nvidia GPUs and CUDA installed. Python>=3.6 is required to run the code.

Installation

Clone the Synchronized-BatchNorm-PyTorch repository for

cd Face_Enhancement/models/networks/
git clone https://github.com/vacancy/Synchronized-BatchNorm-PyTorch
cp -rf Synchronized-BatchNorm-PyTorch/sync_batchnorm .
cd ../../../

cd Global/detection_models
git clone https://github.com/vacancy/Synchronized-BatchNorm-PyTorch
cp -rf Synchronized-BatchNorm-PyTorch/sync_batchnorm .
cd ../../

Download the landmark detection pretrained model

cd Face_Detection/
wget http://dlib.net/files/shape_predictor_68_face_landmarks.dat.bz2
bzip2 -d shape_predictor_68_face_landmarks.dat.bz2
cd ../

Download the pretrained model, put the file Face_Enhancement/checkpoints.zip under ./Face_Enhancement, and put the file Global/checkpoints.zip under ./Global. Then unzip them respectively.

cd Face_Enhancement/
wget https://github.com/microsoft/Bringing-Old-Photos-Back-to-Life/releases/download/v1.0/face_checkpoints.zip
unzip face_checkpoints.zip
cd ../
cd Global/
wget https://github.com/microsoft/Bringing-Old-Photos-Back-to-Life/releases/download/v1.0/global_checkpoints.zip
unzip global_checkpoints.zip
cd ../

Install dependencies:

pip install -r requirements.txt

:rocket: How to use?

Note: GPU can be set 0 or 0,1,2 or 0,2; use -1 for CPU

1) Full Pipeline

You could easily restore the old photos with one simple command after installation and downloading the pretrained model.

For images without scratches:

python run.py --input_folder [test_image_folder_path] \
              --output_folder [output_path] \
              --GPU 0

For scratched images:

python run.py --input_folder [test_image_folder_path] \
              --output_folder [output_path] \
              --GPU 0 \
              --with_scratch

For high-resolution images with scratches:

python run.py --input_folder [test_image_folder_path] \
              --output_folder [output_path] \
              --GPU 0 \
              --with_scratch \
              --HR

Note: Please try to use the absolute path. The final results will be saved in ./output_path/final_output/. You could also check the produced results of different steps in output_path.

2) Scratch Detection

Currently we don't plan to release the scratched old photos dataset with labels directly. If you want to get the paired data, you could use our pretrained model to test the collected images to obtain the labels.

cd Global/
python detection.py --test_path [test_image_folder_path] \
                    --output_dir [output_path] \
                    --input_size [resize_256|full_size|scale_256]

3) Global Restoration

A triplet domain translation network is proposed to solve both structured degradation and unstructured degradation of old photos.

cd Global/
python test.py --Scratch_and_Quality_restore \
               --test_input [test_image_folder_path] \
               --test_mask [corresponding mask] \
               --outputs_dir [output_path]

python test.py --Quality_restore \
               --test_input [test_image_folder_path] \
               --outputs_dir [output_path]

4) Face Enhancement

We use a progressive generator to refine the face regions of old photos. More details could be found in our journal submission and ./Face_Enhancement folder.

NOTE: This repo is mainly for research purpose and we have not yet optimized the running performance.

Since the model is pretrained with 256*256 images, the model may not work ideally for arbitrary resolution.

5) GUI

A user-friendly GUI which takes input of image by user and shows result in respective window.

How it works:

  1. Run GUI.py file.
  2. Click browse and select your image from test_images/old_w_scratch folder to remove scratches.
  3. Click Modify Photo button.
  4. Wait for a while and see results on GUI window.
  5. Exit window by clicking Exit Window and get your result image in output folder.

How to train?

1) Create Training File

Put the folders of VOC dataset, collected old photos (e.g., Real_L_old and Real_RGB_old) into one shared folder. Then

cd Global/data/
python Create_Bigfile.py

Note: Remember to modify the code based on your own environment.

2) Train the VAEs of domain A and domain B respectively

cd ..
python train_domain_A.py --use_v2_degradation --continue_train --training_dataset domain_A --name domainA_SR_old_photos --label_nc 0 --loadSize 256 --fineSize 256 --dataroot [your_data_folder] --no_instance --resize_or_crop crop_only --batchSize 100 --no_html --gpu_ids 0,1,2,3 --self_gen --nThreads 4 --n_downsample_global 3 --k_size 4 --use_v2 --mc 64 --start_r 1 --kl 1 --no_cgan --outputs_dir [your_output_folder] --checkpoints_dir [your_ckpt_folder]

python train_domain_B.py --continue_train --training_dataset domain_B --name domainB_old_photos --label_nc 0 --loadSize 256 --fineSize 256 --dataroot [your_data_folder]  --no_instance --resize_or_crop crop_only --batchSize 120 --no_html --gpu_ids 0,1,2,3 --self_gen --nThreads 4 --n_downsample_global 3 --k_size 4 --use_v2 --mc 64 --start_r 1 --kl 1 --no_cgan --outputs_dir [your_output_folder]  --checkpoints_dir [your_ckpt_folder]

Note: For the --name option, please ensure your experiment name contains "domainA" or "domainB", which will be used to select different dataset.

3) Train the mapping network between domains

Train the mapping without scratches:

python train_mapping.py --use_v2_degradation --training_dataset mapping --use_vae_which_epoch 200 --continue_train --name mapping_quality --label_nc 0 --loadSize 256 --fineSize 256 --dataroot [your_data_folder] --no_instance --resize_or_crop crop_only --batchSize 80 --no_html --gpu_ids 0,1,2,3 --nThreads 8 --load_pretrainA [ckpt_of_domainA_SR_old_photos] --load_pretrainB [ckpt_of_domainB_old_photos] --l2_feat 60 --n_downsample_global 3 --mc 64 --k_size 4 --start_r 1 --mapping_n_block 6 --map_mc 512 --use_l1_feat --niter 150 --niter_decay 100 --outputs_dir [your_output_folder] --checkpoints_dir [your_ckpt_folder]

Traing the mapping with scraches:

python train_mapping.py --no_TTUR --NL_res --random_hole --use_SN --correlation_renormalize --training_dataset mapping --NL_use_mask --NL_fusion_method combine --non_local Setting_42 --use_v2_degradation --use_vae_which_epoch 200 --continue_train --name mapping_scratch --label_nc 0 --loadSize 256 --fineSize 256 --dataroot [your_data_folder] --no_instance --resize_or_crop crop_only --batchSize 36 --no_html --gpu_ids 0,1,2,3 --nThreads 8 --load_pretrainA [ckpt_of_domainA_SR_old_photos] --load_pretrainB [ckpt_of_domainB_old_photos] --l2_feat 60 --n_downsample_global 3 --mc 64 --k_size 4 --start_r 1 --mapping_n_block 6 --map_mc 512 --use_l1_feat --niter 150 --niter_decay 100 --outputs_dir [your_output_folder] --checkpoints_dir [your_ckpt_folder] --irregular_mask [absolute_path_of_mask_file]

Traing the mapping with scraches (Multi-Scale Patch Attention for HR input):

python train_mapping.py --no_TTUR --NL_res --random_hole --use_SN --correlation_renormalize --training_dataset mapping --NL_use_mask --NL_fusion_method combine --non_local Setting_42 --use_v2_degradation --use_vae_which_epoch 200 --continue_train --name mapping_Patch_Attention --label_nc 0 --loadSize 256 --fineSize 256 --dataroot [your_data_folder] --no_instance --resize_or_crop crop_only --batchSize 36 --no_html --gpu_ids 0,1,2,3 --nThreads 8 --load_pretrainA [ckpt_of_domainA_SR_old_photos] --load_pretrainB [ckpt_of_domainB_old_photos] --l2_feat 60 --n_downsample_global 3 --mc 64 --k_size 4 --start_r 1 --mapping_n_block 6 --map_mc 512 --use_l1_feat --niter 150 --niter_decay 100 --outputs_dir [your_output_folder] --checkpoints_dir [your_ckpt_folder] --irregular_mask [absolute_path_of_mask_file] --mapping_exp 1

Citation

If you find our work useful for your research, please consider citing the following papers :)

@inproceedings{wan2020bringing,
title={Bringing Old Photos Back to Life},
author={Wan, Ziyu and Zhang, Bo and Chen, Dongdong and Zhang, Pan and Chen, Dong and Liao, Jing and Wen, Fang},
booktitle={Proceedings of the IEEE/CVF Conference on Computer Vision and Pattern Recognition},
pages={2747--2757},
year={2020}
}

@article{wan2020old,
  title={Old Photo Restoration via Deep Latent Space Translation},
  author={Wan, Ziyu and Zhang, Bo and Chen, Dongdong and Zhang, Pan and Chen, Dong and Liao, Jing and Wen, Fang},
  journal={arXiv preprint arXiv:2009.07047},
  year={2020}
}

If you are also interested in the legacy photo/video colorization, please refer to this work.

Maintenance

This project is currently maintained by Ziyu Wan and is for academic research use only. If you have any questions, feel free to contact [email protected].

License

The codes and the pretrained model in this repository are under the MIT license as specified by the LICENSE file. We use our labeled dataset to train the scratch detection model.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Bringing-Old-Photos-Back-to-Life (microsoft/Bringing-Old-Photos-Back-to-Life)

Searching Database…

15.7K ·GitHub
Bringing-Old-Photos-Back-to-Life
archived
Что это такое?Это инструмент на основе ИИ для реставрации старых фотографий от Microsoft Research и City University of Hong Kong: модели глубокого обучения, которые убирают царапины, устраняют общие искажения и улучшают лица на повреждённых снимках. Это официальная реализация на PyTorch статьи с устной презентацией на CVPR 2020, позже расширенной в TPAMI 2022.
Это готовое приложение, которое можно просто открыть, или код, который нужно запускать самому?Это исследовательский код, который вы запускаете сами: скрипты на Python, управляемые из командной строки, после того как вы скачаете предобученные модели (чекпоинты). Есть также простой встроенный графический интерфейс, плюс демо на Colab и Replicate с готовым Docker-образом — если не хочется ничего настраивать.
Как его настроить и запустить?Склонируйте репозиторий вместе с репозиторием Synchronized-BatchNorm-PyTorch, скачайте предобученные модели для определения черт лица и реставрации, распакуйте FaceEnhancement/checkpoints.zip и Global/checkpoints.zip в соответствующие папки и установите зависимости — после этого одна команда восстанавливает фотографию. В README рекомендуется указывать абсолютные пути к входным изображениям.
Что нужно на компьютере, чтобы всё это заработало?Python 3.6 или новее на Ubuntu с видеокартой Nvidia и установленной CUDA — именно в такой среде авторы всё тестировали. Проект построен на PyTorch, а остальные зависимости устанавливаются из репозитория после клонирования.
О чём стоит помнить, прежде чем запускать это на своих фото?Модели обучались на изображениях размером 256x256, поэтому с произвольным разрешением результат реставрации может быть неидеальным — специально для больших снимков с царапинами есть режим с многомерным patch-attention. Авторы также отмечают, что скорость работы не оптимизировалась, поскольку это исследовательский репозиторий.
Можно ли использовать это в коммерческом продукте?Код и предобученные модели распространяются по лицензии MIT, но в README сказано, что проект поддерживается только для использования в академических исследованиях — то есть как коммерческий продукт он не позиционируется, а вопросы следует направлять разработчику по электронной почте.
Можно ли запустить это без видеокарты Nvidia?Да — укажите -1 в качестве номера GPU, и всё запустится на процессоре; также поддерживаются конфигурации с несколькими GPU, например 0,1,2. Поскольку тестировалась среда с видеокартами Nvidia, запуск на CPU будет медленнее, и проверять результат придётся самостоятельно.
Что этот конвейер на самом деле делает с фотографией?Три этапа: модель обнаружения царапин находит повреждения, сеть triplet domain translation устраняет как структурные искажения (царапины), так и неструктурные, а прогрессивный генератор дорабатывает области лиц. Промежуточные результаты каждого шага сохраняются в выходную папку.
Можно ли попробовать, ничего не устанавливая?Да — в README есть ссылка на демо в Colab, которое запускается прямо в браузере, а также демо на Replicate с Docker-образом, так что вы можете проверить всё на своих фотографиях, прежде чем настраивать окружение Ubuntu + CUDA.
Можно ли переобучить модель на своей коллекции старых фотографий?Да, код для обучения включён: соберите обучающий файл из набора данных VOC плюс ваши собранные старые фото, обучите VAE для домена A и домена B по отдельности, затем обучите сеть преобразования (mapping) — есть вариант с многомерным patch-attention для входных изображений в высоком разрешении.
Почему нельзя просто скачать набор данных с фотографиями с царапинами?Авторы не планируют публиковать свой размеченный набор данных с такими снимками напрямую. Вместо этого вы можете прогнать их предобученную модель обнаружения царапин по изображениям, которые соберёте сами, и сгенерировать разметку.
What are similar projects?pytorch-CycleGAN-and-pix2pix, CycleGAN, pix2pix, GFPGAN, CodeFormer, PyTorch-GAN, DragGAN, IOPaint
Which topics is it in?face-restoration, image-to-image-translation, image-restoration, photos, image-manipulation, generative-adversarial-network, ubuntu, microsoft, academic-research, image-processing, computer-vision, cuda
Creator
microsoft
Size
40.9 MB
Stars
15.7K
Updated
CommitJul 23Releasev1.0Jul 12
Age
6y
Commits · 90 Days