diff --git a/Setup-&-Usage.md b/Setup-&-Usage.md new file mode 100644 index 0000000..9752b7c --- /dev/null +++ b/Setup-&-Usage.md @@ -0,0 +1,51 @@ +# Make sure you have the latest version of docker installed + +## Automatic setup + +Download this repo and run: + +``` +docker compose --profile download up --build +``` +This will download all of the required models / files, and validate their integrity. + +Next, choose which UI you want to run: +- `hlky`: The most popular fork, many features, with more on the way, [sd-webui/stable-diffusion-webui](https://github.com/sd-webui/stable-diffusion-webui) +- `auto`: Another great fork, many features with neat UI, [AUTOMATIC1111/stable-diffusion-webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui) +- `auto-cpu`: for users without a GPU. +- `lstein`: One of the earliest forks, the UI is simple but has a lot of potential, [lstein/stable-diffusion](https://github.com/lstein/stable-diffusion) + +After the download is done, you can run the UI using: +```bash +docker compose --profile [ui] up --build +# for example: +# docker compose --profile auto up --build +# or +# docker compose --profile hlky up --build +``` + +Will start the app on http://localhost:7860/ + + +Note: the first start will take some time since other models will be downloaded, these will be cached in the `cache` folder, so next runs are faster. + + +## Manual Download + +Download the models: +- [Stable Diffusion v1.4 (4GB)](https://www.googleapis.com/storage/v1/b/aai-blog-files/o/sd-v1-4.ckpt?alt=media), rename to `model.ckpt` +- [GFPGANv1.3.pth (333MB)](https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.3.pth). +- [RealESRGAN_x4plus.pth (64MB)](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.1.0/RealESRGAN_x4plus.pth) and [RealESRGAN_x4plus_anime_6B.pth (18MB)](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.2.4/RealESRGAN_x4plus_anime_6B.pth). +- [LDSR (2GB)](https://heibox.uni-heidelberg.de/f/578df07c8fc04ffbadf3/?dl=1) and [its configuration](https://heibox.uni-heidelberg.de/f/31a76b13ea27482981b4/?dl=1), rename to `LDSR.ckpt` and `LDSR.yaml` respectively. + +Put all of the downloaded files in the `cache/models` folder (create the folder if not there), it should look something like this: + +``` +cache/models/ +├── model.ckpt +├── GFPGANv1.3.pth +├── RealESRGAN_x4plus.pth +├── RealESRGAN_x4plus_anime_6B.pth +├── LDSR.ckpt +└── LDSR.yaml +``` \ No newline at end of file