Update README.md
Browse files
README.md
CHANGED
@@ -1,205 +1,215 @@
|
|
1 |
-
|
2 |
-
|
3 |
-
|
4 |
-
|
5 |
-
|
6 |
-
|
7 |
-
|
8 |
-
|
9 |
-
|
10 |
-
|
11 |
-
|
12 |
-
|
13 |
-
|
14 |
-
|
15 |
-
|
16 |
-
|
17 |
-
|
18 |
-
|
19 |
-
-
|
20 |
-
-
|
21 |
-
-
|
22 |
-
|
23 |
-
|
24 |
-
|
25 |
-
|
26 |
-
-
|
27 |
-
-
|
28 |
-
-
|
29 |
-
|
30 |
-
|
31 |
-
|
32 |
-
-
|
33 |
-
-
|
34 |
-
-
|
35 |
-
-
|
36 |
-
|
37 |
-
-
|
38 |
-
-
|
39 |
-
-
|
40 |
-
-
|
41 |
-
-
|
42 |
-
|
43 |
-
|
44 |
-
|
45 |
-
|
46 |
-
|
47 |
-
-
|
48 |
-
-
|
49 |
-
-
|
50 |
-
-
|
51 |
-
-
|
52 |
-
-
|
53 |
-
-
|
54 |
-
|
55 |
-
-
|
56 |
-
-
|
57 |
-
-
|
58 |
-
-
|
59 |
-
-
|
60 |
-
-
|
61 |
-
-
|
62 |
-
-
|
63 |
-
-
|
64 |
-
-
|
65 |
-
-
|
66 |
-
-
|
67 |
-
-
|
68 |
-
|
69 |
-
|
70 |
-
-
|
71 |
-
-
|
72 |
-
-
|
73 |
-
-
|
74 |
-
-
|
75 |
-
-
|
76 |
-
|
77 |
-
|
78 |
-
-
|
79 |
-
-
|
80 |
-
-
|
81 |
-
-
|
82 |
-
-
|
83 |
-
-
|
84 |
-
-
|
85 |
-
-
|
86 |
-
-
|
87 |
-
-
|
88 |
-
-
|
89 |
-
-
|
90 |
-
-
|
91 |
-
-
|
92 |
-
-
|
93 |
-
-
|
94 |
-
-
|
95 |
-
|
96 |
-
|
97 |
-
|
98 |
-
- [
|
99 |
-
-
|
100 |
-
-
|
101 |
-
-
|
102 |
-
|
103 |
-
|
104 |
-
|
105 |
-
|
106 |
-
|
107 |
-
|
108 |
-
|
109 |
-
|
110 |
-
|
111 |
-
|
112 |
-
|
113 |
-
|
114 |
-
|
115 |
-
|
116 |
-
|
117 |
-
|
118 |
-
|
119 |
-
|
120 |
-
|
121 |
-
|
122 |
-
|
123 |
-
|
124 |
-
|
125 |
-
|
126 |
-
|
127 |
-
|
128 |
-
|
129 |
-
|
130 |
-
|
131 |
-
|
132 |
-
|
133 |
-
|
134 |
-
|
135 |
-
sudo
|
136 |
-
|
137 |
-
|
138 |
-
#
|
139 |
-
sudo pacman -S
|
140 |
-
|
141 |
-
|
142 |
-
|
143 |
-
#
|
144 |
-
|
145 |
-
|
146 |
-
|
147 |
-
|
148 |
-
|
149 |
-
|
150 |
-
|
151 |
-
|
152 |
-
|
153 |
-
|
154 |
-
|
155 |
-
|
156 |
-
|
157 |
-
|
158 |
-
|
159 |
-
|
160 |
-
|
161 |
-
|
162 |
-
|
163 |
-
|
164 |
-
|
165 |
-
|
166 |
-
|
167 |
-
|
168 |
-
|
169 |
-
|
170 |
-
|
171 |
-
|
172 |
-
|
173 |
-
|
174 |
-
|
175 |
-
|
176 |
-
|
177 |
-
|
178 |
-
|
179 |
-
|
180 |
-
|
181 |
-
|
182 |
-
|
183 |
-
|
184 |
-
|
185 |
-
-
|
186 |
-
-
|
187 |
-
-
|
188 |
-
-
|
189 |
-
-
|
190 |
-
-
|
191 |
-
-
|
192 |
-
-
|
193 |
-
-
|
194 |
-
-
|
195 |
-
-
|
196 |
-
-
|
197 |
-
-
|
198 |
-
-
|
199 |
-
-
|
200 |
-
-
|
201 |
-
-
|
202 |
-
-
|
203 |
-
-
|
204 |
-
-
|
205 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
license: apache-2.0
|
3 |
+
title: A1111
|
4 |
+
sdk: gradio
|
5 |
+
emoji: 🚀
|
6 |
+
colorFrom: indigo
|
7 |
+
colorTo: yellow
|
8 |
+
pinned: true
|
9 |
+
short_description: AI generator
|
10 |
+
---
|
11 |
+
# Stable Diffusion web UI
|
12 |
+
A web interface for Stable Diffusion, implemented using Gradio library.
|
13 |
+
|
14 |
+

|
15 |
+
|
16 |
+
## Features
|
17 |
+
[Detailed feature showcase with images](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Features):
|
18 |
+
- Original txt2img and img2img modes
|
19 |
+
- One click install and run script (but you still must install python and git)
|
20 |
+
- Outpainting
|
21 |
+
- Inpainting
|
22 |
+
- Color Sketch
|
23 |
+
- Prompt Matrix
|
24 |
+
- Stable Diffusion Upscale
|
25 |
+
- Attention, specify parts of text that the model should pay more attention to
|
26 |
+
- a man in a `((tuxedo))` - will pay more attention to tuxedo
|
27 |
+
- a man in a `(tuxedo:1.21)` - alternative syntax
|
28 |
+
- select text and press `Ctrl+Up` or `Ctrl+Down` (or `Command+Up` or `Command+Down` if you're on a MacOS) to automatically adjust attention to selected text (code contributed by anonymous user)
|
29 |
+
- Loopback, run img2img processing multiple times
|
30 |
+
- X/Y/Z plot, a way to draw a 3 dimensional plot of images with different parameters
|
31 |
+
- Textual Inversion
|
32 |
+
- have as many embeddings as you want and use any names you like for them
|
33 |
+
- use multiple embeddings with different numbers of vectors per token
|
34 |
+
- works with half precision floating point numbers
|
35 |
+
- train embeddings on 8GB (also reports of 6GB working)
|
36 |
+
- Extras tab with:
|
37 |
+
- GFPGAN, neural network that fixes faces
|
38 |
+
- CodeFormer, face restoration tool as an alternative to GFPGAN
|
39 |
+
- RealESRGAN, neural network upscaler
|
40 |
+
- ESRGAN, neural network upscaler with a lot of third party models
|
41 |
+
- SwinIR and Swin2SR ([see here](https://github.com/AUTOMATIC1111/stable-diffusion-webui/pull/2092)), neural network upscalers
|
42 |
+
- LDSR, Latent diffusion super resolution upscaling
|
43 |
+
- Resizing aspect ratio options
|
44 |
+
- Sampling method selection
|
45 |
+
- Adjust sampler eta values (noise multiplier)
|
46 |
+
- More advanced noise setting options
|
47 |
+
- Interrupt processing at any time
|
48 |
+
- 4GB video card support (also reports of 2GB working)
|
49 |
+
- Correct seeds for batches
|
50 |
+
- Live prompt token length validation
|
51 |
+
- Generation parameters
|
52 |
+
- parameters you used to generate images are saved with that image
|
53 |
+
- in PNG chunks for PNG, in EXIF for JPEG
|
54 |
+
- can drag the image to PNG info tab to restore generation parameters and automatically copy them into UI
|
55 |
+
- can be disabled in settings
|
56 |
+
- drag and drop an image/text-parameters to promptbox
|
57 |
+
- Read Generation Parameters Button, loads parameters in promptbox to UI
|
58 |
+
- Settings page
|
59 |
+
- Running arbitrary python code from UI (must run with `--allow-code` to enable)
|
60 |
+
- Mouseover hints for most UI elements
|
61 |
+
- Possible to change defaults/mix/max/step values for UI elements via text config
|
62 |
+
- Tiling support, a checkbox to create images that can be tiled like textures
|
63 |
+
- Progress bar and live image generation preview
|
64 |
+
- Can use a separate neural network to produce previews with almost none VRAM or compute requirement
|
65 |
+
- Negative prompt, an extra text field that allows you to list what you don't want to see in generated image
|
66 |
+
- Styles, a way to save part of prompt and easily apply them via dropdown later
|
67 |
+
- Variations, a way to generate same image but with tiny differences
|
68 |
+
- Seed resizing, a way to generate same image but at slightly different resolution
|
69 |
+
- CLIP interrogator, a button that tries to guess prompt from an image
|
70 |
+
- Prompt Editing, a way to change prompt mid-generation, say to start making a watermelon and switch to anime girl midway
|
71 |
+
- Batch Processing, process a group of files using img2img
|
72 |
+
- Img2img Alternative, reverse Euler method of cross attention control
|
73 |
+
- Highres Fix, a convenience option to produce high resolution pictures in one click without usual distortions
|
74 |
+
- Reloading checkpoints on the fly
|
75 |
+
- Checkpoint Merger, a tab that allows you to merge up to 3 checkpoints into one
|
76 |
+
- [Custom scripts](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Custom-Scripts) with many extensions from community
|
77 |
+
- [Composable-Diffusion](https://energy-based-model.github.io/Compositional-Visual-Generation-with-Composable-Diffusion-Models/), a way to use multiple prompts at once
|
78 |
+
- separate prompts using uppercase `AND`
|
79 |
+
- also supports weights for prompts: `a cat :1.2 AND a dog AND a penguin :2.2`
|
80 |
+
- No token limit for prompts (original stable diffusion lets you use up to 75 tokens)
|
81 |
+
- DeepDanbooru integration, creates danbooru style tags for anime prompts
|
82 |
+
- [xformers](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Xformers), major speed increase for select cards: (add `--xformers` to commandline args)
|
83 |
+
- via extension: [History tab](https://github.com/yfszzx/stable-diffusion-webui-images-browser): view, direct and delete images conveniently within the UI
|
84 |
+
- Generate forever option
|
85 |
+
- Training tab
|
86 |
+
- hypernetworks and embeddings options
|
87 |
+
- Preprocessing images: cropping, mirroring, autotagging using BLIP or deepdanbooru (for anime)
|
88 |
+
- Clip skip
|
89 |
+
- Hypernetworks
|
90 |
+
- Loras (same as Hypernetworks but more pretty)
|
91 |
+
- A separate UI where you can choose, with preview, which embeddings, hypernetworks or Loras to add to your prompt
|
92 |
+
- Can select to load a different VAE from settings screen
|
93 |
+
- Estimated completion time in progress bar
|
94 |
+
- API
|
95 |
+
- Support for dedicated [inpainting model](https://github.com/runwayml/stable-diffusion#inpainting-with-stable-diffusion) by RunwayML
|
96 |
+
- via extension: [Aesthetic Gradients](https://github.com/AUTOMATIC1111/stable-diffusion-webui-aesthetic-gradients), a way to generate images with a specific aesthetic by using clip images embeds (implementation of [https://github.com/vicgalle/stable-diffusion-aesthetic-gradients](https://github.com/vicgalle/stable-diffusion-aesthetic-gradients))
|
97 |
+
- [Stable Diffusion 2.0](https://github.com/Stability-AI/stablediffusion) support - see [wiki](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Features#stable-diffusion-20) for instructions
|
98 |
+
- [Alt-Diffusion](https://arxiv.org/abs/2211.06679) support - see [wiki](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Features#alt-diffusion) for instructions
|
99 |
+
- Now without any bad letters!
|
100 |
+
- Load checkpoints in safetensors format
|
101 |
+
- Eased resolution restriction: generated image's dimensions must be a multiple of 8 rather than 64
|
102 |
+
- Now with a license!
|
103 |
+
- Reorder elements in the UI from settings screen
|
104 |
+
- [Segmind Stable Diffusion](https://huggingface.co/segmind/SSD-1B) support
|
105 |
+
|
106 |
+
## Installation and Running
|
107 |
+
Make sure the required [dependencies](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Dependencies) are met and follow the instructions available for:
|
108 |
+
- [NVidia](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Install-and-Run-on-NVidia-GPUs) (recommended)
|
109 |
+
- [AMD](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Install-and-Run-on-AMD-GPUs) GPUs.
|
110 |
+
- [Intel CPUs, Intel GPUs (both integrated and discrete)](https://github.com/openvinotoolkit/stable-diffusion-webui/wiki/Installation-on-Intel-Silicon) (external wiki page)
|
111 |
+
- [Ascend NPUs](https://github.com/wangshuai09/stable-diffusion-webui/wiki/Install-and-run-on-Ascend-NPUs) (external wiki page)
|
112 |
+
|
113 |
+
Alternatively, use online services (like Google Colab):
|
114 |
+
|
115 |
+
- [List of Online Services](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Online-Services)
|
116 |
+
|
117 |
+
### Installation on Windows 10/11 with NVidia-GPUs using release package
|
118 |
+
1. Download `sd.webui.zip` from [v1.0.0-pre](https://github.com/AUTOMATIC1111/stable-diffusion-webui/releases/tag/v1.0.0-pre) and extract its contents.
|
119 |
+
2. Run `update.bat`.
|
120 |
+
3. Run `run.bat`.
|
121 |
+
> For more details see [Install-and-Run-on-NVidia-GPUs](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Install-and-Run-on-NVidia-GPUs)
|
122 |
+
|
123 |
+
### Automatic Installation on Windows
|
124 |
+
1. Install [Python 3.10.6](https://www.python.org/downloads/release/python-3106/) (Newer version of Python does not support torch), checking "Add Python to PATH".
|
125 |
+
2. Install [git](https://git-scm.com/download/win).
|
126 |
+
3. Download the stable-diffusion-webui repository, for example by running `git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui.git`.
|
127 |
+
4. Run `webui-user.bat` from Windows Explorer as normal, non-administrator, user.
|
128 |
+
|
129 |
+
### Automatic Installation on Linux
|
130 |
+
1. Install the dependencies:
|
131 |
+
```bash
|
132 |
+
# Debian-based:
|
133 |
+
sudo apt install wget git python3 python3-venv libgl1 libglib2.0-0
|
134 |
+
# Red Hat-based:
|
135 |
+
sudo dnf install wget git python3 gperftools-libs libglvnd-glx
|
136 |
+
# openSUSE-based:
|
137 |
+
sudo zypper install wget git python3 libtcmalloc4 libglvnd
|
138 |
+
# Arch-based:
|
139 |
+
sudo pacman -S wget git python3
|
140 |
+
```
|
141 |
+
If your system is very new, you need to install python3.11 or python3.10:
|
142 |
+
```bash
|
143 |
+
# Ubuntu 24.04
|
144 |
+
sudo add-apt-repository ppa:deadsnakes/ppa
|
145 |
+
sudo apt update
|
146 |
+
sudo apt install python3.11
|
147 |
+
|
148 |
+
# Manjaro/Arch
|
149 |
+
sudo pacman -S yay
|
150 |
+
yay -S python311 # do not confuse with python3.11 package
|
151 |
+
|
152 |
+
# Only for 3.11
|
153 |
+
# Then set up env variable in launch script
|
154 |
+
export python_cmd="python3.11"
|
155 |
+
# or in webui-user.sh
|
156 |
+
python_cmd="python3.11"
|
157 |
+
```
|
158 |
+
2. Navigate to the directory you would like the webui to be installed and execute the following command:
|
159 |
+
```bash
|
160 |
+
wget -q https://raw.githubusercontent.com/AUTOMATIC1111/stable-diffusion-webui/master/webui.sh
|
161 |
+
```
|
162 |
+
Or just clone the repo wherever you want:
|
163 |
+
```bash
|
164 |
+
git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui
|
165 |
+
```
|
166 |
+
|
167 |
+
3. Run `webui.sh`.
|
168 |
+
4. Check `webui-user.sh` for options.
|
169 |
+
### Installation on Apple Silicon
|
170 |
+
|
171 |
+
Find the instructions [here](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Installation-on-Apple-Silicon).
|
172 |
+
|
173 |
+
## Contributing
|
174 |
+
Here's how to add code to this repo: [Contributing](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Contributing)
|
175 |
+
|
176 |
+
## Documentation
|
177 |
+
|
178 |
+
The documentation was moved from this README over to the project's [wiki](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki).
|
179 |
+
|
180 |
+
For the purposes of getting Google and other search engines to crawl the wiki, here's a link to the (not for humans) [crawlable wiki](https://github-wiki-see.page/m/AUTOMATIC1111/stable-diffusion-webui/wiki).
|
181 |
+
|
182 |
+
## Credits
|
183 |
+
Licenses for borrowed code can be found in `Settings -> Licenses` screen, and also in `html/licenses.html` file.
|
184 |
+
|
185 |
+
- Stable Diffusion - https://github.com/Stability-AI/stablediffusion, https://github.com/CompVis/taming-transformers, https://github.com/mcmonkey4eva/sd3-ref
|
186 |
+
- k-diffusion - https://github.com/crowsonkb/k-diffusion.git
|
187 |
+
- Spandrel - https://github.com/chaiNNer-org/spandrel implementing
|
188 |
+
- GFPGAN - https://github.com/TencentARC/GFPGAN.git
|
189 |
+
- CodeFormer - https://github.com/sczhou/CodeFormer
|
190 |
+
- ESRGAN - https://github.com/xinntao/ESRGAN
|
191 |
+
- SwinIR - https://github.com/JingyunLiang/SwinIR
|
192 |
+
- Swin2SR - https://github.com/mv-lab/swin2sr
|
193 |
+
- LDSR - https://github.com/Hafiidz/latent-diffusion
|
194 |
+
- MiDaS - https://github.com/isl-org/MiDaS
|
195 |
+
- Ideas for optimizations - https://github.com/basujindal/stable-diffusion
|
196 |
+
- Cross Attention layer optimization - Doggettx - https://github.com/Doggettx/stable-diffusion, original idea for prompt editing.
|
197 |
+
- Cross Attention layer optimization - InvokeAI, lstein - https://github.com/invoke-ai/InvokeAI (originally http://github.com/lstein/stable-diffusion)
|
198 |
+
- Sub-quadratic Cross Attention layer optimization - Alex Birch (https://github.com/Birch-san/diffusers/pull/1), Amin Rezaei (https://github.com/AminRezaei0x443/memory-efficient-attention)
|
199 |
+
- Textual Inversion - Rinon Gal - https://github.com/rinongal/textual_inversion (we're not using his code, but we are using his ideas).
|
200 |
+
- Idea for SD upscale - https://github.com/jquesnelle/txt2imghd
|
201 |
+
- Noise generation for outpainting mk2 - https://github.com/parlance-zz/g-diffuser-bot
|
202 |
+
- CLIP interrogator idea and borrowing some code - https://github.com/pharmapsychotic/clip-interrogator
|
203 |
+
- Idea for Composable Diffusion - https://github.com/energy-based-model/Compositional-Visual-Generation-with-Composable-Diffusion-Models-PyTorch
|
204 |
+
- xformers - https://github.com/facebookresearch/xformers
|
205 |
+
- DeepDanbooru - interrogator for anime diffusers https://github.com/KichangKim/DeepDanbooru
|
206 |
+
- Sampling in float32 precision from a float16 UNet - marunine for the idea, Birch-san for the example Diffusers implementation (https://github.com/Birch-san/diffusers-play/tree/92feee6)
|
207 |
+
- Instruct pix2pix - Tim Brooks (star), Aleksander Holynski (star), Alexei A. Efros (no star) - https://github.com/timothybrooks/instruct-pix2pix
|
208 |
+
- Security advice - RyotaK
|
209 |
+
- UniPC sampler - Wenliang Zhao - https://github.com/wl-zhao/UniPC
|
210 |
+
- TAESD - Ollin Boer Bohan - https://github.com/madebyollin/taesd
|
211 |
+
- LyCORIS - KohakuBlueleaf
|
212 |
+
- Restart sampling - lambertae - https://github.com/Newbeeer/diffusion_restart_sampling
|
213 |
+
- Hypertile - tfernd - https://github.com/tfernd/HyperTile
|
214 |
+
- Initial Gradio script - posted on 4chan by an Anonymous user. Thank you Anonymous user.
|
215 |
+
- (You)
|