Stable Diffusion web UI
Go to file
ritosonn b383702752 fix #3145 #3093 2022-10-25 08:32:33 +03:00
.github Make commit hash mandatory field 2022-10-21 16:48:13 +03:00
embeddings add embeddings dir 2022-09-30 14:16:26 +03:00
extensions add extensions dir 2022-10-24 09:51:17 +03:00
javascript Remove rtl: false from localizations 2022-10-25 08:15:44 +03:00
localizations Fixes 2022-10-25 08:17:41 +03:00
models deepdanbooru interrogator 2022-10-05 20:55:26 +02:00
modules fix #3145 #3093 2022-10-25 08:32:33 +03:00
scripts remove browser to extension 2022-10-24 10:10:33 +08:00
textual_inversion_templates hypernetwork training mk1 2022-10-07 23:22:22 +03:00
.gitignore remove browser to extension 2022-10-24 09:51:56 +08:00
.pylintrc Add basic Pylint to catch syntax errors on PRs 2022-10-15 16:26:07 +03:00
CODEOWNERS add codeowners file so stop the great guys who are collaborating on the project from merging in PRs. 2022-10-11 17:08:03 +03:00
README.md added info about History/Image browser to readme 2022-10-24 14:42:36 +03:00
artists.csv Update artists.csv 2022-10-18 18:11:20 +03:00
environment-wsl2.yaml update environment-wsl2.yaml 2022-10-12 09:08:44 +03:00
launch.py update deepdanbooru version 2022-10-24 08:46:31 +03:00
requirements.txt add missing requirement for api and fix some typos 2022-10-17 11:50:20 +03:00
requirements_versions.txt add missing requirement for api and fix some typos 2022-10-17 11:50:20 +03:00
screenshot.png updated interface to use Blocks 2022-08-30 21:51:30 +03:00
script.js localization support 2022-10-17 21:15:32 +03:00
style.css Add RTL languages support and improved Arabic localization 2022-10-25 08:15:44 +03:00
txt2img_Screenshot.png Add files via upload 2022-10-09 18:45:37 +03:00
webui-user.bat Revert "Update webui-user.bat" 2022-09-14 08:58:13 +03:00
webui-user.sh revert changes to two bat files I asked to revert but the author couldn't in 863e9efc19. 2022-10-16 10:14:27 +03:00
webui.bat add windows equivalent 2022-10-18 17:24:21 +03:00
webui.py remove erroneous dir in the extension directory 2022-10-24 09:39:46 +03:00
webui.sh Pass arguments from bash to python 2022-10-18 17:24:21 +03:00

README.md

Stable Diffusion web UI

A browser interface based on Gradio library for Stable Diffusion.

Check the custom scripts wiki page for extra scripts developed by users.

Features

