Mirrored_Repos/InvokeAI
1
0
Fork 0
mirror of https://github.com/invoke-ai/InvokeAI synced 2024-08-30 20:32:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

huge update

Browse Source 
I was pretty busy trying to make the Readmes / docs  look good in MkDocs
This commit is contained in:
mauwii 2022-09-14 07:42:56 +02:00
parent 0b4f5a926f
commit 3b5a8308eb
No known key found for this signature in database
GPG Key ID: D923DB04ADB3F5AB
16 changed files with 985 additions and 758 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
docs/features/CHANGELOG.md
View File

@ -1,52 +1,72 @@
--- ---
title: **Changelog** title: Changelog
--- ---
## v1.13 (in process) ## v1.13 (in process)
- Supports a Google Colab notebook for a standalone server running on Google hardware [Arturo Mendivil](https://github.com/artmen1516) - Supports a Google Colab notebook for a standalone server running on Google
- WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling [Kevin Gibbons](https://github.com/bakkot) hardware [Arturo Mendivil](https://github.com/artmen1516)
- WebUI supports incremental display of in-progress images during generation [Kevin Gibbons](https://github.com/bakkot) - WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling
[Kevin Gibbons](https://github.com/bakkot)
- WebUI supports incremental display of in-progress images during generation
[Kevin Gibbons](https://github.com/bakkot)
- Output directory can be specified on the dream> command line. - Output directory can be specified on the dream> command line.
- The grid was displaying duplicated images when not enough images to fill the final row [Muhammad Usama](https://github.com/SMUsamaShah) - The grid was displaying duplicated images when not enough images to fill the
final row [Muhammad Usama](https://github.com/SMUsamaShah)
- Can specify --grid on dream.py command line as the default. - Can specify --grid on dream.py command line as the default.
- Miscellaneous internal bug and stability fixes. - Miscellaneous internal bug and stability fixes.
---
## v1.12 (28 August 2022) ## v1.12 (28 August 2022)
- Improved file handling, including ability to read prompts from standard input. - Improved file handling, including ability to read prompts from standard input.
(kudos to [Yunsaki](https://github.com/yunsaki) (kudos to [Yunsaki](https://github.com/yunsaki)
- The web server is now integrated with the dream.py script. Invoke by adding --web to - The web server is now integrated with the dream.py script. Invoke by adding
the dream.py command arguments. --web to the dream.py command arguments.
- Face restoration and upscaling via GFPGAN and Real-ESGAN are now automatically - Face restoration and upscaling via GFPGAN and Real-ESGAN are now automatically
enabled if the GFPGAN directory is located as a sibling to Stable Diffusion. enabled if the GFPGAN directory is located as a sibling to Stable Diffusion.
VRAM requirements are modestly reduced. Thanks to both [Blessedcoolant](https://github.com/blessedcoolant) and VRAM requirements are modestly reduced. Thanks to both
[Blessedcoolant](https://github.com/blessedcoolant) and
[Oceanswave](https://github.com/oceanswave) for their work on this. [Oceanswave](https://github.com/oceanswave) for their work on this.
- You can now swap samplers on the dream> command line. [Blessedcoolant](https://github.com/blessedcoolant) - You can now swap samplers on the dream> command line.
[Blessedcoolant](https://github.com/blessedcoolant)
---
## v1.11 (26 August 2022) ## v1.11 (26 August 2022)
- NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module. (kudos to [Oceanswave](https://github.com/Oceanswave) - NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module.
- You now can specify a seed of -1 to use the previous image's seed, -2 to use the seed for the image generated before that, etc. (kudos to [Oceanswave](https://github.com/Oceanswave))
Seed memory only extends back to the previous command, but will work on all images generated with the -n# switch. - You now can specify a seed of -1 to use the previous image's seed, -2 to use
the seed for the image generated before that, etc. Seed memory only extends
back to the previous command, but will work on all images generated with the
-n# switch.
- Variant generation support temporarily disabled pending more general solution. - Variant generation support temporarily disabled pending more general solution.
- Created a feature branch named **yunsaki-morphing-dream** which adds experimental support for - Created a feature branch named **yunsaki-morphing-dream** which adds
iteratively modifying the prompt and its parameters. Please see[ Pull Request #86](https://github.com/lstein/stable-diffusion/pull/86) experimental support for iteratively modifying the prompt and its parameters.
for a synopsis of how this works. Note that when this feature is eventually added to the main branch, it will may be modified Please
significantly. see[ Pull Request #86](https://github.com/lstein/stable-diffusion/pull/86) for
a synopsis of how this works. Note that when this feature is eventually added
to the main branch, it will may be modified significantly.
---
## v1.10 (25 August 2022) ## v1.10 (25 August 2022)
- A barebones but fully functional interactive web server for online generation of txt2img and img2img. - A barebones but fully functional interactive web server for online generation
of txt2img and img2img.
--- ---
## v1.09 (24 August 2022) ## v1.09 (24 August 2022)
- A new -v option allows you to generate multiple variants of an initial image - A new -v option allows you to generate multiple variants of an initial image
in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave). [ in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave).
See this discussion in the PR for examples and details on use](https://github.com/lstein/stable-diffusion/pull/71#issuecomment-1226700810)) - [See this discussion in the PR for examples and details on use](https://github.com/lstein/stable-diffusion/pull/71#issuecomment-1226700810))
- Added ability to personalize text to image generation (kudos to [Oceanswave](https://github.com/Oceanswave) and [nicolai256](https://github.com/nicolai256)) - Added ability to personalize text to image generation (kudos to
[Oceanswave](https://github.com/Oceanswave) and
[nicolai256](https://github.com/nicolai256))
- Enabled all of the samplers from k_diffusion - Enabled all of the samplers from k_diffusion
--- ---
@ -64,34 +84,34 @@ title: **Changelog**
## v1.07 (23 August 2022) ## v1.07 (23 August 2022)
- Image filenames will now never fill gaps in the sequence, but will be assigned the - Image filenames will now never fill gaps in the sequence, but will be assigned
next higher name in the chosen directory. This ensures that the alphabetic and chronological the next higher name in the chosen directory. This ensures that the alphabetic
sort orders are the same. and chronological sort orders are the same.
--- ---
## v1.06 (23 August 2022) ## v1.06 (23 August 2022)
- Added weighted prompt support contributed by [xraxra](https://github.com/xraxra) - Added weighted prompt support contributed by
- Example of using weighted prompts to tweak a demonic figure contributed by [bmaltais](https://github.com/bmaltais) [xraxra](https://github.com/xraxra)
- Example of using weighted prompts to tweak a demonic figure contributed by
[bmaltais](https://github.com/bmaltais)
--- ---
## v1.05 (22 August 2022 - after the drop) ## v1.05 (22 August 2022 - after the drop)
- Filenames now use the following formats: - Filenames now use the following formats: 000010.95183149.png -- Two files
000010.95183149.png -- Two files produced by the same command (e.g. -n2), produced by the same command (e.g. -n2), 000010.26742632.png -- distinguished
000010.26742632.png -- distinguished by a different seed. by a different seed.
000011.455191342.01.png -- Two files produced by the same command using
000011.455191342.01.png -- Two files produced by the same command using 000011.455191342.02.png -- a batch size>1 (e.g. -b2). They have the same seed.
000011.455191342.02.png -- a batch size>1 (e.g. -b2). They have the same seed. 000011.4160627868.grid#1-4.png -- a grid of four images (-g); the whole grid
can be regenerated with the indicated key
000011.4160627868.grid#1-4.png -- a grid of four images (-g); the whole grid can
be regenerated with the indicated key
- It should no longer be possible for one image to overwrite another - It should no longer be possible for one image to overwrite another
- You can use the "cd" and "pwd" commands at the dream> prompt to set and retrieve - You can use the "cd" and "pwd" commands at the dream> prompt to set and
the path of the output directory. retrieve the path of the output directory.
## v1.04 (22 August 2022 - after the drop) ## v1.04 (22 August 2022 - after the drop)
@ -101,19 +121,21 @@ title: **Changelog**
## v1.03 (22 August 2022) ## v1.03 (22 August 2022)
- The original txt2img and img2img scripts from the CompViz repository have been moved into - The original txt2img and img2img scripts from the CompViz repository have been
a subfolder named "orig_scripts", to reduce confusion. moved into a subfolder named "orig_scripts", to reduce confusion.
## v1.02 (21 August 2022) ## v1.02 (21 August 2022)
- A copy of the prompt and all of its switches and options is now stored in the corresponding - A copy of the prompt and all of its switches and options is now stored in the
image in a tEXt metadata field named "Dream". You can read the prompt using scripts/images2prompt.py, corresponding image in a tEXt metadata field named "Dream". You can read the
or an image editor that allows you to explore the full metadata. prompt using scripts/images2prompt.py, or an image editor that allows you to
**Please run "conda env update -f environment.yaml" to load the k_lms dependencies!!** explore the full metadata. **Please run "conda env update -f environment.yaml"
to load the k_lms dependencies!!**
## v1.01 (21 August 2022) ## v1.01 (21 August 2022)
- added k_lms sampling. - added k_lms sampling. **Please run "conda env update -f environment.yaml" to
**Please run "conda env update -f environment.yaml" to load the k_lms dependencies!!** load the k_lms dependencies!!**
- use half precision arithmetic by default, resulting in faster execution and lower memory requirements - use half precision arithmetic by default, resulting in faster execution and
Pass argument --full_precision to dream.py to get slower but more accurate image generation lower memory requirements Pass argument --full_precision to dream.py to get
slower but more accurate image generation

272
docs/features/CLI.md
View File

@ -1,21 +1,27 @@
--- ---
title: "CLI" title: CLI
--- ---
**Interactive Command Line Interface** ## **Interactive Command Line Interface**
The `dream.py` script, located in `scripts/dream.py`, provides an interactive interface to image generation similar to the "dream mothership" bot that Stable AI provided on its Discord server. The `dream.py` script, located in `scripts/dream.py`, provides an interactive interface to image
generation similar to the "dream mothership" bot that Stable AI provided on its Discord server.
Unlike the txt2img.py and img2img.py scripts provided in the original CompViz/stable-diffusion source code repository, the time-consuming initialization of the AI model initialization only happens once. After that image generation Unlike the txt2img.py and img2img.py scripts provided in the original CompViz/stable-diffusion
from the command-line interface is very fast. source code repository, the time-consuming initialization of the AI model initialization only
happens once. After that image generation from the command-line interface is very fast.
The script uses the readline library to allow for in-line editing, command history (up and down arrows), autocompletion, and more. To help keep track of which prompts generated which images, the script writes a log file of image names and prompts to the selected output directory. The script uses the readline library to allow for in-line editing, command history (up and down
arrows), autocompletion, and more. To help keep track of which prompts generated which images, the
script writes a log file of image names and prompts to the selected output directory.
In addition, as of version 1.02, it also writes the prompt into the PNG file's metadata where it can be retrieved using scripts/images2prompt.py In addition, as of version 1.02, it also writes the prompt into the PNG file's metadata where it can
be retrieved using scripts/images2prompt.py
The script is confirmed to work on Linux, Windows and Mac systems. The script is confirmed to work on Linux, Windows and Mac systems.
_Note:_ This script runs from the command-line or can be used as a Web application. The Web GUI is currently rudimentary, but a much better replacement is on its way. _Note:_ This script runs from the command-line or can be used as a Web application. The Web GUI is
currently rudimentary, but a much better replacement is on its way.
```bash ```bash
(ldm) ~/stable-diffusion$ python3 ./scripts/dream.py (ldm) ~/stable-diffusion$ python3 ./scripts/dream.py
@ -45,184 +51,174 @@ dream> q
<img src="../assets/dream-py-demo.png"/> <img src="../assets/dream-py-demo.png"/>
</p> </p>
The `dream>` prompt's arguments are pretty much identical to those The `dream>` prompt's arguments are pretty much identical to those used in the Discord bot, except
used in the Discord bot, except you don't need to type "!dream" (it you don't need to type "!dream" (it doesn't hurt if you do). A significant change is that creation
doesn't hurt if you do). A significant change is that creation of of individual images is now the default unless --grid (-g) is given. A full list is given in [List
individual images is now the default unless --grid (-g) is given. A of prompt arguments] (#list-of-prompt-arguments).
full list is given in [List of prompt arguments]
(#list-of-prompt-arguments).
# Arguments ## Arguments
The script itself also recognizes a series of command-line switches The script itself also recognizes a series of command-line switches that will change important
that will change important global defaults, such as the directory for global defaults, such as the directory for image outputs and the location of the model weight files.
image outputs and the location of the model weight files.
## List of arguments recognized at the command line ## List of arguments recognized at the command line
These command-line arguments can be passed to dream.py when you first These command-line arguments can be passed to dream.py when you first run it from the Windows, Mac
run it from the Windows, Mac or Linux command line. Some set defaults or Linux command line. Some set defaults that can be overridden on a per-prompt basis (see [List of
that can be overridden on a per-prompt basis (see [List of prompt prompt arguments] (#list-of-prompt-arguments). Others
arguments] (#list-of-prompt-arguments). Others
| Argument | Shortcut | Default | Description | | Argument | Shortcut | Default | Description |
|--------------------|------------|---------------------|--------------| | :---------------------- | :---------: | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
| --help | -h | | Print a concise help message. | | --help | -h | | Print a concise help message. |
| --outdir <path> | -o<path> | outputs/img_samples | Location for generated images. | | --outdir <path> | -o<path> | outputs/img_samples | Location for generated images. |
| --prompt_as_dir | -p | False | Name output directories using the prompt text. | | --prompt_as_dir | -p | False | Name output directories using the prompt text. |
| --from_file <path> | | None | Read list of prompts from a file. Use "-" to read from standard input | | --from_file <path> | | None | Read list of prompts from a file. Use "-" to read from standard input |
| --model <modelname>| | stable-diffusion-1.4| Loads model specified in configs/models.yaml. Currently one of "stable-diffusion-1.4" or "laion400m"| | --model <modelname> | | stable-diffusion-1.4 | Loads model specified in configs/models.yaml. Currently one of "stable-diffusion-1.4" or "laion400m" |
| --full_precision | -F | False | Run in slower full-precision mode. Needed for Macintosh M1/M2 hardware and some older video cards. | | --full_precision | -F | False | Run in slower full-precision mode. Needed for Macintosh M1/M2 hardware and some older video cards. |
| --web | | False | Start in web server mode | | --web | | False | Start in web server mode |
| --host <ip addr> | | localhost | Which network interface web server should listen on. Set to 0.0.0.0 to listen on any. | | --host <ip addr> | | localhost | Which network interface web server should listen on. Set to 0.0.0.0 to listen on any. |
| --port <port> | | 9090 | Which port web server should listen for requests on. | | --port <port> | | 9090 | Which port web server should listen for requests on. |
| --config <path> | | configs/models.yaml | Configuration file for models and their weights. | | --config <path> | | configs/models.yaml | Configuration file for models and their weights. |
| --iterations <int> | -n<int> | 1 | How many images to generate per prompt. | | --iterations <int> | -n<int> | 1 | How many images to generate per prompt. |
| --grid | -g | False | Save all image series as a grid rather than individually. | | --grid | -g | False | Save all image series as a grid rather than individually. |
| --sampler <sampler>| -A<sampler>| k_lms | Sampler to use. Use -h to get list of available samplers. | | --sampler <sampler> | -A<sampler> | k_lms | Sampler to use. Use -h to get list of available samplers. |
| --seamless | | False | Create interesting effects by tiling elements of the image. | | --seamless | | False | Create interesting effects by tiling elements of the image. |
| --embedding_path <path>| | None | Path to pre-trained embedding manager checkpoints, for custom models | | --embedding_path <path> | | None | Path to pre-trained embedding manager checkpoints, for custom models |
| --gfpgan_dir | | src/gfpgan | Path to where GFPGAN is installed. | | --gfpgan_dir | | src/gfpgan | Path to where GFPGAN is installed. |
| --gfpgan_model_path| | experiments/pretrained_models/GFPGANv1.3.pth| Path to GFPGAN model file, relative to --gfpgan_dir. | | --gfpgan_model_path | | experiments/pretrained_models<br>/GFPGANv1.3.pth | Path to GFPGAN model file, relative to --gfpgan_dir. |
| --device <device> | -d<device>| torch.cuda.current_device() | Device to run SD on, e.g. "cuda:0" | | --device <device> | -d<device> | torch.cuda.current_device() | Device to run SD on, e.g. "cuda:0" |
These arguments are deprecated but still work: These arguments are deprecated but still work:
| Argument | Shortcut | Default | Description | | Argument | Shortcut | Default | Description |
|--------------------|------------|---------------------|--------------| | ---------------- | -------- | ------- | --------------------------------------------------------------- |
| --weights <path> | | None | Pth to weights file; use `--model stable-diffusion-1.4` instead | | --weights <path> | | None | Pth to weights file; use `--model stable-diffusion-1.4` instead |
| --laion400m | -l | False | Use older LAION400m weights; use `--model=laion400m` instead | | --laion400m | -l | False | Use older LAION400m weights; use `--model=laion400m` instead |
**A note on path names:** On Windows systems, you may run into ### **A note on path names:**
problems when passing the dream script standard backslashed path
names because the Python interpreter treats "\" as an escape.
You can either double your slashes (ick): C:\\\\path\\\\to\\\\my\\\\file, or
use Linux/Mac style forward slashes (better): C:/path/to/my/file.
## List of prompt arguments On Windows systems, you may run into problems when passing the dream script standard backslashed
path names because the Python interpreter treats "\" as an escape. You can either double your
slashes (ick): C:\\\\path\\\\to\\\\my\\\\file, or use Linux/Mac style forward slashes (better):
C:/path/to/my/file.
After the dream.py script initializes, it will present you with a ### List of prompt arguments
**dream>** prompt. Here you can enter information to generate images
from text (txt2img), to embellish an existing image or sketch After the dream.py script initializes, it will present you with a **dream>** prompt. Here you can
(img2img), or to selectively alter chosen regions of the image enter information to generate images from text (txt2img), to embellish an existing image or sketch
(inpainting). (img2img), or to selectively alter chosen regions of the image (inpainting).
### This is an example of txt2img ### This is an example of txt2img
~~~~ ```bash
dream> waterfall and rainbow -W640 -H480 dream> "waterfall and rainbow" -W640 -H480
~~~~ ```
This will create the requested image with the dimensions 640 (width) This will create the requested image with the dimensions 640 (width) and 480 (height).
and 480 (height).
Here are the dream> command that apply to txt2img: Those are the `dream` commands that apply to txt2img:
| Argument | Shortcut | Default | Description | | Argument | Shortcut | Default | Description |
|--------------------|------------|---------------------|--------------| | --------------------------- | ---------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "my prompt" | | | Text prompt to use. The quotation marks are optional. | | "my prompt" | | | Text prompt to use. The quotation marks are optional. |
| --width <int> | -W<int> | 512 | Width of generated image | | --width <int> | -W<int> | 512 | Width of generated image |
| --height <int> | -H<int> | 512 | Height of generated image | | --height <int> | -H<int> | 512 | Height of generated image |
| --iterations <int> | -n<int> | 1 | How many images to generate from this prompt | | --iterations <int> | -n<int> | 1 | How many images to generate from this prompt |
| --steps <int> | -s<int> | 50 | How many steps of refinement to apply | | --steps <int> | -s<int> | 50 | How many steps of refinement to apply |
| --cfg_scale <float>| -C<float> | 7.5 | How hard to try to match the prompt to the generated image; any number greater than 0.0 works, but the useful range is roughly 5.0 to 20.0 | | --cfg_scale <float> | -C<float> | 7.5 | How hard to try to match the prompt to the generated image; any number greater than 0.0 works, but the useful range is roughly 5.0 to 20.0 |
| --seed <int> | -S<int> | None | Set the random seed for the next series of images. This can be used to recreate an image generated previously.| | --seed <int> | -S<int> | None | Set the random seed for the next series of images. This can be used to recreate an image generated previously. |
| --sampler <sampler>| -A<sampler>| k_lms | Sampler to use. Use -h to get list of available samplers. | | --sampler <sampler> | -A<sampler> | k_lms | Sampler to use. Use -h to get list of available samplers. |
| --grid | -g | False | Turn on grid mode to return a single image combining all the images generated by this prompt | | --grid | -g | False | Turn on grid mode to return a single image combining all the images generated by this prompt |
| --individual | -i | True | Turn off grid mode (deprecated; leave off --grid instead) | | --individual | -i | True | Turn off grid mode (deprecated; leave off --grid instead) |
| --outdir <path> | -o<path> | outputs/img_samples | Temporarily change the location of these images | | --outdir <path> | -o<path> | outputs/img_samples | Temporarily change the location of these images |
| --seamless | | False | Activate seamless tiling for interesting effects | | --seamless | | False | Activate seamless tiling for interesting effects |
| --log_tokenization | -t | False | Display a color-coded list of the parsed tokens derived from the prompt | | --log_tokenization | -t | False | Display a color-coded list of the parsed tokens derived from the prompt |
| --skip_normalization| -x | False | Weighted subprompts will not be normalized. See [Weighted Prompts](./OTHER.md#weighted-prompts) | | --skip_normalization | -x | False | Weighted subprompts will not be normalized. See [Weighted Prompts](./OTHER.md#weighted-prompts) |
| --upscale <int> <float> | -U <int> <float> | -U 1 0.75| Upscale image by magnification factor (2, 4), and set strength of upscaling (0.0-1.0). If strength not set, will default to 0.75. | | --upscale <int> <float> | -U <int> <float> | -U 1 0.75 | Upscale image by magnification factor (2, 4), and set strength of upscaling (0.0-1.0). If strength not set, will default to 0.75. |
| --gfpgan_strength <float> | -G <float> | -G0 | Fix faces using the GFPGAN algorithm; argument indicates how hard the algorithm should try (0.0-1.0) | | --gfpgan_strength <float> | -G <float> | -G0 | Fix faces using the GFPGAN algorithm; argument indicates how hard the algorithm should try (0.0-1.0) |
| --save_original | -save_orig| False | When upscaling or fixing faces, this will cause the original image to be saved rather than replaced. | | --save_original | -save_orig | False | When upscaling or fixing faces, this will cause the original image to be saved rather than replaced. |
| --variation <float> |-v<float>| 0.0 | Add a bit of noise (0.0=none, 1.0=high) to the image in order to generate a series of variations. Usually used in combination with -S<seed> and -n<int> to generate a series a riffs on a starting image. See [Variations](./VARIATIONS.md). | | --variation <float> | -v<float> | 0.0 | Add a bit of noise (0.0=none, 1.0=high) to the image in order to generate a series of variations. Usually used in combination with -S<seed> and -n<int> to generate a series a riffs on a starting image. See [Variations](./VARIATIONS.md). |
| --with_variations <pattern> | -V<pattern>| None | Combine two or more variations. See [Variations](./VARIATIONS.md) for now to use this. | | --with_variations <pattern> | -V<pattern> | None | Combine two or more variations. See [Variations](./VARIATIONS.md) for now to use this. |
Note that the width and height of the image must be multiples of Note that the width and height of the image must be multiples of 64. You can provide different
64. You can provide different values, but they will be rounded down to values, but they will be rounded down to the nearest multiple of 64.
the nearest multiple of 64.
### This is an example of img2img ### This is an example of img2img
~~~~ ```bash
dream> waterfall and rainbow -I./vacation-photo.png -W640 -H480 --fit dream> waterfall and rainbow -I./vacation-photo.png -W640 -H480 --fit
~~~~ ```
This will modify the indicated vacation photograph by making it more This will modify the indicated vacation photograph by making it more like the prompt. Results will
like the prompt. Results will vary greatly depending on what is in the vary greatly depending on what is in the image. We also ask to --fit the image into a box no bigger
image. We also ask to --fit the image into a box no bigger than than 640x480. Otherwise the image size will be identical to the provided photo and you may run out
640x480. Otherwise the image size will be identical to the provided of memory if it is large.
photo and you may run out of memory if it is large.
In addition to the command-line options recognized by txt2img, img2img In addition to the command-line options recognized by txt2img, img2img accepts additional options:
accepts additional options:
| Argument | Shortcut | Default | Description | | Argument | Shortcut | Default | Description |
|--------------------|------------|---------------------|--------------| | ------------------ | --------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| --init_img <path> | -I<path> | None | Path to the initialization image | | --init_img <path> | -I<path> | None | Path to the initialization image |
| --fit | -F | False | Scale the image to fit into the specified -H and -W dimensions | | --fit | -F | False | Scale the image to fit into the specified -H and -W dimensions |
| --strength <float> | -s<float> | 0.75 | How hard to try to match the prompt to the initial image. Ranges from 0.0-0.99, with higher values replacing the initial image completely.| | --strength <float> | -s<float> | 0.75 | How hard to try to match the prompt to the initial image. Ranges from 0.0-0.99, with higher values replacing the initial image completely. |
### This is an example of inpainting ### This is an example of inpainting
~~~~ ```bash
dream> waterfall and rainbow -I./vacation-photo.png -M./vacation-mask.png -W640 -H480 --fit dream> "waterfall and rainbow" -I./vacation-photo.png -M./vacation-mask.png -W640 -H480 --fit
~~~~ ```
This will do the same thing as img2img, but image alterations will This will do the same thing as img2img, but image alterations will only occur within transparent
only occur within transparent areas defined by the mask file specified areas defined by the mask file specified by -M. You may also supply just a single initial image with
by -M. You may also supply just a single initial image with the areas the areas to overpaint made transparent, but you must be careful not to destroy the pixels
to overpaint made transparent, but you must be careful not to destroy underneath when you create the transparent areas. See [Inpainting](./INPAINTING.md) for details.
the pixels underneath when you create the transparent areas. See
[Inpainting](./INPAINTING.md) for details.
inpainting accepts all the arguments used for txt2img and img2img, as inpainting accepts all the arguments used for txt2img and img2img, as well as the --mask (-M)
well as the --mask (-M) argument: argument:
| Argument | Shortcut | Default | Description | | Argument | Shortcut | Default | Description |
|--------------------|------------|---------------------|--------------| | ------------------ | -------- | ------- | ------------------------------------------------------------------------------------------------ |
| --init_mask <path> | -M<path> | None |Path to an image the same size as the initial_image, with areas for inpainting made transparent.| | --init_mask <path> | -M<path> | None | Path to an image the same size as the initial_image, with areas for inpainting made transparent. |
# Command-line editing and completion ## Command-line editing and completion
If you are on a Macintosh or Linux machine, the command-line offers If you are on a Macintosh or Linux machine, the command-line offers convenient history tracking,
convenient history tracking, editing, and command completion. editing, and command completion.
- To scroll through previous commands and potentially edit/reuse them, use the up and down cursor keys. - To scroll through previous commands and potentially edit/reuse them, use the up and down cursor
- To edit the current command, use the left and right cursor keys to position the cursor, and then backspace, delete or insert characters. keys.
- To edit the current command, use the left and right cursor keys to position the cursor, and then
backspace, delete or insert characters.
- To move to the very beginning of the command, type CTRL-A (or command-A on the Mac) - To move to the very beginning of the command, type CTRL-A (or command-A on the Mac)
- To move to the end of the command, type CTRL-E. - To move to the end of the command, type CTRL-E.
- To cut a section of the command, position the cursor where you want to start cutting and type CTRL-K. - To cut a section of the command, position the cursor where you want to start cutting and type
CTRL-K.
- To paste a cut section back in, position the cursor where you want to paste, and type CTRL-Y - To paste a cut section back in, position the cursor where you want to paste, and type CTRL-Y
Windows users can get similar, but more limited, functionality if they Windows users can get similar, but more limited, functionality if they launch dream.py with the
launch dream.py with the "winpty" program: "winpty" program:
~~~ ```
> winpty python scripts\dream.py > winpty python scripts\dream.py
~~~ ```
On the Mac and Linux platforms, when you exit dream.py, the last 1000 On the Mac and Linux platforms, when you exit dream.py, the last 1000 lines of your command-line
lines of your command-line history will be saved. When you restart history will be saved. When you restart dream.py, you can access the saved history using the
dream.py, you can access the saved history using the up-arrow key. up-arrow key.
In addition, limited command-line completion is installed. In various In addition, limited command-line completion is installed. In various contexts, you can start typing
contexts, you can start typing your command and press tab. A list of your command and press tab. A list of potential completions will be presented to you. You can then
potential completions will be presented to you. You can then type a type a little more, hit tab again, and eventually autocomplete what you want.
little more, hit tab again, and eventually autocomplete what you want.
When specifying file paths using the one-letter shortcuts, the CLI When specifying file paths using the one-letter shortcuts, the CLI will attempt to complete
will attempt to complete pathnames for you. This is most handy for the pathnames for you. This is most handy for the -I (init image) and -M (init mask) paths. To initiate
-I (init image) and -M (init mask) paths. To initiate completion, start completion, start the path with a slash ("/") or "./". For example:
the path with a slash ("/") or "./". For example:
~~~ ```
dream> zebra with a mustache -I./test-pictures<TAB> dream> zebra with a mustache -I./test-pictures<TAB>
-I./test-pictures/Lincoln-and-Parrot.png -I./test-pictures/zebra.jpg -I./test-pictures/madonna.png -I./test-pictures/Lincoln-and-Parrot.png -I./test-pictures/zebra.jpg -I./test-pictures/madonna.png
-I./test-pictures/bad-sketch.png -I./test-pictures/man_with_eagle/ -I./test-pictures/bad-sketch.png -I./test-pictures/man_with_eagle/
~~~ ```
You can then type "z", hit tab again, and it will autofill to "zebra.jpg". You can then type "z", hit tab again, and it will autofill to "zebra.jpg".

43
docs/features/IMG2IMG.md
View File

@ -1,31 +1,28 @@
--- ---
title: **Image-to-Image** title: Image-to-Image
--- ---
This script also provides an img2img feature that lets you seed your
creations with an initial drawing or photo. This is a really cool
feature that tells stable diffusion to build the prompt on top of the
image you provide, preserving the original's basic shape and
layout. To use it, provide the `--init_img` option as shown here:
``` ## **IMG2IMG**
This script also provides an `img2img` feature that lets you seed your creations with an initial
drawing or photo. This is a really cool feature that tells stable diffusion to build the prompt on
top of the image you provide, preserving the original's basic shape and layout. To use it, provide
the `--init_img` option as shown here:
```bash
dream> "waterfall and rainbow" --init_img=./init-images/crude_drawing.png --strength=0.5 -s100 -n4 dream> "waterfall and rainbow" --init_img=./init-images/crude_drawing.png --strength=0.5 -s100 -n4
``` ```
The `--init_img (-I)` option gives the path to the seed The `--init_img (-I)` option gives the path to the seed picture. `--strength (-f)` controls how much
picture. `--strength (-f)` controls how much the original will be the original will be modified, ranging from `0.0` (keep the original intact), to `1.0` (ignore the
modified, ranging from `0.0` (keep the original intact), to `1.0` original completely). The default is `0.75`, and ranges from `0.25-0.75` give interesting results.
(ignore the original completely). The default is `0.75`, and ranges
from `0.25-0.75` give interesting results.
You may also pass a `-v<count>` option to generate count variants on You may also pass a `-v <count>` option to generate count variants on the original image. This is
the original image. This is done by passing the first generated image done by passing the first generated image back into img2img the requested number of times. It
back into img2img the requested number of times. It generates generates interesting variants.
interesting variants.
If the initial image contains transparent regions, then Stable If the initial image contains transparent regions, then Stable Diffusion will only draw within the
Diffusion will only draw within the transparent regions, a process transparent regions, a process called "inpainting". However, for this to work correctly, the color
called "inpainting". However, for this to work correctly, the color information underneath the transparent needs to be preserved, not erased.
information underneath the transparent needs to be preserved, not
erased. See [Creating Transparent Images For More Details can be found here:
Inpainting](./INPAINTING.md#creating-transparent-regions-for-inpainting) [Creating Transparent Images For Inpainting](./INPAINTING.md#creating-transparent-regions-for-inpainting)
for details.

44
docs/features/INPAINTING.md
View File

@ -1,27 +1,27 @@
# **Creating Transparent Regions for Inpainting** ---
title: Inpainting
---
Inpainting is really cool. To do it, you start with an initial image ## **Creating Transparent Regions for Inpainting**
and use a photoeditor to make one or more regions transparent
(i.e. they have a "hole" in them). You then provide the path to this
image at the dream> command line using the `-I` switch. Stable
Diffusion will only paint within the transparent region.
There's a catch. In the current implementation, you have to prepare Inpainting is really cool. To do it, you start with an initial image and use a photoeditor to make
the initial image correctly so that the underlying colors are one or more regions transparent (i.e. they have a "hole" in them). You then provide the path to this
preserved under the transparent area. Many imaging editing image at the dream> command line using the `-I` switch. Stable Diffusion will only paint within the
applications will by default erase the color information under the transparent region.
transparent pixels and replace them with white or black, which will
lead to suboptimal inpainting. You also must take care to export the
PNG file in such a way that the color information is preserved.
If your photoeditor is erasing the underlying color information, There's a catch. In the current implementation, you have to prepare the initial image correctly so
`dream.py` will give you a big fat warning. If you can't find a way to that the underlying colors are preserved under the transparent area. Many imaging editing
coax your photoeditor to retain color values under transparent areas, applications will by default erase the color information under the transparent pixels and replace
then you can combine the `-I` and `-M` switches to provide both the them with white or black, which will lead to suboptimal inpainting. You also must take care to
original unedited image and the masked (partially transparent) image: export the PNG file in such a way that the color information is preserved.
``` If your photoeditor is erasing the underlying color information, `dream.py` will give you a big fat
dream> man with cat on shoulder -I./images/man.png -M./images/man-transparent.png warning. If you can't find a way to coax your photoeditor to retain color values under transparent
areas, then you can combine the `-I` and `-M` switches to provide both the original unedited image
and the masked (partially transparent) image:
```bash
dream> "man with cat on shoulder" -I./images/man.png -M./images/man-transparent.png
``` ```
We are hoping to get rid of the need for this workaround in an upcoming release. We are hoping to get rid of the need for this workaround in an upcoming release.
@ -37,5 +37,5 @@ We are hoping to get rid of the need for this workaround in an upcoming release.
5. Open the Layers toolbar (^L) and select "Floating Selection" 5. Open the Layers toolbar (^L) and select "Floating Selection"
6. Set opacity to 0% 6. Set opacity to 0%
7. Export as PNG 7. Export as PNG
8. In the export dialogue, Make sure the "Save colour values from 8. In the export dialogue, Make sure the "Save colour values from transparent pixels" checkbox is
transparent pixels" checkbox is selected. selected.

76
docs/features/OTHER.md
View File

@ -1,27 +1,26 @@
--- ---
title: other title: Others
--- ---
## **Google Colab** ## **Google Colab**
Stable Diffusion AI Notebook: <a Stable Diffusion AI Notebook: <a
href="https://colab.research.google.com/github/lstein/stable-diffusion/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb" href="https://colab.research.google.com/github/lstein/stable-diffusion/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb"
target="_parent"><img target="_parent">
<img
src="https://colab.research.google.com/assets/colab-badge.svg" src="https://colab.research.google.com/assets/colab-badge.svg"
alt="Open In Colab"/></a> <br> Open and follow instructions to use an alt="Open In Colab"/></a> <br> Open and follow instructions to use an isolated environment running
isolated environment running Dream.<br> Dream.<br>
Output Example: Output Example: ![Colab Notebook](../assets/colab_notebook.png)
![Colab Notebook](../assets/colab_notebook.png)
--- ---
## **Seamless Tiling** ## **Seamless Tiling**
The seamless tiling mode causes generated images to seamlessly tile The seamless tiling mode causes generated images to seamlessly tile with itself. To use it, add the
with itself. To use it, add the `--seamless` option when starting the `--seamless` option when starting the script which will result in all generated images to tile, or
script which will result in all generated images to tile, or for each for each `dream>` prompt as shown here:
`dream>` prompt as shown here:
```python ```python
dream> "pond garden with lotus by claude monet" --seamless -s100 -n4 dream> "pond garden with lotus by claude monet" --seamless -s100 -n4
@ -31,12 +30,11 @@ dream> "pond garden with lotus by claude monet" --seamless -s100 -n4
## **Reading Prompts from a File** ## **Reading Prompts from a File**
You can automate `dream.py` by providing a text file with the prompts You can automate `dream.py` by providing a text file with the prompts you want to run, one line per
you want to run, one line per prompt. The text file must be composed prompt. The text file must be composed with a text editor (e.g. Notepad) and not a word processor.
with a text editor (e.g. Notepad) and not a word processor. Each line Each line should look like what you would type at the dream> prompt:
should look like what you would type at the dream> prompt:
``` ```bash
a beautiful sunny day in the park, children playing -n4 -C10 a beautiful sunny day in the park, children playing -n4 -C10
stormy weather on a mountain top, goats grazing -s100 stormy weather on a mountain top, goats grazing -s100
innovative packaging for a squid's dinner -S137038382 innovative packaging for a squid's dinner -S137038382
@ -58,12 +56,16 @@ You may read a series of prompts from standard input by providing a filename of
## **Shortcuts: Reusing Seeds** ## **Shortcuts: Reusing Seeds**
Since it is so common to reuse seeds while refining a prompt, there is now a shortcut as of version 1.11. Provide a `**-S**` (or `**--seed**`) Since it is so common to reuse seeds while refining a prompt, there is now a shortcut as of version
switch of `-1` to use the seed of the most recent image generated. If you produced multiple images with the `**-n**` switch, then you can go back further using -2, -3, etc. up to the first image generated by the previous command. Sorry, but you can't go back further than one command. 1.11. Provide a `**-S**` (or `**--seed**`) switch of `-1` to use the seed of the most recent image
generated. If you produced multiple images with the `**-n**` switch, then you can go back further
using -2, -3, etc. up to the first image generated by the previous command. Sorry, but you can't go
back further than one command.
Here's an example of using this to do a quick refinement. It also illustrates using the new `**-G**` switch to turn on upscaling and face enhancement (see previous section): Here's an example of using this to do a quick refinement. It also illustrates using the new `**-G**`
switch to turn on upscaling and face enhancement (see previous section):
``` ```bash
dream> a cute child playing hopscotch -G0.5 dream> a cute child playing hopscotch -G0.5
[...] [...]
outputs/img-samples/000039.3498014304.png: "a cute child playing hopscotch" -s50 -W512 -H512 -C7.5 -mk_lms -S3498014304 outputs/img-samples/000039.3498014304.png: "a cute child playing hopscotch" -s50 -W512 -H512 -C7.5 -mk_lms -S3498014304
@ -80,26 +82,26 @@ outputs/img-samples/000040.3498014304.png: "a cute child playing hopscotch" -G1.
## **Weighted Prompts** ## **Weighted Prompts**
You may weight different sections of the prompt to tell the sampler to attach different levels of You may weight different sections of the prompt to tell the sampler to attach different levels of
priority to them, by adding `:(number)` to the end of the section you wish to up- or downweight. priority to them, by adding `:(number)` to the end of the section you wish to up- or downweight. For
For example consider this prompt: example consider this prompt:
``` ```bash
tabby cat:0.25 white duck:0.75 hybrid tabby cat:0.25 white duck:0.75 hybrid
``` ```
This will tell the sampler to invest 25% of its effort on the tabby This will tell the sampler to invest 25% of its effort on the tabby cat aspect of the image and 75%
cat aspect of the image and 75% on the white duck aspect on the white duck aspect (surprisingly, this example actually works). The prompt weights can use any
(surprisingly, this example actually works). The prompt weights can combination of integers and floating point numbers, and they do not need to add up to 1.
use any combination of integers and floating point numbers, and they
do not need to add up to 1.
--- ---
## **Simplified API** ## **Simplified API**
For programmers who wish to incorporate stable-diffusion into other products, this repository includes a simplified API for text to image generation, which lets you create images from a prompt in just three lines of code: For programmers who wish to incorporate stable-diffusion into other products, this repository
includes a simplified API for text to image generation, which lets you create images from a prompt
in just three lines of code:
``` ```bash
from ldm.generate import Generate from ldm.generate import Generate
g = Generate() g = Generate()
outputs = g.txt2img("a unicorn in manhattan") outputs = g.txt2img("a unicorn in manhattan")
@ -113,16 +115,14 @@ Please see ldm/generate.py for more information. A set of example scripts is com
## **Preload Models** ## **Preload Models**
In situations where you have limited internet connectivity or are In situations where you have limited internet connectivity or are blocked behind a firewall, you can
blocked behind a firewall, you can use the preload script to preload use the preload script to preload the required files for Stable Diffusion to run.
the required files for Stable Diffusion to run.
The preload script `scripts/preload_models.py` needs to be run once at The preload script `scripts/preload_models.py` needs to be run once at least while connected to the
least while connected to the internet. In the following runs, it will internet. In the following runs, it will load up the cached versions of the required files from the
load up the cached versions of the required files from the `.cache` `.cache` directory of the system.
directory of the system.
``` ```bash
(ldm) ~/stable-diffusion$ python3 ./scripts/preload_models.py (ldm) ~/stable-diffusion$ python3 ./scripts/preload_models.py
preloading bert tokenizer... preloading bert tokenizer...
Downloading: 100%|██████████████████████████████████| 28.0/28.0 [00:00<00:00, 49.3kB/s] Downloading: 100%|██████████████████████████████████| 28.0/28.0 [00:00<00:00, 49.3kB/s]

47
docs/features/TEXTUAL_INVERSION.md
View File

@ -6,18 +6,19 @@ title: TEXTUAL_INVERSION
You may personalize the generated images to provide your own styles or objects You may personalize the generated images to provide your own styles or objects
by training a new LDM checkpoint and introducing a new vocabulary to the fixed by training a new LDM checkpoint and introducing a new vocabulary to the fixed
model as a (.pt) embeddings file. Alternatively, you may use or train HuggingFace model as a (.pt) embeddings file. Alternatively, you may use or train
Concepts embeddings files (.bin) from <https://huggingface.co/sd-concepts-library> HuggingFace Concepts embeddings files (.bin) from
and its associated notebooks. <https://huggingface.co/sd-concepts-library> and its associated notebooks.
## **Training** ## **Training**
To train, prepare a folder that contains images sized at 512x512 and execute the following: To train, prepare a folder that contains images sized at 512x512 and execute the
following:
### WINDOWS: ### WINDOWS
As the default backend is not available on Windows, if you're using that platform, As the default backend is not available on Windows, if you're using that
set the environment variable `PL_TORCH_DISTRIBUTED_BACKEND` to `gloo` platform, set the environment variable `PL_TORCH_DISTRIBUTED_BACKEND` to `gloo`
```bash ```bash
python3 ./main.py --base ./configs/stable-diffusion/v1-finetune.yaml \ python3 ./main.py --base ./configs/stable-diffusion/v1-finetune.yaml \
@ -32,9 +33,9 @@ python3 ./main.py --base ./configs/stable-diffusion/v1-finetune.yaml \
During the training process, files will be created in During the training process, files will be created in
`/logs/[project][time][project]/` where you can see the process. `/logs/[project][time][project]/` where you can see the process.
Conditioning contains the training prompts inputs, reconstruction the Conditioning contains the training prompts inputs, reconstruction the input
input images for the training epoch samples, samples scaled for a images for the training epoch samples, samples scaled for a sample of the prompt
sample of the prompt and one with the init word provided. and one with the init word provided.
On a RTX3090, the process for SD will take ~1h @1.6 iterations/sec. On a RTX3090, the process for SD will take ~1h @1.6 iterations/sec.
@ -44,17 +45,16 @@ On a RTX3090, the process for SD will take ~1h @1.6 iterations/sec.
images is 3-5. Your model may not converge if you use more images than images is 3-5. Your model may not converge if you use more images than
that. that.
Training will run indefinitely, but you may wish to stop it (with Training will run indefinitely, but you may wish to stop it (with ctrl-c) before
ctrl-c) before the heat death of the universe, when you find a low the heat death of the universe, when you find a low loss epoch or around ~5000
loss epoch or around ~5000 iterations. Note that you can set a fixed iterations. Note that you can set a fixed limit on the number of training steps
limit on the number of training steps by decreasing the "max_steps" by decreasing the "max_steps" option in
option in configs/stable_diffusion/v1-finetune.yaml (currently set to configs/stable_diffusion/v1-finetune.yaml (currently set to 4000000)
4000000)
## **Running** ## **Run the Model**
Once the model is trained, specify the trained .pt or .bin file when Once the model is trained, specify the trained .pt or .bin file when starting
starting dream using dream using
```bash ```bash
python3 ./scripts/dream.py \ python3 ./scripts/dream.py \
@ -75,16 +75,17 @@ dream> "waterfall and rainbow in the style of *" --init_img=./init-images/crude_
``` ```
For .pt files it's also possible to train multiple tokens (modify the For .pt files it's also possible to train multiple tokens (modify the
placeholder string in `configs/stable-diffusion/v1-finetune.yaml`) and placeholder string in `configs/stable-diffusion/v1-finetune.yaml`) and combine
combine LDM checkpoints using: LDM checkpoints using:
```bash ```bash
python3 ./scripts/merge_embeddings.py \ python3 ./scripts/merge_embeddings.py \
--manager_ckpts /path/to/first/embedding.pt \ --manager_ckpts /path/to/first/embedding.pt \
[</path/to/second/embedding.pt> [...]] \ [</path/to/second/embedding.pt>,[...]] \
--output_path /path/to/output/embedding.pt --output_path /path/to/output/embedding.pt
``` ```
Credit goes to rinongal and the repository Credit goes to rinongal and the repository
Please see [the repository](https://github.com/rinongal/textual_inversion) and associated paper for details and limitations. Please see [the repository](https://github.com/rinongal/textual_inversion) and
associated paper for details and limitations.

128
docs/features/UPSCALE.md
View File

@ -1,105 +1,99 @@
# **GFPGAN and Real-ESRGAN Support** ---
title: Upscale
---
The script also provides the ability to do face restoration and ## **GFPGAN and Real-ESRGAN Support**
upscaling with the help of GFPGAN and Real-ESRGAN respectively.
As of version 1.14, environment.yaml will install the Real-ESRGAN package into the The script also provides the ability to do face restoration and upscaling with the help of GFPGAN
standard install location for python packages, and will put GFPGAN into a subdirectory of "src" and Real-ESRGAN respectively.
in the stable-diffusion directory.
(The reason for this is that the standard GFPGAN distribution has a minor bug that adversely affects image
color.) Upscaling with Real-ESRGAN should "just work" without further intervention. Simply pass the --upscale (-U)
option on the dream> command line, or indicate the desired scale on the popup in the Web GUI.
For **GFPGAN** to work, there is one additional step needed. You will need to download and As of version 1.14, environment.yaml will install the Real-ESRGAN package into the standard install
copy the GFPGAN [models file](https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.3.pth) location for python packages, and will put GFPGAN into a subdirectory of "src" in the
into **src/gfpgan/experiments/pretrained_models**. On Mac and Linux systems, here's how you'd do it using stable-diffusion directory. (The reason for this is that the standard GFPGAN distribution has a
**wget**: minor bug that adversely affects image color.) Upscaling with Real-ESRGAN should "just work" without
~~~~ further intervention. Simply pass the --upscale (-U) option on the dream> command line, or indicate
the desired scale on the popup in the Web GUI.
For **GFPGAN** to work, there is one additional step needed. You will need to download and copy the
GFPGAN [models file](https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.3.pth)
into **src/gfpgan/experiments/pretrained_models**. On Mac and Linux systems, here's how you'd do it
using **wget**:
```bash
> wget https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.3.pth src/gfpgan/experiments/pretrained_models/ > wget https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.3.pth src/gfpgan/experiments/pretrained_models/
~~~~ ```
Make sure that you're in the stable-diffusion directory when you do this. Make sure that you're in the stable-diffusion directory when you do this.
Alternatively, if you have GFPGAN installed elsewhere, or if you are using Alternatively, if you have GFPGAN installed elsewhere, or if you are using an earlier version of
an earlier version of this package which asked you to install GFPGAN in a this package which asked you to install GFPGAN in a sibling directory, you may use the
sibling directory, you may use the `--gfpgan_dir` argument with `dream.py` to set a `--gfpgan_dir` argument with `dream.py` to set a custom path to your GFPGAN directory. _There are
custom path to your GFPGAN directory. _There are other GFPGAN related other GFPGAN related boot arguments if you wish to customize further._
boot arguments if you wish to customize further._
**Note: Internet connection needed:** **Note: Internet connection needed:** Users whose GPU machines are isolated from the Internet (e.g.
Users whose GPU machines are isolated from the Internet (e.g. on a on a University cluster) should be aware that the first time you run dream.py with GFPGAN and
University cluster) should be aware that the first time you run Real-ESRGAN turned on, it will try to download model files from the Internet. To rectify this, you
dream.py with GFPGAN and Real-ESRGAN turned on, it will try to may run `python3 scripts/preload_models.py` after you have installed GFPGAN and all its
download model files from the Internet. To rectify this, you may run dependencies.
`python3 scripts/preload_models.py` after you have installed GFPGAN
and all its dependencies.
**Usage** ## **Usage**
You will now have access to two new prompt arguments. You will now have access to two new prompt arguments.
**Upscaling** ### **Upscaling**
`-U : <upscaling_factor> <upscaling_strength>` `-U : <upscaling_factor> <upscaling_strength>`
The upscaling prompt argument takes two values. The first value is a The upscaling prompt argument takes two values. The first value is a scaling factor and should be
scaling factor and should be set to either `2` or `4` only. This will set to either `2` or `4` only. This will either scale the image 2x or 4x respectively using
either scale the image 2x or 4x respectively using different models. different models.
You can set the scaling stength between `0` and `1.0` to control You can set the scaling stength between `0` and `1.0` to control intensity of the of the scaling.
intensity of the of the scaling. This is handy because AI upscalers This is handy because AI upscalers generally tend to smooth out texture details. If you wish to
generally tend to smooth out texture details. If you wish to retain retain some of those for natural looking results, we recommend using values between `0.5 to 0.8`.
some of those for natural looking results, we recommend using values
between `0.5 to 0.8`.
If you do not explicitly specify an upscaling_strength, it will If you do not explicitly specify an upscaling_strength, it will default to 0.75.
default to 0.75.
**Face Restoration** ### **Face Restoration**
`-G : <gfpgan_strength>` `-G : <gfpgan_strength>`
This prompt argument controls the strength of the face restoration This prompt argument controls the strength of the face restoration that is being applied. Similar to
that is being applied. Similar to upscaling, values between `0.5 to 0.8` are recommended. upscaling, values between `0.5 to 0.8` are recommended.
You can use either one or both without any conflicts. In cases where You can use either one or both without any conflicts. In cases where you use both, the image will be
you use both, the image will be first upscaled and then the face first upscaled and then the face restoration process will be executed to ensure you get the highest
restoration process will be executed to ensure you get the highest
quality facial features. quality facial features.
`--save_orig` `--save_orig`
When you use either `-U` or `-G`, the final result you get is upscaled When you use either `-U` or `-G`, the final result you get is upscaled or face modified. If you want
or face modified. If you want to save the original Stable Diffusion to save the original Stable Diffusion generation, you can use the `-save_orig` prompt argument to
generation, you can use the `-save_orig` prompt argument to save the save the original unaffected version too.
original unaffected version too.
**Example Usage** ### **Example Usage**
``` ```bash
dream > superman dancing with a panda bear -U 2 0.6 -G 0.4 dream> superman dancing with a panda bear -U 2 0.6 -G 0.4
``` ```
This also works with img2img: This also works with img2img:
``` ```bash
dream> a man wearing a pineapple hat -I path/to/your/file.png -U 2 0.5 -G 0.6 dream> a man wearing a pineapple hat -I path/to/your/file.png -U 2 0.5 -G 0.6
``` ```
**Note** ### **Note**
GFPGAN and Real-ESRGAN are both memory intensive. In order to avoid GFPGAN and Real-ESRGAN are both memory intensive. In order to avoid crashes and memory overloads
crashes and memory overloads during the Stable Diffusion process, during the Stable Diffusion process, these effects are applied after Stable Diffusion has completed
these effects are applied after Stable Diffusion has completed its its work.
work.
In single image generations, you will see the output right away but In single image generations, you will see the output right away but when you are using multiple
when you are using multiple iterations, the images will first be iterations, the images will first be generated and then upscaled and face restored after that
generated and then upscaled and face restored after that process is process is complete. While the image generation is taking place, you will still be able to preview
complete. While the image generation is taking place, you will still the base images.
be able to preview the base images.
If you wish to stop during the image generation but want to upscale or If you wish to stop during the image generation but want to upscale or face restore a particular
face restore a particular generated image, pass it again with the same generated image, pass it again with the same prompt and generated seed along with the `-U` and `-G`
prompt and generated seed along with the `-U` and `-G` prompt prompt arguments to perform those actions.
arguments to perform those actions.

75
docs/features/VARIATIONS.md
View File

@ -1,26 +1,33 @@
# **Variations** ---
title: Variations
---
Release 1.13 of SD-Dream adds support for image variations. Release 1.13 of SD-Dream adds support for image variations.
You are able to do the following: You are able to do the following:
1. Generate a series of systematic variations of an image, given a prompt. The amount of variation from one image to the next can be controlled. 1. Generate a series of systematic variations of an image, given a prompt. The
amount of variation from one image to the next can be controlled.
2. Given two or more variations that you like, you can combine them in a weighted fashion. 2. Given two or more variations that you like, you can combine them in a
weighted fashion.
--- ---
This cheat sheet provides a quick guide for how this works in practice, using variations to create the desired image of Xena, Warrior Princess. This cheat sheet provides a quick guide for how this works in practice, using
variations to create the desired image of Xena, Warrior Princess.
--- ---
## Step 1 -- Find a base image that you like ## Step 1 -- Find a base image that you like
The prompt we will use throughout is `lucy lawless as xena, warrior princess, character portrait, high resolution.` The prompt we will use throughout is
`lucy lawless as xena, warrior princess, character portrait, high resolution.`
This will be indicated as `prompt` in the examples below. This will be indicated as `prompt` in the examples below.
First we let SD create a series of images in the usual way, in this case requesting six iterations: First we let SD create a series of images in the usual way, in this case
requesting six iterations:
``` ```
dream> lucy lawless as xena, warrior princess, character portrait, high resolution -n6 dream> lucy lawless as xena, warrior princess, character portrait, high resolution -n6
@ -36,17 +43,18 @@ Outputs:
The one with seed 3357757885 looks nice: The one with seed 3357757885 looks nice:
<img src="../assets/variation_walkthru/000001.3357757885.png"/> ![var1](../assets/variation_walkthru/000001.3357757885.png)
--- ---
## Step 2 - Generating Variations ## Step 2 - Generating Variations
Let's try to generate some variations. Using the same seed, we pass the argument `-v0.1` (or --variant_amount), which generates a series of Let's try to generate some variations. Using the same seed, we pass the argument
variations each differing by a variation amount of 0.2. This number ranges from `0` to `1.0`, with higher numbers being larger amounts of `-v0.1` (or --variant_amount), which generates a series of variations each
variation. differing by a variation amount of 0.2. This number ranges from `0` to `1.0`,
with higher numbers being larger amounts of variation.
``` ```bash
dream> "prompt" -n6 -S3357757885 -v0.2 dream> "prompt" -n6 -S3357757885 -v0.2
... ...
Outputs: Outputs:
@ -60,32 +68,41 @@ Outputs:
### **Variation Sub Seeding** ### **Variation Sub Seeding**
Note that the output for each image has a `-V` option giving the "variant subseed" for that image, consisting of a seed followed by the Note that the output for each image has a `-V` option giving the "variant
variation amount used to generate it. subseed" for that image, consisting of a seed followed by the variation amount
used to generate it.
This gives us a series of closely-related variations, including the two shown here. This gives us a series of closely-related variations, including the two shown
here.
<img src="../assets/variation_walkthru/000002.3647897225.png"> ![var2](../assets/variation_walkthru/000002.3647897225.png)
<img src="../assets/variation_walkthru/000002.1614299449.png">
I like the expression on Xena's face in the first one (subseed 3647897225), and the armor on her shoulder in the second one (subseed 1614299449). Can we combine them to get the best of both worlds? ![var3](../assets/variation_walkthru/000002.1614299449.png)
We combine the two variations using `-V` (--with_variations). Again, we must provide the seed for the originally-chosen image in order for I like the expression on Xena's face in the first one (subseed 3647897225), and
this to work. the armor on her shoulder in the second one (subseed 1614299449). Can we combine
them to get the best of both worlds?
``` We combine the two variations using `-V` (--with_variations). Again, we must
provide the seed for the originally-chosen image in order for this to work.
```bash
dream> "prompt" -S3357757885 -V3647897225,0.1;1614299449,0.1 dream> "prompt" -S3357757885 -V3647897225,0.1;1614299449,0.1
Outputs: Outputs:
./outputs/Xena/000003.1614299449.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -V 3647897225:0.1,1614299449:0.1 -S3357757885 ./outputs/Xena/000003.1614299449.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -V 3647897225:0.1,1614299449:0.1 -S3357757885
``` ```
Here we are providing equal weights (0.1 and 0.1) for both the subseeds. The resulting image is close, but not exactly what I wanted: Here we are providing equal weights (0.1 and 0.1) for both the subseeds. The
resulting image is close, but not exactly what I wanted:
<img src="../assets/variation_walkthru/000003.1614299449.png"> ![var4](../assets/variation_walkthru/000003.1614299449.png)
We could either try combining the images with different weights, or we can generate more variations around the almost-but-not-quite image. We do the latter, using both the `-V` (combining) and `-v` (variation strength) options. Note that we use `-n6` to generate 6 variations: We could either try combining the images with different weights, or we can
generate more variations around the almost-but-not-quite image. We do the
latter, using both the `-V` (combining) and `-v` (variation strength) options.
Note that we use `-n6` to generate 6 variations:
``` ```bash
dream> "prompt" -S3357757885 -V3647897225,0.1;1614299449,0.1 -v0.05 -n6 dream> "prompt" -S3357757885 -V3647897225,0.1;1614299449,0.1 -v0.05 -n6
Outputs: Outputs:
./outputs/Xena/000004.3279757577.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -V 3647897225:0.1,1614299449:0.1,3279757577:0.05 -S3357757885 ./outputs/Xena/000004.3279757577.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -V 3647897225:0.1,1614299449:0.1,3279757577:0.05 -S3357757885
@ -96,9 +113,11 @@ Outputs:
./outputs/Xena/000004.2183375608.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -V 3647897225:0.1,1614299449:0.1,2183375608:0.05 -S3357757885 ./outputs/Xena/000004.2183375608.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -V 3647897225:0.1,1614299449:0.1,2183375608:0.05 -S3357757885
``` ```
This produces six images, all slight variations on the combination of the chosen two images. Here's the one I like best: This produces six images, all slight variations on the combination of the chosen
two images. Here's the one I like best:
<img src="../assets/variation_walkthru/000004.3747154981.png"> ![var5](../assets/variation_walkthru/000004.3747154981.png)
As you can see, this is a very powerful tool, which when combined with subprompt weighting, gives you great control over the content and As you can see, this is a very powerful tool, which when combined with subprompt
quality of your generated images. weighting, gives you great control over the content and quality of your
generated images.

16
docs/features/WEB.md
View File

@ -1,13 +1,19 @@
# Barebones Web Server ---
title: Barebones Web Server
---
As of version 1.10, this distribution comes with a bare bones web server (see screenshot). To use it, run the `dream.py` script by adding the `**--web**` option. As of version 1.10, this distribution comes with a bare bones web server (see
screenshot). To use it, run the `dream.py` script by adding the `**--web**`
option.
``` ```bash
(ldm) ~/stable-diffusion$ python3 scripts/dream.py --web (ldm) ~/stable-diffusion$ python3 scripts/dream.py --web
``` ```
You can then connect to the server by pointing your web browser at http://localhost:9090, or to the network name or IP address of the server. You can then connect to the server by pointing your web browser at
http://localhost:9090, or to the network name or IP address of the server.
Kudos to [Tesseract Cat](https://github.com/TesseractCat) for contributing this code, and to [dagf2101](https://github.com/dagf2101) for refining it. Kudos to [Tesseract Cat](https://github.com/TesseractCat) for contributing this
code, and to [dagf2101](https://github.com/dagf2101) for refining it.
![Dream Web Server](../assets/dream_web_server.png) ![Dream Web Server](../assets/dream_web_server.png)

77
docs/help/TROUBLESHOOT.md
View File

@ -2,71 +2,88 @@
title: F.A.Q. title: F.A.Q.
--- ---
## **Frequently Asked Questions** ## **Frequently-Asked-Questions**
Here are a few common installation problems and their solutions. Often these are caused by incomplete installations or crashes during the Here are a few common installation problems and their solutions. Often these are caused by
install process. incomplete installations or crashes during the install process.
--- ---
**QUESTION** ### **QUESTION**
During `conda env create -f environment.yaml`, conda hangs indefinitely. During `conda env create -f environment.yaml`, conda hangs indefinitely.
**SOLUTION** ### **SOLUTION**
Enter the stable-diffusion directory and completely remove the `src` directory and all its contents. The safest way to do this is to enter the stable-diffusion directory and give the command `git clean -f`. If this still doesn't fix the problem, try "conda clean -all" and then restart at the `conda env create` step. Enter the stable-diffusion directory and completely remove the `src` directory and all its contents.
The safest way to do this is to enter the stable-diffusion directory and give the command
`git clean -f`. If this still doesn't fix the problem, try "conda clean -all" and then restart at
the `conda env create` step.
--- ---
**QUESTION** ### **QUESTION**
`dream.py` crashes with the complaint that it can't find `ldm.simplet2i.py`. Or it complains that function is being passed incorrect parameters. `dream.py` crashes with the complaint that it can't find `ldm.simplet2i.py`. Or it complains that
function is being passed incorrect parameters.
**SOLUTION** ### **SOLUTION**
Reinstall the stable diffusion modules. Enter the `stable-diffusion` directory and give the command `pip install -e .` Reinstall the stable diffusion modules. Enter the `stable-diffusion` directory and give the command
`pip install -e .`
--- ---
**QUESTION** ### **QUESTION**
`dream.py` dies, complaining of various missing modules, none of which starts with `ldm``. `dream.py` dies, complaining of various missing modules, none of which starts with `ldm``.
**SOLUTION** ### **SOLUTION**
From within the `stable-diffusion` directory, run `conda env update -f environment.yaml` This is also frequently the solution to From within the `stable-diffusion` directory, run `conda env update -f environment.yaml` This is
complaints about an unknown function in a module. also frequently the solution to complaints about an unknown function in a module.
--- ---
**QUESTION** ### **QUESTION**
There's a feature or bugfix in the Stable Diffusion GitHub that you want to try out. There's a feature or bugfix in the Stable Diffusion GitHub that you want to try out.
**SOLUTION** ### **SOLUTION**
**Main Branch** #### **Main Branch**
If the fix/feature is on the `main` branch, enter the stable-diffusion directory and do a `git pull`. If the fix/feature is on the `main` branch, enter the stable-diffusion directory and do a
`git pull`.
Usually this will be sufficient, but if you start to see errors about missing or incorrect modules, use the command `pip install -e .` and/or `conda env update -f environment.yaml` (These commands won't break anything.) Usually this will be sufficient, but if you start to see errors about missing or incorrect modules,
use the command
**Sub Branch** `pip install -e .` and/or
If the feature/fix is on a branch (e.g. "_foo-bugfix_"), the recipe is similar, but do a `git pull <name of branch>`. `conda env update -f environment.yaml`
**Not Committed** (These commands won't break anything.)
If the feature/fix is in a pull request that has not yet been made part of the main branch or a feature/bugfix branch, then from the page for the desired pull request, look for the line at the top that reads "_xxxx wants to merge xx commits into lstein:main from YYYYYY_". Copy the URL in YYYY. It should have the format `https://github.com/<name of contributor>/stable-diffusion/tree/<name of branch>` #### **Sub Branch**
Then **go to the directory above stable-diffusion** and rename the directory to "_stable-diffusion.lstein_", "_stable-diffusion.old_", or anything else. You can then git clone the branch that contains the pull request: If the feature/fix is on a branch (e.g. "_foo-bugfix_"), the recipe is similar, but do a
`git pull <name of branch>`.
``` #### **Not Committed**
git clone https://github.com/<name of contributor>/stable-diffusion/tree/<name
of branch>
```
You will need to go through the install procedure again, but it should be fast because all the dependencies are already loaded. If the feature/fix is in a pull request that has not yet been made part of the main branch or a
feature/bugfix branch, then from the page for the desired pull request, look for the line at the top
that reads "_xxxx wants to merge xx commits into lstein:main from YYYYYY_". Copy the URL in YYYY. It
should have the format
--- `https://github.com/<name of contributor>/stable-diffusion/tree/<name of branch>`
Then **go to the directory above stable-diffusion** and rename the directory to
"_stable-diffusion.lstein_", "_stable-diffusion.old_", or anything else. You can then git clone the
branch that contains the pull request:
`git clone https://github.com/<name of contributor>/stable-diffusion/tree/<name of branch>`
You will need to go through the install procedure again, but it should be fast because all the
dependencies are already loaded.

80
docs/index.md
View File

@ -4,7 +4,9 @@ title: Home
<h1 align='center'><b>Stable Diffusion Dream Script</b></h1> <h1 align='center'><b>Stable Diffusion Dream Script</b></h1>
![logo](./assets/logo.png){align='center'} <p align='center'>
<img src="./assets/logo.png"/>
</p>
<p align="center"> <p align="center">
<img src="https://img.shields.io/github/last-commit/lstein/stable-diffusion?logo=Python&logoColor=green&style=for-the-badge" alt="last-commit"/> <img src="https://img.shields.io/github/last-commit/lstein/stable-diffusion?logo=Python&logoColor=green&style=for-the-badge" alt="last-commit"/>
@ -16,17 +18,14 @@ title: Home
--- ---
This is a fork of This is a fork of [CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion), the open
[CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion), source text-to-image generator. It provides a streamlined process with various new features and
the open source text-to-image generator. It provides a streamlined options to aid the image generation process. It runs on Windows, Mac and Linux machines, and runs on
process with various new features and options to aid the image GPU cards with as little as 4 GB or RAM.
generation process. It runs on Windows, Mac and Linux machines,
and runs on GPU cards with as little as 4 GB or RAM.
_Note: This fork is rapidly evolving. Please use the _Note: This fork is rapidly evolving. Please use the
[Issues](https://github.com/lstein/stable-diffusion/issues) tab to [Issues](https://github.com/lstein/stable-diffusion/issues) tab to report bugs and make feature
report bugs and make feature requests. Be sure to use the provided requests. Be sure to use the provided templates. They will help aid diagnose issues faster._
templates. They will help aid diagnose issues faster._
## **Table of Contents** ## **Table of Contents**
@ -49,7 +48,8 @@ templates. They will help aid diagnose issues faster._
## Installation ## Installation
This fork is supported across multiple platforms. You can find individual installation instructions below. This fork is supported across multiple platforms. You can find individual installation instructions
below.
- [Linux](./installation/INSTALL_LINUX.md) - [Linux](./installation/INSTALL_LINUX.md)
- [Windows](./installation/INSTALL_WINDOWS.md) - [Windows](./installation/INSTALL_WINDOWS.md)
@ -74,13 +74,12 @@ You wil need one of the following:
### **Note** ### **Note**
If you are have a Nvidia 10xx series card (e.g. the 1080ti), please If you are have a Nvidia 10xx series card (e.g. the 1080ti), please run the dream script in
run the dream script in full-precision mode as shown below. full-precision mode as shown below.
Similarly, specify full-precision mode on Apple M1 hardware. Similarly, specify full-precision mode on Apple M1 hardware.
To run in full-precision mode, start `dream.py` with the To run in full-precision mode, start `dream.py` with the `--full_precision` flag:
`--full_precision` flag:
```bash ```bash
(ldm) ~/stable-diffusion$ python scripts/dream.py --full_precision (ldm) ~/stable-diffusion$ python scripts/dream.py --full_precision
@ -113,20 +112,27 @@ To run in full-precision mode, start `dream.py` with the
## Latest Changes ## Latest Changes
- v1.14 (11 September 2022) - v1.14 (11 September 2022)
- Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs. - Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs.
- Full support for Apple hardware with M1 or M2 chips. - Full support for Apple hardware with M1 or M2 chips.
- Add "seamless mode" for circular tiling of image. Generates beautiful effects. ([prixt](https://github.com/prixt)). - Add "seamless mode" for circular tiling of image. Generates beautiful effects.
([prixt](https://github.com/prixt)).
- Inpainting support. - Inpainting support.
- Improved web server GUI. - Improved web server GUI.
- Lots of code and documentation cleanups. - Lots of code and documentation cleanups.
- v1.13 (3 September 2022 - v1.13 (3 September 2022
- Support image variations (see [VARIATIONS](./features/VARIATIONS.md) ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers) - Support image variations (see [VARIATIONS](./features/VARIATIONS.md)
- Supports a Google Colab notebook for a standalone server running on Google hardware [Arturo Mendivil](https://github.com/artmen1516) ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers)
- WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling [Kevin Gibbons](https://github.com/bakkot) - Supports a Google Colab notebook for a standalone server running on Google hardware
- WebUI supports incremental display of in-progress images during generation [Kevin Gibbons](https://github.com/bakkot) [Arturo Mendivil](https://github.com/artmen1516)
- A new configuration file scheme that allows new models (including upcoming stable-diffusion-v1.5) - WebUI supports GFPGAN/ESRGAN facial reconstruction and upscaling
to be added without altering the code. ([David Wager](https://github.com/maddavid12)) [Kevin Gibbons](https://github.com/bakkot)
- WebUI supports incremental display of in-progress images during generation
[Kevin Gibbons](https://github.com/bakkot)
- A new configuration file scheme that allows new models (including upcoming
stable-diffusion-v1.5) to be added without altering the code.
([David Wager](https://github.com/maddavid12))
- Can specify --grid on dream.py command line as the default. - Can specify --grid on dream.py command line as the default.
- Miscellaneous internal bug and stability fixes. - Miscellaneous internal bug and stability fixes.
- Works on M1 Apple hardware. - Works on M1 Apple hardware.
@ -136,28 +142,36 @@ For older changelogs, please visit **[CHANGELOGS](./CHANGELOG.md)**.
## Troubleshooting ## Troubleshooting
Please check out our **[Q&A](./help/TROUBLESHOOT.md)** to get solutions for common installation problems and other issues. Please check out our **[Q&A](./help/TROUBLESHOOT.md)** to get solutions for common installation
problems and other issues.
## Contributing ## Contributing
Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code cleanup, testing, or code reviews, is very much encouraged to do so. If you are unfamiliar with Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code
how to contribute to GitHub projects, here is a [Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github). cleanup, testing, or code reviews, is very much encouraged to do so. If you are unfamiliar with how
to contribute to GitHub projects, here is a
[Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github).
A full set of contribution guidelines, along with templates, are in progress, but for now the most important thing is to **make your pull request against the "development" branch**, and not against "main". This will help keep public breakage to a minimum and will allow you to propose more radical changes. A full set of contribution guidelines, along with templates, are in progress, but for now the most
important thing is to **make your pull request against the "development" branch**, and not against
"main". This will help keep public breakage to a minimum and will allow you to propose more radical
changes.
### **Contributors** ### **Contributors**
This fork is a combined effort of various people from across the world. [Check out the list of all these amazing people](./CONTRIBUTORS.md). We thank them for their time, hard work and effort. This fork is a combined effort of various people from across the world.
[Check out the list of all these amazing people](./CONTRIBUTORS.md). We thank them for their time,
hard work and effort.
## Support ## Support
For support, For support, please use this repository's GitHub Issues tracking service. Feel free to send me an
please use this repository's GitHub Issues tracking service. Feel free email if you use and like the script.
to send me an email if you use and like the script.
Original portions of the software are Copyright (c) 2020 Lincoln D. Stein (https://github.com/lstein) Original portions of the software are Copyright (c) 2020
[Lincoln D. Stein](https://github.com/lstein)
## Further Reading ## Further Reading
Please see the original README for more information on this software Please see the original README for more information on this software and underlying algorithm,
and underlying algorithm, located in the file [README-CompViz.md](./README-CompViz.md). located in the file [README-CompViz.md](./README-CompViz.md).

131
docs/installation/INSTALL_LINUX.md
View File

@ -1,89 +1,110 @@
# **Linux Installation** ---
title: Linux
---
1. You will need to install the following prerequisites if they are not already available. Use your operating system's preferred installer 1. You will need to install the following prerequisites if they are not already
available. Use your operating system's preferred installer.
- Python (version 3.8.5 recommended; higher may work) - Python (version 3.8.5 recommended; higher may work)
- git - git
2. Install the Python Anaconda environment manager. 2. Install the Python Anaconda environment manager.
``` ```bash
~$ wget https://repo.anaconda.com/archive/Anaconda3-2022.05-Linux-x86_64.sh ~$ wget https://repo.anaconda.com/archive/Anaconda3-2022.05-Linux-x86_64.sh
~$ chmod +x Anaconda3-2022.05-Linux-x86_64.sh ~$ chmod +x Anaconda3-2022.05-Linux-x86_64.sh
~$ ./Anaconda3-2022.05-Linux-x86_64.sh ~$ ./Anaconda3-2022.05-Linux-x86_64.sh
``` ```
After installing anaconda, you should log out of your system and log back in. If the installation After installing anaconda, you should log out of your system and log back in. If
worked, your command prompt will be prefixed by the name of the current anaconda environment - `(base)`. the installation worked, your command prompt will be prefixed by the name of the
current anaconda environment - `(base)`.
3. Copy the stable-diffusion source code from GitHub: 3. Copy the stable-diffusion source code from GitHub:
``` ```bash
(base) ~$ git clone https://github.com/lstein/stable-diffusion.git (base) ~$ git clone https://github.com/lstein/stable-diffusion.git
``` ```
This will create stable-diffusion folder where you will follow the rest of the steps. This will create stable-diffusion folder where you will follow the rest of the
steps.
4. Enter the newly-created stable-diffusion folder. From this step forward make sure that you are working in the stable-diffusion directory! 4. Enter the newly-created stable-diffusion folder. From this step forward make
sure that you are working in the stable-diffusion directory!
``` ```bash
(base) ~$ cd stable-diffusion (base) ~$ cd stable-diffusion
(base) ~/stable-diffusion$ (base) ~/stable-diffusion$
``` ```
5. Use anaconda to copy necessary python packages, create a new python environment named `ldm` and activate the environment. 5. Use anaconda to copy necessary python packages, create a new python
environment named `ldm` and activate the environment.
``` ```bash
(base) ~/stable-diffusion$ conda env create -f environment.yaml (base) ~/stable-diffusion$ conda env create -f environment.yaml
(base) ~/stable-diffusion$ conda activate ldm (base) ~/stable-diffusion$ conda activate ldm
(ldm) ~/stable-diffusion$ (ldm) ~/stable-diffusion$
``` ```
After these steps, your command prompt will be prefixed by `(ldm)` as shown above. After these steps, your command prompt will be prefixed by `(ldm)` as shown
above.
6. Load a couple of small machine-learning models required by stable diffusion: 6. Load a couple of small machine-learning models required by stable diffusion:
``` ```bash
(ldm) ~/stable-diffusion$ python3 scripts/preload_models.py (ldm) ~/stable-diffusion$ python3 scripts/preload_models.py
``` ```
Note that this step is necessary because I modified the original just-in-time model loading scheme to allow the script to work on GPU machines that are not internet connected. See [Preload Models](../features/OTHER.md#preload-models) Note that this step is necessary because I modified the original just-in-time
model loading scheme to allow the script to work on GPU machines that are not
internet connected. See [Preload Models](../features/OTHER.md#preload-models)
7. Now you need to install the weights for the stable diffusion model. 7. Now you need to install the weights for the stable diffusion model.
- For running with the released weights, you will first need to set up an acount with Hugging Face (https://huggingface.co). - For running with the released weights, you will first need to set up an acount
- Use your credentials to log in, and then point your browser at https://huggingface.co/CompVis/stable-diffusion-v-1-4-original. with [Hugging Face](https://huggingface.co).
- You may be asked to sign a license agreement at this point. - Use your credentials to log in, and then point your browser [here](https://huggingface.co/CompVis/stable-diffusion-v-1-4-original.)
- Click on "Files and versions" near the top of the page, and then click on the file named "sd-v1-4.ckpt". You'll be taken to a page that prompts you to click the "download" link. Save the file somewhere safe on your local machine. - You may be asked to sign a license agreement at this point.
- Click on "Files and versions" near the top of the page, and then click on the
file named "sd-v1-4.ckpt". You'll be taken to a page that prompts you to click
the "download" link. Save the file somewhere safe on your local machine.
Now run the following commands from within the stable-diffusion directory. This will create a symbolic link from the stable-diffusion model.ckpt file, to the true location of the sd-v1-4.ckpt file. Now run the following commands from within the stable-diffusion directory.
This will create a symbolic link from the stable-diffusion model.ckpt file, to
the true location of the `sd-v1-4.ckpt` file.
``` ```bash
(ldm) ~/stable-diffusion$ mkdir -p models/ldm/stable-diffusion-v1 (ldm) ~/stable-diffusion$ mkdir -p models/ldm/stable-diffusion-v1
(ldm) ~/stable-diffusion$ ln -sf /path/to/sd-v1-4.ckpt models/ldm/stable-diffusion-v1/model.ckpt (ldm) ~/stable-diffusion$ ln -sf /path/to/sd-v1-4.ckpt models/ldm/stable-diffusion-v1/model.ckpt
``` ```
8. Start generating images! 8. Start generating images!
``` ```bash
# for the pre-release weights use the -l or --liaon400m switch # for the pre-release weights use the -l or --liaon400m switch
(ldm) ~/stable-diffusion$ python3 scripts/dream.py -l (ldm) ~/stable-diffusion$ python3 scripts/dream.py -l
# for the post-release weights do not use the switch # for the post-release weights do not use the switch
(ldm) ~/stable-diffusion$ python3 scripts/dream.py (ldm) ~/stable-diffusion$ python3 scripts/dream.py
# for additional configuration switches and arguments, use -h or --help # for additional configuration switches and arguments, use -h or --help
(ldm) ~/stable-diffusion$ python3 scripts/dream.py -h (ldm) ~/stable-diffusion$ python3 scripts/dream.py -h
``` ```
9. Subsequently, to relaunch the script, be sure to run "conda activate ldm" (step 5, second command), enter the `stable-diffusion` directory, and then launch the dream script (step 8). If you forget to activate the ldm environment, the script will fail with multiple `ModuleNotFound` errors. 9. Subsequently, to relaunch the script, be sure to run "conda activate ldm"
(step 5, second command), enter the `stable-diffusion` directory, and then
launch the dream script (step 8). If you forget to activate the ldm
environment, the script will fail with multiple `ModuleNotFound` errors.
### Updating to newer versions of the script ### Updating to newer versions of the script
This distribution is changing rapidly. If you used the `git clone` method (step 5) to download the stable-diffusion directory, then to update to the latest and greatest version, launch the Anaconda window, enter `stable-diffusion` and type: This distribution is changing rapidly. If you used the `git clone` method
(step 5) to download the stable-diffusion directory, then to update to the
latest and greatest version, launch the Anaconda window, enter
`stable-diffusion` and type:
``` ```bash
(ldm) ~/stable-diffusion$ git pull (ldm) ~/stable-diffusion$ git pull
``` ```
This will bring your local copy into sync with the remote one. This will bring your local copy into sync with the remote one.

351
docs/installation/INSTALL_MAC.md
View File

@ -1,37 +1,44 @@
# **macOS Instructions** ---
title: macOS
---
Requirements ## Requirements
- macOS 12.3 Monterey or later - macOS 12.3 Monterey or later
- Python - Python
- Patience - Patience
- Apple Silicon\* - Apple Silicon\*
\*I haven't tested any of this on Intel Macs but I have read that one person got it to work, so Apple Silicon might not be requried. \*I haven't tested any of this on Intel Macs but I have read that one person got
it to work, so Apple Silicon might not be requried.
Things have moved really fast and so these instructions change often Things have moved really fast and so these instructions change often and are
and are often out-of-date. One of the problems is that there are so often out-of-date. One of the problems is that there are so many different ways
many different ways to run this. to run this.
We are trying to build a testing setup so that when we make changes it We are trying to build a testing setup so that when we make changes it doesn't
doesn't always break. always break.
How to (this hasn't been 100% tested yet): How to (this hasn't been 100% tested yet):
First get the weights checkpoint download started - it's big: First get the weights checkpoint download started - it's big:
1. Sign up at https://huggingface.co 1. Sign up at https://huggingface.co
2. Go to the [Stable diffusion diffusion model page](https://huggingface.co/CompVis/stable-diffusion-v-1-4-original) 2. Go to the
[Stable diffusion diffusion model page](https://huggingface.co/CompVis/stable-diffusion-v-1-4-original)
3. Accept the terms and click Access Repository: 3. Accept the terms and click Access Repository:
4. Download [sd-v1-4.ckpt (4.27 GB)](https://huggingface.co/CompVis/stable-diffusion-v-1-4-original/blob/main/sd-v1-4.ckpt) and note where you have saved it (probably the Downloads folder) 4. Download
[sd-v1-4.ckpt (4.27 GB)](https://huggingface.co/CompVis/stable-diffusion-v-1-4-original/blob/main/sd-v1-4.ckpt)
and note where you have saved it (probably the Downloads folder)
While that is downloading, open Terminal and run the following commands one at a time. While that is downloading, open Terminal and run the following commands one
at a time.
```bash ```bash
# install brew (and Xcode command line tools): # install brew (and Xcode command line tools):
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
#
# Now there are two different routes to get the Python (miniconda) environment up and running: # Now there are two different routes to get the Python (miniconda) environment up and running:
# 1. Alongside pyenv # 1. Alongside pyenv
# 2. No pyenv # 2. No pyenv
@ -41,11 +48,11 @@ While that is downloading, open Terminal and run the following commands one at a
# NOW EITHER DO # NOW EITHER DO
# 1. Installing alongside pyenv # 1. Installing alongside pyenv
brew install pyenv-virtualenv # you might have this from before, no problem brew install pyenv-virtualenv # you might have this from before, no problem
pyenv install anaconda3-2022.05 pyenv install anaconda3-2022.05
pyenv virtualenv anaconda3-2022.05 pyenv virtualenv anaconda3-2022.05
eval "$(pyenv init -)" eval "$(pyenv init -)"
pyenv activate anaconda3-2022.05 pyenv activate anaconda3-2022.05
# OR, # OR,
# 2. Installing standalone # 2. Installing standalone
@ -53,31 +60,31 @@ pyenv activate anaconda3-2022.05
brew install cmake protobuf rust brew install cmake protobuf rust
# install miniconda (M1 arm64 version): # install miniconda (M1 arm64 version):
curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o Miniconda3-latest-MacOSX-arm64.sh curl https://repo.anaconda.com/miniconda/Miniconda3-latest-MacOSX-arm64.sh -o Miniconda3-latest-MacOSX-arm64.sh
/bin/bash Miniconda3-latest-MacOSX-arm64.sh /bin/bash Miniconda3-latest-MacOSX-arm64.sh
# EITHER WAY, # EITHER WAY,
# continue from here # continue from here
# clone the repo # clone the repo
git clone https://github.com/lstein/stable-diffusion.git git clone https://github.com/lstein/stable-diffusion.git
cd stable-diffusion cd stable-diffusion
# #
# wait until the checkpoint file has downloaded, then proceed # wait until the checkpoint file has downloaded, then proceed
# #
# create symlink to checkpoint # create symlink to checkpoint
mkdir -p models/ldm/stable-diffusion-v1/ mkdir -p models/ldm/stable-diffusion-v1/
PATH_TO_CKPT="$HOME/Downloads" # or wherever you saved sd-v1-4.ckpt PATH_TO_CKPT="$HOME/Downloads" # or wherever you saved sd-v1-4.ckpt
ln -s "$PATH_TO_CKPT/sd-v1-4.ckpt" models/ldm/stable-diffusion-v1/model.ckpt ln -s "$PATH_TO_CKPT/sd-v1-4.ckpt" models/ldm/stable-diffusion-v1/model.ckpt
# install packages # install packages
PIP_EXISTS_ACTION=w CONDA_SUBDIR=osx-arm64 conda env create -f environment-mac.yaml PIP_EXISTS_ACTION=w CONDA_SUBDIR=osx-arm64 conda env create -f environment-mac.yaml
conda activate ldm conda activate ldm
# only need to do this once # only need to do this once
python scripts/preload_models.py python scripts/preload_models.py
@ -88,117 +95,172 @@ python scripts/dream.py --full_precision # half-precision requires autocast and
The original scripts should work as well. The original scripts should work as well.
``` ```bash
python scripts/orig_scripts/txt2img.py --prompt "a photograph of an astronaut riding a horse" --plms python scripts/orig_scripts/txt2img.py --prompt "a photograph of an astronaut riding a horse" --plms
``` ```
Note, `export PIP_EXISTS_ACTION=w` is a precaution to fix `conda env Note,
create -f environment-mac.yaml` never finishing in some situations. So
it isn't required but wont hurt.
After you follow all the instructions and run dream.py you might get several errors. Here's the errors I've seen and found solutions for. ```bash
export PIP_EXISTS_ACTION=w
```
is a precaution to fix
```bash
conda env create -f environment-mac.yaml
```
never finishing in some situations. So it isn't required but wont hurt.
After you follow all the instructions and run dream.py you might get several
errors. Here's the errors I've seen and found solutions for.
---
### Is it slow? ### Is it slow?
Be sure to specify 1 sample and 1 iteration. Be sure to specify 1 sample and 1 iteration.
python ./scripts/orig_scripts/txt2img.py --prompt "ocean" --ddim_steps 5 --n_samples 1 --n_iter 1 ```bash
python ./scripts/orig_scripts/txt2img.py \
--prompt "ocean" \
--ddim_steps 5 \
--n_samples 1 \
--n_iter 1
```
---
### Doesn't work anymore? ### Doesn't work anymore?
PyTorch nightly includes support for MPS. Because of this, this setup is inherently unstable. One morning I woke up and it no longer worked no matter what I did until I switched to miniforge. However, I have another Mac that works just fine with Anaconda. If you can't get it to work, please search a little first because many of the errors will get posted and solved. If you can't find a solution please [create an issue](https://github.com/lstein/stable-diffusion/issues). PyTorch nightly includes support for MPS. Because of this, this setup is
inherently unstable. One morning I woke up and it no longer worked no matter
what I did until I switched to miniforge. However, I have another Mac that works
just fine with Anaconda. If you can't get it to work, please search a little
first because many of the errors will get posted and solved. If you can't find a
solution please
[create an issue](https://github.com/lstein/stable-diffusion/issues).
One debugging step is to update to the latest version of PyTorch nightly. One debugging step is to update to the latest version of PyTorch nightly.
conda install pytorch torchvision torchaudio -c pytorch-nightly ```bash
conda install pytorch torchvision torchaudio -c pytorch-nightly
```
If `conda env create -f environment-mac.yaml` takes forever run this. If it takes forever to run
git clean -f ```bash
conda env create -f environment-mac.yaml
```
And run this. you could try to run `git clean -f` followed by:
conda clean --yes --all `conda clean --yes --all`
Or you could reset Anaconda. Or you could try to completley reset Anaconda:
conda update --force-reinstall -y -n base -c defaults conda ```bash
conda update --force-reinstall -y -n base -c defaults conda
```
### "No module named cv2", torch, 'ldm', 'transformers', 'taming', etc. ---
### "No module named cv2", torch, 'ldm', 'transformers', 'taming', etc
There are several causes of these errors. There are several causes of these errors.
First, did you remember to `conda activate ldm`? If your terminal prompt - First, did you remember to `conda activate ldm`? If your terminal prompt
begins with "(ldm)" then you activated it. If it begins with "(base)" begins with "(ldm)" then you activated it. If it begins with "(base)" or
or something else you haven't. something else you haven't.
Second, you might've run `./scripts/preload_models.py` or `./scripts/dream.py` - Second, you might've run `./scripts/preload_models.py` or `./scripts/dream.py`
instead of `python ./scripts/preload_models.py` or `python ./scripts/dream.py`. instead of `python ./scripts/preload_models.py` or
The cause of this error is long so it's below. `python ./scripts/dream.py`. The cause of this error is long so it's below.
Third, if it says you're missing taming you need to rebuild your virtual - Third, if it says you're missing taming you need to rebuild your virtual
environment. environment.
conda env remove -n ldm `conda env remove -n ldm conda env create -f environment-mac.yaml`
conda env create -f environment-mac.yaml
Fourth, If you have activated the ldm virtual environment and tried rebuilding it, maybe the problem could be that I have something installed that you don't and you'll just need to manually install it. Make sure you activate the virtual environment so it installs there instead of Fourth, If you have activated the ldm virtual environment and tried rebuilding
globally. it, maybe the problem could be that I have something installed that you don't
and you'll just need to manually install it. Make sure you activate the virtual
environment so it installs there instead of globally.
conda activate ldm `conda activate ldm pip install _name_`
pip install *name*
You might also need to install Rust (I mention this again below). You might also need to install Rust (I mention this again below).
---
### How many snakes are living in your computer? ### How many snakes are living in your computer?
You might have multiple Python installations on your system, in which case it's You might have multiple Python installations on your system, in which case it's
important to be explicit and consistent about which one to use for a given project. important to be explicit and consistent about which one to use for a given
This is because virtual environments are coupled to the Python that created it (and all project. This is because virtual environments are coupled to the Python that
the associated 'system-level' modules). created it (and all the associated 'system-level' modules).
When you run `python` or `python3`, your shell searches the colon-delimited locations When you run `python` or `python3`, your shell searches the colon-delimited
in the `PATH` environment variable (`echo $PATH` to see that list) in that order - first match wins. locations in the `PATH` environment variable (`echo $PATH` to see that list) in
You can ask for the location of the first `python3` found in your `PATH` with the `which` command like this: that order - first match wins. You can ask for the location of the first
`python3` found in your `PATH` with the `which` command like this:
% which python3 ```bash
/usr/bin/python3 % which python3
/usr/bin/python3
```
Anything in `/usr/bin` is [part of the OS](https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html#//apple_ref/doc/uid/TP40010672-CH2-SW6). However, `/usr/bin/python3` is not actually python3, but Anything in `/usr/bin` is
rather a stub that offers to install Xcode (which includes python 3). If you have Xcode installed already, [part of the OS](https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html#//apple_ref/doc/uid/TP40010672-CH2-SW6).
`/usr/bin/python3` will execute `/Library/Developer/CommandLineTools/usr/bin/python3` or However, `/usr/bin/python3` is not actually python3, but rather a stub that
offers to install Xcode (which includes python 3). If you have Xcode installed
already, `/usr/bin/python3` will execute
`/Library/Developer/CommandLineTools/usr/bin/python3` or
`/Applications/Xcode.app/Contents/Developer/usr/bin/python3` (depending on which `/Applications/Xcode.app/Contents/Developer/usr/bin/python3` (depending on which
Xcode you've selected with `xcode-select`). Xcode you've selected with `xcode-select`).
Note that `/usr/bin/python` is an entirely different python - specifically, python 2. Note: starting in Note that `/usr/bin/python` is an entirely different python - specifically,
macOS 12.3, `/usr/bin/python` no longer exists. python 2. Note: starting in macOS 12.3, `/usr/bin/python` no longer exists.
% which python3 ```bash
/opt/homebrew/bin/python3 % which python3
/opt/homebrew/bin/python3
```
If you installed python3 with Homebrew and you've modified your path to search If you installed python3 with Homebrew and you've modified your path to search
for Homebrew binaries before system ones, you'll see the above path. for Homebrew binaries before system ones, you'll see the above path.
% which python ```bash
/opt/anaconda3/bin/python % which python
/opt/anaconda3/bin/python
```
If you have Anaconda installed, you will see the above path. There is a If you have Anaconda installed, you will see the above path. There is a
`/opt/anaconda3/bin/python3` also. We expect that `/opt/anaconda3/bin/python` `/opt/anaconda3/bin/python3` also.
and `/opt/anaconda3/bin/python3` should actually be the *same python*, which you can
verify by comparing the output of `python3 -V` and `python -V`.
(ldm) % which python We expect that `/opt/anaconda3/bin/python` and `/opt/anaconda3/bin/python3`
/Users/name/miniforge3/envs/ldm/bin/python should actually be the _same python_, which you can verify by comparing the
output of `python3 -V` and `python -V`.
The above is what you'll see if you have miniforge and you've correctly activated ```bash
the ldm environment, and you used option 2 in the setup instructions above ("no pyenv"). (ldm) % which python
/Users/name/miniforge3/envs/ldm/bin/python
```
(anaconda3-2022.05) % which python The above is what you'll see if you have miniforge and you've correctly
/Users/name/.pyenv/shims/python activated the ldm environment, and you used option 2 in the setup instructions
above ("no pyenv").
```bash
(anaconda3-2022.05) % which python
/Users/name/.pyenv/shims/python
```
... and the above is what you'll see if you used option 1 ("Alongside pyenv"). ... and the above is what you'll see if you used option 1 ("Alongside pyenv").
It's all a mess and you should know [how to modify the path environment variable](https://support.apple.com/guide/terminal/use-environment-variables-apd382cc5fa-4f58-4449-b20a-41c53c006f8f/mac) It's all a mess and you should know
[how to modify the path environment variable](https://support.apple.com/guide/terminal/use-environment-variables-apd382cc5fa-4f58-4449-b20a-41c53c006f8f/mac)
if you want to fix it. Here's a brief hint of all the ways you can modify it if you want to fix it. Here's a brief hint of all the ways you can modify it
(don't really have the time to explain it all here). (don't really have the time to explain it all here).
@ -211,18 +273,19 @@ if you want to fix it. Here's a brief hint of all the ways you can modify it
Which one you use will depend on what you have installed except putting a file Which one you use will depend on what you have installed except putting a file
in /etc/paths.d is what I prefer to do. in /etc/paths.d is what I prefer to do.
Finally, to answer the question posed by this section's title, it may help to list Finally, to answer the question posed by this section's title, it may help to
all of the `python` / `python3` things found in `$PATH` instead of just the one that list all of the `python` / `python3` things found in `$PATH` instead of just the
will be executed by default. To do that, add the `-a` switch to `which`: one that will be executed by default. To do that, add the `-a` switch to
`which`:
% which -a python3 % which -a python3
... ...
### Debugging? ### Debugging?
Tired of waiting for your renders to finish before you can see if it Tired of waiting for your renders to finish before you can see if it works?
works? Reduce the steps! The image quality will be horrible but at least you'll Reduce the steps! The image quality will be horrible but at least you'll get
get quick feedback. quick feedback.
python ./scripts/txt2img.py --prompt "ocean" --ddim_steps 5 --n_samples 1 --n_iter 1 python ./scripts/txt2img.py --prompt "ocean" --ddim_steps 5 --n_samples 1 --n_iter 1
@ -235,15 +298,24 @@ get quick feedback.
Example error. Example error.
``` ```
...
NotImplementedError: The operator 'aten::_index_put_impl_' is not current implemented for the MPS device. If you want this op to be added in priority during the prototype phase of this feature, please comment on [https://github.com/pytorch/pytorch/issues/77764](https://github.com/pytorch/pytorch/issues/77764). As a temporary fix, you can set the environment variable `PYTORCH_ENABLE_MPS_FALLBACK=1` to use the CPU as a fallback for this op. WARNING: this will be slower than running natively on MPS. ... NotImplementedError: The operator 'aten::_index_put_impl_' is not current
implemented for the MPS device. If you want this op to be added in priority
during the prototype phase of this feature, please comment on
[https://github.com/pytorch/pytorch/issues/77764](https://github.com/pytorch/pytorch/issues/77764).
As a temporary fix, you can set the environment variable
`PYTORCH_ENABLE_MPS_FALLBACK=1` to use the CPU as a fallback for this op.
WARNING: this will be slower than running natively on MPS.
``` ```
The lstein branch includes this fix in [environment-mac.yaml](https://github.com/lstein/stable-diffusion/blob/main/environment-mac.yaml). The lstein branch includes this fix in
[environment-mac.yaml](https://github.com/lstein/stable-diffusion/blob/main/environment-mac.yaml).
### "Could not build wheels for tokenizers" ### "Could not build wheels for tokenizers"
I have not seen this error because I had Rust installed on my computer before I started playing with Stable Diffusion. The fix is to install Rust. I have not seen this error because I had Rust installed on my computer before I
started playing with Stable Diffusion. The fix is to install Rust.
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
@ -251,10 +323,9 @@ I have not seen this error because I had Rust installed on my computer before I
First this: First this:
> Completely reproducible results are not guaranteed across PyTorch > Completely reproducible results are not guaranteed across PyTorch releases,
> releases, individual commits, or different platforms. Furthermore, > individual commits, or different platforms. Furthermore, results may not be
> results may not be reproducible between CPU and GPU executions, even > reproducible between CPU and GPU executions, even when using identical seeds.
> when using identical seeds.
[PyTorch docs](https://pytorch.org/docs/stable/notes/randomness.html) [PyTorch docs](https://pytorch.org/docs/stable/notes/randomness.html)
@ -265,53 +336,56 @@ still working on it.
OMP: Error #15: Initializing libiomp5.dylib, but found libomp.dylib already initialized. OMP: Error #15: Initializing libiomp5.dylib, but found libomp.dylib already initialized.
You are likely using an Intel package by mistake. Be sure to run conda with You are likely using an Intel package by mistake. Be sure to run conda with the
the environment variable `CONDA_SUBDIR=osx-arm64`, like so: environment variable `CONDA_SUBDIR=osx-arm64`, like so:
`CONDA_SUBDIR=osx-arm64 conda install ...` `CONDA_SUBDIR=osx-arm64 conda install ...`
This error happens with Anaconda on Macs when the Intel-only `mkl` is pulled in by This error happens with Anaconda on Macs when the Intel-only `mkl` is pulled in
a dependency. [nomkl](https://stackoverflow.com/questions/66224879/what-is-the-nomkl-python-package-used-for) by a dependency.
[nomkl](https://stackoverflow.com/questions/66224879/what-is-the-nomkl-python-package-used-for)
is a metapackage designed to prevent this, by making it impossible to install is a metapackage designed to prevent this, by making it impossible to install
`mkl`, but if your environment is already broken it may not work. `mkl`, but if your environment is already broken it may not work.
Do _not_ use `os.environ['KMP_DUPLICATE_LIB_OK']='True'` or equivalents as this Do _not_ use `os.environ['KMP_DUPLICATE_LIB_OK']='True'` or equivalents as this
masks the underlying issue of using Intel packages. masks the underlying issue of using Intel packages.
### Not enough memory. ### Not enough memory
This seems to be a common problem and is probably the underlying This seems to be a common problem and is probably the underlying problem for a
problem for a lot of symptoms (listed below). The fix is to lower your lot of symptoms (listed below). The fix is to lower your image size or to add
image size or to add `model.half()` right after the model is loaded. I `model.half()` right after the model is loaded. I should probably test it out.
should probably test it out. I've read that the reason this fixes I've read that the reason this fixes problems is because it converts the model
problems is because it converts the model from 32-bit to 16-bit and from 32-bit to 16-bit and that leaves more RAM for other things. I have no idea
that leaves more RAM for other things. I have no idea how that would how that would affect the quality of the images though.
affect the quality of the images though.
See [this issue](https://github.com/CompVis/stable-diffusion/issues/71). See [this issue](https://github.com/CompVis/stable-diffusion/issues/71).
### "Error: product of dimension sizes > 2\*\*31'" ### "Error: product of dimension sizes > 2\*\*31'"
This error happens with img2img, which I haven't played with too much This error happens with img2img, which I haven't played with too much yet. But I
yet. But I know it's because your image is too big or the resolution know it's because your image is too big or the resolution isn't a multiple of
isn't a multiple of 32x32. Because the stable-diffusion model was 32x32. Because the stable-diffusion model was trained on images that were 512 x
trained on images that were 512 x 512, it's always best to use that 512, it's always best to use that output size (which is the default). However,
output size (which is the default). However, if you're using that size if you're using that size and you get the above error, try 256 x 256 or 512 x
and you get the above error, try 256 x 256 or 512 x 256 or something 256 or something as the source image.
as the source image.
BTW, 2\*\*31-1 = [2,147,483,647](https://en.wikipedia.org/wiki/2,147,483,647#In_computing), which is also 32-bit signed [LONG_MAX](https://en.wikipedia.org/wiki/C_data_types) in C. BTW, 2\*\*31-1 =
[2,147,483,647](https://en.wikipedia.org/wiki/2,147,483,647#In_computing), which
is also 32-bit signed [LONG_MAX](https://en.wikipedia.org/wiki/C_data_types) in
C.
### I just got Rickrolled! Do I have a virus? ### I just got Rickrolled! Do I have a virus?
You don't have a virus. It's part of the project. Here's You don't have a virus. It's part of the project. Here's
[Rick](https://github.com/lstein/stable-diffusion/blob/main/assets/rick.jpeg) [Rick](https://github.com/lstein/stable-diffusion/blob/main/assets/rick.jpeg)
and here's [the and here's
code](https://github.com/lstein/stable-diffusion/blob/69ae4b35e0a0f6ee1af8bb9a5d0016ccb27e36dc/scripts/txt2img.py#L79) [the code](https://github.com/lstein/stable-diffusion/blob/69ae4b35e0a0f6ee1af8bb9a5d0016ccb27e36dc/scripts/txt2img.py#L79)
that swaps him in. It's a NSFW filter, which IMO, doesn't work very that swaps him in. It's a NSFW filter, which IMO, doesn't work very good (and we
good (and we call this "computer vision", sheesh). call this "computer vision", sheesh).
Actually, this could be happening because there's not enough RAM. You could try the `model.half()` suggestion or specify smaller output images. Actually, this could be happening because there's not enough RAM. You could try
the `model.half()` suggestion or specify smaller output images.
### My images come out black ### My images come out black
@ -319,31 +393,29 @@ We might have this fixed, we are still testing.
There's a [similar issue](https://github.com/CompVis/stable-diffusion/issues/69) There's a [similar issue](https://github.com/CompVis/stable-diffusion/issues/69)
on CUDA GPU's where the images come out green. Maybe it's the same issue? on CUDA GPU's where the images come out green. Maybe it's the same issue?
Someone in that issue says to use "--precision full", but this fork Someone in that issue says to use "--precision full", but this fork actually
actually disables that flag. I don't know why, someone else provided disables that flag. I don't know why, someone else provided that code and I
that code and I don't know what it does. Maybe the `model.half()` don't know what it does. Maybe the `model.half()` suggestion above would fix
suggestion above would fix this issue too. I should probably test it. this issue too. I should probably test it.
### "view size is not compatible with input tensor's size and stride" ### "view size is not compatible with input tensor's size and stride"
``` ```bash
File "/opt/anaconda3/envs/ldm/lib/python3.10/site-packages/torch/nn/functional.py", line 2511, in layer_norm File "/opt/anaconda3/envs/ldm/lib/python3.10/site-packages/torch/nn/functional.py", line 2511, in layer_norm
return torch.layer_norm(input, normalized_shape, weight, bias, eps, torch.backends.cudnn.enabled) return torch.layer_norm(input, normalized_shape, weight, bias, eps, torch.backends.cudnn.enabled)
RuntimeError: view size is not compatible with input tensor's size and stride (at least one dimension spans across two contiguous subspaces). Use .reshape(...) instead. RuntimeError: view size is not compatible with input tensor's size and stride (at least one dimension spans across two contiguous subspaces). Use .reshape(...) instead.
``` ```
Update to the latest version of lstein/stable-diffusion. We were Update to the latest version of lstein/stable-diffusion. We were patching
patching pytorch but we found a file in stable-diffusion that we could pytorch but we found a file in stable-diffusion that we could change instead.
change instead. This is a 32-bit vs 16-bit problem. This is a 32-bit vs 16-bit problem.
---
### The processor must support the Intel bla bla bla ### The processor must support the Intel bla bla bla
What? Intel? On an Apple Silicon? What? Intel? On an Apple Silicon?
`bash Intel MKL FATAL ERROR: This system does not meet the minimum requirements for use of the Intel(R) Math Kernel Library. The processor must support the Intel(R) Supplemental Streaming SIMD Extensions 3 (Intel(R) SSSE3) instructions. The processor must support the Intel(R) Streaming SIMD Extensions 4.2 (Intel(R) SSE4.2) instructions. The processor must support the Intel(R) Advanced Vector Extensions (Intel(R) AVX) instructions. `
Intel MKL FATAL ERROR: This system does not meet the minimum requirements for use of the Intel(R) Math Kernel Library.
The processor must support the Intel(R) Supplemental Streaming SIMD Extensions 3 (Intel(R) SSSE3) instructions.
The processor must support the Intel(R) Streaming SIMD Extensions 4.2 (Intel(R) SSE4.2) instructions.
The processor must support the Intel(R) Advanced Vector Extensions (Intel(R) AVX) instructions.
This is due to the Intel `mkl` package getting picked up when you try to install This is due to the Intel `mkl` package getting picked up when you try to install
something that depends on it-- Rosetta can translate some Intel instructions but something that depends on it-- Rosetta can translate some Intel instructions but
@ -351,11 +423,13 @@ not the specialized ones here. To avoid this, make sure to use the environment
variable `CONDA_SUBDIR=osx-arm64`, which restricts the Conda environment to only variable `CONDA_SUBDIR=osx-arm64`, which restricts the Conda environment to only
use ARM packages, and use `nomkl` as described above. use ARM packages, and use `nomkl` as described above.
---
### input types 'tensor<2x1280xf32>' and 'tensor<\*xf16>' are not broadcast compatible ### input types 'tensor<2x1280xf32>' and 'tensor<\*xf16>' are not broadcast compatible
May appear when just starting to generate, e.g.: May appear when just starting to generate, e.g.:
``` ```bash
dream> clouds dream> clouds
Generating: 0%| | 0/1 [00:00<?, ?it/s]/Users/[...]/dev/stable-diffusion/ldm/modules/embedding_manager.py:152: UserWarning: The operator 'aten::nonzero' is not currently supported on the MPS backend and will fall back to run on the CPU. This may have performance implications. (Triggered internally at /Users/runner/work/_temp/anaconda/conda-bld/pytorch_1662016319283/work/aten/src/ATen/mps/MPSFallback.mm:11.) Generating: 0%| | 0/1 [00:00<?, ?it/s]/Users/[...]/dev/stable-diffusion/ldm/modules/embedding_manager.py:152: UserWarning: The operator 'aten::nonzero' is not currently supported on the MPS backend and will fall back to run on the CPU. This may have performance implications. (Triggered internally at /Users/runner/work/_temp/anaconda/conda-bld/pytorch_1662016319283/work/aten/src/ATen/mps/MPSFallback.mm:11.)
placeholder_idx = torch.where( placeholder_idx = torch.where(
@ -366,4 +440,5 @@ Abort trap: 6
warnings.warn('resource_tracker: There appear to be %d ' warnings.warn('resource_tracker: There appear to be %d '
``` ```
Macs do not support autocast/mixed-precision. Supply `--full_precision` to use float32 everywhere. Macs do not support `autocast/mixed-precision`, so you need to supply
`--full_precision` to use float32 everywhere.

141
docs/installation/INSTALL_WINDOWS.md
View File

@ -1,110 +1,135 @@
# **Windows Installation** ---
title: Windows
---
## **Notebook install (semi-automated)** ## **Notebook install (semi-automated)**
We have a [Jupyter We have a
notebook](https://github.com/lstein/stable-diffusion/blob/main/notebooks/Stable-Diffusion-local-Windows.ipynb) [Jupyter notebook](https://github.com/lstein/stable-diffusion/blob/main/notebooks/Stable-Diffusion-local-Windows.ipynb)
with cell-by-cell installation steps. It will download the code in with cell-by-cell installation steps. It will download the code in this repo as
this repo as one of the steps, so instead of cloning this repo, simply one of the steps, so instead of cloning this repo, simply download the notebook
download the notebook from the link above and load it up in VSCode from the link above and load it up in VSCode (with the appropriate extensions
(with the appropriate extensions installed)/Jupyter/JupyterLab and installed)/Jupyter/JupyterLab and start running the cells one-by-one.
start running the cells one-by-one.
Note that you will need NVIDIA drivers, Python 3.10, and Git installed Note that you will need NVIDIA drivers, Python 3.10, and Git installed
beforehand - simplified [step-by-step beforehand - simplified
instructions](https://github.com/lstein/stable-diffusion/wiki/Easy-peasy-Windows-install) [step-by-step instructions](https://github.com/lstein/stable-diffusion/wiki/Easy-peasy-Windows-install)
are available in the wiki (you'll only need steps 1, 2, & 3 ). are available in the wiki (you'll only need steps 1, 2, & 3 ).
## **Manual Install** ## **Manual Install**
### **pip** ### **pip**
See [Easy-peasy Windows install](https://github.com/lstein/stable-diffusion/wiki/Easy-peasy-Windows-install) See
[Easy-peasy Windows install](https://github.com/lstein/stable-diffusion/wiki/Easy-peasy-Windows-install)
in the wiki in the wiki
---
### **Conda** ### **Conda**
1. Install Anaconda3 (miniconda3 version) from here: https://docs.anaconda.com/anaconda/install/windows/ 1. Install Anaconda3 (miniconda3 version) from here:
https://docs.anaconda.com/anaconda/install/windows/
2. Install Git from here: https://git-scm.com/download/win 2. Install Git from here: https://git-scm.com/download/win
3. Launch Anaconda from the Windows Start menu. This will bring up a command window. Type all the remaining commands in this window. 3. Launch Anaconda from the Windows Start menu. This will bring up a command
window. Type all the remaining commands in this window.
4. Run the command: 4. Run the command:
``` ```bash
git clone https://github.com/lstein/stable-diffusion.git git clone https://github.com/lstein/stable-diffusion.git
``` ```
This will create stable-diffusion folder where you will follow the rest of the steps. This will create stable-diffusion folder where you will follow the rest of
the steps.
5. Enter the newly-created stable-diffusion folder. From this step forward make sure that you are working in the stable-diffusion directory! 5. Enter the newly-created stable-diffusion folder. From this step forward make
sure that you are working in the stable-diffusion directory!
``` ```bash
cd stable-diffusion cd stable-diffusion
``` ```
6. Run the following two commands: 6. Run the following two commands:
``` ```bash
conda env create -f environment.yaml (step 6a) conda env create -f environment.yaml (step 6a)
conda activate ldm (step 6b) conda activate ldm (step 6b)
``` ```
This will install all python requirements and activate the "ldm" This will install all python requirements and activate the "ldm" environment
environment which sets PATH and other environment variables properly. which sets PATH and other environment variables properly.
7. Run the command: 7. Run the command:
``` ```bash
python scripts\preload_models.py python scripts\preload_models.py
``` ```
This installs several machine learning models that stable diffusion requires. This installs several machine learning models that stable diffusion requires.
Note: This step is required. This was done because some users may might be blocked by firewalls or have limited internet connectivity for the models to be downloaded just-in-time. Note: This step is required. This was done because some users may might be
blocked by firewalls or have limited internet connectivity for the models to
be downloaded just-in-time.
8. Now you need to install the weights for the big stable diffusion model. 8. Now you need to install the weights for the big stable diffusion model.
- For running with the released weights, you will first need to set up an acount with Hugging Face (https://huggingface.co). - For running with the released weights, you will first need to set up an
- Use your credentials to log in, and then point your browser at https://huggingface.co/CompVis/stable-diffusion-v-1-4-original. acount with Hugging Face (https://huggingface.co).
- You may be asked to sign a license agreement at this point. - Use your credentials to log in, and then point your browser at
- Click on "Files and versions" near the top of the page, and then click on the file named `sd-v1-4.ckpt`. You'll be taken to a page that https://huggingface.co/CompVis/stable-diffusion-v-1-4-original.
prompts you to click the "download" link. Now save the file somewhere safe on your local machine. - You may be asked to sign a license agreement at this point.
- The weight file is >4 GB in size, so - Click on "Files and versions" near the top of the page, and then click on
downloading may take a while. the file named `sd-v1-4.ckpt`. You'll be taken to a page that prompts you
to click the "download" link. Now save the file somewhere safe on your
local machine.
- The weight file is >4 GB in size, so downloading may take a while.
Now run the following commands from **within the stable-diffusion directory** to copy the weights file to the right place: Now run the following commands from **within the stable-diffusion directory**
to copy the weights file to the right place:
``` ```bash
mkdir -p models\ldm\stable-diffusion-v1 mkdir -p models\ldm\stable-diffusion-v1
copy C:\path\to\sd-v1-4.ckpt models\ldm\stable-diffusion-v1\model.ckpt copy C:\path\to\sd-v1-4.ckpt models\ldm\stable-diffusion-v1\model.ckpt
``` ```
Please replace `C:\path\to\sd-v1.4.ckpt` with the correct path to wherever you stashed this file. If you prefer not to copy or move the .ckpt file, Please replace `C:\path\to\sd-v1.4.ckpt` with the correct path to wherever
you may instead create a shortcut to it from within `models\ldm\stable-diffusion-v1\`. you stashed this file. If you prefer not to copy or move the .ckpt file, you
may instead create a shortcut to it from within
`models\ldm\stable-diffusion-v1\`.
9. Start generating images! 9. Start generating images!
``` ```bash
# for the pre-release weights # for the pre-release weights
python scripts\dream.py -l python scripts\dream.py -l
# for the post-release weights # for the post-release weights
python scripts\dream.py python scripts\dream.py
``` ```
10. Subsequently, to relaunch the script, first activate the Anaconda command window (step 3),enter the stable-diffusion directory (step 5, `cd \path\to\stable-diffusion`), run `conda activate ldm` (step 6b), and then launch the dream script (step 9). 10. Subsequently, to relaunch the script, first activate the Anaconda command
window (step 3),enter the stable-diffusion directory (step 5,
`cd \path\to\stable-diffusion`), run `conda activate ldm` (step 6b), and
then launch the dream script (step 9).
**Note:** Tildebyte has written an alternative ["Easy peasy Windows **Note:** Tildebyte has written an alternative
install"](https://github.com/lstein/stable-diffusion/wiki/Easy-peasy-Windows-install) ["Easy peasy Windows install"](https://github.com/lstein/stable-diffusion/wiki/Easy-peasy-Windows-install)
which uses the Windows Powershell and pew. If you are having trouble with Anaconda on Windows, give this a try (or try it first!) which uses the Windows Powershell and pew. If you are having trouble with
Anaconda on Windows, give this a try (or try it first!)
---
### Updating to newer versions of the script ### Updating to newer versions of the script
This distribution is changing rapidly. If you used the `git clone` method (step 5) to download the stable-diffusion directory, then to update to the latest and greatest version, launch the Anaconda window, enter `stable-diffusion`, and type: This distribution is changing rapidly. If you used the `git clone` method
(step 5) to download the stable-diffusion directory, then to update to the
latest and greatest version, launch the Anaconda window, enter
`stable-diffusion`, and type:
``` ```bash
git pull git pull
conda env update -f environment.yaml conda env update -f environment.yaml
``` ```

2
docs/other/CONTRIBUTORS.md
View File

@ -1,5 +1,5 @@
--- ---
title: **Contributors** title: Contributors
--- ---
The list of all the amazing people who have contributed to the various features that you get to experience in this fork. The list of all the amazing people who have contributed to the various features that you get to experience in this fork.

140
docs/other/README-CompViz.md
View File

@ -2,9 +2,11 @@
title: CompViz-Readme title: CompViz-Readme
--- ---
# *README from [CompViz/stable-diffusion](https://github.com/CompVis/stable-diffusion)* # _README from [CompViz/stable-diffusion](https://github.com/CompVis/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:_ _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/> [**High-Resolution Image Synthesis with Latent Diffusion Models**](https://ommer-lab.com/research/latent-diffusion-models/)<br/>
[Robin Rombach](https://github.com/rromb)\*, [Robin Rombach](https://github.com/rromb)\*,
@ -15,28 +17,36 @@ _Stable Diffusion was made possible thanks to a collaboration with [Stability AI
## **CVPR '22 Oral** ## **CVPR '22 Oral**
which is available on [GitHub](https://github.com/CompVis/latent-diffusion). PDF at [arXiv](https://arxiv.org/abs/2112.10752). Please also visit our [Project page](https://ommer-lab.com/research/latent-diffusion-models/). which is available on [GitHub](https://github.com/CompVis/latent-diffusion). PDF
at [arXiv](https://arxiv.org/abs/2112.10752). Please also visit our
[Project page](https://ommer-lab.com/research/latent-diffusion-models/).
![txt2img-stable2](../assets/stable-samples/txt2img/merged-0006.png) ![txt2img-stable2](../assets/stable-samples/txt2img/merged-0006.png)
[Stable Diffusion](#stable-diffusion-v1) is a latent text-to-image diffusion [Stable Diffusion](#stable-diffusion-v1) is a latent text-to-image diffusion
model. model. Thanks to a generous compute donation from
Thanks to a generous compute donation from [Stability AI](https://stability.ai/) and support from [LAION](https://laion.ai/), we were able to train a Latent Diffusion Model on 512x512 images from a subset of the [LAION-5B](https://laion.ai/blog/laion-5b/) database. [Stability AI](https://stability.ai/) and support from
Similar to Google's [Imagen](https://arxiv.org/abs/2205.11487), [LAION](https://laion.ai/), we were able to train a Latent Diffusion Model on
this model uses a frozen CLIP ViT-L/14 text encoder to condition the model on text prompts. 512x512 images from a subset of the [LAION-5B](https://laion.ai/blog/laion-5b/)
With its 860M UNet and 123M text encoder, the model is relatively lightweight and runs on a GPU with at least 10GB VRAM. database. Similar to Google's [Imagen](https://arxiv.org/abs/2205.11487), this
See [this section](#stable-diffusion-v1) below and the [model card](https://huggingface.co/CompVis/stable-diffusion). model uses a frozen CLIP ViT-L/14 text encoder to condition the model on text
prompts. 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).
## Requirements ## Requirements
A suitable [conda](https://conda.io/) environment named `ldm` can be created A suitable [conda](https://conda.io/) environment named `ldm` can be created and
and activated with: activated with:
```bash ```bash
conda env create -f environment.yaml conda env create -f environment.yaml
conda activate ldm conda activate ldm
``` ```
You can also update an existing [latent diffusion](https://github.com/CompVis/latent-diffusion) environment by running You can also update an existing
[latent diffusion](https://github.com/CompVis/latent-diffusion) environment by
running
```bash ```bash
conda install pytorch torchvision -c pytorch conda install pytorch torchvision -c pytorch
@ -46,42 +56,57 @@ pip install -e .
## Stable Diffusion v1 ## Stable Diffusion v1
Stable Diffusion v1 refers to a specific configuration of the model Stable Diffusion v1 refers to a specific configuration of the model architecture
architecture that uses a downsampling-factor 8 autoencoder with an 860M UNet that uses a downsampling-factor 8 autoencoder with an 860M UNet and CLIP
and CLIP ViT-L/14 text encoder for the diffusion model. The model was pretrained on 256x256 images and ViT-L/14 text encoder for the diffusion model. The model was pretrained on
then finetuned on 512x512 images. 256x256 images and then finetuned on 512x512 images.
\*Note: Stable Diffusion v1 is a general text-to-image diffusion model and therefore mirrors biases and (mis-)conceptions that are present \*Note: Stable Diffusion v1 is a general text-to-image diffusion model and
in its training data. therefore mirrors biases and (mis-)conceptions that are present in its training
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). data. Details on the training procedure and data, as well as the intended use of
Research into the safe deployment of general text-to-image models is an ongoing effort. To prevent misuse and harm, we currently provide access to the checkpoints only for [academic research purposes upon request](https://stability.ai/academia-access-form). the model can be found in the corresponding
**This is an experiment in safe and community-driven publication of a capable and general text-to-image model. We are working on a public release with a more permissive license that also incorporates ethical considerations.\*** [model card](https://huggingface.co/CompVis/stable-diffusion). Research into the
safe deployment of general text-to-image models is an ongoing effort. To prevent
misuse and harm, we currently provide access to the checkpoints only for
[academic research purposes upon request](https://stability.ai/academia-access-form).
**This is an experiment in safe and community-driven publication of a capable
and general text-to-image model. We are working on a public release with a more
permissive license that also incorporates ethical considerations.\***
[Request access to Stable Diffusion v1 checkpoints for academic research](https://stability.ai/academia-access-form) [Request access to Stable Diffusion v1 checkpoints for academic research](https://stability.ai/academia-access-form)
### Weights ### Weights
We currently provide three checkpoints, `sd-v1-1.ckpt`, `sd-v1-2.ckpt` and `sd-v1-3.ckpt`, We currently provide three checkpoints, `sd-v1-1.ckpt`, `sd-v1-2.ckpt` and
which were trained as follows, `sd-v1-3.ckpt`, which were trained as follows,
- `sd-v1-1.ckpt`: 237k steps at resolution `256x256` on [laion2B-en](https://huggingface.co/datasets/laion/laion2B-en). - `sd-v1-1.ckpt`: 237k steps at resolution `256x256` on
194k steps at resolution `512x512` on [laion-high-resolution](https://huggingface.co/datasets/laion/laion-high-resolution) (170M examples from LAION-5B with resolution `>= 1024x1024`). [laion2B-en](https://huggingface.co/datasets/laion/laion2B-en). 194k steps at
- `sd-v1-2.ckpt`: Resumed from `sd-v1-1.ckpt`. resolution `512x512` on
515k steps at resolution `512x512` on "laion-improved-aesthetics" (a subset of laion2B-en, [laion-high-resolution](https://huggingface.co/datasets/laion/laion-high-resolution)
filtered to images with an original size `>= 512x512`, estimated aesthetics score `> 5.0`, and an estimated watermark probability `< 0.5`. The watermark estimate is from the LAION-5B metadata, the aesthetics score is estimated using an [improved aesthetics estimator](https://github.com/christophschuhmann/improved-aesthetic-predictor)). (170M examples from LAION-5B with resolution `>= 1024x1024`).
- `sd-v1-3.ckpt`: Resumed from `sd-v1-2.ckpt`. 195k steps at resolution `512x512` on "laion-improved-aesthetics" and 10\% dropping of the text-conditioning to improve [classifier-free guidance sampling](https://arxiv.org/abs/2207.12598). - `sd-v1-2.ckpt`: Resumed from `sd-v1-1.ckpt`. 515k steps at resolution
`512x512` on "laion-improved-aesthetics" (a subset of laion2B-en, filtered to
images with an original size `>= 512x512`, estimated aesthetics score `> 5.0`,
and an estimated watermark probability `< 0.5`. The watermark estimate is from
the LAION-5B metadata, the aesthetics score is estimated using an
[improved aesthetics estimator](https://github.com/christophschuhmann/improved-aesthetic-predictor)).
- `sd-v1-3.ckpt`: Resumed from `sd-v1-2.ckpt`. 195k steps at resolution
`512x512` on "laion-improved-aesthetics" and 10\% dropping of the
text-conditioning to improve
[classifier-free guidance sampling](https://arxiv.org/abs/2207.12598).
Evaluations with different classifier-free guidance scales (1.5, 2.0, 3.0, 4.0, Evaluations with different classifier-free guidance scales (1.5, 2.0, 3.0, 4.0,
5.0, 6.0, 7.0, 8.0) and 50 PLMS sampling 5.0, 6.0, 7.0, 8.0) and 50 PLMS sampling steps show the relative improvements of
steps show the relative improvements of the checkpoints: the checkpoints: ![sd evaluation results](../assets/v1-variants-scores.jpg)
![sd evaluation results](../assets/v1-variants-scores.jpg)
### Text-to-Image with Stable Diffusion ### Text-to-Image with Stable Diffusion
![txt2img-stable2](../assets/stable-samples/txt2img/merged-0005.png) ![txt2img-stable2](../assets/stable-samples/txt2img/merged-0005.png)
![txt2img-stable2](../assets/stable-samples/txt2img/merged-0007.png) ![txt2img-stable2](../assets/stable-samples/txt2img/merged-0007.png)
Stable Diffusion is a latent diffusion model conditioned on the (non-pooled) text embeddings of a CLIP ViT-L/14 text encoder. Stable Diffusion is a latent diffusion model conditioned on the (non-pooled)
text embeddings of a CLIP ViT-L/14 text encoder.
#### Sampling Script #### Sampling Script
@ -98,8 +123,11 @@ and sample with
python scripts/txt2img.py --prompt "a photograph of an astronaut riding a horse" --plms python scripts/txt2img.py --prompt "a photograph of an astronaut riding a horse" --plms
``` ```
By default, this uses a guidance scale of `--scale 7.5`, [Katherine Crowson's implementation](https://github.com/CompVis/latent-diffusion/pull/51) of the [PLMS](https://arxiv.org/abs/2202.09778) sampler, By default, this uses a guidance scale of `--scale 7.5`,
and renders images of size 512x512 (which it was trained on) in 50 steps. All supported arguments are listed below (type `python scripts/txt2img.py --help`). [Katherine Crowson's implementation](https://github.com/CompVis/latent-diffusion/pull/51)
of the [PLMS](https://arxiv.org/abs/2202.09778) sampler, and renders images of
size 512x512 (which it was trained on) in 50 steps. All supported arguments are
listed below (type `python scripts/txt2img.py --help`).
```commandline ```commandline
usage: txt2img.py [-h] [--prompt [PROMPT]] [--outdir [OUTDIR]] [--skip_grid] [--skip_save] [--ddim_steps DDIM_STEPS] [--plms] [--laion400m] [--fixed_code] [--ddim_eta DDIM_ETA] [--n_iter N_ITER] [--H H] [--W W] [--C C] [--f F] [--n_samples N_SAMPLES] [--n_rows N_ROWS] usage: txt2img.py [-h] [--prompt [PROMPT]] [--outdir [OUTDIR]] [--skip_grid] [--skip_save] [--ddim_steps DDIM_STEPS] [--plms] [--laion400m] [--fixed_code] [--ddim_eta DDIM_ETA] [--n_iter N_ITER] [--H H] [--W W] [--C C] [--f F] [--n_samples N_SAMPLES] [--n_rows N_ROWS]
@ -137,14 +165,17 @@ optional arguments:
``` ```
Note: The inference config for all v1 versions is designed to be used with EMA-only checkpoints. Note: The inference config for all v1 versions is designed to be used with
For this reason `use_ema=False` is set in the configuration, otherwise the code will try to switch from EMA-only checkpoints. For this reason `use_ema=False` is set in the
non-EMA to EMA weights. If you want to examine the effect of EMA vs no EMA, we provide "full" checkpoints configuration, otherwise the code will try to switch from non-EMA to EMA
which contain both types of weights. For these, `use_ema=False` will load and use the non-EMA weights. weights. If you want to examine the effect of EMA vs no EMA, we provide "full"
checkpoints which contain both types of weights. For these, `use_ema=False` will
load and use the non-EMA weights.
#### Diffusers Integration #### Diffusers Integration
Another way to download and sample Stable Diffusion is by using the [diffusers library](https://github.com/huggingface/diffusers/tree/main#new--stable-diffusion-is-now-fully-compatible-with-diffusers) Another way to download and sample Stable Diffusion is by using the
[diffusers library](https://github.com/huggingface/diffusers/tree/main#new--stable-diffusion-is-now-fully-compatible-with-diffusers)
```py ```py
# make sure you're logged in with `huggingface-cli login` # make sure you're logged in with `huggingface-cli login`
@ -165,18 +196,23 @@ image.save("astronaut_rides_horse.png")
### Image Modification with Stable Diffusion ### Image Modification with Stable Diffusion
By using a diffusion-denoising mechanism as first proposed by [SDEdit](https://arxiv.org/abs/2108.01073), the model can be used for different By using a diffusion-denoising mechanism as first proposed by
tasks such as text-guided image-to-image translation and upscaling. Similar to the txt2img sampling script, [SDEdit](https://arxiv.org/abs/2108.01073), the model can be used for different
we provide a script to perform image modification with Stable Diffusion. tasks such as text-guided image-to-image translation and upscaling. Similar to
the txt2img sampling script, we provide a script to perform image modification
with Stable Diffusion.
The following describes an example where a rough sketch made in [Pinta](https://www.pinta-project.com/) is converted into a detailed artwork. The following describes an example where a rough sketch made in
[Pinta](https://www.pinta-project.com/) is converted into a detailed artwork.
``` ```
python scripts/img2img.py --prompt "A fantasy landscape, trending on artstation" --init-img <path-to-img.jpg> --strength 0.8 python scripts/img2img.py --prompt "A fantasy landscape, trending on artstation" --init-img <path-to-img.jpg> --strength 0.8
``` ```
Here, strength is a value between 0.0 and 1.0, that controls the amount of noise that is added to the input image. Here, strength is a value between 0.0 and 1.0, that controls the amount of noise
Values that approach 1.0 allow for lots of variations but will also produce images that are not semantically consistent with the input. See the following example. that is added to the input image. Values that approach 1.0 allow for lots of
variations but will also produce images that are not semantically consistent
with the input. See the following example.
**Input** **Input**
@ -187,15 +223,19 @@ Values that approach 1.0 allow for lots of variations but will also produce imag
![out3](../assets/stable-samples/img2img/mountains-3.png) ![out3](../assets/stable-samples/img2img/mountains-3.png)
![out2](../assets/stable-samples/img2img/mountains-2.png) ![out2](../assets/stable-samples/img2img/mountains-2.png)
This procedure can, for example, also be used to upscale samples from the base model. This procedure can, for example, also be used to upscale samples from the base
model.
## Comments ## Comments
- Our codebase for the diffusion models builds heavily on [OpenAI's ADM codebase](https://github.com/openai/guided-diffusion) - Our codebase for the diffusion models builds heavily on
and [https://github.com/lucidrains/denoising-diffusion-pytorch](https://github.com/lucidrains/denoising-diffusion-pytorch). [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! 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). - 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