Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fmu2 authored Oct 21, 2024
1 parent da3f3d2 commit c8215ce
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,19 @@
<img src="docs/assets/teaser1.jpg" alt="teaser" width="90%" height="90%">
</p>
[//]: # (## Overview)
## Overview

[//]: # ()
[//]: # (This is the official PyTorch implementation of our method for Controllable Generation with pre-trained Diffusion Models.)
This is the official implementation of FreeControl, a Generative AI algorithm for controllable text-to-image generation using pre-trained Diffusion Models.

[//]: # ()
[//]: # (## Quick Start)
## Changelog
* 10/21/2024: Added SDXL pipeline.

* 02/19/2024: Initial code release. The paper is accepted to CVPR 2024.

## Getting Started

**Environment Setup**
- We proovide a [conda env file](environment.yml) for environment setup.
- We provide a [conda env file](environment.yml) for environment setup.
```bash
conda env create -f environment.yml
conda activate freecontrol
Expand All @@ -30,20 +31,19 @@ pip install -U gradio
```

**Sample Semantic Bases**
- We provide two example file under the [scripts](scripts) folder as an example of how to compute target semantic bases.
- You can also download from [google drive](https://drive.google.com/file/d/1o1BcIBANukeJ2pCG064-eNH9hbQoB24Z/view?usp=sharing) to use our pre-computed bases.
- After downloading the file, you can put it under the [dataset](dataset) folder and use the gradio demo.
- We provide three sample scripts in the [scripts](scripts) folder (one for each base model) to showcase how to compute target semantic bases.
- You may also download pre-computed bases from [google drive](https://drive.google.com/file/d/1o1BcIBANukeJ2pCG064-eNH9hbQoB24Z/view?usp=sharing). Put them in the [dataset](dataset) folder and launch the gradio demo.


**Gradio demo**
- We provide the user interface for testing out method. Ruuning the following commend to start the demo.
- We provide a graphical user interface (GUI) for users to try out FreeControl. Run the following command to start the demo.
```python
python gradio_app.py
```


## Galley:
We are building a gallery generated with FreeControl. You are wellcomed to share your generated images with us.
We are building a gallery of images generated with FreeControl. You are welcome to share your generated images with us.
## Contact
[Sicheng Mo](https://sichengmo.github.io/) ([email protected])

Expand All @@ -56,4 +56,4 @@ We are building a gallery generated with FreeControl. You are wellcomed to share
journal={arXiv preprint arXiv:2312.07536},
year={2023}
}
```
```

0 comments on commit c8215ce

Please sign in to comment.