2022-08-22 22:15:46 +08:00
# Stable Diffusion web UI
A browser interface based on Gradio library for Stable Diffusion.
2022-09-04 18:08:06 +08:00
2022-09-15 18:50:55 +08:00
## Features
[Detailed feature showcase with images ](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Features ):
2022-09-04 18:08:06 +08:00
- Original txt2img and img2img modes
2022-09-09 16:39:41 +08:00
- One click install and run script (but you still must install python and git)
2022-09-04 18:08:06 +08:00
- Outpainting
- Inpainting
- Prompt matrix
- Stable Diffusion upscale
- Attention
- Loopback
- X/Y plot
- Textual Inversion
2022-09-04 23:54:12 +08:00
- Extras tab with:
2022-09-15 18:50:55 +08:00
- GFPGAN, neural network that fixes faces
- CodeFormer, face restoration tool as an alternative to GFPGAN
- RealESRGAN, neural network upscaler
- ESRGAN, neural network with a lot of third party models
2022-09-22 04:58:41 +08:00
- SwinIR, neural network upscaler
2022-09-04 23:54:12 +08:00
- Resizing aspect ratio options
2022-09-04 18:08:06 +08:00
- Sampling method selection
- Interrupt processing at any time
2022-09-13 08:00:40 +08:00
- 4GB video card support
2022-09-04 18:08:06 +08:00
- Correct seeds for batches
- Prompt length validation
- Generation parameters added as text to PNG
- Tab to view an existing picture's generation parameters
- Settings page
- Running custom code from UI
2022-09-13 08:00:40 +08:00
- Mouseover hints for most UI elements
2022-09-04 18:52:01 +08:00
- Possible to change defaults/mix/max/step values for UI elements via text config
2022-09-07 04:10:12 +08:00
- Random artist button
- Tiling support: UI checkbox to create images that can be tiled like textures
- Progress bar and live image generation preview
2022-09-10 20:41:29 +08:00
- Negative prompt
2022-09-10 19:53:38 +08:00
- Styles
- Variations
- Seed resizing
2022-09-11 23:48:36 +08:00
- CLIP interrogator
2022-09-15 20:54:11 +08:00
- Prompt Editing
2022-09-22 04:58:41 +08:00
- Batch Processing
- Img2img Alternative
- Highres Fix
- Golatent Upscaling
2022-09-04 18:08:06 +08:00
2022-09-15 18:50:55 +08:00
## Installation and Running
Make sure the required [dependencies ](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Dependencies ) are met and follow the instructions available for both [NVidia ](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Install-and-Run-on-NVidia-GPUs ) (recommended) and [AMD ](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Install-and-Run-on-AMD-GPUs ) GPUs.
2022-09-11 17:13:26 +08:00
2022-09-15 18:50:55 +08:00
Alternatively, use [Google Colab ](https://colab.research.google.com/drive/1Iy-xW9t1-OQWhb0hNxueGij8phCyluOh ).
2022-09-02 14:49:35 +08:00
2022-09-15 18:50:55 +08:00
### Automatic Installation on Windows
1. Install [Python 3.10.6 ](https://www.python.org/downloads/windows/ ), checking "Add Python to PATH"
2. Install [git ](https://git-scm.com/download/win ).
3. Download the stable-diffusion-webui repository, for example by running `git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui.git` .
2022-09-18 14:09:10 +08:00
4. Place `model.ckpt` in the `models` directory (see [dependencies ](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Dependencies ) for where to get it).
2022-09-20 00:24:58 +08:00
5. _*(Optional)*_ Place `GFPGANv1.4.pth` in the base directory, alongside `webui.py` (see [dependencies ](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Dependencies ) for where to get it).
2022-09-18 14:09:10 +08:00
6. Run `webui-user.bat` from Windows Explorer as normal, non-administrator, user.
2022-09-09 13:37:19 +08:00
2022-09-15 18:50:55 +08:00
### Automatic Installation on Linux
1. Install the dependencies:
```bash
# Debian-based:
2022-09-13 21:28:04 +08:00
sudo apt install wget git python3 python3-venv
2022-09-15 18:50:55 +08:00
# Red Hat-based:
2022-09-13 21:28:04 +08:00
sudo dnf install wget git python3
2022-09-15 18:50:55 +08:00
# Arch-based:
sudo pacman -S wget git python3
2022-09-13 21:28:04 +08:00
```
2022-09-15 18:50:55 +08:00
2. To install in `/home/$(whoami)/stable-diffusion-webui/` , run:
2022-09-10 05:31:58 +08:00
```bash
2022-09-15 18:50:55 +08:00
bash < (wget -qO- https://raw.githubusercontent.com/AUTOMATIC1111/stable-diffusion-webui/master/webui.sh)
2022-09-10 05:31:58 +08:00
```
2022-09-15 18:50:55 +08:00
## Documentation
The documentation was moved from this README over to the project's [wiki ](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki ).
2022-09-12 06:55:34 +08:00
2022-09-05 00:09:00 +08:00
## Credits
- Stable Diffusion - https://github.com/CompVis/stable-diffusion, https://github.com/CompVis/taming-transformers
- k-diffusion - https://github.com/crowsonkb/k-diffusion.git
- GFPGAN - https://github.com/TencentARC/GFPGAN.git
2022-09-21 15:38:06 +08:00
- CodeFormer - https://github.com/sczhou/CodeFormer
2022-09-05 00:09:00 +08:00
- ESRGAN - https://github.com/xinntao/ESRGAN
2022-09-22 04:58:41 +08:00
- SwinIR - https://github.com/JingyunLiang/SwinIR
2022-09-10 17:06:19 +08:00
- Ideas for optimizations - https://github.com/basujindal/stable-diffusion
2022-09-15 20:54:11 +08:00
- Doggettx - Cross Attention layer optimization - https://github.com/Doggettx/stable-diffusion, original idea for prompt editing.
2022-09-05 00:09:00 +08:00
- Idea for SD upscale - https://github.com/jquesnelle/txt2imghd
2022-09-17 04:17:10 +08:00
- Noise generation for outpainting mk2 - https://github.com/parlance-zz/g-diffuser-bot
2022-09-11 23:48:36 +08:00
- CLIP interrogator idea and borrowing some code - https://github.com/pharmapsychotic/clip-interrogator
2022-09-05 00:09:00 +08:00
- Initial Gradio script - posted on 4chan by an Anonymous user. Thank you Anonymous user.
2022-09-15 18:50:55 +08:00
- (You)
