uptodiff / Real-ESRGAN

Real-ESRGAN aims at developing Practical Algorithms for General Image Restoration.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Real-ESRGAN

download PyPI Open issue Closed issue LICENSE python lint Publish-pip

  1. Colab Demo for Real-ESRGAN google colab logo.
  2. Portable Windows / Linux / MacOS executable files for Intel/AMD/Nvidia GPU. You can find more information here.

Real-ESRGAN aims at developing Practical Algorithms for General Image Restoration.
We extend the powerful ESRGAN to a practical restoration application (namely, Real-ESRGAN), which is trained with pure synthetic data.

🎨 Real-ESRGAN needs your contributions. Any contributions are welcome, such as new features/models/typo fixes/suggestions/maintenance, etc. See CONTRIBUTING.md. All contributors are list here.

❓ Frequently Asked Questions can be found in FAQ.md.

🚩 Updates

  • βœ… Add RealESRGAN_x4plus_anime_6B.pth, which is optimized for anime images with much smaller model size. More details and comparisons with waifu2x are in anime_model.md
  • βœ… Support finetuning on your own data or paired data (i.e., finetuning ESRGAN). See here
  • βœ… Integrate GFPGAN to support face enhancement.
  • βœ… Integrated to Huggingface Spaces with Gradio. See Gradio Web Demo. Thanks @AK391
  • βœ… Support arbitrary scale with --outscale (It actually further resizes outputs with LANCZOS4). Add RealESRGAN_x2plus.pth model.
  • βœ… The inference code supports: 1) tile options; 2) images with alpha channel; 3) gray images; 4) 16-bit images.
  • βœ… The training codes have been released. A detailed guide can be found in Training.md.

If Real-ESRGAN is helpful in your photos/projects, please help to ⭐ this repo or recommend it to your friends. Thanks😊
Other recommended projects:
▢️ GFPGAN: A practical algorithm for real-world face restoration
▢️ BasicSR: An ppen-source image and video restoration toolbox
▢️ facexlib: A collection that provides useful face-relation functions.
▢️ HandyView: A PyQt5-based image viewer that is handy for view and comparison.


πŸ“– Real-ESRGAN: Training Real-World Blind Super-Resolution with Pure Synthetic Data

[Paper]   [Project Page]   [Demo]
Xintao Wang, Liangbin Xie, Chao Dong, Ying Shan
Applied Research Center (ARC), Tencent PCG
Shenzhen Institutes of Advanced Technology, Chinese Academy of Sciences


We have provided a pretrained model (RealESRGAN_x4plus.pth) with upsampling X4.
Note that RealESRGAN may still fail in some cases as the real-world degradations are really too complex.
Moreover, it may not perform well on human faces, text, etc, which will be optimized later.

Real-ESRGAN will be a long-term supported project (in my current plan πŸ˜ƒ). It will be continuously updated in my spare time.

Here is a TODO list in the near future:

  • optimize for human faces
  • optimize for texts
  • optimize for anime images
  • support more scales
  • support controllable restoration strength

If you have any good ideas or demands, please open an issue/discussion to let me know.
If you have some images that Real-ESRGAN could not well restored, please also open an issue/discussion. I will record it (but I cannot guarantee to resolve itπŸ˜›). If necessary, I will open a page to specially record these real-world cases that need to be solved, but the current technology is difficult to handle well.


Portable executable files

You can download Windows / Linux / MacOS executable files for Intel/AMD/Nvidia GPU.

This executable file is portable and includes all the binaries and models required. No CUDA or PyTorch environment is needed.

You can simply run the following command (the Windows example, more information is in the README.md of each executable files):

./realesrgan-ncnn-vulkan.exe -i input.jpg -o output.png

We have provided three models:

  1. realesrgan-x4plus (default)
  2. realesrnet-x4plus
  3. realesrgan-x4plus-anime (optimized for anime images, small model size)

You can use the -n argument for other models, for example, ./realesrgan-ncnn-vulkan.exe -i input.jpg -o output.png -n realesrnet-x4plus

Note that it may introduce block inconsistency (and also generate slightly different results from the PyTorch implementation), because this executable file first crops the input image into several tiles, and then processes them separately, finally stitches together.

This executable file is based on the wonderful Tencent/ncnn and realsr-ncnn-vulkan by nihui.


πŸ”§ Dependencies and Installation

Installation

  1. Clone repo

    git clone https://github.com/xinntao/Real-ESRGAN.git
    cd Real-ESRGAN
  2. Install dependent packages

    # Install basicsr - https://github.com/xinntao/BasicSR
    # We use BasicSR for both training and inference
    pip install basicsr
    # facexlib and gfpgan are for face enhancement
    pip install facexlib
    pip install gfpgan
    pip install -r requirements.txt
    python setup.py develop

⚑ Quick Inference

Inference general images

Download pre-trained models: RealESRGAN_x4plus.pth

wget https://github.com/xinntao/Real-ESRGAN/releases/download/v0.1.0/RealESRGAN_x4plus.pth -P experiments/pretrained_models

Inference!

python inference_realesrgan.py --model_path experiments/pretrained_models/RealESRGAN_x4plus.pth --input inputs --face_enhance

Results are in the results folder

Inference anime images

Pre-trained models: RealESRGAN_x4plus_anime_6B
More details and comparisons with waifu2x are in anime_model.md

# download model
wget https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.2.4/RealESRGAN_x4plus_anime_6B.pth -P experiments/pretrained_models
# inference
python inference_realesrgan.py --model_path experiments/pretrained_models/RealESRGAN_x4plus_anime_6B.pth --input inputs

Results are in the results folder

🏰 Model Zoo

πŸ’» Training and Finetuning on your own dataset

A detailed guide can be found in Training.md.

BibTeX

@Article{wang2021realesrgan,
    title={Real-ESRGAN: Training Real-World Blind Super-Resolution with Pure Synthetic Data},
    author={Xintao Wang and Liangbin Xie and Chao Dong and Ying Shan},
    journal={arXiv:2107.10833},
    year={2021}
}

πŸ“§ Contact

If you have any question, please email xintao.wang@outlook.com or xintaowang@tencent.com.

About

Real-ESRGAN aims at developing Practical Algorithms for General Image Restoration.

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Python 100.0%