mirror of https://github.com/vladmandic/automatic
190 lines
11 KiB
Markdown
190 lines
11 KiB
Markdown
<div align="center">
|
||
|
||
# SD.Next
|
||
|
||
**Stable Diffusion implementation with advanced features**
|
||
|
||
<br>
|
||
|
||
[](https://github.com/sponsors/vladmandic)
|
||
|
||
|
||
[](https://discord.gg/VjvR2tabEX)
|
||
|
||
### [Wiki](https://github.com/vladmandic/automatic/wiki) | [Discord](https://discord.gg/VjvR2tabEX) | [Changelog](CHANGELOG.md)
|
||
|
||
</div>
|
||
|
||
## Top-13 Features (10 wasn't enough)
|
||
|
||
All Individual features are not listed here, instead check [ChangeLog](CHANGELOG.md) for full list of changes.
|
||
|
||
- Support for multiple backends!
|
||
**original** and **diffusers**
|
||
- Support for multiple diffusion models!
|
||
**Stable Diffusion, SD-XL, LCM, Segmind, Kandinsky, Pixart-α, Wuerstchen, DeepFloyd IF, UniDiffusion, SD-Distilled, etc.**
|
||
- Fully multiplatform with platform specific autodetection and tuning performed on install
|
||
**Windows / Linux / MacOS with CPU / nVidia / AMD / IntelArc / DirectML / OpenVINO / ONNX+Olive**
|
||
- Optimized processing with latest **torch** developments
|
||
Including built-in support for `torch.compile`
|
||
- Improved prompt parser
|
||
- Enhanced *Lora*/*Locon*/*Lyco* code supporting latest trends in training
|
||
- Built-in queue management
|
||
- Advanced metadata caching and handling to speed up operations
|
||
- Enterprise level logging and hardened API
|
||
- Modern localization and hints engine
|
||
- Broad compatibility with existing extensions ecosystem and new extensions manager
|
||
- Built in installer with automatic updates and dependency management
|
||
- Modernized UI with theme support and number of built-in themes
|
||
|
||
## Backend support
|
||
|
||
**SD.Next** supports two main backends: *Original* and *Diffusers* which can be switched on-the-fly:
|
||
|
||
- **Original**: Based on [LDM](https://github.com/Stability-AI/stablediffusion) reference implementation and significantly expanded on by [A1111](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
|
||
This is the default backend and it is fully compatible with all existing functionality and extensions
|
||
It supports **SD 1.x** and **SD 2.x** models
|
||
All other model types such as SD-XL, LCM, PixArt, Segmind, Kandinsky, etc. require backend **Diffusers**
|
||
- **Diffusers**: Based on new [Huggingface Diffusers](https://huggingface.co/docs/diffusers/index) implementation
|
||
It supports *original* SD models as well as *all* models listed below
|
||
See [wiki article](https://github.com/vladmandic/automatic/wiki/Diffusers) for more information
|
||
|
||
## Model support
|
||
|
||
Additional models will be added as they become available and there is public interest in them
|
||
|
||
- [RunwayML Stable Diffusion](https://github.com/Stability-AI/stablediffusion/) 1.x and 2.x *(all variants)*
|
||
- [StabilityAI Stable Diffusion XL](https://github.com/Stability-AI/generative-models)
|
||
- [Segmind SSD-1B](https://huggingface.co/segmind/SSD-1B)
|
||
- [LCM: Latent Consistency Models](https://github.com/openai/consistency_models)
|
||
- [Kandinsky](https://github.com/ai-forever/Kandinsky-2) 2.1 and 2.2
|
||
- [PixArt-α XL 2](https://github.com/PixArt-alpha/PixArt-alpha) Medium and Large
|
||
- [Warp Wuerstchen](https://huggingface.co/blog/wuertschen)
|
||
- [Tsinghua UniDiffusion](https://github.com/thu-ml/unidiffuser)
|
||
- [DeepFloyd IF](https://github.com/deep-floyd/IF) Medium and Large
|
||
- [Segmind SD Distilled](https://huggingface.co/blog/sd_distillation) *(all variants)*
|
||
|
||
*Notes*:
|
||
- Loading any model other than standard SD 1.x / SD 2.x requires use of backend **Diffusers**
|
||
Loading any other models using **Original** backend is not supproted
|
||
- Loading manually download model `.safetensors` files is supported for SD 1.x / SD 2.x / SD-XL models only
|
||
For all other model types, use backend **Diffusers** and use built in Model downloader or
|
||
select model from Networks -> Models -> Reference list in which case it will be auto-downloaded and loaded
|
||
|
||
## Platform support
|
||
|
||
- *nVidia* GPUs using **CUDA** libraries on both *Windows and Linux*
|
||
- *AMD* GPUs using **ROCm** libraries on *Linux*
|
||
Support will be extended to *Windows* once AMD releases ROCm for Windows
|
||
- *Intel Arc* GPUs using **OneAPI** with *IPEX XPU* libraries on both *Windows and Linux*
|
||
- Any GPU compatible with *DirectX* on *Windows* using **DirectML** libraries
|
||
This includes support for AMD GPUs that are not supported by native ROCm libraries
|
||
- Any GPU or device compatible with **OpenVINO** libraries on both *Windows and Linux*
|
||
- *Apple M1/M2* on *OSX* using built-in support in Torch with **MPS** optimizations
|
||
- *ONNX/Olive* (experimental)
|
||
|
||
## Install & Run
|
||
|
||
- [Step-by-step install guide](https://github.com/vladmandic/automatic/wiki/Installation)
|
||
- [Advanced install notes](https://github.com/vladmandic/automatic/wiki/Advanced-Install)
|
||
|
||
### Installation Notes
|
||
|
||
- [Common installation errors](https://github.com/vladmandic/automatic/discussions/1627)
|
||
- [FAQ](https://github.com/vladmandic/automatic/discussions/1011)
|
||
- Server can run without virtual environment,
|
||
but it is recommended to use it to avoid library version conflicts with other applications
|
||
- **nVidia/CUDA** / **AMD/ROCm** / **Intel/OneAPI** are auto-detected if present and available,
|
||
but for any other use case specify required parameter explicitly or wrong packages may be installed
|
||
as installer will assume CPU-only environment
|
||
- Full startup sequence is logged in `sdnext.log`, so if you encounter any issues, please check it first
|
||
|
||
### Run
|
||
|
||
Once SD.Next is installed, simply run `webui.ps1` or `webui.bat` (*Windows*) or `webui.sh` (*Linux or MacOS*)
|
||
|
||
Below is partial list of all available parameters, run `webui --help` for the full list:
|
||
|
||
Setup options:
|
||
--use-directml Use DirectML if no compatible GPU is detected, default: False
|
||
--use-openvino Use Intel OpenVINO backend, default: False
|
||
--use-ipex Force use Intel OneAPI XPU backend, default: False
|
||
--use-cuda Force use nVidia CUDA backend, default: False
|
||
--use-rocm Force use AMD ROCm backend, default: False
|
||
--skip-update Skip update of extensions and submodules, default: False
|
||
--skip-requirements Skips checking and installing requirements, default: False
|
||
--skip-extensions Skips running individual extension installers, default: False
|
||
--skip-git Skips running all GIT operations, default: False
|
||
--skip-torch Skips running Torch checks, default: False
|
||
--reinstall Force reinstallation of all requirements, default: False
|
||
--debug Run installer with debug logging, default: False
|
||
--reset Reset main repository to latest version, default: False
|
||
--upgrade Upgrade main repository to latest version, default: False
|
||
--safe Run in safe mode with no user extensions
|
||
|
||
<br><br>
|
||
|
||
## Notes
|
||
|
||
### **Extensions**
|
||
|
||
SD.Next comes with several extensions pre-installed:
|
||
|
||
- [ControlNet](https://github.com/Mikubill/sd-webui-controlnet)
|
||
- [Agent Scheduler](https://github.com/ArtVentureX/sd-webui-agent-scheduler)
|
||
- [Image Browser](https://github.com/AlUlkesh/stable-diffusion-webui-images-browser)
|
||
- [Rembg Background Removal](https://github.com/AUTOMATIC1111/stable-diffusion-webui-rembg)
|
||
|
||
### **Collab**
|
||
|
||
- To avoid having this repo rely just on me, I'd love to have additional maintainers with full admin rights. If you're interested, ping me!
|
||
- In addition to general cross-platform code, desire is to have a lead for each of the main platforms.
|
||
This should be fully cross-platform, but I would really love to have additional contributors and/or maintainers to join and help lead the efforts on different platforms.
|
||
|
||
### **Goals**
|
||
|
||
This project started as a fork from [Automatic1111 WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui/) and it grew significantly since then,
|
||
but although it diverged considerably, any substantial features to original work is ported to this repository as well.
|
||
|
||
The idea behind the fork is to enable latest technologies and advances in text-to-image generation.
|
||
|
||
> *Sometimes this is not the same as "as simple as possible to use".*
|
||
|
||
If you are looking an amazing simple-to-use Stable Diffusion tool, I'd suggest [InvokeAI](https://invoke-ai.github.io/InvokeAI/) specifically due to its automated installer and ease of use.
|
||
|
||
General goals:
|
||
|
||
- Cross-platform
|
||
- Create uniform experience while automatically managing any platform specific differences
|
||
- Performance
|
||
- Enable best possible performance on all platforms
|
||
- Ease-of-Use
|
||
- Automatically handle all requirements, dependencies, flags regardless of platform
|
||
- Integrate all best options for uniform out-of-the-box experience without the need to tweak anything manually
|
||
- Look-and-Feel
|
||
- Create modern, intuitive and clean UI
|
||
- Up-to-Date
|
||
- Keep code up to date with latest advanced in text-to-image generation
|
||
|
||
## Credits
|
||
|
||
- Main credit goes to [Automatic1111 WebUI](https://github.com/AUTOMATIC1111/stable-diffusion-webui)
|
||
- Additional credits are listed in [Credits](https://github.com/AUTOMATIC1111/stable-diffusion-webui/#credits)
|
||
- Licenses for modules are listed in [Licenses](html/licenses.html)
|
||
|
||
### **Docs**
|
||
|
||
- [Wiki](https://github.com/vladmandic/automatic/wiki)
|
||
- [ReadMe](README.md)
|
||
- [ToDo](TODO.md)
|
||
- [ChangeLog](CHANGELOG.md)
|
||
- [CLI Tools](cli/README.md)
|
||
|
||
### **Sponsors**
|
||
|
||
<div align="center">
|
||
<!-- sponsors --><a href="https://github.com/allangrant"><img src="https://github.com/allangrant.png" width="60px" alt="Allan Grant" /></a><a href="https://github.com/demib72"><img src="https://github.com/demib72.png" width="60px" alt="Michael Harris" /></a><a href="https://github.com/BrentOzar"><img src="https://github.com/BrentOzar.png" width="60px" alt="Brent Ozar" /></a><a href="https://github.com/AimwiseTonix"><img src="https://github.com/AimwiseTonix.png" width="60px" alt="ToniX" /></a><a href="https://github.com/inktomi"><img src="https://github.com/inktomi.png" width="60px" alt="Matthew Runo" /></a><a href="https://github.com/HELLO-WORLD-SAS"><img src="https://github.com/HELLO-WORLD-SAS.png" width="60px" alt="HELLO WORLD SAS" /></a><a href="https://github.com/4joeknight4"><img src="https://github.com/4joeknight4.png" width="60px" alt="" /></a><a href="https://github.com/SaladTechnologies"><img src="https://github.com/SaladTechnologies.png" width="60px" alt="Salad Technologies" /></a><a href="https://github.com/mantzaris"><img src="https://github.com/mantzaris.png" width="60px" alt="a.v.mantzaris" /></a><a href="https://github.com/anothertal3"><img src="https://github.com/anothertal3.png" width="60px" alt="" /></a><!-- sponsors -->
|
||
</div>
|
||
|
||
<br>
|