-
-
-
+# InvokeAI: A Stable Diffusion Toolkit
-
- 
- 
-
- 
- 
-
+
-This is a fork of
-[CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion),
-the open source text-to-image generator. It provides a streamlined
-process with various new features and options to aid the image
-generation process. It runs on Windows, Mac and Linux machines,
-and runs on GPU cards with as little as 4 GB or RAM.
+[![discord badge]][discord link]
+
+[![latest release badge]][latest release link] [![github stars badge]][github stars link] [![github forks badge]][github forks link]
+
+[![CI checks on main badge]][CI checks on main link] [![CI checks on dev badge]][CI checks on dev link] [![latest commit to dev badge]][latest commit to dev link]
+
+[![github open issues badge]][github open issues link] [![github open prs badge]][github open prs link]
+
+[CI checks on dev badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/development?label=CI%20status%20on%20dev&cache=900&icon=github
+[CI checks on dev link]: https://github.com/invoke-ai/InvokeAI/actions?query=branch%3Adevelopment
+[CI checks on main badge]: https://flat.badgen.net/github/checks/invoke-ai/InvokeAI/main?label=CI%20status%20on%20main&cache=900&icon=github
+[CI checks on main link]: https://github.com/invoke-ai/InvokeAI/actions/workflows/test-dream-conda.yml
+[discord badge]: https://flat.badgen.net/discord/members/htRgbc7e?icon=discord
+[discord link]: https://discord.gg/ZmtBAhwWhy
+[github forks badge]: https://flat.badgen.net/github/forks/invoke-ai/InvokeAI?icon=github
+[github forks link]: https://useful-forks.github.io/?repo=invoke-ai%2FInvokeAI
+[github open issues badge]: https://flat.badgen.net/github/open-issues/invoke-ai/InvokeAI?icon=github
+[github open issues link]: https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen
+[github open prs badge]: https://flat.badgen.net/github/open-prs/invoke-ai/InvokeAI?icon=github
+[github open prs link]: https://github.com/invoke-ai/InvokeAI/pulls?q=is%3Apr+is%3Aopen
+[github stars badge]: https://flat.badgen.net/github/stars/invoke-ai/InvokeAI?icon=github
+[github stars link]: https://github.com/invoke-ai/InvokeAI/stargazers
+[latest commit to dev badge]: https://flat.badgen.net/github/last-commit/invoke-ai/InvokeAI/development?icon=github&color=yellow&label=last%20dev%20commit&cache=900
+[latest commit to dev link]: https://github.com/invoke-ai/InvokeAI/commits/development
+[latest release badge]: https://flat.badgen.net/github/release/invoke-ai/InvokeAI/development?icon=github
+[latest release link]: https://github.com/invoke-ai/InvokeAI/releases
+
-
-
-
-
-
-
-
+
---
## 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
-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
-variation.
+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 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 variation.
-```
+```bash
dream> "prompt" -n6 -S3357757885 -v0.2
...
Outputs:
@@ -60,33 +70,42 @@ Outputs:
### **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
-variation amount used to generate it.
+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 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.
-
-
+
-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?
+
-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.
+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?
-```
-dream> "prompt" -S3357757885 -V3647897225,0.1;1614299449,0.1
+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
Outputs:
./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:
-
+
-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:
-```
-dream> "prompt" -S3357757885 -V3647897225,0.1;1614299449,0.1 -v0.05 -n6
+```bash
+dream> "prompt" -S3357757885 -V3647897225,0.1,1614299449,0.1 -v0.05 -n6
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.2853129515.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -V 3647897225:0.1,1614299449:0.1,2853129515:0.05 -S3357757885
@@ -96,9 +115,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
```
-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:
-
+
-As you can see, this is a very powerful tool, which when combined with subprompt weighting, gives you great control over the content and
-quality of your generated images.
+As you can see, this is a very powerful tool, which when combined with subprompt
+weighting, gives you great control over the content and quality of your
+generated images.
diff --git a/docs/features/WEB.md b/docs/features/WEB.md
index 9eb6aa5bfc..833b18cdfc 100644
--- a/docs/features/WEB.md
+++ b/docs/features/WEB.md
@@ -1,13 +1,21 @@
-# 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.
+# :material-web: 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.
+
+```bash
(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.
diff --git a/docs/help/TROUBLESHOOT.md b/docs/help/TROUBLESHOOT.md
index cac5dddf23..f5dcfe2c1c 100644
--- a/docs/help/TROUBLESHOOT.md
+++ b/docs/help/TROUBLESHOOT.md
@@ -1,68 +1,91 @@
-# **Frequently Asked Questions**
+---
+title: F.A.Q.
+---
-Here are a few common installation problems and their solutions. Often these are caused by incomplete installations or crashes during the
-install process.
+# :material-frequently-asked-questions: F.A.Q.
+
+## **Frequently-Asked-Questions**
+
+Here are a few common installation problems and their solutions. Often these are caused by
+incomplete installations or crashes during the install process.
---
-**QUESTION**
+### **QUESTION**
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``.
-**SOLUTION**
+### **SOLUTION**
-From within the `stable-diffusion` directory, run `conda env update -f environment.yaml` This is also frequently the solution to
-complaints about an unknown function in a module.
+From within the `stable-diffusion` directory, run `conda env update -f environment.yaml` This is
+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.
-**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