stable-diffusion-webui README

The project's README from github.com/AUTOMATIC1111/stable-diffusion-webui. As one markdown file: README.md.

Stable Diffusion web UI

A web interface for Stable Diffusion, implemented using Gradio library.

Features

Detailed feature showcase with images:

Installation and Running

Make sure the required dependencies are met and follow the instructions available for:

Alternatively, use online services (like Google Colab):

Installation on Windows 10/11 with NVidia-GPUs using release package

  1. Download sd.webui.zip from v1.0.0-pre and extract its contents.
  2. Run update.bat.
  3. Run run.bat.

    For more details see Install-and-Run-on-NVidia-GPUs

Automatic Installation on Windows

  1. Install Python 3.10.6 (Newer version of Python does not support torch), 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. 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 libgl1 libglib2.0-0
# Red Hat-based:
sudo dnf install wget git python3 gperftools-libs libglvnd-glx
# openSUSE-based:
sudo zypper install wget git python3 libtcmalloc4 libglvnd
# Arch-based:
sudo pacman -S wget git python3

If your system is very new, you need to install python3.11 or python3.10:

# Ubuntu 24.04
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt update
sudo apt install python3.11

# Manjaro/Arch
sudo pacman -S yay
yay -S python311 # do not confuse with python3.11 package

# Only for 3.11
# Then set up env variable in launch script
export python_cmd="python3.11"
# or in webui-user.sh
python_cmd="python3.11"
  1. Navigate to the directory you would like the webui to be installed and execute the following command:
wget -q https://raw.githubusercontent.com/AUTOMATIC1111/stable-diffusion-webui/master/webui.sh

Or just clone the repo wherever you want:

git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui
  1. Run webui.sh.
  2. Check webui-user.sh for options.

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.

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.

Credits

Licenses for borrowed code can be found in Settings -> Licenses screen, and also in html/licenses.html file.

stable-diffusion-webui (AUTOMATIC1111/stable-diffusion-webui)

Searching Database…

165.1K ·GitHub
Stable-diffusion-webui
What is this?A browser-based interface for Stable Diffusion, built with the Gradio library, letting you generate and edit AI images (txt2img, img2img, inpainting, outpainting and more) on your own machine.
Is this a desktop app or something I open in my browser?It is a local web server: you launch it with a script and then use it through your browser like a webpage, not a traditional installed desktop application.
How do I get it running?On Windows, download the sd.webui.zip release package, extract it, then run update.bat followed by run.bat; or do the automatic install by cloning the repo and running webui-user.bat. On Linux, install the listed dependencies and run webui.sh.
Do I need Python and git set up first?Yes, for the automatic installer you need Python 3.10.6 specifically (newer versions break torch) with PATH enabled, plus git; the packaged Windows release still requires both to run the scripts.
Does it work on low-VRAM or non-NVIDIA cards?It supports GPUs with as little as 4GB VRAM (some report 2GB working), but NVIDIA is the recommended path; AMD, Intel CPUs/GPUs, and Ascend NPUs each need their own separate setup guide.
Do I need an NVIDIA GPU, or can I use AMD or Intel instead?NVIDIA is recommended, but the project documents separate install paths for AMD GPUs and for Intel CPUs/GPUs, both integrated and discrete, plus Ascend NPUs and Apple Silicon Macs.
What is the difference between the one-click Windows package and the automatic install?The one-click package (sd.webui.zip) already bundles almost everything, you just run update.bat then run.bat, while the automatic install has you install Python 3.10.6 and git yourself, clone the repo, and run webui-user.bat.
What can I do with LoRAs and hypernetworks here?Both let you fine-tune the style of generated images with small add-on files; the UI has a dedicated picker with previews so you can mix LoRAs, hypernetworks, or textual-inversion embeddings directly into your prompt.
Can I drive it from scripts instead of the browser UI?Yes, it exposes an API so generation can be triggered programmatically instead of only through the Gradio interface.
What does the Extras tab do?It bundles face-restoration and upscaling tools (GFPGAN, CodeFormer, RealESRGAN, ESRGAN, SwinIR, LDSR) that you can run on existing images to fix faces or increase resolution.
What are similar projects?stable-diffusion-webui-colab, InvokeAI, stable-diffusion.cpp, stable-diffusion-webui-forge, krita-ai-diffusion, diffusers, ControlNet, IOPaint
Which topics is it in?face-restoration, text2image, torch, img2img, ai-art, inpainting, upscaling, diffusion, amd, stable-diffusion, gradio, local-ai
Creator
AUTOMATIC1111
Size
35.7 MB
Stars
165.1K
Updated
CommitJul 27Releasev1.10.1Feb 09
Age
4y
Commits · 90 Days