jennyxue commited on
Commit
c890752
·
verified ·
1 Parent(s): ec825b1

Model card and the original license

Browse files
Files changed (2) hide show
  1. LICENSE +29 -0
  2. README.md +339 -0
LICENSE ADDED
@@ -0,0 +1,29 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2021, Xintao Wang
4
+ All rights reserved.
5
+
6
+ Redistribution and use in source and binary forms, with or without
7
+ modification, are permitted provided that the following conditions are met:
8
+
9
+ 1. Redistributions of source code must retain the above copyright notice, this
10
+ list of conditions and the following disclaimer.
11
+
12
+ 2. Redistributions in binary form must reproduce the above copyright notice,
13
+ this list of conditions and the following disclaimer in the documentation
14
+ and/or other materials provided with the distribution.
15
+
16
+ 3. Neither the name of the copyright holder nor the names of its
17
+ contributors may be used to endorse or promote products derived from
18
+ this software without specific prior written permission.
19
+
20
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
README.md ADDED
@@ -0,0 +1,339 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: bsd-3-clause
3
+ pipeline_tag: image-to-image
4
+ library_name: mlx
5
+ tags:
6
+ - mlx
7
+ - moonbox
8
+ - real-esrgan
9
+ - super-resolution
10
+ - image-upscaling
11
+ ---
12
+
13
+ # Real-ESRGAN MLX
14
+
15
+ MLX builds of [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN), made by Moonbox for Apple Silicon Macs. Each precision is a folder; keep a folder's
16
+ files together. Only the parts listed below are converted: the rest of the pipeline comes from the original
17
+ repository unless the section below says otherwise.
18
+
19
+ ## Files
20
+
21
+ The last column is how far each build is from the original PyTorch model on the same inputs (see the section below
22
+ for what was measured).
23
+
24
+ | Precision | File | Size | sha256 | Checked against the original |
25
+ |---|---|---|---|---|
26
+ | fp16 | [`fp16/config.json`](https://huggingface.co/moonbox-ai/Real-ESRGAN-MLX/blob/main/fp16/config.json) | 0.00 GB | `a5848755fc43` | PSNR 54.3 dB mean / 46.9 min, LPIPS <= 0.0004 |
27
+ | fp16 | [`fp16/mlx_model.py`](https://huggingface.co/moonbox-ai/Real-ESRGAN-MLX/blob/main/fp16/mlx_model.py) | 0.00 GB | `dca0f44b9087` | PSNR 54.3 dB mean / 46.9 min, LPIPS <= 0.0004 |
28
+ | fp16 | [`fp16/model.safetensors`](https://huggingface.co/moonbox-ai/Real-ESRGAN-MLX/blob/main/fp16/model.safetensors) | 0.03 GB | `5173c577ace0` | PSNR 54.3 dB mean / 46.9 min, LPIPS <= 0.0004 |
29
+
30
+ ## How to run
31
+
32
+ Real-ESRGAN x4plus (`RealESRGAN_x4plus.pth`, the general-photo model) ported to MLX. Each folder holds
33
+ `model.safetensors`, `config.json` and `mlx_model.py`, the port (only `mlx` and `numpy` needed):
34
+
35
+ ```python
36
+ import numpy as np, mlx_model
37
+ from PIL import Image
38
+ model = mlx_model.load("fp16")
39
+ out = mlx_model.upscale(model, np.array(Image.open("in.png").convert("RGB"))) # 4x, tiled (256 px tiles)
40
+ Image.fromarray(out).save("out.png")
41
+ ```
42
+
43
+ **Which one:** `fp16/` is the closest to the original (54 dB PSNR); `bf16/` is visually the same (LPIPS <= 0.015) but
44
+ drifts on some images (30.7 dB worst). There are no 8bit / 6bit / 4bit builds: the network is all convolutions, which
45
+ MLX doesn't quantize, and at 33 MB it gains nothing from it.
46
+
47
+ | Precision | Size | PSNR vs PyTorch fp32 (mean / worst) | LPIPS (worst) | Time, ~130x130 -> 4x on an M5 |
48
+ |---|---|---|---|---|
49
+ | `fp16/` | 33.5 MB | 54.3 / 46.9 dB | 0.0004 | 0.25 s |
50
+ | `bf16/` | 33.5 MB | 40.8 / 30.7 dB | 0.015 | 0.28 s |
51
+
52
+ ## How these were made
53
+
54
+ From [Real-ESRGAN](https://github.com/xinntao/Real-ESRGAN) at revision `a4abfb2979`: the original weights loaded in MLX and stored as bf16 or fp16, or
55
+ quantized with MLX's affine quantization (`8bit`, `6bit`, `4bit`, group size 64; layers MLX can't quantize, such as
56
+ convolutions and norms, stay bf16). Every build was checked against the original before upload; the `sha256` column
57
+ above is what the files must hash to.
58
+
59
+ ## License
60
+
61
+ BSD-3-Clause. These files are a derivative of the original model and carry its license: it is copied in this
62
+ repository, and it governs your use of these files. The original model card follows unchanged.
63
+
64
+ ---
65
+
66
+ # Original model card
67
+
68
+ <p align="center">
69
+ <img src="assets/realesrgan_logo.png" height=120>
70
+ </p>
71
+
72
+ ## <div align="center"><b><a href="README.md">English</a> | <a href="README_CN.md">简体中文</a></b></div>
73
+
74
+ <div align="center">
75
+
76
+ 👀[**Demos**](#-demos-videos) **|** 🚩[**Updates**](#-updates) **|** ⚡[**Usage**](#-quick-inference) **|** 🏰[**Model Zoo**](docs/model_zoo.md) **|** 🔧[Install](#-dependencies-and-installation) **|** 💻[Train](docs/Training.md) **|** ❓[FAQ](docs/FAQ.md) **|** 🎨[Contribution](docs/CONTRIBUTING.md)
77
+
78
+ [![download](https://img.shields.io/github/downloads/xinntao/Real-ESRGAN/total.svg)](https://github.com/xinntao/Real-ESRGAN/releases)
79
+ [![PyPI](https://img.shields.io/pypi/v/realesrgan)](https://pypi.org/project/realesrgan/)
80
+ [![Open issue](https://img.shields.io/github/issues/xinntao/Real-ESRGAN)](https://github.com/xinntao/Real-ESRGAN/issues)
81
+ [![Closed issue](https://img.shields.io/github/issues-closed/xinntao/Real-ESRGAN)](https://github.com/xinntao/Real-ESRGAN/issues)
82
+ [![LICENSE](https://img.shields.io/github/license/xinntao/Real-ESRGAN.svg)](https://github.com/xinntao/Real-ESRGAN/blob/master/LICENSE)
83
+ [![python lint](https://github.com/xinntao/Real-ESRGAN/actions/workflows/pylint.yml/badge.svg)](https://github.com/xinntao/Real-ESRGAN/blob/master/.github/workflows/pylint.yml)
84
+ [![Publish-pip](https://github.com/xinntao/Real-ESRGAN/actions/workflows/publish-pip.yml/badge.svg)](https://github.com/xinntao/Real-ESRGAN/blob/master/.github/workflows/publish-pip.yml)
85
+
86
+ </div>
87
+
88
+ 🔥 **AnimeVideo-v3 model (动漫视频小模型)**. Please see [[*anime video models*](docs/anime_video_model.md)] and [[*comparisons*](docs/anime_comparisons.md)]<br>
89
+ 🔥 **RealESRGAN_x4plus_anime_6B** for anime images **(动漫插图模型)**. Please see [[*anime_model*](docs/anime_model.md)]
90
+
91
+ <!-- 1. You can try in our website: [ARC Demo](https://arc.tencent.com/en/ai-demos/imgRestore) (now only support RealESRGAN_x4plus_anime_6B) -->
92
+ 1. :boom: **Update** online Replicate demo: [![Replicate](https://img.shields.io/static/v1?label=Demo&message=Replicate&color=blue)](https://replicate.com/xinntao/realesrgan)
93
+ 1. Online Colab demo for Real-ESRGAN: [![Colab](https://img.shields.io/static/v1?label=Demo&message=Colab&color=orange)](https://colab.research.google.com/drive/1k2Zod6kSHEvraybHl50Lys0LerhyTMCo?usp=sharing) **|** Online Colab demo for for Real-ESRGAN (**anime videos**): [![Colab](https://img.shields.io/static/v1?label=Demo&message=Colab&color=orange)](https://colab.research.google.com/drive/1yNl9ORUxxlL4N0keJa2SEPB61imPQd1B?usp=sharing)
94
+ 1. Portable [Windows](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.5.0/realesrgan-ncnn-vulkan-20220424-windows.zip) / [Linux](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.5.0/realesrgan-ncnn-vulkan-20220424-ubuntu.zip) / [MacOS](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.5.0/realesrgan-ncnn-vulkan-20220424-macos.zip) **executable files for Intel/AMD/Nvidia GPU**. You can find more information [here](#portable-executable-files-ncnn). The ncnn implementation is in [Real-ESRGAN-ncnn-vulkan](https://github.com/xinntao/Real-ESRGAN-ncnn-vulkan)
95
+ <!-- 1. You can watch enhanced animations in [Tencent Video](https://v.qq.com/s/topic/v_child/render/fC4iyCAM.html). 欢迎观看[腾讯视频动漫修复](https://v.qq.com/s/topic/v_child/render/fC4iyCAM.html) -->
96
+
97
+ Real-ESRGAN aims at developing **Practical Algorithms for General Image/Video Restoration**.<br>
98
+ We extend the powerful ESRGAN to a practical restoration application (namely, Real-ESRGAN), which is trained with pure synthetic data.
99
+
100
+ 🌌 Thanks for your valuable feedbacks/suggestions. All the feedbacks are updated in [feedback.md](docs/feedback.md).
101
+
102
+ ---
103
+
104
+ If Real-ESRGAN is helpful, please help to ⭐ this repo or recommend it to your friends 😊 <br>
105
+ Other recommended projects:<br>
106
+ ▶️ [GFPGAN](https://github.com/TencentARC/GFPGAN): A practical algorithm for real-world face restoration <br>
107
+ ▶️ [BasicSR](https://github.com/xinntao/BasicSR): An open-source image and video restoration toolbox<br>
108
+ ▶️ [facexlib](https://github.com/xinntao/facexlib): A collection that provides useful face-relation functions.<br>
109
+ ▶️ [HandyView](https://github.com/xinntao/HandyView): A PyQt5-based image viewer that is handy for view and comparison <br>
110
+ ▶️ [HandyFigure](https://github.com/xinntao/HandyFigure): Open source of paper figures <br>
111
+
112
+ ---
113
+
114
+ ### 📖 Real-ESRGAN: Training Real-World Blind Super-Resolution with Pure Synthetic Data
115
+
116
+ > [[Paper](https://arxiv.org/abs/2107.10833)] &emsp; [[YouTube Video](https://www.youtube.com/watch?v=fxHWoDSSvSc)] &emsp; [[B站讲解](https://www.bilibili.com/video/BV1H34y1m7sS/)] &emsp; [[Poster](https://xinntao.github.io/projects/RealESRGAN_src/RealESRGAN_poster.pdf)] &emsp; [[PPT slides](https://docs.google.com/presentation/d/1QtW6Iy8rm8rGLsJ0Ldti6kP-7Qyzy6XL/edit?usp=sharing&ouid=109799856763657548160&rtpof=true&sd=true)]<br>
117
+ > [Xintao Wang](https://xinntao.github.io/), Liangbin Xie, [Chao Dong](https://scholar.google.com.hk/citations?user=OSDCB0UAAAAJ), [Ying Shan](https://scholar.google.com/citations?user=4oXBp9UAAAAJ&hl=en) <br>
118
+ > [Tencent ARC Lab](https://arc.tencent.com/en/ai-demos/imgRestore); Shenzhen Institutes of Advanced Technology, Chinese Academy of Sciences
119
+
120
+ <p align="center">
121
+ <img src="assets/teaser.jpg">
122
+ </p>
123
+
124
+ ---
125
+
126
+ <!---------------------------------- Updates --------------------------->
127
+ ## 🚩 Updates
128
+
129
+ - ✅ Add the **realesr-general-x4v3** model - a tiny small model for general scenes. It also supports the **-dn** option to balance the noise (avoiding over-smooth results). **-dn** is short for denoising strength.
130
+ - ✅ Update the **RealESRGAN AnimeVideo-v3** model. Please see [anime video models](docs/anime_video_model.md) and [comparisons](docs/anime_comparisons.md) for more details.
131
+ - ✅ Add small models for anime videos. More details are in [anime video models](docs/anime_video_model.md).
132
+ - ✅ Add the ncnn implementation [Real-ESRGAN-ncnn-vulkan](https://github.com/xinntao/Real-ESRGAN-ncnn-vulkan).
133
+ - ✅ Add [*RealESRGAN_x4plus_anime_6B.pth*](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.2.4/RealESRGAN_x4plus_anime_6B.pth), which is optimized for **anime** images with much smaller model size. More details and comparisons with [waifu2x](https://github.com/nihui/waifu2x-ncnn-vulkan) are in [**anime_model.md**](docs/anime_model.md)
134
+ - ✅ Support finetuning on your own data or paired data (*i.e.*, finetuning ESRGAN). See [here](docs/Training.md#Finetune-Real-ESRGAN-on-your-own-dataset)
135
+ - ✅ Integrate [GFPGAN](https://github.com/TencentARC/GFPGAN) to support **face enhancement**.
136
+ - ✅ Integrated to [Huggingface Spaces](https://huggingface.co/spaces) with [Gradio](https://github.com/gradio-app/gradio). See [Gradio Web Demo](https://huggingface.co/spaces/akhaliq/Real-ESRGAN). Thanks [@AK391](https://github.com/AK391)
137
+ - ✅ Support arbitrary scale with `--outscale` (It actually further resizes outputs with `LANCZOS4`). Add *RealESRGAN_x2plus.pth* model.
138
+ - ✅ [The inference code](inference_realesrgan.py) supports: 1) **tile** options; 2) images with **alpha channel**; 3) **gray** images; 4) **16-bit** images.
139
+ - ✅ The training codes have been released. A detailed guide can be found in [Training.md](docs/Training.md).
140
+
141
+ ---
142
+
143
+ <!---------------------------------- Demo videos --------------------------->
144
+ ## 👀 Demos Videos
145
+
146
+ #### Bilibili
147
+
148
+ - [大闹天宫片段](https://www.bilibili.com/video/BV1ja41117zb)
149
+ - [Anime dance cut 动漫魔性舞蹈](https://www.bilibili.com/video/BV1wY4y1L7hT/)
150
+ - [海贼王片段](https://www.bilibili.com/video/BV1i3411L7Gy/)
151
+
152
+ #### YouTube
153
+
154
+ ## 🔧 Dependencies and Installation
155
+
156
+ - Python >= 3.7 (Recommend to use [Anaconda](https://www.anaconda.com/download/#linux) or [Miniconda](https://docs.conda.io/en/latest/miniconda.html))
157
+ - [PyTorch >= 1.7](https://pytorch.org/)
158
+
159
+ ### Installation
160
+
161
+ 1. Clone repo
162
+
163
+ ```bash
164
+ git clone https://github.com/xinntao/Real-ESRGAN.git
165
+ cd Real-ESRGAN
166
+ ```
167
+
168
+ 1. Install dependent packages
169
+
170
+ ```bash
171
+ # Install basicsr - https://github.com/xinntao/BasicSR
172
+ # We use BasicSR for both training and inference
173
+ pip install basicsr
174
+ # facexlib and gfpgan are for face enhancement
175
+ pip install facexlib
176
+ pip install gfpgan
177
+ pip install -r requirements.txt
178
+ python setup.py develop
179
+ ```
180
+
181
+ ---
182
+
183
+ ## ⚡ Quick Inference
184
+
185
+ There are usually three ways to inference Real-ESRGAN.
186
+
187
+ 1. [Online inference](#online-inference)
188
+ 1. [Portable executable files (NCNN)](#portable-executable-files-ncnn)
189
+ 1. [Python script](#python-script)
190
+
191
+ ### Online inference
192
+
193
+ 1. You can try in our website: [ARC Demo](https://arc.tencent.com/en/ai-demos/imgRestore) (now only support RealESRGAN_x4plus_anime_6B)
194
+ 1. [Colab Demo](https://colab.research.google.com/drive/1k2Zod6kSHEvraybHl50Lys0LerhyTMCo?usp=sharing) for Real-ESRGAN **|** [Colab Demo](https://colab.research.google.com/drive/1yNl9ORUxxlL4N0keJa2SEPB61imPQd1B?usp=sharing) for Real-ESRGAN (**anime videos**).
195
+
196
+ ### Portable executable files (NCNN)
197
+
198
+ You can download [Windows](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.5.0/realesrgan-ncnn-vulkan-20220424-windows.zip) / [Linux](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.5.0/realesrgan-ncnn-vulkan-20220424-ubuntu.zip) / [MacOS](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.5.0/realesrgan-ncnn-vulkan-20220424-macos.zip) **executable files for Intel/AMD/Nvidia GPU**.
199
+
200
+ This executable file is **portable** and includes all the binaries and models required. No CUDA or PyTorch environment is needed.<br>
201
+
202
+ You can simply run the following command (the Windows example, more information is in the README.md of each executable files):
203
+
204
+ ```bash
205
+ ./realesrgan-ncnn-vulkan.exe -i input.jpg -o output.png -n model_name
206
+ ```
207
+
208
+ We have provided five models:
209
+
210
+ 1. realesrgan-x4plus (default)
211
+ 2. realesrnet-x4plus
212
+ 3. realesrgan-x4plus-anime (optimized for anime images, small model size)
213
+ 4. realesr-animevideov3 (animation video)
214
+
215
+ You can use the `-n` argument for other models, for example, `./realesrgan-ncnn-vulkan.exe -i input.jpg -o output.png -n realesrnet-x4plus`
216
+
217
+ #### Usage of portable executable files
218
+
219
+ 1. Please refer to [Real-ESRGAN-ncnn-vulkan](https://github.com/xinntao/Real-ESRGAN-ncnn-vulkan#computer-usages) for more details.
220
+ 1. Note that it does not support all the functions (such as `outscale`) as the python script `inference_realesrgan.py`.
221
+
222
+ ```console
223
+ Usage: realesrgan-ncnn-vulkan.exe -i infile -o outfile [options]...
224
+
225
+ -h show this help
226
+ -i input-path input image path (jpg/png/webp) or directory
227
+ -o output-path output image path (jpg/png/webp) or directory
228
+ -s scale upscale ratio (can be 2, 3, 4. default=4)
229
+ -t tile-size tile size (>=32/0=auto, default=0) can be 0,0,0 for multi-gpu
230
+ -m model-path folder path to the pre-trained models. default=models
231
+ -n model-name model name (default=realesr-animevideov3, can be realesr-animevideov3 | realesrgan-x4plus | realesrgan-x4plus-anime | realesrnet-x4plus)
232
+ -g gpu-id gpu device to use (default=auto) can be 0,1,2 for multi-gpu
233
+ -j load:proc:save thread count for load/proc/save (default=1:2:2) can be 1:2,2,2:2 for multi-gpu
234
+ -x enable tta mode"
235
+ -f format output image format (jpg/png/webp, default=ext/png)
236
+ -v verbose output
237
+ ```
238
+
239
+ 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.
240
+
241
+ ### Python script
242
+
243
+ #### Usage of python script
244
+
245
+ 1. You can use X4 model for **arbitrary output size** with the argument `outscale`. The program will further perform cheap resize operation after the Real-ESRGAN output.
246
+
247
+ ```console
248
+ Usage: python inference_realesrgan.py -n RealESRGAN_x4plus -i infile -o outfile [options]...
249
+
250
+ A common command: python inference_realesrgan.py -n RealESRGAN_x4plus -i infile --outscale 3.5 --face_enhance
251
+
252
+ -h show this help
253
+ -i --input Input image or folder. Default: inputs
254
+ -o --output Output folder. Default: results
255
+ -n --model_name Model name. Default: RealESRGAN_x4plus
256
+ -s, --outscale The final upsampling scale of the image. Default: 4
257
+ --suffix Suffix of the restored image. Default: out
258
+ -t, --tile Tile size, 0 for no tile during testing. Default: 0
259
+ --face_enhance Whether to use GFPGAN to enhance face. Default: False
260
+ --fp32 Use fp32 precision during inference. Default: fp16 (half precision).
261
+ --ext Image extension. Options: auto | jpg | png, auto means using the same extension as inputs. Default: auto
262
+ ```
263
+
264
+ #### Inference general images
265
+
266
+ Download pre-trained models: [RealESRGAN_x4plus.pth](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.1.0/RealESRGAN_x4plus.pth)
267
+
268
+ ```bash
269
+ wget https://github.com/xinntao/Real-ESRGAN/releases/download/v0.1.0/RealESRGAN_x4plus.pth -P weights
270
+ ```
271
+
272
+ Inference!
273
+
274
+ ```bash
275
+ python inference_realesrgan.py -n RealESRGAN_x4plus -i inputs --face_enhance
276
+ ```
277
+
278
+ Results are in the `results` folder
279
+
280
+ #### Inference anime images
281
+
282
+ <p align="center">
283
+ <img src="https://raw.githubusercontent.com/xinntao/public-figures/master/Real-ESRGAN/cmp_realesrgan_anime_1.png">
284
+ </p>
285
+
286
+ Pre-trained models: [RealESRGAN_x4plus_anime_6B](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.2.4/RealESRGAN_x4plus_anime_6B.pth)<br>
287
+ More details and comparisons with [waifu2x](https://github.com/nihui/waifu2x-ncnn-vulkan) are in [**anime_model.md**](docs/anime_model.md)
288
+
289
+ ```bash
290
+ # download model
291
+ wget https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.2.4/RealESRGAN_x4plus_anime_6B.pth -P weights
292
+ # inference
293
+ python inference_realesrgan.py -n RealESRGAN_x4plus_anime_6B -i inputs
294
+ ```
295
+
296
+ Results are in the `results` folder
297
+
298
+ ---
299
+
300
+ ## BibTeX
301
+
302
+ @InProceedings{wang2021realesrgan,
303
+ author = {Xintao Wang and Liangbin Xie and Chao Dong and Ying Shan},
304
+ title = {Real-ESRGAN: Training Real-World Blind Super-Resolution with Pure Synthetic Data},
305
+ booktitle = {International Conference on Computer Vision Workshops (ICCVW)},
306
+ date = {2021}
307
+ }
308
+
309
+ ## 📧 Contact
310
+
311
+ If you have any question, please email `xintao.wang@outlook.com` or `xintaowang@tencent.com`.
312
+
313
+ <!---------------------------------- Projects that use Real-ESRGAN --------------------------->
314
+ ## 🧩 Projects that use Real-ESRGAN
315
+
316
+ If you develop/use Real-ESRGAN in your projects, welcome to let me know.
317
+
318
+ - NCNN-Android: [RealSR-NCNN-Android](https://github.com/tumuyan/RealSR-NCNN-Android) by [tumuyan](https://github.com/tumuyan)
319
+ - VapourSynth: [vs-realesrgan](https://github.com/HolyWu/vs-realesrgan) by [HolyWu](https://github.com/HolyWu)
320
+ - NCNN: [Real-ESRGAN-ncnn-vulkan](https://github.com/xinntao/Real-ESRGAN-ncnn-vulkan)
321
+
322
+ &nbsp;&nbsp;&nbsp;&nbsp;**GUI**
323
+
324
+ - [Waifu2x-Extension-GUI](https://github.com/AaronFeng753/Waifu2x-Extension-GUI) by [AaronFeng753](https://github.com/AaronFeng753)
325
+ - [Squirrel-RIFE](https://github.com/Justin62628/Squirrel-RIFE) by [Justin62628](https://github.com/Justin62628)
326
+ - [Real-GUI](https://github.com/scifx/Real-GUI) by [scifx](https://github.com/scifx)
327
+ - [Real-ESRGAN_GUI](https://github.com/net2cn/Real-ESRGAN_GUI) by [net2cn](https://github.com/net2cn)
328
+ - [Real-ESRGAN-EGUI](https://github.com/WGzeyu/Real-ESRGAN-EGUI) by [WGzeyu](https://github.com/WGzeyu)
329
+ - [anime_upscaler](https://github.com/shangar21/anime_upscaler) by [shangar21](https://github.com/shangar21)
330
+ - [Upscayl](https://github.com/upscayl/upscayl) by [Nayam Amarshe](https://github.com/NayamAmarshe) and [TGS963](https://github.com/TGS963)
331
+
332
+ ## 🤗 Acknowledgement
333
+
334
+ Thanks for all the contributors.
335
+
336
+ - [AK391](https://github.com/AK391): Integrate RealESRGAN to [Huggingface Spaces](https://huggingface.co/spaces) with [Gradio](https://github.com/gradio-app/gradio). See [Gradio Web Demo](https://huggingface.co/spaces/akhaliq/Real-ESRGAN).
337
+ - [Asiimoviet](https://github.com/Asiimoviet): Translate the README.md to Chinese (中文).
338
+ - [2ji3150](https://github.com/2ji3150): Thanks for the [detailed and valuable feedbacks/suggestions](https://github.com/xinntao/Real-ESRGAN/issues/131).
339
+ - [Jared-02](https://github.com/Jared-02): Translate the Training.md to Chinese (中文).