Detailed feature showcase with images:

  • Original txt2img and img2img modes
  • One click install and run script (but you still must install python and git)
  • Outpainting
  • Inpainting
  • Color Sketch
  • Prompt Matrix
  • Stable Diffusion Upscale
  • Attention, specify parts of text that the model should pay more attention to
    • a man in a ((tuxedo)) - will pay more attention to tuxedo
    • a man in a (tuxedo:1.21) - alternative syntax
    • select text and press ctrl+up or ctrl+down to automatically adjust attention to selected text (code contributed by anonymous user)
  • Loopback, run img2img processing multiple times
  • X/Y plot, a way to draw a 2 dimensional plot of images with different parameters
  • Textual Inversion
    • have as many embeddings as you want and use any names you like for them
    • use multiple embeddings with different numbers of vectors per token
    • works with half precision floating point numbers
    • train embeddings on 8GB (also reports of 6GB working)
  • Extras tab with:
    • GFPGAN, neural network that fixes faces
    • CodeFormer, face restoration tool as an alternative to GFPGAN
    • RealESRGAN, neural network upscaler
    • ESRGAN, neural network upscaler with a lot of third party models
    • SwinIR and Swin2SR(see here), neural network upscalers
    • LDSR, Latent diffusion super resolution upscaling
  • Resizing aspect ratio options
  • Sampling method selection
    • Adjust sampler eta values (noise multiplier)
    • More advanced noise setting options
  • Interrupt processing at any time
  • 4GB video card support (also reports of 2GB working)
  • Correct seeds for batches
  • Live prompt token length validation
  • Generation parameters
    • parameters you used to generate images are saved with that image
    • in PNG chunks for PNG, in EXIF for JPEG
    • can drag the image to PNG info tab to restore generation parameters and automatically copy them into UI
    • can be disabled in settings
    • drag and drop an image/text-parameters to promptbox
  • Read Generation Parameters Button, loads parameters in promptbox to UI
  • Settings page
  • Running arbitrary python code from UI (must run with --allow-code to enable)
  • Mouseover hints for most UI elements
  • Possible to change defaults/mix/max/step values for UI elements via text config
  • Random artist button
  • Tiling support, a checkbox to create images that can be tiled like textures
  • Progress bar and live image generation preview
  • Negative prompt, an extra text field that allows you to list what you don't want to see in generated image
  • Styles, a way to save part of prompt and easily apply them via dropdown later
  • Variations, a way to generate same image but with tiny differences
  • Seed resizing, a way to generate same image but at slightly different resolution
  • CLIP interrogator, a button that tries to guess prompt from an image
  • Prompt Editing, a way to change prompt mid-generation, say to start making a watermelon and switch to anime girl midway
  • Batch Processing, process a group of files using img2img
  • Img2img Alternative, reverse Euler method of cross attention control
  • Highres Fix, a convenience option to produce high resolution pictures in one click without usual distortions
  • Reloading checkpoints on the fly
  • Checkpoint Merger, a tab that allows you to merge up to 3 checkpoints into one
  • Custom scripts with many extensions from community
  • Composable-Diffusion, a way to use multiple prompts at once
    • separate prompts using uppercase AND
    • also supports weights for prompts: a cat :1.2 AND a dog AND a penguin :2.2
  • No token limit for prompts (original stable diffusion lets you use up to 75 tokens)
  • DeepDanbooru integration, creates danbooru style tags for anime prompts (add --deepdanbooru to commandline args)
  • xformers, major speed increase for select cards: (add --xformers to commandline args)
  • via extension: History tab: view, direct and delete images conveniently within the UI
  • Generate forever option
  • Training tab
    • hypernetworks and embeddings options
    • Preprocessing images: cropping, mirroring, autotagging using BLIP or deepdanbooru (for anime)
  • Clip skip
  • Use Hypernetworks
  • Use VAEs
  • Estimated completion time in progress bar
  • API
  • Support for dedicated inpainting model by RunwayML.
  • via extension: Aesthetic Gradients, a way to generate images with a specific aesthetic by using clip images embds (implementation of https://github.com/vicgalle/stable-diffusion-aesthetic-gradients)

Where are Aesthetic Gradients?!?!

Aesthetic Gradients are now an extension. You can install it using git:

git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui-aesthetic-gradients extensions/aesthetic-gradients

After running this command, make sure that you have aesthetic-gradients dir in webui's extensions directory and restart the UI. The interface for Aesthetic Gradients should appear exactly the same as it was.

Where is History/Image browser?!?!

Image browser is now an extension. You can install it using git:

git clone https://github.com/yfszzx/stable-diffusion-webui-images-browser extensions/images-browser

After running this command, make sure that you have images-browser dir in webui's extensions directory and restart the UI. The interface for Image browser should appear exactly the same as it was.

Installation and Running

Make sure the required dependencies are met and follow the instructions available for both NVidia (recommended) and AMD GPUs.

Alternatively, use online services (like Google Colab):

Automatic Installation on Windows

  1. Install Python 3.10.6, checking "Add Python to PATH"
  2. Install git.
  3. Download the stable-diffusion-webui repository, for example by running git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui.git.
  4. Place model.ckpt in the models directory (see dependencies for where to get it).
  5. (Optional) Place GFPGANv1.4.pth in the base directory, alongside webui.py (see dependencies for where to get it).
  6. Run webui-user.bat from Windows Explorer as normal, non-administrator, user.

Automatic Installation on Linux

  1. Install the dependencies:
# Debian-based:
sudo apt install wget git python3 python3-venv
# Red Hat-based:
sudo dnf install wget git python3
# Arch-based:
sudo pacman -S wget git python3
  1. To install in /home/$(whoami)/stable-diffusion-webui/, run:
bash <(wget -qO- https://raw.githubusercontent.com/AUTOMATIC1111/stable-diffusion-webui/master/webui.sh)

Installation on Apple Silicon

Find the instructions here.

Contributing

Here's how to add code to this repo: Contributing

Documentation

The documentation was moved from this README over to the project's wiki.

Credits