diff --git a/README.md b/README.md index c6bd6f27e..91193d9a0 100644 --- a/README.md +++ b/README.md @@ -1,162 +1,80 @@ -# Stable Diffusion web UI -A browser interface based on Gradio library for Stable Diffusion. +# Stable Diffusion - Automatic -![](screenshot.png) +*Heavily opinionated custom fork of* -## Features -[Detailed feature showcase with images](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Features): -- 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](https://github.com/AUTOMATIC1111/stable-diffusion-webui/pull/2092)), 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 -- Tiling support, a checkbox to create images that can be tiled like textures -- Progress bar and live image generation preview - - Can use a separate neural network to produce previews with almost none VRAM or compute requirement -- 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](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Custom-Scripts) with many extensions from community -- [Composable-Diffusion](https://energy-based-model.github.io/Compositional-Visual-Generation-with-Composable-Diffusion-Models/), 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 -- [xformers](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Xformers), major speed increase for select cards: (add --xformers to commandline args) -- via extension: [History tab](https://github.com/yfszzx/stable-diffusion-webui-images-browser): 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 -- Hypernetworks -- Loras (same as Hypernetworks but more pretty) -- A sparate UI where you can choose, with preview, which embeddings, hypernetworks or Loras to add to your prompt. -- Can select to load a different VAE from settings screen -- Estimated completion time in progress bar -- API -- Support for dedicated [inpainting model](https://github.com/runwayml/stable-diffusion#inpainting-with-stable-diffusion) by RunwayML. -- 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)) -- [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 -- [Alt-Diffusion](https://arxiv.org/abs/2211.06679) support - see [wiki](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Features#alt-diffusion) for instructions -- Now without any bad letters! -- Load checkpoints in safetensors format -- Eased resolution restriction: generated image's domension must be a multiple of 8 rather than 64 -- Now with a license! -- Reorder elements in the UI from settings screen -- +![](ui-screenshot.jpg) -## 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. +
-Alternatively, use online services (like Google Colab): +## Notes -- [List of Online Services](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Online-Services) +Fork is as close as up-to-date with origin as time allows +All code changes are merged upstream whenever possible -### 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`. -4. Place stable diffusion checkpoint (`model.ckpt`) in the `models/Stable-diffusion` directory (see [dependencies](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Dependencies) for where to get it). -5. Run `webui-user.bat` from Windows Explorer as normal, non-administrator, user. +Fork adds extra functionality: +- Ships with additional **extensions** + e.g. `System Info`, `Steps Animation`, etc. +- Ships with set of **CLI** tools that rely on *SD API* for execution: + e.g. `generate`, `train`, `bench`, etc. + [Full list]() -### Automatic Installation on Linux -1. Install the dependencies: -```bash -# 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 -``` -2. To install in `/home/$(whoami)/stable-diffusion-webui/`, run: -```bash -bash <(wget -qO- https://raw.githubusercontent.com/AUTOMATIC1111/stable-diffusion-webui/master/webui.sh) -``` +Simplified start script: `automatic.sh` +*Existing `webui.sh` still exists for backward compatibility, fresh installs to auto-install dependencies, etc.* -### Installation on Apple Silicon +> ./automatic.sh -Find the instructions [here](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Installation-on-Apple-Silicon). +- Start in default mode with optimizations enabled -## Contributing -Here's how to add code to this repo: [Contributing](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki/Contributing) +> ./automatic.sh env -## Documentation -The documentation was moved from this README over to the project's [wiki](https://github.com/AUTOMATIC1111/stable-diffusion-webui/wiki). +- Print env info and exit + Example: -## Credits -Licenses for borrowed code can be found in `Settings -> Licenses` screen, and also in `html/licenses.html` file. + Version: c07487a Tue Jan 24 08:04:31 2023 -0500 + Platform: Ubuntu 22.04.1 LTS 5.15.79.1-microsoft-standard-WSL2 x86_64 + Python 3.10.6 + Torch: 2.0.0.dev20230118+cu118 CUDA: 11.8 cuDNN: 8700 GPU: NVIDIA GeForce RTX 3060 Arch: (8, 6) -- 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 -- CodeFormer - https://github.com/sczhou/CodeFormer -- ESRGAN - https://github.com/xinntao/ESRGAN -- SwinIR - https://github.com/JingyunLiang/SwinIR -- Swin2SR - https://github.com/mv-lab/swin2sr -- LDSR - https://github.com/Hafiidz/latent-diffusion -- MiDaS - https://github.com/isl-org/MiDaS -- Ideas for optimizations - https://github.com/basujindal/stable-diffusion -- Cross Attention layer optimization - Doggettx - https://github.com/Doggettx/stable-diffusion, original idea for prompt editing. -- Cross Attention layer optimization - InvokeAI, lstein - https://github.com/invoke-ai/InvokeAI (originally http://github.com/lstein/stable-diffusion) -- 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) -- Textual Inversion - Rinon Gal - https://github.com/rinongal/textual_inversion (we're not using his code, but we are using his ideas). -- Idea for SD upscale - https://github.com/jquesnelle/txt2imghd -- Noise generation for outpainting mk2 - https://github.com/parlance-zz/g-diffuser-bot -- CLIP interrogator idea and borrowing some code - https://github.com/pharmapsychotic/clip-interrogator -- Idea for Composable Diffusion - https://github.com/energy-based-model/Compositional-Visual-Generation-with-Composable-Diffusion-Models-PyTorch -- xformers - https://github.com/facebookresearch/xformers -- DeepDanbooru - interrogator for anime diffusers https://github.com/KichangKim/DeepDanbooru -- 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) -- Instruct pix2pix - Tim Brooks (star), Aleksander Holynski (star), Alexei A. Efros (no star) - https://github.com/timothybrooks/instruct-pix2pix -- Security advice - RyotaK -- Initial Gradio script - posted on 4chan by an Anonymous user. Thank you Anonymous user. -- (You) +> ./automatic.sh install + +- Install requirements and exit + +> ./automatic.sh public + +- Start with listen on public IP with authentication enabled + +> ./automatic.sh clean + +- Start with all optimizations disabled + Use this for troubleshooting + +
+ +## Differences + +Fork does differ in few things: +- Drops compatibility with `python` **3.7** and requires **3.9** +- Updated **Python** libraries to latest known compatible versions + e.g. `accelerate`, `transformers`, `numpy`, etc. +- Includes opinionated **System** and **Options** configuration + e.g. `samplers`, `upscalers`, etc. +- Includes reskinned **UI** + Black and orange dark theme with fixed width options panels and larger previews +- Includes **SD2** configuration files +- Uses simplified folder structure + e.g. `/train`, `/outputs/*` +- Modified training templates + +Only Python library which is not auto-updated is `PyTorch` itself as that is very system specific +For some Torch optimizations notes, see Wiki + +Fork is compatible with regular **PyTorch 1.13** as well as pre-release of **PyTorch 2.0** +See [Wiki](https://github.com/vladmandic/automatic/wiki) for **Torch** optimization notes + + +
+ +## Docs + +Everything is in [Wiki](https://github.com/vladmandic/automatic/wiki) +Except my current [TODO](TODO.md) diff --git a/requirements.txt b/requirements.txt index 6d53f0893..484d935d0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,18 +1,31 @@ -blendmodes accelerate +aenum basicsr fonts +blendmodes +clean-fid +einops +fairscale +fastapi +filetype font-roboto +fonts gfpgan -gradio==3.16.2 +GitPython +gradio +inflection invisible-watermark +jsonmerge +kornia +lark +mediapipe numpy omegaconf opencv-contrib-python -requests piexif Pillow -pytorch_lightning==1.7.7 +psutil +pytorch_lightning realesrgan scikit-image>=0.19 timm==0.4.12 @@ -21,12 +34,12 @@ torch einops jsonmerge clean-fid +requests resize-right -torchdiffeq -kornia -lark -inflection -GitPython -torchsde safetensors -psutil +scikit-image +timm +torch +torchdiffeq +torchsde +transformers diff --git a/requirements_versions.txt b/requirements_versions.txt index eaa08806d..aada281c8 100644 --- a/requirements_versions.txt +++ b/requirements_versions.txt @@ -1,29 +1,37 @@ +accelerate==0.15.0 +basicsr==1.4.2 blendmodes==2022 +clean-fid==0.1.29 +einops==0.4.1 +fairscale==0.4.9 transformers==4.25.1 accelerate==0.12.0 basicsr==1.4.2 gfpgan==1.3.8 +GitPython==3.1.27 gradio==3.16.2 -numpy==1.23.3 -Pillow==9.4.0 -realesrgan==0.3.0 -torch +httpcore<=0.15 +inflection==0.5.1 +jsonmerge==1.8.0 +kornia==0.6.7 +lark==1.1.2 +numpy==1.23.5 omegaconf==2.2.3 -pytorch_lightning==1.7.6 +piexif==1.1.3 +Pillow==9.4.0 +protobuf==3.20.3 +pytorch_lightning==1.7.7 +realesrgan==0.3.0 +resize-right==0.0.2 +safetensors==0.2.7 scikit-image==0.19.2 -fonts -font-roboto timm==0.6.7 +fairscale==0.4.9 piexif==1.1.3 einops==0.4.1 jsonmerge==1.8.0 clean-fid==0.1.29 resize-right==0.0.2 torchdiffeq==0.2.3 -kornia==0.6.7 -lark==1.1.2 -inflection==0.5.1 -GitPython==3.1.27 torchsde==0.2.5 -safetensors==0.2.7 -httpcore<=0.15 +transformers==4.25.1 diff --git a/wiki b/wiki index b3d0104b6..e465ffb28 160000 --- a/wiki +++ b/wiki @@ -1 +1 @@ -Subproject commit b3d0104b686b4a46dbb291d6240ea7e9f58c670b +Subproject commit e465ffb2840ea42c5507d293faf8b5d41aec2e59