You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.en-US.md
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,6 +38,7 @@ Quick Start:
38
38
* The artifacts in GitHub Actions are built based on the latest commits. They don't contain Real-ESRGAN-ncnn-vulkan's executable file and models either.
39
39
* Use Python 3.10 or above if you want to run Real-ESRGAN GUI from source. Don't forget to install the dependcies by `pip install -r requirements.txt` and extract Real-ESRGAN-ncnn-vulkan to the repository before running `python main.py`.
40
40
* It may be possible to run Real-ESRGAN GUI in other Linux distributions, but I have not tested it.
41
+
* You can also download more [additional models](#addition-models) and place the `bin` and `param` files in the `models` directory.
41
42
42
43
</details>
43
44
@@ -59,6 +60,11 @@ sh Build-macOS-arm64.sh
59
60
60
61
> ⚠️ Since I don't have any device running macOS, I may not be able to handle macOS-related issues.
61
62
63
+
### Related projects
64
+
65
+
* Use Real-ESRGAN on Android: [tumuyan/RealSR-NCNN-Android](https://github.com/tumuyan/RealSR-NCNN-Android)
66
+
* Upscale video with Real-ESRGAN and Vapoursynth: [HolyWu/vs-realesrgan](https://github.com/HolyWu/vs-realesrgan)
67
+
62
68
## Features
63
69
64
70
In addition to the features supported by Real-ESRGAN-ncnn-vulkan, Real-ESRGAN GUI also supports these additional features:
@@ -114,7 +120,7 @@ I recommend `realesrgan-x4plus` for real-life photos and `realesrgan-x4plus-anim
114
120
115
121
For different upscale ratio versions of the same model, it is recommended to choose the version that is equal to or greater than the ratio at which you want to enlarge the image. For example, if a model has x2 and x4 version and you want to upscale an image by 3x, you should choose the x4 version.
116
122
117
-
Models with `animevideo` in the filename are designed for anime videos. These models are small and have a faster processing speed (about 1.5-3x compare to `realesrgan-x4plus-anime`). However, I recommend [VapourSynth](https://www.vapoursynth.com/) and its [Real-ESRGAN plugin](https://github.com/HolyWu/vs-realesrgan) if you want to upscale an video. Real-ESRGAN GUI will not consider adding video processing related features.
123
+
Models with `animevideo` in the filename are designed for anime videos. These models are small and have a faster processing speed (about 1.5-3x compare to `realesrgan-x4plus-anime`). However, Real-ESRGAN GUI will not consider adding video processing related features.
118
124
119
125
### The usage of tile size
120
126
@@ -159,6 +165,14 @@ If this option is not turned on, lossless compression is used when the output is
159
165
160
166
The configuration will be saved automatically when exiting the program.
161
167
168
+
### Additional models
169
+
170
+
You can download additional models from [Upscale Wiki](https://upscale.wiki/wiki/Model_Database) and use them in Real-ESRGAN GUI. These model may produce better (or worse) results than the official model for some images.
171
+
172
+
These model uses PyTorch's `pth` format, but Real-ESRGAN GUI (Real-ESRGAN-ncnn-vulkan) needs NCNN's `bin` and `param` format. You can follow this [guide](https://note.youdao.com/ynoteshare/?id=2b001cd4175ab46d2ce11ecb5a6d84ff) (written by RealSR-NCNN-Android's author in Chinese) to make a conversion with [cupscale](https://github.com/n00mkrad/cupscale)'s `pth2ncnn` utility. The model's filename must contain its upscale factor like `x4` or `4x`.
173
+
174
+
You can download some converted additional models from [here](https://github.com/TransparentLC/realesrgan-gui/releases/tag/additional-models).
0 commit comments