mirror of
https://github.com/sd-webui/stable-diffusion-webui.git
synced 2024-12-14 23:02:00 +03:00
Update README.md
This commit is contained in:
hlky
parent
342dcdccc5
commit
894599f98c
251
README.md
251
README.md
@ -1,14 +1,9 @@
|
||||
# Stable Diffusion Web UI
|
||||
# Web based UI for Stable Diffusion by [sd-webui](https://github.com/sd-webui)
|
||||
|
||||
## [Visit sd-webui's Discord Server](https://discord.gg/gyXNe4NySY) [](https://discord.gg/gyXNe4NySY)
|
||||
|
||||
## Installation instructions for [Windows](/docs/1.installation.md), [Linux](/docs/1.linux-installation.md)
|
||||
|
||||
### Have an **issue**?
|
||||
|
||||
* If the issue involves _a bug_ in **textual-inversion** create the issue on **_[sd-webui/stable-diffusion-webui](https://github.com/sd-webui/stable-diffusion-webui)_**
|
||||
* If you want to know how to **activate** or **use** textual-inversion see **_[hlky/sd-enable-textual-inversion](https://github.com/hlky/sd-enable-textual-inversion)_**. Activation not working? create the issue on **_[sd-webui/stable-diffusion-webui](https://github.com/sd-webui/stable-diffusion-webui)_**
|
||||
|
||||
### Want to ask a question or request a feature?
|
||||
|
||||
Come to our [Discord Server](https://discord.gg/gyXNe4NySY) or use [Discussions](https://github.com/sd-webui/stable-diffusion-webui/discussions).
|
||||
@ -21,236 +16,30 @@ Come to our [Discord Server](https://discord.gg/gyXNe4NySY) or use [Discussions]
|
||||
|
||||
Check the [Contribution Guide](CONTRIBUTING.md)
|
||||
|
||||
## **Important**
|
||||
[sd-webui](https://github.com/sd-webui) is
|
||||
*  [hlky](https://github.com/hlky)
|
||||
* [ZeroCool940711](https://github.com/ZeroCool940711)
|
||||
* [codedealer](https://github.com/codedealer)
|
||||
|
||||
🔥 NEW! webui.cmd updates with any changes in environment.yaml file so the environment will always be up to date as long as you get the new environment.yaml file 🔥
|
||||
|
||||
:fire: no need to remove environment, delete src folder and create again, MUCH simpler! 🔥
|
||||
|
||||
## Gradio
|
||||
|
||||
### Features
|
||||
|
||||
### Screenshots
|
||||
|
||||
## Streamlit
|
||||
|
||||
### Features
|
||||
|
||||
### Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
--------------
|
||||
|
||||
### Questions about **_[Upscalers](/docs/4.upscalers.md)_**?
|
||||
### Questions about **_[Command line options](/docs/2.cli.md)_**?
|
||||
|
||||
--------------
|
||||
|
||||
|
||||
Features:
|
||||
|
||||
* Gradio GUI: Idiot-proof, fully featured frontend for both txt2img and img2img generation
|
||||
* No more manually typing parameters, now all you have to do is write your prompt and adjust sliders
|
||||
* GFPGAN Face Correction 🔥: [Download the model](/docs/1.installation.md#optional-additional-models) Automatically correct distorted faces with a built-in GFPGAN option, fixes them in less than half a second
|
||||
* RealESRGAN Upscaling 🔥: [Download the models](/docs/1.installation.md#optional-additional-models) Boosts the resolution of images with a built-in RealESRGAN option
|
||||
* :computer: esrgan/gfpgan on cpu support :computer:
|
||||
* Textual inversion 🔥: [info](https://textual-inversion.github.io/) - requires enabling, see [here](https://github.com/hlky/sd-enable-textual-inversion), script works as usual without it enabled
|
||||
* Advanced img2img editor :art: :fire: :art:
|
||||
* :fire::fire: Mask and crop :fire::fire:
|
||||
* Mask painting (NEW) 🖌️: Powerful tool for re-generating only specific parts of an image you want to change
|
||||
* More k_diffusion samplers 🔥🔥 : Far greater quality outputs than the default sampler, less distortion and more accurate
|
||||
* txt2img samplers: "DDIM", "PLMS", 'k_dpm_2_a', 'k_dpm_2', 'k_euler_a', 'k_euler', 'k_heun', 'k_lms'
|
||||
* img2img samplers: "DDIM", 'k_dpm_2_a', 'k_dpm_2', 'k_euler_a', 'k_euler', 'k_heun', 'k_lms'
|
||||
* Loopback (NEW) ➿: Automatically feed the last generated sample back into img2img
|
||||
* Prompt Weighting (NEW) 🏋️: Adjust the strength of different terms in your prompt
|
||||
* :fire: gpu device selectable with --gpu <id> :fire:
|
||||
* Memory Monitoring 🔥: Shows Vram usage and generation time after outputting.
|
||||
* Word Seeds 🔥: Use words instead of seed numbers
|
||||
* CFG: Classifier free guidance scale, a feature for fine-tuning your output
|
||||
* Launcher Automatic 👑🔥 shortcut to load the model, no more typing in Conda
|
||||
* Lighter on Vram: 512x512 img2img & txt2img tested working on 6gb
|
||||
* and ????
|
||||
|
||||
# Stable Diffusion web UI
|
||||
A browser interface based on Gradio library for Stable Diffusion.
|
||||
|
||||
Original script with Gradio UI was written by a kind anonymous user. This is a modification.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GFPGAN
|
||||
|
||||
If you want to use GFPGAN to improve generated faces, you need to install it separately.
|
||||
Download [GFPGANv1.3.pth](https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.3.pth) and put it
|
||||
into the `/stable-diffusion-webui/src/gfpgan/experiments/pretrained_models` directory.
|
||||
|
||||
### RealESRGAN
|
||||
Download [RealESRGAN_x4plus.pth](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.1.0/RealESRGAN_x4plus.pth) and [RealESRGAN_x4plus_anime_6B.pth](https://github.com/xinntao/Real-ESRGAN/releases/download/v0.2.2.4/RealESRGAN_x4plus_anime_6B.pth).
|
||||
Put them into the `stable-diffusion-webui/src/realesrgan/experiments/pretrained_models` directory.
|
||||
|
||||
### LDSR
|
||||
* Download **LDSR** [project.yaml](https://heibox.uni-heidelberg.de/f/31a76b13ea27482981b4/?dl=1) and [ model last.cpkt](https://heibox.uni-heidelberg.de/f/578df07c8fc04ffbadf3/?dl=1). Rename last.ckpt to model.ckpt and place both under stable-diffusion-webui/src/latent-diffusion/experiments/pretrained_models/
|
||||
|
||||
### Web UI
|
||||
|
||||
When launching, you may get a very long warning message related to some weights not being used. You may freely ignore it.
|
||||
After a while, you will get a message like this:
|
||||
|
||||
```
|
||||
Running on local URL: http://127.0.0.1:7860/
|
||||
```
|
||||
|
||||
Open the URL in browser, and you are good to go.
|
||||
|
||||
## Features
|
||||
The script creates a web UI for Stable Diffusion's txt2img and img2img scripts. Following are features added
|
||||
that are not in original script.
|
||||
|
||||
### GFPGAN
|
||||
Lets you improve faces in pictures using the GFPGAN model. There is a checkbox in every tab to use GFPGAN at 100%, and
|
||||
also a separate tab that just allows you to use GFPGAN on any picture, with a slider that controls how strong the effect is.
|
||||
|
||||
|
||||
|
||||
### RealESRGAN
|
||||
Lets you double the resolution of generated images. There is a checkbox in every tab to use RealESRGAN, and you can choose between the regular upscaler and the anime version.
|
||||
There is also a separate tab for using RealESRGAN on any picture.
|
||||
|
||||
|
||||
|
||||
### Sampling method selection
|
||||
txt2img samplers: "DDIM", "PLMS", 'k_dpm_2_a', 'k_dpm_2', 'k_euler_a', 'k_euler', 'k_heun', 'k_lms'
|
||||
img2img samplers: "DDIM", 'k_dpm_2_a', 'k_dpm_2', 'k_euler_a', 'k_euler', 'k_heun', 'k_lms'
|
||||
|
||||
|
||||
|
||||
### Prompt matrix
|
||||
Separate multiple prompts using the `|` character, and the system will produce an image for every combination of them.
|
||||
For example, if you use `a busy city street in a modern city|illustration|cinematic lighting` prompt, there are four combinations possible (first part of prompt is always kept):
|
||||
|
||||
- `a busy city street in a modern city`
|
||||
- `a busy city street in a modern city, illustration`
|
||||
- `a busy city street in a modern city, cinematic lighting`
|
||||
- `a busy city street in a modern city, illustration, cinematic lighting`
|
||||
|
||||
Four images will be produced, in this order, all with same seed and each with corresponding prompt:
|
||||
|
||||
|
||||
Another example, this time with 5 prompts and 16 variations:
|
||||
|
||||
|
||||
If you use this feature, batch count will be ignored, because the number of pictures to produce
|
||||
depends on your prompts, but batch size will still work (generating multiple pictures at the
|
||||
same time for a small speed boost).
|
||||
|
||||
### Copy-paste generation parameters
|
||||
A text output provides generation parameters in an easy to copy-paste form for easy sharing.
|
||||
|
||||
|
||||
|
||||
If you generate multiple pictures, the displayed seed will be the seed of the first one.
|
||||
|
||||
### Correct seeds for batches
|
||||
If you use a seed of 1000 to generate two batches of two images each, four generated images will have seeds: `1000, 1001, 1002, 1003`.
|
||||
Previous versions of the UI would produce `1000, x, 1001, x`, where x is an iamge that can't be generated by any seed.
|
||||
|
||||
### Resizing
|
||||
There are three options for resizing input images in img2img mode:
|
||||
|
||||
- Just resize - simply resizes source image to target resolution, resulting in incorrect aspect ratio
|
||||
- Crop and resize - resize source image preserving aspect ratio so that entirety of target resolution is occupied by it, and crop parts that stick out
|
||||
- Resize and fill - resize source image preserving aspect ratio so that it entirely fits target resolution, and fill empty space by rows/columns from source image
|
||||
|
||||
Example:
|
||||
|
||||
|
||||
### Loading
|
||||
Gradio's loading graphic has a very negative effect on the processing speed of the neural network.
|
||||
My RTX 3090 makes images about 10% faster when the tab with gradio is not active. By default, the UI
|
||||
now hides loading progress animation and replaces it with static "Loading..." text, which achieves
|
||||
the same effect. Use the --no-progressbar-hiding commandline option to revert this and show loading animations.
|
||||
|
||||
### Prompt validation
|
||||
Stable Diffusion has a limit for input text length. If your prompt is too long, you will get a
|
||||
warning in the text output field, showing which parts of your text were truncated and ignored by the model.
|
||||
|
||||
### Loopback
|
||||
A checkbox for img2img allowing to automatically feed output image as input for the next batch. Equivalent to
|
||||
saving output image, and replacing input image with it. Batch count setting controls how many iterations of
|
||||
this you get.
|
||||
|
||||
Usually, when doing this, you would choose one of many images for the next iteration yourself, so the usefulness
|
||||
of this feature may be questionable, but I've managed to get some very nice outputs with it that I wasn't abble
|
||||
to get otherwise.
|
||||
|
||||
Example: (cherrypicked result; original picture by anon)
|
||||
|
||||
|
||||
|
||||
|
||||
### --help
|
||||
```
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
--ckpt CKPT path to checkpoint of model (default: models/ldm/stable-diffusion-v1/model.ckpt)
|
||||
--cli CLI don't launch web server, take Python function kwargs from this file. (default: None)
|
||||
--config CONFIG path to config which constructs model (default: configs/stable-diffusion/v1-inference.yaml)
|
||||
--defaults DEFAULTS path to configuration file providing UI defaults, uses same format as cli parameter (default:
|
||||
configs/webui/webui.yaml)
|
||||
--esrgan-cpu run ESRGAN on cpu (default: False)
|
||||
--esrgan-gpu ESRGAN_GPU
|
||||
run ESRGAN on specific gpu (overrides --gpu) (default: 0)
|
||||
--extra-models-cpu run extra models (GFGPAN/ESRGAN) on cpu (default: False)
|
||||
--extra-models-gpu run extra models (GFGPAN/ESRGAN) on gpu (default: False)
|
||||
--gfpgan-cpu run GFPGAN on cpu (default: False)
|
||||
--gfpgan-dir GFPGAN_DIR
|
||||
GFPGAN directory (default: ./src/gfpgan)
|
||||
--gfpgan-gpu GFPGAN_GPU
|
||||
run GFPGAN on specific gpu (overrides --gpu) (default: 0)
|
||||
--gpu GPU choose which GPU to use if you have multiple (default: 0)
|
||||
--grid-format GRID_FORMAT
|
||||
png for lossless png files; jpg:quality for lossy jpeg; webp:quality for lossy webp, or
|
||||
webp:-compression for lossless webp (default: jpg:95)
|
||||
--inbrowser automatically launch the interface in a new tab on the default browser (default: False)
|
||||
--ldsr-dir LDSR_DIR LDSR directory (default: ./src/latent-diffusion)
|
||||
--n_rows N_ROWS rows in the grid; use -1 for autodetect and 0 for n_rows to be same as batch_size (default:
|
||||
-1) (default: -1)
|
||||
--no-half do not switch the model to 16-bit floats (default: False)
|
||||
--no-progressbar-hiding
|
||||
do not hide progressbar in gradio UI (we hide it because it slows down ML if you have hardware
|
||||
accleration in browser) (default: False)
|
||||
--no-verify-input do not verify input to check if it's too long (default: False)
|
||||
--optimized-turbo alternative optimization mode that does not save as much VRAM but runs siginificantly faster
|
||||
(default: False)
|
||||
--optimized load the model onto the device piecemeal instead of all at once to reduce VRAM usage at the
|
||||
cost of performance (default: False)
|
||||
--outdir_img2img [OUTDIR_IMG2IMG]
|
||||
dir to write img2img results to (overrides --outdir) (default: None)
|
||||
--outdir_imglab [OUTDIR_IMGLAB]
|
||||
dir to write imglab results to (overrides --outdir) (default: None)
|
||||
--outdir_txt2img [OUTDIR_TXT2IMG]
|
||||
dir to write txt2img results to (overrides --outdir) (default: None)
|
||||
--outdir [OUTDIR] dir to write results to (default: None)
|
||||
--filename_format [FILENAME_FORMAT]
|
||||
filenames format (default: None)
|
||||
--port PORT choose the port for the gradio webserver to use (default: 7860)
|
||||
--precision {full,autocast}
|
||||
evaluate at this precision (default: autocast)
|
||||
--realesrgan-dir REALESRGAN_DIR
|
||||
RealESRGAN directory (default: ./src/realesrgan)
|
||||
--realesrgan-model REALESRGAN_MODEL
|
||||
Upscaling model for RealESRGAN (default: RealESRGAN_x4plus)
|
||||
--save-metadata Store generation parameters in the output png. Drop saved png into Image Lab to read
|
||||
parameters (default: False)
|
||||
--share-password SHARE_PASSWORD
|
||||
Sharing is open by default, use this to set a password. Username: webui (default: None)
|
||||
--share Should share your server on gradio.app, this allows you to use the UI from your mobile app
|
||||
(default: False)
|
||||
--skip-grid do not save a grid, only individual samples. Helpful when evaluating lots of samples (default:
|
||||
False)
|
||||
--skip-save do not save indiviual samples. For speed measurements. (default: False)
|
||||
--no-job-manager Don't use the experimental job manager on top of gradio (default: False)
|
||||
--max-jobs MAX_JOBS Maximum number of concurrent 'generate' commands (default: 1)
|
||||
--tiling Generate tiling images (default: False)
|
||||
```
|
||||
|
||||
-----
|
||||
|
||||
# Stable Diffusion
|
||||
*Stable Diffusion was made possible thanks to a collaboration with [Stability AI](https://stability.ai/) and [Runway](https://runwayml.com/) and builds upon our previous work:*
|
||||
|
||||
[**High-Resolution Image Synthesis with Latent Diffusion Models**](https://ommer-lab.com/research/latent-diffusion-models/)<br/>
|
||||
@ -273,8 +62,6 @@ this model uses a frozen CLIP ViT-L/14 text encoder to condition the model on te
|
||||
With its 860M UNet and 123M text encoder, the model is relatively lightweight and runs on a GPU with at least 10GB VRAM.
|
||||
See [this section](#stable-diffusion-v1) below and the [model card](https://huggingface.co/CompVis/stable-diffusion).
|
||||
|
||||
## Stable Diffusion v1
|
||||
|
||||
Stable Diffusion v1 refers to a specific configuration of the model
|
||||
architecture that uses a downsampling-factor 8 autoencoder with an 860M UNet
|
||||
and CLIP ViT-L/14 text encoder for the diffusion model. The model was pretrained on 256x256 images and
|
||||
@ -284,8 +71,6 @@ then finetuned on 512x512 images.
|
||||
in its training data.
|
||||
Details on the training procedure and data, as well as the intended use of the model can be found in the corresponding [model card](https://huggingface.co/CompVis/stable-diffusion).
|
||||
|
||||
## Comments
|
||||
|
||||
- Our codebase for the diffusion models builds heavily on [OpenAI's ADM codebase](https://github.com/openai/guided-diffusion)
|
||||
and [https://github.com/lucidrains/denoising-diffusion-pytorch](https://github.com/lucidrains/denoising-diffusion-pytorch).
|
||||
Thanks for open-sourcing!
|
||||
@ -293,7 +78,7 @@ Thanks for open-sourcing!
|
||||
- The implementation of the transformer encoder is from [x-transformers](https://github.com/lucidrains/x-transformers) by [lucidrains](https://github.com/lucidrains?tab=repositories).
|
||||
|
||||
|
||||
## BibTeX
|
||||
BibTeX
|
||||
|
||||
```
|
||||
@misc{rombach2021highresolution,
|
||||
|
||||
Loading…
Reference in New Issue
Block a user