nielsr HF Staff commited on
Commit
92d9246
·
verified ·
1 Parent(s): 9b50d4c

Improve model card

Browse files

This PR improves the model card for VeraRetouch by adding the relevant pipeline tag, linking to the paper, project page, and GitHub repository, and providing detailed sample usage instructions for the various retouching modes (Auto, Style, and Param).

Files changed (1) hide show
  1. README.md +66 -3
README.md CHANGED
@@ -1,3 +1,66 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ pipeline_tag: image-to-image
4
+ ---
5
+
6
+ # VeraRetouch: A Lightweight Fully Differentiable Framework for Multi-Task Reasoning Photo Retouching
7
+
8
+ VeraRetouch is a lightweight and fully differentiable framework for multi-task photo retouching. It employs a 0.5B Vision-Language Model (VLM) as the central intelligence to formulate retouching plans based on instructions and scene semantics, combined with a fully differentiable Retouch Renderer for direct end-to-end pixel-level training.
9
+
10
+ [**Paper**](https://huggingface.co/papers/2604.27375) | [**Project Page**](https://apollo-yi.github.io/VeraRetouch/) | [**GitHub**](https://github.com/OpenVeraTeam/VeraRetouch)
11
+
12
+ ## 🚀 Quick Start
13
+
14
+ ### ⚙️ Environment Setup
15
+ ```bash
16
+ # Clone the repository
17
+ git clone https://github.com/OpenVeraTeam/VeraRetouch.git
18
+ cd VeraRetouch
19
+
20
+ # Create and activate conda environment
21
+ conda create -n vera-retouch python=3.10
22
+ conda activate vera-retouch
23
+ pip install -r requirements.txt
24
+ ```
25
+
26
+ ### 🎨 Inference Modes
27
+ VeraRetouch supports three primary inference modes via `inference.py`. Ensure you have downloaded the weights and placed them in the `./checkpoints` directory.
28
+
29
+ #### Auto Retouch
30
+ Automatically enhances an image based on scene analysis.
31
+ ```bash
32
+ python inference.py --mode auto \
33
+ --model-path ./checkpoints/VeraRetouch \
34
+ --img_paths ./data_samples/input/sample_flower.jpg \
35
+ --save_dir ./data_samples/output/
36
+ ```
37
+
38
+ #### Style Retouch
39
+ Retouches an image based on a specific user prompt.
40
+ ```bash
41
+ python inference.py --mode style \
42
+ --prompt "I want a dreamy bright pink style." \
43
+ --model-path ./checkpoints/VeraRetouch \
44
+ --img_paths ./data_samples/input/sample_flower.jpg \
45
+ --save_dir ./data_samples/output/
46
+ ```
47
+
48
+ #### Param Retouch
49
+ Applies retouching based on specific operator parameters.
50
+ ```bash
51
+ python inference.py --mode style \
52
+ --instruction_path ./data_samples/param.json \
53
+ --model-path ./checkpoints/VeraRetouch \
54
+ --img_paths ./data_samples/input/sample_flower.jpg \
55
+ --save_dir ./data_samples/output/
56
+ ```
57
+
58
+ ## Citation
59
+ ```bibtex
60
+ @article{guo2026veraretouch,
61
+ title={VeraRetouch: A Lightweight Fully Differentiable Framework for Multi-Task Reasoning Photo Retouching},
62
+ author={Guo, Yihong and Lyu, Youwei and Tang, Jiajun and Zhou, Yizhuo and Wang, Hongliang and Chen, Jinwei and Zou, Changqing and Fan, Qingnan},
63
+ journal={arXiv preprint arXiv:2604.27375},
64
+ year={2026}
65
+ }
66
+ ```