diff --git a/README.md b/README.md index 2c3918f..dae06d3 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,18 @@ # Stable Diffusion Modal -This is the script to execute Stable Diffusion on [Modal](https://modal.com/). +This is a Diffusers-based script for running Stable Diffusion on [Modal](https://modal.com/). It can perform txt2img inference and has the ability to increase resolution using ControlNet Tile and Upscaler. + +## Features + +1. Image generation using txt2img +![](assets/20230902_tile_imgs.png) + +2. Upscaling + +| Before upscaling | After upscaling | +| ---- | ---- | +| | | ## Requirements @@ -31,11 +42,10 @@ Please see [the documentation of Modal](https://modal.com/docs/guide) for modals To use the script, execute the below. 1. git clone the repository. -2. Create the `.env` file and set a huggingface API token with reference to `.env.example`. -3. Copy `./setup_files/config.sample.yml` to `./setup_files/config.yml` -4. Open the Makefile and set prompts. -5. Execute `make deploy` command. An application will be deployed to Modal. -6. Execute `make run` command. +2. Copy `./setup_files/config.sample.yml` to `./setup_files/config.yml` +3. Open the Makefile and set prompts. +4. Execute `make deploy` command. An application will be deployed to Modal. +5. Execute `make run` command. Images are generated and output to the `outputs/` directory.