Skip to content

Commit 22c5ef4

Browse files
committed
Update README.md
1 parent 02f8606 commit 22c5ef4

File tree

1 file changed

+19
-27
lines changed

1 file changed

+19
-27
lines changed

README.md

+19-27
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,47 @@ Download pre-built binaries and model files from [releases](https://github.com/N
99
## Usage
1010

1111
```
12-
core.w2xnvk.Waifu2x(clip[, noise, scale, model, tile_size, gpu_id, gpu_thread])
12+
core.w2xnvk.Waifu2x(clip[, noise, scale, model, tile_size, gpu_id, gpu_thread, precision])
1313
```
1414

15-
* clip: input clip. Only 8-bit RGB is supported.
15+
* clip: Input clip. Only 32-bit float RGB is supported.
1616

17-
* noise: denoise level (int -1/0/1/2/3, defualt=0)
17+
* noise: Denoise level. (int -1/0/1/2/3, defualt=0)
1818
* -1 = none
1919
* 0 = low
2020
* 1 = medium
2121
* 2 = high
2222
* 3 = highest
2323

24-
* scale: upscale ratio (int 1/2, default=2)
24+
* scale: Upscale ratio. (int 1/2, default=2)
25+
* 1 = no scaling, denoise only. upconv_7 doesn't support this mode.
26+
* 2 = upscale 2x.
2527

26-
* model: model to use (int 0/1/2, default=0)
28+
* model: Model to use. (int 0/1/2, default=0)
2729
* 0 = upconv_7_anime_style_art_rgb
2830
* 1 = upconv_7_photo
29-
* 2 = cunet (slow, but better quality)
31+
* 2 = cunet (For 2D artwork. Slow, but better quality.)
3032

31-
* tile_size: tile size (int >=32, default=180)
33+
* tile_size: Tile size. Must be divisible by 4. Increasing tile size will take more VRAM. (int >=32, default=180)
3234

33-
* gpu_id: gpu device to use (int >=0, default=0)
35+
* gpu_id: GPU device to use. (int >=0, default=0)
3436

35-
* gpu_thread: number of threads that can simultaneously access GPU (int >=1, default=0 for auto detect)
37+
* gpu_thread: Number of threads that can simultaneously access GPU. (int >=1, default=0 for auto detect)
38+
39+
* precision: Floating-point precision. Single-precision (fp32) is slow but more precise in color. Default is half-precision (fp16). (int 16/32, default=16)
3640

3741
## Performance Comparison
3842

3943
### AMD graphics card
4044

4145
* Ryzen 5 1600X + Radeon RX 580 2048SP
42-
* vapoursynth-waifu2x-ncnn-vulkan: `core.w2xnvk.Waifu2x(last, noise=0, scale=2, gpu_thread=3)`
46+
* vapoursynth-waifu2x-ncnn-vulkan: `core.w2xnvk.Waifu2x(last, noise=0, scale=2)`
4347
* vapoursynth-waifu2x-w2xc: `core.w2xc.Waifu2x(last, noise=0, scale=2)`
4448

4549
| | 540p -> 1080p | 720p -> 2K | 1080p -> 4K |
4650
|---------------------------------|----------------|-------------|-------------|
47-
| vapoursynth-waifu2x-ncnn-vulkan | 3.282 fps | 1.848 fps | 0.822 fps |
4851
| vapoursynth-waifu2x-w2xc | 0.744 fps | 0.435 fps | 0.199 fps |
52+
| vapoursynth-waifu2x-ncnn-vulkan | 3.203 fps | 1.788 fps | 0.795 fps |
4953

5054
### NVIDIA graphics card
5155

@@ -55,8 +59,8 @@ core.w2xnvk.Waifu2x(clip[, noise, scale, model, tile_size, gpu_id, gpu_thread])
5559

5660
| | 540p -> 1080p | 720p -> 2K | 1080p -> 4K |
5761
|---------------------------------|----------------|-------------|-------------|
58-
| vapoursynth-waifu2x-ncnn-vulkan | 1.759 fps | 1.003 fps | 0.455 fps |
5962
| vapoursynth-waifu2x-caffe | 1.674 fps | 1.085 fps | 0.477 fps |
63+
| vapoursynth-waifu2x-ncnn-vulkan | 1.880 fps | 1.034 fps | 0.471 fps |
6064

6165
## Build
6266

@@ -70,26 +74,14 @@ mkdir /tmp/workspace
7074
# build ncnn
7175
cd /tmp/workspace
7276
git clone https://github.com/Tencent/ncnn.git
73-
mkdir ncnn/build && cd ncnn/build
77+
cd ncnn && mkdir build && cd build
7478
cmake -DCMAKE_INSTALL_PREFIX=./install -DNCNN_VULKAN=ON -DNCNN_OPENMP=OFF ..
7579
make && make install
7680

77-
# build waifu2x-ncnn-vulkan
78-
cd /tmp/workspace
79-
git clone https://github.com/Nlzy/waifu2x-ncnn-vulkan.git
80-
mkdir waifu2x-ncnn-vulkan/src/build && cd waifu2x-ncnn-vulkan/src/build
81-
cmake -DCMAKE_INSTALL_PREFIX=./install -Dncnn_DIR=/tmp/workspace/ncnn/build/install/lib/cmake/ncnn ..
82-
make && make install
83-
8481
# build vapoursynth-waifu2x-ncnn-vulkan
8582
cd /tmp/workspace
8683
git clone https://github.com/Nlzy/vapoursynth-waifu2x-ncnn-vulkan.git
87-
mkdir vapoursynth-waifu2x-ncnn-vulkan/src/build
88-
cd vapoursynth-waifu2x-ncnn-vulkan/src/build
89-
cmake -DCMAKE_INSTALL_PREFIX=./install -Dncnn_DIR=/tmp/workspace/ncnn/build/install/lib/cmake/ncnn -Dw2xnvk_DIR=/tmp/workspace/waifu2x-ncnn-vulkan/src/build/install/lib/w2xnvk ..
84+
cd vapoursynth-waifu2x-ncnn-vulkan && mkdir build && cd build
85+
cmake -Dncnn_DIR=/tmp/workspace/ncnn/build/install/lib/cmake/ncnn ..
9086
make
9187
```
92-
93-
### Windows
94-
95-
TODO.

0 commit comments

Comments
 (0)