Add pipeline tag, paper link and sample usage

#1
by nielsr HF Staff - opened
Files changed (1) hide show
  1. README.md +18 -10
README.md CHANGED
@@ -1,27 +1,35 @@
1
  ---
2
  license: apache-2.0
 
3
  ---
4
 
5
  # RealRestorer Degradation Models
6
 
7
- This repository provides the degradation models used in the degradation pipeline of [RealRestorer](https://github.com/yfyang007/RealRestorer).
8
 
9
  In particular, these models are used for **moire synthesis** and **specular reflection synthesis** in the RealRestorer degradation pipeline, which are designed to generate realistic degradations for training data construction and controlled degradation simulation.
10
 
11
- ## Usage
12
 
13
- Please refer to the main RealRestorer repository for the complete pipeline, code, and usage instructions:
 
 
 
 
14
 
15
- - **RealRestorer**: https://github.com/yfyang007/RealRestorer
16
 
17
  These degradation models are intended to be used together with the degradation pipeline in RealRestorer rather than as a standalone image restoration model.
18
 
19
- ## Related Links
20
-
21
- - **Project Page**: https://yfyang007.github.io/RealRestorer/
22
- - **RealRestorer Model**: https://huggingface.co/RealRestorer/RealRestorer
23
- - **RealIR-Bench**: https://huggingface.co/datasets/RealRestorer/RealIR-Bench
24
 
 
 
 
 
 
 
 
25
 
26
  ## Citation
27
 
@@ -55,4 +63,4 @@ If you find RealRestorer useful in your research, please star and cite:
55
  pages={3771--3779},
56
  year={2019}
57
  }
58
- ```
 
1
  ---
2
  license: apache-2.0
3
+ pipeline_tag: image-to-image
4
  ---
5
 
6
  # RealRestorer Degradation Models
7
 
8
+ This repository provides the degradation models used in the degradation pipeline of **RealRestorer**, as presented in the paper [RealRestorer: Towards Generalizable Real-World Image Restoration with Large-Scale Image Editing Models](https://huggingface.co/papers/2603.25502).
9
 
10
  In particular, these models are used for **moire synthesis** and **specular reflection synthesis** in the RealRestorer degradation pipeline, which are designed to generate realistic degradations for training data construction and controlled degradation simulation.
11
 
12
+ ## Links
13
 
14
+ - **Paper**: [RealRestorer: Towards Generalizable Real-World Image Restoration with Large-Scale Image Editing Models](https://huggingface.co/papers/2603.25502)
15
+ - **Project Page**: [https://yfyang007.github.io/RealRestorer/](https://yfyang007.github.io/RealRestorer/)
16
+ - **Code**: [https://github.com/yfyang007/RealRestorer](https://github.com/yfyang007/RealRestorer)
17
+ - **RealRestorer Model**: [Hugging Face](https://huggingface.co/RealRestorer/RealRestorer)
18
+ - **RealIR-Bench Dataset**: [Hugging Face](https://huggingface.co/datasets/RealRestorer/RealIR-Bench)
19
 
20
+ ## Usage
21
 
22
  These degradation models are intended to be used together with the degradation pipeline in RealRestorer rather than as a standalone image restoration model.
23
 
24
+ To synthesize degradations (e.g., reflection) using these models, you can use the generation script provided in the [official repository](https://github.com/yfyang007/RealRestorer):
 
 
 
 
25
 
26
+ ```bash
27
+ python3 infer_degradation.py \
28
+ --image /path/to/input.png \
29
+ --degradation reflection \
30
+ --output /path/to/degraded.png \
31
+ --reflection_ckpt_path /path/to/130_net_G.pth
32
+ ```
33
 
34
  ## Citation
35
 
 
63
  pages={3771--3779},
64
  year={2019}
65
  }
66
+ ```