Add dataset card and metadata
Browse filesThis PR adds a structured dataset card with metadata to improve discoverability and usability. It organizes the existing README content into a clearer format.
README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc-by-nc-4.0 # Assuming a Creative Commons license, adjust if needed.
|
| 3 |
+
task_categories:
|
| 4 |
+
- image-to-image
|
| 5 |
+
tags:
|
| 6 |
+
- image-editing
|
| 7 |
+
- artistic-style-transfer
|
| 8 |
+
- few-shot-learning
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# PhotoDoodle: Learning Artistic Image Editing from Few-Shot Pairwise Data
|
| 12 |
+
|
| 13 |
+
[Paper](https://arxiv.org/abs/2502.14397) | [Hugging Face Model](https://huggingface.co/nicolaus-huang/PhotoDoodle)
|
| 14 |
+
|
| 15 |
+
|
| 16 |
+
Authors: [Huang Shijie](https://scholar.google.com/citations?user=HmqYYosAAAAJ), [Yiren Song](https://scholar.google.com.hk/citations?user=L2YS0jgAAAAJ), [Yuxuan Zhang](https://xiaojiu-z.github.io/YuxuanZhang.github.io/), [Hailong Guo](https://github.com/logn-2024), Xueyin Wang, [Mike Zheng Shou](https://sites.google.com/view/showlab), [Liu Jiaming](https://scholar.google.com/citations?user=SmL7oMQAAAAJ&hl=en)
|
| 17 |
+
[Show Lab](https://sites.google.com/view/showlab), National University of Singapore
|
| 18 |
+
|
| 19 |
+
|
| 20 |
+
<img src='./assets/teaser.png' width='100%' />
|
| 21 |
+
|
| 22 |
+
|
| 23 |
+
## Dataset
|
| 24 |
+
|
| 25 |
+
This dataset provides paired image data for artistic image editing. Each entry contains:
|
| 26 |
+
|
| 27 |
+
* **source:** Path to the original image.
|
| 28 |
+
* **target:** Path to the artistically edited image.
|
| 29 |
+
* **caption:** A description of the edits applied.
|
| 30 |
+
|
| 31 |
+
|
| 32 |
+
The dataset is available on [Hugging Face Datasets](https://huggingface.co/datasets/nicolaus-huang/PhotoDoodle). See the [dataset README](./data/README.md) for further details (add if a separate README exists).
|
| 33 |
+
|
| 34 |
+
|
| 35 |
+
## Quick Start (Model Usage)
|
| 36 |
+
|
| 37 |
+
### Configuration
|
| 38 |
+
1. **Environment setup:**
|
| 39 |
+
```bash
|
| 40 |
+
git clone git@github.com:showlab/PhotoDoodle.git
|
| 41 |
+
cd PhotoDoodle
|
| 42 |
+
conda create -n doodle python=3.11.10
|
| 43 |
+
conda activate doodle
|
| 44 |
+
```
|
| 45 |
+
2. **Requirements installation:**
|
| 46 |
+
```bash
|
| 47 |
+
pip install torch==2.5.1 torchvision==0.20.1 torchaudio==2.5.1 --index-url https://download.pytorch.org/whl/cu124
|
| 48 |
+
pip install --upgrade -r requirements.txt
|
| 49 |
+
```
|
| 50 |
+
|
| 51 |
+
### Inference
|
| 52 |
+
The provided code integrates the `diffusers` pipeline with the PhotoDoodle model. You can run inference using the script:
|
| 53 |
+
|
| 54 |
+
```bash
|
| 55 |
+
python inference.py
|
| 56 |
+
```
|
| 57 |
+
|
| 58 |
+
or directly use the pipeline: (Code example from original README remains here)
|
| 59 |
+
|
| 60 |
+
```python
|
| 61 |
+
from src.pipeline_pe_clone import FluxPipeline
|
| 62 |
+
import torch
|
| 63 |
+
from PIL import Image
|
| 64 |
+
|
| 65 |
+
# ... (rest of the inference code from original README)
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
### Model Weights
|
| 69 |
+
[Hugging Face Model](https://huggingface.co/nicolaus-huang/PhotoDoodle) contains the following weights:
|
| 70 |
+
|
| 71 |
+
| Model Name | Description | Resolution |
|
| 72 |
+
|---------------------------------|------------------------------------------------|------------|
|
| 73 |
+
| `pretrain.safetensors` | Base PhotoDoodle model | 768, 768 |
|
| 74 |
+
| `sksmonstercalledlulu.safetensors` | Style model for Cartoon monster | 768, 512 |
|
| 75 |
+
| `sksmagiceffects.safetensors` | Style model for 3D effects | 768, 512 |
|
| 76 |
+
| `skspaintingeffects.safetensors` | Style model for Flowing color blocks | 768, 512 |
|
| 77 |
+
| `sksedgeeffect.safetensors` | Style model for Hand-drawn outline | 768, 512 |
|
| 78 |
+
|
| 79 |
+
**(Note: You need to load and fuse the `pretrained` checkpoint to use the style models.)**
|
| 80 |
+
|
| 81 |
+
|
| 82 |
+
### Results
|
| 83 |
+

|
| 84 |
+
|
| 85 |
+
## Citation
|
| 86 |
+
```
|
| 87 |
+
@misc{huang2025photodoodlelearningartisticimage,
|
| 88 |
+
title={PhotoDoodle: Learning Artistic Image Editing from Few-Shot Pairwise Data},
|
| 89 |
+
author={Shijie Huang and Yiren Song and Yuxuan Zhang and Hailong Guo and Xueyin Wang and Mike Zheng Shou and Jiaming Liu},
|
| 90 |
+
year={2025},
|
| 91 |
+
eprint={2502.14397},
|
| 92 |
+
archivePrefix={arXiv},
|
| 93 |
+
primaryClass={cs.CV},
|
| 94 |
+
url={https://arxiv.org/abs/2502.14397},
|
| 95 |
+
}
|
| 96 |
+
```
|