Skip to content

Commit

Permalink
添加Real-CUGAN相关说明
Browse files Browse the repository at this point in the history
  • Loading branch information
TransparentLC committed May 4, 2024
1 parent 529feec commit de07ed2
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ Quick Start:
>
> Download the latest release and extract `upscayl-bin[.exe]` to the directory where Real-ESRGAN GUI's executable file is located. It will be used in priority.
> [!TIP]
> You can alse use [Real-CUGAN](https://github.com/bilibili/ailab/tree/main/Real-CUGAN) in Real-ESRGAN GUI for upscaling! See this [section](#) for details.
<details>

<summary>Notes</summary>
Expand Down Expand Up @@ -198,6 +201,16 @@ These model uses PyTorch's `pth` format, but Real-ESRGAN GUI (Real-ESRGAN-ncnn-v

You can download some converted additional models from [here](https://github.com/TransparentLC/realesrgan-gui/releases/tag/additional-models).

### I think Real-CUGAN performs better in upscaling than Real-ESRGAN

Someone recommends it. So I added support for it.

Follow these steps if you want to use Real-CUGAN instead of Real-ESRGAN:

* Download [Real-CUGAN-ncnn-vulkan](https://github.com/nihui/realcugan-ncnn-vulkan).
* Set `upscaler` in `config.ini` to the path of `realcugan-ncnn-vulkan[.exe]`.
* Put Real-CUGAN's models (the `models-{nose,pro,se}` folders) into the `models` folder (or the directory specified by `modeldir` in `config.ini`).

### Why not (other similar GUI)?

Of course, there is more than one GUI for Real-ESRGAN. Here is a list of some, with reasons why I didn't use them and decided to build on my own.
Expand All @@ -222,7 +235,7 @@ Since it is an Electron application, the users will have to [install yet another

These GUIs are simple wrappers for the CLI parameters without any extra features.

However, I like the Material Design used by tsukumijima/Real-ESRGAN-GUI.
However, I like the Material Design used by tsukumijima/Real-ESRGAN-GUI. It also supports Real-CUGAN.

## Open-source libraries used

Expand Down
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@
>
> 下载最新的 Release 并将压缩包中的 `upscayl-bin[.exe]` 解压到 GUI 的主程序所在的目录,它将会被优先使用。
> [!TIP]
> 你也可以在 Real-ESRGAN GUI 中使用 [Real-CUGAN](https://github.com/bilibili/ailab/tree/main/Real-CUGAN) 进行放大!详细配置方法参见[这里](#我觉得-real-cugan-的放大效果比-real-esrgan-更好)
<details>

<summary>其它的运行方式和说明</summary>
Expand Down Expand Up @@ -187,6 +190,16 @@ GIF 只支持最多 256 种 RGB 颜色的调色板并设定其中一种颜色为

如果因为配置文件的问题导致程序不能运行的话,可以先尝试将配置文件删除。

### 我觉得 Real-CUGAN 的放大效果比 Real-ESRGAN 更好

有些用户是这么认为的,所以我决定添加对 Real-CUGAN 的支持。

想要使用 Real-CUGAN 而不是 Real-ESRGAN 进行放大的话,请遵循以下步骤:

* 下载 [Real-CUGAN-ncnn-vulkan](https://github.com/nihui/realcugan-ncnn-vulkan)
*`config.ini` 中将 `upscaler` 设定为 `realcugan-ncnn-vulkan[.exe]` 的路径
* 将 Real-CUGAN 的模型(`models-{nose,pro,se}` 三个文件夹)放入 `models` 文件夹(或是 `config.ini``modeldir` 指定的目录)

### 为什么不使用(其他功能类似的 GUI)?

Real-ESRGAN 的 GUI 当然不止一个,这里列出了其中的一部分,并且附上了我没有使用它们而是选择自己写一个 GUI 的理由。
Expand All @@ -211,7 +224,7 @@ Real-ESRGAN 的 GUI 当然不止一个,这里列出了其中的一部分,并

这些 GUI 基本上都是对 CLI 参数的简单封装,没有多少额外的功能。

不过,我很喜欢 tsukumijima/Real-ESRGAN-GUI 使用的 Material Design 风格。
不过,我很喜欢 tsukumijima/Real-ESRGAN-GUI 使用的 Material Design 风格,它也支持 Real-CUGAN

## 借物表

Expand Down

0 comments on commit de07ed2

Please sign in to comment.