Skip to content

Commit

Permalink
docs: add README_zh
Browse files Browse the repository at this point in the history
  • Loading branch information
Nikaidou-Shinku committed Dec 18, 2023
1 parent 324a1e9 commit 220cc56
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
## Real-CUGAN-rs

English | [中文](./README_zh.md)

---

A Rust port of [Real-CUGAN](https://github.com/bilibili/ailab/tree/main/Real-CUGAN).

### Usages

Short view:
Quick view:

```shell
real-cugan-rs -i input.webp -o output.webp
Expand Down
40 changes: 40 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Real-CUGAN-rs

[English](./README.md) | 中文

---

[Real-CUGAN](https://github.com/bilibili/ailab/tree/main/Real-CUGAN) 的 Rust 移植。

### 使用方法

`input.webp` 超分后保存到 `output.webp`

```shell
real-cugan-rs -i input.webp -o output.webp
```

完整帮助文档:

```console
A Rust port of Real-CUGAN

Usage: real-cugan-rs [OPTIONS] --input-path <INPUT> --output-path <OUTPUT>

Options:
-i, --input-path <INPUT> Input image path
-o, --output-path <OUTPUT> Output image path
-c, --use-cpu Use CPU instead of GPU for inference
-m, --model-name <MODEL> Filename of the model in `models` directory [default: pro-no-denoise-up2x.pth]
-h, --help Print help
-V, --version Print version
```

支持的图片格式:JPEG、PNG、WebP。

### 注意事项

- 目前仅支持 pro 模型的 2 倍超分。
- 目前不支持切分图片后推理(仅支持直接使用整张图片进行推理)。
- 目前不支持透明图片。
- **欢迎 PR!**

0 comments on commit 220cc56

Please sign in to comment.