Skip to main content

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

Project description

Real-ESRGAN

download PyPI Open 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.

:question: Frequently Asked Questions can be found in FAQ.md.

:triangular_flag_on_post: Updates

  • :white_check_mark: Integrate GFPGAN to support face enhancement.
  • :white_check_mark: Integrated to Huggingface Spaces with Gradio. See Gradio Web Demo.
  • :white_check_mark: Support arbitrary scale with --outscale (It actually further resizes outputs with LANCZOS4). Add RealESRGAN_x2plus.pth model.
  • :white_check_mark: The inference code supports: 1) tile options; 2) images with alpha channel; 3) gray images; 4) 16-bit images.
  • :white_check_mark: 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 :star: this repo. Thanks:blush:
Other recommended projects:   :arrow_forward: GFPGAN   :arrow_forward: BasicSR   :arrow_forward: facexlib


:book: 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 :smiley:). 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 [in progress]
  • 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:stuck_out_tongue:). 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. esrgan-x4

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.


:wrench: 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
    

:zap: Quick Inference

Download pre-trained models: RealESRGAN_x4plus.pth

Download pretrained models:

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

:european_castle: Model Zoo

:computer: Training

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}
}

:e-mail: Contact

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

realesrgan-0.2.2.3.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

realesrgan-0.2.2.3-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file realesrgan-0.2.2.3.tar.gz.

File metadata

  • Download URL: realesrgan-0.2.2.3.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for realesrgan-0.2.2.3.tar.gz
Algorithm Hash digest
SHA256 13e9a146b5fb95d6878f0f4ef3908a133481f279a7cf30cb4ac428e067fa3f61
MD5 64690628fec9498b0df558d212ec4ff9
BLAKE2b-256 ad37179b2401ded2be860aac878f439e47f7020677073fe0b1f46d98ef7c4b75

See more details on using hashes here.

File details

Details for the file realesrgan-0.2.2.3-py3-none-any.whl.

File metadata

  • Download URL: realesrgan-0.2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.4 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for realesrgan-0.2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 e1d855f35aac3b688fe62a129c84451d854db22ba458f905e633b8c6ff872546
MD5 900965db2824b6f439927bc1af03cbb2
BLAKE2b-256 18731d5c66f15c190c3d05aaa29916e57f88df5e532947b54c632ebc629db2d3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page