img2img-turbo 0.0.1
Wrapper package for img2img-turbo with python API
Requires Python: >=3.11

# img2img-turbo

**This repository is a pip-installable Python package + CPU/GPU compatibility wrapper** for the original **img2img-turbo** project by Gaurav Parmar et al.

**Original project & code:**  
[https://github.com/GaParmar/img2img-turbo](https://github.com/GaParmar/img2img-turbo)  
Please star the original repo if you find this work useful!

**Paper:** [One-Step Image Translation with Text-to-Image Models](https://arxiv.org/abs/2403.12036)  
**Authors:** Gaurav Parmar, Taesung Park, Srinivasa Narasimhan, Jun-Yan Zhu  
**Hugging Face Demo:** [gparmar/img2img-turbo-sketch](https://huggingface.co/spaces/gparmar/img2img-turbo-sketch)

**This packaged version (pip + CPU support):**  
[https://github.com/HamedDaneshvar/img2img-turbo](https://github.com/HamedDaneshvar/img2img-turbo)

Contributions welcome: issues, PRs, new models, better docs, etc.

---

[**Quick start:** Running Locally](#getting-started) · [**Gradio Demo**](#gradio-demo) · [**Training**](#training-with-your-own-data)

[**Paper**](https://arxiv.org/abs/2403.12036) | [**Sketch2Image Demo**](https://huggingface.co/spaces/gparmar/img2img-turbo-sketch) 
#### **Quick start:** [**Running Locally**](#getting-started) | [**Gradio (locally hosted)**](#gradio-demo) | [**Training**](#training-with-your-own-data)

### Cat Sketching
<p align="left" >
<img src="https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/cat_2x.gif" width="800" />
</p>

### Fish Sketching
<p align="left">
<img src="https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/fish_2x.gif"  width="800" />
</p>


We propose a general method for adapting a single-step diffusion model, such as SD-Turbo, to new tasks and domains through adversarial learning. This enables us to leverage the internal knowledge of pre-trained diffusion models while achieving efficient inference (e.g., for 512x512 images, 0.29 seconds on A6000 and 0.11 seconds on A100). 

Our one-step conditional models **CycleGAN-Turbo** and **pix2pix-turbo** can perform various image-to-image translation tasks for both unpaired and paired settings. CycleGAN-Turbo outperforms existing GAN-based and diffusion-based methods, while pix2pix-turbo is on par with recent works such as ControlNet for Sketch2Photo and Edge2Image, but with one-step inference. 

[One-Step Image Translation with Text-to-Image Models](https://arxiv.org/abs/2403.12036)<br>
[Gaurav Parmar](https://gauravparmar.com/), [Taesung Park](https://taesung.me/), [Srinivasa Narasimhan](https://www.cs.cmu.edu/~srinivas/), [Jun-Yan Zhu](https://github.com/junyanz/)<br>
CMU and Adobe, arXiv 2403.12036

<br>
<div>
<p align="center">
<img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/teaser_results.jpg' align="center" width=1000px>
</p>
</div>




## Results

### Paired Translation with pix2pix-turbo
**Edge to Image**
<div>
<p align="center">
<img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/edge_to_image_results.jpg' align="center" width=800px>
</p>
</div>

<!-- **Sketch to Image**
TODO -->
### Generating Diverse Outputs
By varying the input noise map, our method can generate diverse outputs from the same input conditioning.
The output style can be controlled by changing the text prompt.
<div> <p align="center">
<img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/gen_variations.jpg' align="center" width=800px>
</p> </div>

### Unpaired Translation with CycleGAN-Turbo

**Day to Night**
<div> <p align="center">
<img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/day2night_results.jpg' align="center" width=800px>
</p> </div>

**Night to Day**
<div><p align="center">
<img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/night2day_results.jpg' align="center" width=800px>
</p> </div>

**Clear to Rainy**
<div>
<p align="center">
<img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/clear2rainy_results.jpg' align="center" width=800px>
</p>
</div>

**Rainy to Clear**
<div>
<p align="center">
<img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/rainy2clear.jpg' align="center" width=800px>
</p>
</div>
<hr>


## Method
**Our Generator Architecture:**
We tightly integrate three separate modules in the original latent diffusion models into a single end-to-end network with small trainable weights. This architecture allows us to translate the input image x to the output y, while retaining the input scene structure. We use LoRA adapters in each module, introduce skip connections and Zero-Convs between input and output, and retrain the first layer of the U-Net. Blue boxes indicate trainable layers. Semi-transparent layers are frozen. The same generator can be used for various GAN objectives.
<div>
<p align="center">
<img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/method.jpg' align="center" width=900px>
</p>
</div>


## Getting Started
**Environment Setup**
- We provide a [conda env file](environment.yaml) that contains all the required dependencies.
    ```
    conda env create -f environment.yaml
    ```
- Following this, you can activate the conda environment with the command below. 
  ```
  conda activate img2img-turbo
  ```
- Or use virtual environment:
  ```
  python3 -m venv venv
  source venv/bin/activate
  pip install -r requirements.txt
  ```
**Paired Image Translation (pix2pix-turbo)**
- The following command takes an image file and a prompt as inputs, extracts the canny edges, and saves the results in the directory specified.
    ```bash
    python src/inference_paired.py --model_name "edge_to_image" \
        --input_image "assets/examples/bird.png" \
        --prompt "a blue bird" \
        --output_dir "outputs"
    ```
    <table>
    <th>Input Image</th>
    <th>Canny Edges</th>
    <th>Model Output</th>
    </tr>
    <tr>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/bird.png' width="200px"></td>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/bird_canny.png' width="200px"></td>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/bird_canny_blue.png' width="200px"></td>
    </tr>
    </table>
    <br>

- The following command takes a sketch and a prompt as inputs, and saves the results in the directory specified.
    ```bash
    python src/inference_paired.py --model_name "sketch_to_image_stochastic" \
    --input_image "assets/examples/sketch_input.png" --gamma 0.4 \
    --prompt "ethereal fantasy concept art of an asteroid. magnificent, celestial, ethereal, painterly, epic, majestic, magical, fantasy art, cover art, dreamy" \
    --output_dir "outputs"
    ```
    <table>
    <th>Input</th>
    <th>Model Output</th>
    </tr>
    <tr>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/sketch_input.png' width="400px"></td>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/sketch_output.png' width="400px"></td>
    </tr>
    </table>
    <br>

**Unpaired Image Translation (CycleGAN-Turbo)**
- The following command takes a **day** image file as input, and saves the output **night** in the directory specified.
    ```
    python src/inference_unpaired.py --model_name "day_to_night" \
        --input_image "assets/examples/day2night_input.png" --output_dir "outputs"
    ```
    <table>
    <th>Input (day)</th>
    <th>Model Output (night)</th>
    </tr>
    <tr>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/day2night_input.png' width="400px"></td>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/day2night_output.png' width="400px"></td>
    </tr>
    </table>

- The following command takes a **night** image file as input, and saves the output **day** in the directory specified.
    ```
    python src/inference_unpaired.py --model_name "night_to_day" \
        --input_image "assets/examples/night2day_input.png" --output_dir "outputs"
    ```
    <table>
    <th>Input (night)</th>
    <th>Model Output (day)</th>
    </tr>
    <tr>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/night2day_input.png' width="400px"></td>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/night2day_output.png' width="400px"></td>
    </tr>
    </table>

- The following command takes a **clear** image file as input, and saves the output **rainy** in the directory specified.
    ```
    python src/inference_unpaired.py --model_name "clear_to_rainy" \
        --input_image "assets/examples/clear2rainy_input.png" --output_dir "outputs"
    ```
    <table>
    <th>Input (clear)</th>
    <th>Model Output (rainy)</th>
    </tr>
    <tr>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/clear2rainy_input.png' width="400px"></td>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/clear2rainy_output.png' width="400px"></td>
    </tr>
    </table>

- The following command takes a **rainy** image file as input, and saves the output **clear** in the directory specified.
    ```
    python src/inference_unpaired.py --model_name "rainy_to_clear" \
        --input_image "assets/examples/rainy2clear_input.png" --output_dir "outputs"
    ```
    <table>
    <th>Input (rainy)</th>
    <th>Model Output (clear)</th>
    </tr>
    <tr>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/rainy2clear_input.png' width="400px"></td>
    <td><img src='https://raw.githubusercontent.com/HamedDaneshvar/img2img-turbo/main/assets/examples/rainy2clear_output.png' width="400px"></td>
    </tr>
    </table>



## Gradio Demo
- We provide a Gradio demo for the paired image translation tasks.
- The following command will launch the sketch to image locally using gradio.
    ```
    gradio gradio_sketch2image.py
    ```
- The following command will launch the canny edge to image gradio demo locally.
   ```
    gradio gradio_canny2image.py
   ```


## Training with your own data
- See the steps [here](docs/training_pix2pix_turbo.md) for training a pix2pix-turbo model on your paired data.
- See the steps [here](docs/training_cyclegan_turbo.md) for training a CycleGAN-Turbo model on your unpaired data.


## Acknowledgment
Our work uses the Stable Diffusion-Turbo as the base model with the following [LICENSE](https://huggingface.co/stabilityai/sd-turbo/blob/main/LICENSE).