fix basicsr conflict on windows

- The previous fix for the "install in Windows system directory" error would fail
   if the path includes directories with spaces in them. This fixes that.

- In addition, addressing the same issue in source installer, although not
	yet reported in wild.

binary_installer/create_installers.sh

@@ -6,6 +6,8 @@ IFS=$'\n\t'
 echo "Be certain that you're in the 'installer' directory before continuing."
 read -p "Press any key to continue, or CTRL-C to exit..."
 
+VERSION='2.2.3'
+
 # make the installer zip for linux and mac
 rm -rf InvokeAI
 mkdir -p InvokeAI
@@ -13,8 +15,8 @@ cp install.sh.in InvokeAI/install.sh
 chmod a+x InvokeAI/install.sh
 cp readme.txt InvokeAI
 
-zip -r InvokeAI-binary-linux.zip InvokeAI
-zip -r InvokeAI-binary-mac.zip InvokeAI
+zip -r InvokeAI-binary-$VERSION-linux.zip InvokeAI
+zip -r InvokeAI-binary-$VERSION-mac.zip InvokeAI
 
 # make the installer zip for windows
 rm -rf InvokeAI
@@ -23,7 +25,7 @@ cp install.bat.in InvokeAI/install.bat
 cp readme.txt InvokeAI
 cp WinLongPathsEnabled.reg InvokeAI
 
-zip -r InvokeAI-binary-windows.zip InvokeAI
+zip -r InvokeAI-binary-$VERSION-windows.zip InvokeAI
 
 rm -rf InvokeAI
 

binary_installer/install.bat.in

@@ -10,7 +10,8 @@
 
 @rem This enables a user to install this project without manually installing git or Python
 
-PUSHD %~dp0
+@rem change to the script's directory
+PUSHD "%~dp0"
 
 set "no_cache_dir=--no-cache-dir"
 if "%1" == "use-cache" (

binary_installer/install.sh.in

@@ -214,7 +214,7 @@ _err_exit $? _err_msg
 echo -e "\n***** Installed InvokeAI *****\n"
 
 cp binary_installer/invoke.sh.in ./invoke.sh
-chmod a+x ./invoke.sh
+chmod a+rx ./invoke.sh
 echo -e "\n***** Installed invoke launcher script ******\n"
 
 # more cleanup
@@ -229,7 +229,7 @@ deactivate
 echo -e "\n***** Finished downloading models *****\n"
 
 echo "All done! Run the command"
-echo "  \"$scriptdir/invoke.sh\""
+echo "  $scriptdir/invoke.sh"
 echo "to start InvokeAI."
 read -p "Press any key to exit..."
 exit

binary_installer/invoke.sh.in

@@ -4,6 +4,11 @@ set -eu
 
 . .venv/bin/activate
 
+# set required env var for torch on mac MPS
+ if [ "$(uname -s)" == "Darwin" ]; then
+     export PYTORCH_ENABLE_MPS_FALLBACK=1
+ fi
+
 echo "Do you want to generate images using the"
 echo "1. command-line"
 echo "2. browser-based UI"

binary_installer/py3.10-linux-x86_64-cuda-reqs.txt

@@ -1,6 +1,6 @@
 #
-# This file is autogenerated by pip-compile with python 3.9
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.9
+# by the following command:
 #
 #    pip-compile --allow-unsafe --generate-hashes --output-file=binary_installer/py3.10-linux-x86_64-cuda-reqs.txt binary_installer/requirements.in
 #
@@ -418,8 +418,8 @@ getpass-asterisk==1.0.1 \
     --hash=sha256:20d45cafda0066d761961e0919728526baf7bb5151fbf48a7d5ea4034127d857 \
     --hash=sha256:7cc357a924cf62fa4e15b73cb4e5e30685c9084e464ffdc3fd9000a2b54ea9e9
     # via -r binary_installer/requirements.in
-gfpgan @ https://github.com/TencentARC/GFPGAN/archive/2eac2033893ca7f427f4035d80fe95b92649ac56.zip \
-    --hash=sha256:79e6d71c8f1df7c7ccb0ac6b9a2ccb615ad5cde818c8b6f285a8711c05aebf85
+gfpgan @ https://github.com/invoke-ai/GFPGAN/archive/c796277a1cf77954e5fc0b288d7062d162894248.zip ; platform_system == "Linux" or platform_system == "Darwin" \
+    --hash=sha256:4155907b8b7db3686324554df7007eedd245cdf8656c21da9d9a3f44bef2fcaa
     # via
     #   -r binary_installer/requirements.in
     #   realesrgan

binary_installer/requirements.in

@@ -26,6 +26,7 @@ transformers
 picklescan
 https://github.com/openai/CLIP/archive/d50d76daa670286dd6cacf3bcd80b5e4823fc8e1.zip
 https://github.com/invoke-ai/clipseg/archive/1f754751c85d7d4255fa681f4491ff5711c1c288.zip
-https://github.com/TencentARC/GFPGAN/archive/2eac2033893ca7f427f4035d80fe95b92649ac56.zip
+https://github.com/invoke-ai/GFPGAN/archive/3f5d2397361199bc4a91c08bb7d80f04d7805615.zip ; platform_system=='Windows'
+https://github.com/invoke-ai/GFPGAN/archive/c796277a1cf77954e5fc0b288d7062d162894248.zip ; platform_system=='Linux' or platform_system=='Darwin'
 https://github.com/Birch-san/k-diffusion/archive/363386981fee88620709cf8f6f2eea167bd6cd74.zip
 https://github.com/invoke-ai/PyPatchMatch/archive/129863937a8ab37f6bbcec327c994c0f932abdbc.zip

docs/features/CLI.md

@@ -130,20 +130,34 @@ file should contain the startup options as you would type them on the
 command line (`--steps=10 --grid`), one argument per line, or a
 mixture of both using any of the accepted command switch formats:
 
-!!! example ""
+!!! example "my unmodified initialization file"
 
-    ```bash
-    --web
-    --steps=28
-    --grid
-    -f 0.6 -C 11.0 -A k_euler_a
+    ```bash title="~/.invokeai" linenums="1"
+    # InvokeAI initialization file
+    # This is the InvokeAI initialization file, which contains command-line default values.
+    # Feel free to edit. If anything goes wrong, you can re-initialize this file by deleting
+    # or renaming it and then running configure_invokeai.py again.
+
+    # The --root option below points to the folder in which InvokeAI stores its models, configs and outputs.
+    --root="/Users/mauwii/invokeai"
+
+    # the --outdir option controls the default location of image files.
+    --outdir="/Users/mauwii/invokeai/outputs"
+
+    # You may place other  frequently-used startup commands here, one or more per line.
+    # Examples:
+    # --web --host=0.0.0.0
+    # --steps=20
+    # -Ak_euler_a -C10.0
     ```
 
-Note that the initialization file only accepts the command line arguments.
-There are additional arguments that you can provide on the `invoke>` command
-line (such as `-n` or `--iterations`) that cannot be entered into this file.
-Also be alert for empty blank lines at the end of the file, which will cause
-an arguments error at startup time.
+!!! note
+
+    The  initialization file only accepts the command line arguments.
+    There are additional arguments that you can provide on the `invoke>` command
+    line (such as `-n` or `--iterations`) that cannot be entered into this file.
+    Also be alert for empty blank lines at the end of the file, which will cause
+    an arguments error at startup time.
 
 ## List of prompt arguments
 
@@ -195,15 +209,17 @@ Here are the invoke> command that apply to txt2img:
 | `--with_variations <pattern>`             |                                           | `None`                                   | Combine two or more variations. See [Variations](./VARIATIONS.md) for now to use this.                                                                                                                                                           |
 | `--save_intermediates <n>`                |                                           | `None`                                   | Save the image from every nth step into an "intermediates" folder inside the output directory                                                                                                                                                    |
 
-Note that the width and height of the image must be multiples of 64. You can
-provide different values, but they will be rounded down to the nearest multiple
-of 64.
+!!! note
 
-### This is an example of img2img:
+    the width and height of the image must be multiples of 64. You can
+    provide different values, but they will be rounded down to the nearest multiple
+    of 64.
 
-```
-invoke> waterfall and rainbow -I./vacation-photo.png -W640 -H480 --fit
-```
+!!! example "This is a example of img2img"
+
+    ```bash
+    invoke> waterfall and rainbow -I./vacation-photo.png -W640 -H480 --fit
+    ```
 
 This will modify the indicated vacation photograph by making it more like the
 prompt. Results will vary greatly depending on what is in the image. We also ask
@@ -253,7 +269,7 @@ description of the part of the image to replace. For example, if you have an
 image of a breakfast plate with a bagel, toast and scrambled eggs, you can
 selectively mask the bagel and replace it with a piece of cake this way:
 
-```
+```bash
 invoke> a piece of cake -I /path/to/breakfast.png -tm bagel
 ```
 
@@ -265,7 +281,7 @@ are getting too much or too little masking you can adjust the threshold down (to
 get more mask), or up (to get less). In this example, by passing `-tm` a higher
 value, we are insisting on a more stringent classification.
 
-```
+```bash
 invoke> a piece of cake -I /path/to/breakfast.png -tm bagel 0.6
 ```
 
@@ -275,16 +291,16 @@ You can load and use hundreds of community-contributed Textual
 Inversion models just by typing the appropriate trigger phrase. Please
 see [Concepts Library](CONCEPTS.md) for more details.
 
-# Other Commands
+## Other Commands
 
 The CLI offers a number of commands that begin with "!".
 
-## Postprocessing images
+### Postprocessing images
 
 To postprocess a file using face restoration or upscaling, use the `!fix`
 command.
 
-### `!fix`
+#### `!fix`
 
 This command runs a post-processor on a previously-generated image. It takes a
 PNG filename or path and applies your choice of the `-U`, `-G`, or `--embiggen`
@@ -311,19 +327,19 @@ Some examples:
     [1] outputs/img-samples/000017.4829112.gfpgan-00.png: !fix "outputs/img-samples/0000045.4829112.png" -s 50 -S  -W 512 -H 512 -C 7.5 -A k_lms -G 0.8
     ```
 
-### !mask
+#### `!mask`
 
 This command takes an image, a text prompt, and uses the `clipseg` algorithm to
 automatically generate a mask of the area that matches the text prompt. It is
 useful for debugging the text masking process prior to inpainting with the
 `--text_mask` argument. See [INPAINTING.md] for details.
 
-## Model selection and importation
+### Model selection and importation
 
 The CLI allows you to add new models on the fly, as well as to switch among them
 rapidly without leaving the script.
 
-### !models
+#### `!models`
 
 This prints out a list of the models defined in `config/models.yaml'. The active
 model is bold-faced
@@ -336,7 +352,7 @@ laion400m                 not loaded  <no description>
 waifu-diffusion           not loaded  Waifu Diffusion v1.3
 </pre>
 
-### !switch <model>
+#### `!switch <model>`
 
 This quickly switches from one model to another without leaving the CLI script.
 `invoke.py` uses a memory caching system; once a model has been loaded,
@@ -361,7 +377,7 @@ invoke> !switch waifu-diffusion
    | Making attention of type 'vanilla' with 512 in_channels
    | Using faster float16 precision
 >> Model loaded in 18.24s
->> Max VRAM used to load the model: 2.17G 
+>> Max VRAM used to load the model: 2.17G
 >> Current VRAM usage:2.17G
 >> Setting Sampler to k_lms
 
@@ -381,7 +397,7 @@ laion400m                 not loaded  <no description>
 waifu-diffusion               cached  Waifu Diffusion v1.3
 </pre>
 
-### !import_model <path/to/model/weights>
+#### `!import_model <path/to/model/weights>`
 
 This command imports a new model weights file into InvokeAI, makes it available
 for image generation within the script, and writes out the configuration for the
@@ -428,10 +444,10 @@ OK to import [n]? <b>y</b>
    | Working with z of shape (1, 4, 32, 32) = 4096 dimensions.
    | Making attention of type 'vanilla' with 512 in_channels
    | Using faster float16 precision
-invoke> 
+invoke>
 </pre>
 
-###!edit_model <name_of_model>
+#### `!edit_model <name_of_model>`
 
 The `!edit_model` command can be used to modify a model that is already defined
 in `config/models.yaml`. Call it with the short name of the model you wish to
@@ -468,12 +484,12 @@ text... Outputs: [2] outputs/img-samples/000018.2273800735.embiggen-00.png: !fix
 "outputs/img-samples/000017.243781548.gfpgan-00.png" -s 50 -S 2273800735 -W 512
 -H 512 -C 7.5 -A k_lms --embiggen 3.0 0.75 0.25 ```
 
-## History processing
+### History processing
 
 The CLI provides a series of convenient commands for reviewing previous actions,
 retrieving them, modifying them, and re-running them.
 
-### !history
+#### `!history`
 
 The invoke script keeps track of all the commands you issue during a session,
 allowing you to re-run them. On Mac and Linux systems, it also writes the
@@ -485,20 +501,22 @@ during the session (Windows), or the most recent 1000 commands (Mac|Linux). You
 can then repeat a command by using the command `!NNN`, where "NNN" is the
 history line number. For example:
 
-```bash
-invoke> !history
-...
-[14] happy woman sitting under tree wearing broad hat and flowing garment
-[15] beautiful woman sitting under tree wearing broad hat and flowing garment
-[18] beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6
-[20] watercolor of beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6 -S2878767194
-[21] surrealist painting of beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6 -S2878767194
-...
-invoke> !20
-invoke> watercolor of beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6 -S2878767194
-```
+!!! example ""
 
-### !fetch
+    ```bash
+    invoke> !history
+    ...
+    [14] happy woman sitting under tree wearing broad hat and flowing garment
+    [15] beautiful woman sitting under tree wearing broad hat and flowing garment
+    [18] beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6
+    [20] watercolor of beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6 -S2878767194
+    [21] surrealist painting of beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6 -S2878767194
+    ...
+    invoke> !20
+    invoke> watercolor of beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6 -S2878767194
+    ```
+
+####`!fetch`
 
 This command retrieves the generation parameters from a previously generated
 image and either loads them into the command line (Linux|Mac), or prints them
@@ -508,33 +526,36 @@ a folder with image png files, and wildcard \*.png to retrieve the dream command
 used to generate the images, and save them to a file commands.txt for further
 processing.
 
-This example loads the generation command for a single png file:
+!!! example "load the generation command for a single png file"
 
-```bash
-invoke> !fetch 0000015.8929913.png
-# the script returns the next line, ready for editing and running:
-invoke> a fantastic alien landscape -W 576 -H 512 -s 60 -A plms -C 7.5
-```
+    ```bash
+    invoke> !fetch 0000015.8929913.png
+    # the script returns the next line, ready for editing and running:
+    invoke> a fantastic alien landscape -W 576 -H 512 -s 60 -A plms -C 7.5
+    ```
 
-This one fetches the generation commands from a batch of files and stores them
-into `selected.txt`:
+!!! example "fetch the generation commands from a batch of files and store them into `selected.txt`"
 
-```bash
-invoke> !fetch outputs\selected-imgs\*.png selected.txt
-```
+    ```bash
+    invoke> !fetch outputs\selected-imgs\*.png selected.txt
+    ```
 
-### !replay
+#### `!replay`
 
 This command replays a text file generated by !fetch or created manually
 
-```
-invoke> !replay outputs\selected-imgs\selected.txt
-```
+!!! example
 
-Note that these commands may behave unexpectedly if given a PNG file that was
-not generated by InvokeAI.
+    ```bash
+    invoke> !replay outputs\selected-imgs\selected.txt
+    ```
 
-### !search <search string>
+!!! note
+
+    These commands may behave unexpectedly if given a PNG file that was
+    not generated by InvokeAI.
+
+#### `!search <search string>`
 
 This is similar to !history but it only returns lines that contain
 `search string`. For example:
@@ -544,7 +565,7 @@ invoke> !search surreal
 [21] surrealist painting of beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6 -S2878767194
 ```
 
-### `!clear`
+#### `!clear`
 
 This clears the search history from memory and disk. Be advised that this
 operation is irreversible and does not issue any warnings!

docs/features/CONCEPTS.md

@@ -1,130 +1,110 @@
 ---
-title: The Hugging Face Concepts Library and Importing Textual Inversion files
+title: Concepts Library
 ---
 
-# :material-file-document: Concepts Library
+# :material-library-shelves: The Hugging Face Concepts Library and Importing Textual Inversion files
 
 ## Using Textual Inversion Files
 
 Textual inversion (TI) files are small models that customize the output of
-Stable Diffusion image generation. They can augment SD with
-specialized subjects and artistic styles. They are also known as
-"embeds" in the machine learning world.
+Stable Diffusion image generation. They can augment SD with specialized subjects
+and artistic styles. They are also known as "embeds" in the machine learning
+world.
 
-Each TI file introduces one or more vocabulary terms to the SD
-model. These are known in InvokeAI as "triggers." Triggers are often,
-but not always, denoted using angle brackets as in
-"<trigger-phrase>". The two most common type of TI files that you'll
-encounter are `.pt` and `.bin` files, which are produced by different
-TI training packages. InvokeAI supports both formats, but its [built-in
-TI training system](TEXTUAL_INVERSION.md) produces `.pt`.
+Each TI file introduces one or more vocabulary terms to the SD model. These are
+known in InvokeAI as "triggers." Triggers are often, but not always, denoted
+using angle brackets as in "<trigger-phrase>". The two most common type of
+TI files that you'll encounter are `.pt` and `.bin` files, which are produced by
+different TI training packages. InvokeAI supports both formats, but its
+[built-in TI training system](TEXTUAL_INVERSION.md) produces `.pt`.
 
-The [Hugging Face company](https://huggingface.co/sd-concepts-library)
-has amassed a large ligrary of >800 community-contributed TI files
-covering a broad range of subjects and styles. InvokeAI has built-in
-support for this library which downloads and merges TI files
-automatically upon request. You can also install your own or others'
-TI files by placing them in a designated directory.
+The [Hugging Face company](https://huggingface.co/sd-concepts-library) has
+amassed a large ligrary of >800 community-contributed TI files covering a
+broad range of subjects and styles. InvokeAI has built-in support for this
+library which downloads and merges TI files automatically upon request. You can
+also install your own or others' TI files by placing them in a designated
+directory.
 
 ### An Example
 
-Here are a few examples to illustrate how it works. All these images
-were generated using the command-line client and the Stable Diffusion
-1.5 model:
+Here are a few examples to illustrate how it works. All these images were
+generated using the command-line client and the Stable Diffusion 1.5 model:
 
-Japanese gardener
-<br>
-<img src="../assets/concepts/image1.png">
-
-Japanese gardener &lt;ghibli-face&gt;
-<br>
-<img src="../assets/concepts/image2.png">
-
-Japanese gardener &lt;hoi4-leaders&gt;
-<br>
-<img src="../assets/concepts/image3.png">
-
-Japanese gardener &lt;cartoona-animals&gt;
-<br>
-<img src="../assets/concepts/image4.png">
+|         Japanese gardener          | Japanese gardener &lt;ghibli-face&gt; | Japanese gardener &lt;hoi4-leaders&gt; | Japanese gardener &lt;cartoona-animals&gt; |
+| :--------------------------------: | :-----------------------------------: | :------------------------------------: | :----------------------------------------: |
+| ![](../assets/concepts/image1.png) |  ![](../assets/concepts/image2.png)   |   ![](../assets/concepts/image3.png)   |     ![](../assets/concepts/image4.png)     |
 
 You can also combine styles and concepts:
 
-A portrait of &lt;alf&gt; in &lt;cartoona-animal&gt; style
-<br>
-<img src="../assets/concepts/image5.png">
-
+<figure markdown>
+  ![](../assets/concepts/image5.png)
+  <figcaption>A portrait of &lt;alf&gt; in &lt;cartoona-animal&gt; style</figcaption>
+</figure>
 ## Using a Hugging Face Concept
 
-Hugging Face TI concepts are downloaded and installed automatically as
-you require them. This requires your machine to be connected to the
-Internet. To find out what each concept is for, you can browse the
-[Hugging Face concepts
-library](https://huggingface.co/sd-concepts-library) and look at
-examples of what each concept produces.
+Hugging Face TI concepts are downloaded and installed automatically as you
+require them. This requires your machine to be connected to the Internet. To
+find out what each concept is for, you can browse the
+[Hugging Face concepts library](https://huggingface.co/sd-concepts-library) and
+look at examples of what each concept produces.
 
-When you have an idea of a concept you wish to try, go to the
-command-line client (CLI) and type a "&lt;" character and the beginning
-of the Hugging Face concept name you wish to load.  Press the Tab key,
-and the CLI will show you all matching concepts. You can also type "&lt;"
-and Tab to get a listing of all ~800 concepts, but be prepared to
-scroll up to see them all! If there is more than one match you can
-continue to type and Tab until the concept is completed.
+When you have an idea of a concept you wish to try, go to the command-line
+client (CLI) and type a "&lt;" character and the beginning of the Hugging Face
+concept name you wish to load. Press the Tab key, and the CLI will show you all
+matching concepts. You can also type "&lt;" and Tab to get a listing of all ~800
+concepts, but be prepared to scroll up to see them all! If there is more than
+one match you can continue to type and Tab until the concept is completed.
 
-For example if you type "&lt;x" and Tab, you'll be prompted with the completions:
+For example if you type "&lt;x" and Tab, you'll be prompted with the
+completions:
 
 ```
-<xatu2>        <xatu>         <xbh>          <xi>           <xidiversity>  <xioboma>      <xuna>         <xyz>          
+<xatu2>        <xatu>         <xbh>          <xi>           <xidiversity>  <xioboma>      <xuna>         <xyz>
 ```
 
-Now type "id" and press Tab. It will be autocompleted to
-"&lt;xidiversity&gt;" because this is a unique match.
+Now type "id" and press Tab. It will be autocompleted to "&lt;xidiversity&gt;"
+because this is a unique match.
 
-Finish your prompt and generate as usual. You may include multiple
-concept terms in the prompt.
+Finish your prompt and generate as usual. You may include multiple concept terms
+in the prompt.
 
-If you have never used this concept before, you will see a message
-that the TI model is being downloaded and installed. After this, the
-concept will be saved locally (in the `models/sd-concepts-library`
-directory) for future use.
+If you have never used this concept before, you will see a message that the TI
+model is being downloaded and installed. After this, the concept will be saved
+locally (in the `models/sd-concepts-library` directory) for future use.
 
-Several steps happen during downloading and
-installation, including a scan of the file for malicious code. Should
-any errors occur, you will be warned and the concept will fail to
-load. Generation will then continue treating the trigger term as a
-normal string of characters (e.g. as literal "&lt;ghibli-face&gt;").
+Several steps happen during downloading and installation, including a scan of
+the file for malicious code. Should any errors occur, you will be warned and the
+concept will fail to load. Generation will then continue treating the trigger
+term as a normal string of characters (e.g. as literal "&lt;ghibli-face&gt;").
 
-Currently auto-installation of concepts is a feature only available on
-the command-line client. Support for the WebUI is a work in progress.
+Currently auto-installation of concepts is a feature only available on the
+command-line client. Support for the WebUI is a work in progress.
 
 ## Installing your Own TI Files
 
-You may install any number of `.pt` and `.bin` files simply by copying
-them into the `embeddings` directory of the InvokeAI runtime directory
-(usually `invokeai` in your home directory). You may create
-subdirectories in order to organize the files in any way you wish. Be
-careful not to overwrite one file with another. For example, TI files
-generated by the Hugging Face toolkit share the named
-`learned_embedding.bin`. You can use subdirectories to keep them
-distinct.
+You may install any number of `.pt` and `.bin` files simply by copying them into
+the `embeddings` directory of the InvokeAI runtime directory (usually `invokeai`
+in your home directory). You may create subdirectories in order to organize the
+files in any way you wish. Be careful not to overwrite one file with another.
+For example, TI files generated by the Hugging Face toolkit share the named
+`learned_embedding.bin`. You can use subdirectories to keep them distinct.
 
-At startup time, InvokeAI will scan the `embeddings` directory and
-load any TI files it finds there. At startup you will see a message
-similar to this one:
+At startup time, InvokeAI will scan the `embeddings` directory and load any TI
+files it finds there. At startup you will see a message similar to this one:
 
-```
+```bash
 >> Current embedding manager terms: *, <HOI4-Leader>, <princess-knight>
 ```
 
-Note the "*" trigger term. This is a placeholder term that many early
-TI tutorials taught people to use rather than a more descriptive
-term. Unfortunately, if you have multiple TI files that all use this
-term, only the first one loaded will be triggered by use of the term.
+Note the `*` trigger term. This is a placeholder term that many early TI
+tutorials taught people to use rather than a more descriptive term.
+Unfortunately, if you have multiple TI files that all use this term, only the
+first one loaded will be triggered by use of the term.
 
-To avoid this problem, you can use the `merge_embeddings.py` script to
-merge two or more TI files together. If it encounters a collision of
-terms, the script will prompt you to select new terms that do not
-collide. See [Textual Inversion](TEXTUAL_INVERSION.md) for details.
+To avoid this problem, you can use the `merge_embeddings.py` script to merge two
+or more TI files together. If it encounters a collision of terms, the script
+will prompt you to select new terms that do not collide. See
+[Textual Inversion](TEXTUAL_INVERSION.md) for details.
 
 ## Further Reading
 

docs/features/IMG2IMG.md

@@ -12,21 +12,19 @@ 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:
 
-```commandline
-tree on a hill with a river, nature photograph, national geographic -I./test-pictures/tree-and-river-sketch.png -f 0.85
-```
+!!! example ""
 
-This will take the original image shown here:
+    ```commandline
+    tree on a hill with a river, nature photograph, national geographic -I./test-pictures/tree-and-river-sketch.png -f 0.85
+    ```
 
-<figure markdown>
-![original-image](https://user-images.githubusercontent.com/50542132/193946000-c42a96d8-5a74-4f8a-b4c3-5213e6cadcce.png){ width=320 }
-</figure>
+    <figure markdown>
 
-and generate a new image based on it as shown here:
+    | original image | generated image |
+    | :------------: | :-------------: |
+    | ![original-image](https://user-images.githubusercontent.com/50542132/193946000-c42a96d8-5a74-4f8a-b4c3-5213e6cadcce.png){ width=320 } | ![generated-image](https://user-images.githubusercontent.com/111189/194135515-53d4c060-e994-4016-8121-7c685e281ac9.png){ width=320 } |
 
-<figure markdown>
-![generated-image](https://user-images.githubusercontent.com/111189/194135515-53d4c060-e994-4016-8121-7c685e281ac9.png){ width=320 }
-</figure>
+    </figure>
 
 The `--init_img` (`-I`) option gives the path to the seed picture. `--strength`
 (`-f`) controls how much the original will be modified, ranging from `0.0` (keep
@@ -88,13 +86,15 @@ from a prompt. If the step count is 10, then the "latent space" (Stable
 Diffusion's internal representation of the image) for the prompt "fire" with
 seed `1592514025` develops something like this:
 
-```bash
-invoke> "fire" -s10 -W384 -H384 -S1592514025
-```
+!!! example ""
 
-<figure markdown>
-![latent steps](../assets/img2img/000019.steps.png)
-</figure>
+    ```bash
+    invoke> "fire" -s10 -W384 -H384 -S1592514025
+    ```
+
+    <figure markdown>
+    ![latent steps](../assets/img2img/000019.steps.png){ width=720 }
+    </figure>
 
 Put simply: starting from a frame of fuzz/static, SD finds details in each frame
 that it thinks look like "fire" and brings them a little bit more into focus,
@@ -109,25 +109,23 @@ into the sequence at the appropriate point, with just the right amount of noise.
 
 ### A concrete example
 
-I want SD to draw a fire based on this hand-drawn image:
+!!! example "I want SD to draw a fire based on this hand-drawn image"
 
-<figure markdown>
-![drawing of a fireplace](../assets/img2img/fire-drawing.png)
-</figure>
+    ![drawing of a fireplace](../assets/img2img/fire-drawing.png){ align=left }
 
-Let's only do 10 steps, to make it easier to see what's happening. If strength
-is `0.7`, this is what the internal steps the algorithm has to take will look
-like:
+    Let's only do 10 steps, to make it easier to see what's happening. If strength
+    is `0.7`, this is what the internal steps the algorithm has to take will look
+    like:
 
-<figure markdown>
-![gravity32](../assets/img2img/000032.steps.gravity.png)
-</figure>
+    <figure markdown>
+    ![gravity32](../assets/img2img/000032.steps.gravity.png)
+    </figure>
 
-With strength `0.4`, the steps look more like this:
+    With strength `0.4`, the steps look more like this:
 
-<figure markdown>
-![gravity30](../assets/img2img/000030.steps.gravity.png)
-</figure>
+    <figure markdown>
+    ![gravity30](../assets/img2img/000030.steps.gravity.png)
+    </figure>
 
 Notice how much more fuzzy the starting image is for strength `0.7` compared to
 `0.4`, and notice also how much longer the sequence is with `0.7`:

docs/features/POSTPROCESS.md

@@ -39,10 +39,6 @@ If you do not run this script in advance, the GFPGAN module will attempt to
 download the models files the first time you try to perform facial
 reconstruction.
 
-## Usage
-
-You will now have access to two new prompt arguments.
-
 ### Upscaling
 
 `-U : <upscaling_factor> <upscaling_strength>`
@@ -119,7 +115,7 @@ You can use `-ft` prompt argument to swap between CodeFormer and the default
 GFPGAN. The above mentioned `-G` prompt argument will allow you to control the
 strength of the restoration effect.
 
-### Usage
+### CodeFormer Usage
 
 The following command will perform face restoration with CodeFormer instead of
 the default gfpgan.
@@ -160,7 +156,7 @@ A new file named `000044.2945021133.fixed.png` will be created in the output
 directory. Note that the `!fix` command does not replace the original file,
 unlike the behavior at generate time.
 
-### Disabling
+## How to disable
 
 If, for some reason, you do not wish to load the GFPGAN and/or ESRGAN libraries,
 you can disable them on the invoke.py command line with the `--no_restore` and

docs/features/index.md

@@ -0,0 +1,5 @@
+---
+title: Overview
+---
+
+Here you can find the documentation for different features.

docs/installation/BUILDING_BINARY_INSTALLERS.md

@@ -1,4 +1,8 @@
-# How to build "binary" installers (InvokeAI-mac/windows/linux_on_*.zip)
+---
+title: build binary installers
+---
+
+# :simple-buildkite: How to build "binary" installers (InvokeAI-mac/windows/linux_on_*.zip)
 
 ## 1. Ensure `installers/requirements.in` is correct
 

docs/installation/INSTALLING_MODELS.md

@@ -162,6 +162,12 @@ the command-line client's `!import_model` command.
          Type a bit of the path name and hit ++tab++ in order to get a choice of
          possible completions.
 
+    !!! tip "on Windows, you can drag model files onto the command-line"
+
+         Once you have typed in `!import_model `, you can drag the model `.ckpt` file
+         onto the command-line to insert the model path. This way, you don't need to
+         type it or copy/paste.
+
 4.  Follow the wizard's instructions to complete installation as shown in the
     example here:
 

docs/installation/index.md

@@ -5,31 +5,7 @@ title: Overview
 We offer several ways to install InvokeAI, each one suited to your
 experience and preferences.
 
-1. [InvokeAI binary installer](INSTALL_INVOKE.md)
-
-    This is a installer script that installs InvokeAI and all the
-    third party libraries it depends on. It includes access to a
-    "developer console" which will help us debug problems with you and
-    give you to access experimental features.
-
-    When a new InvokeAI release is available, you will run an `update`
-    script to download and install the new version. Intermediate versions
-    that contain experimental and possibly unstable features will not be
-    available.
-
-    This installer is designed for people who want the system to "just
-    work", don't have an interest in tinkering with it, and do not
-    care about upgrading to unreleased experimental features.
-
-    **Important Caveats**
-    - This script does not support AMD GPUs. For Linux AMD support,
-    please use the manual or source code installer methods.
-    - The tab autocomplete feature of the command-line client,
-    which completes commonly used filenames and commands, will
-    not work in this version. All Web UI functions are fully
-    operational, however.
-
-2. [InvokeAI source code installer](INSTALL_SOURCE.md)
+1. [InvokeAI source code installer](INSTALL_SOURCE.md)
 
     This is a script that will install Python, the Anaconda ("conda")
     package manager, all of InvokeAI's its essential third party
@@ -46,8 +22,7 @@ experience and preferences.
     **Important Caveats**
     - This script is a bit cranky and occasionally hangs or times out,
     forcing you to cancel and restart the script (it will pick up where
-    it left off). It also takes noticeably longer to run than the
-    binary installer.
+    it left off).
 
 2. [Manual Installation](INSTALL_MANUAL.md)
 

docs/installation/older_docs_to_be_removed/INSTALL_LINUX.md

@@ -79,7 +79,7 @@ title: Manual Installation, Linux
         and obtaining an access token for downloading. It will then download and
         install the weights files for you.
 
-        Please look [here](INSTALLING_MODELS.md) for a manual process for doing
+        Please look [here](../INSTALL_MANUAL.md) for a manual process for doing
         the same thing.
 
 7.  Start generating images!
@@ -112,7 +112,7 @@ title: Manual Installation, Linux
         To use an alternative model you may invoke the `!switch` command in
         the CLI, or pass `--model <model_name>` during `invoke.py` launch for
         either the CLI or the Web UI. See [Command Line
-        Client](../features/CLI.md#model-selection-and-importation). The
+        Client](../../features/CLI.md#model-selection-and-importation). The
         model names are defined in `configs/models.yaml`.
 
 8. Subsequently, to relaunch the script, be sure to run "conda activate

docs/installation/older_docs_to_be_removed/INSTALL_MAC.md

@@ -150,7 +150,7 @@ will do our best to help.
     To use an alternative model you may invoke the `!switch` command in
     the CLI, or pass `--model <model_name>` during `invoke.py` launch for
     either the CLI or the Web UI. See [Command Line
-    Client](../features/CLI.md#model-selection-and-importation). The
+    Client](../../features/CLI.md#model-selection-and-importation). The
     model names are defined in `configs/models.yaml`.
 
 ---

docs/installation/older_docs_to_be_removed/INSTALL_WINDOWS.md

@@ -75,7 +75,7 @@ Note that you will need NVIDIA drivers, Python 3.10, and Git installed beforehan
           obtaining an access token for downloading. It will then download and install the
           weights files for you.
 
-          Please look [here](INSTALLING_MODELS.md) for a manual process for doing the
+          Please look [here](../INSTALL_MANUAL.md) for a manual process for doing the
           same thing.
 
 8. Start generating images!
@@ -108,7 +108,7 @@ Note that you will need NVIDIA drivers, Python 3.10, and Git installed beforehan
         To use an alternative model you may invoke the `!switch` command in
         the CLI, or pass `--model <model_name>` during `invoke.py` launch for
         either the CLI or the Web UI. See [Command Line
-        Client](../features/CLI.md#model-selection-and-importation). The
+        Client](../../features/CLI.md#model-selection-and-importation). The
         model names are defined in `configs/models.yaml`.
 
 9. Subsequently, to relaunch the script, first activate the Anaconda

docs/other/CONTRIBUTORS.md

@@ -15,16 +15,16 @@ We thank them for all of their time and hard work.
 
 ## **Current core team**
 
-* lstein (Lincoln Stein) - Co-maintainer
-* blessedcoolant - Co-maintainer
-* hipsterusername (Kent Keirsey) - Product Manager
-* psychedelicious - Web Team Leader
-* Kyle0654 (Kyle Schouviller) - Node Architect and General Backend Wizard
-* damian0815 - Attention Systems and Gameplay Engineer
-* mauwii (Matthias Wild) - Continuous integration and product maintenance engineer
-* Netsvetaev (Artur Netsvetaev) - UI/UX Developer
-* tildebyte - general gadfly and resident (self-appointed) know-it-all
-* keturn - Lead for Diffusers port
+* @lstein (Lincoln Stein) - Co-maintainer
+* @blessedcoolant - Co-maintainer
+* @hipsterusername (Kent Keirsey) - Product Manager
+* @psychedelicious - Web Team Leader
+* @Kyle0654 (Kyle Schouviller) - Node Architect and General Backend Wizard
+* @damian0815 - Attention Systems and Gameplay Engineer
+* @mauwii (Matthias Wild) - Continuous integration and product maintenance engineer
+* @Netsvetaev (Artur Netsvetaev) - UI/UX Developer
+* @tildebyte - general gadfly and resident (self-appointed) know-it-all
+* @keturn - Lead for Diffusers port
 
 ## **Contributions by**
 

source_installer/create_installers.sh

@@ -2,6 +2,8 @@
 
 cd "$(dirname "${BASH_SOURCE[0]}")"
 
+VERSION='2.2.3'
+
 # make the installer zip for linux and mac
 rm -rf invokeAI
 mkdir -p invokeAI
@@ -9,8 +11,8 @@ cp install.sh.in invokeAI/install.sh
 chmod a+x invokeAI/install.sh
 cp readme.txt invokeAI
 
-zip -r invokeAI-src-installer-linux.zip invokeAI
-zip -r invokeAI-src-installer-mac.zip invokeAI
+zip -r invokeAI-src-installer-$VERSION-linux.zip invokeAI
+zip -r invokeAI-src-installer-$VERSION-mac.zip invokeAI
 
 # make the installer zip for windows
 rm -rf invokeAI
@@ -19,7 +21,7 @@ cp install.bat.in invokeAI/install.bat
 cp readme.txt invokeAI
 cp WinLongPathsEnabled.reg invokeAI
 
-zip -r invokeAI-src-installer-windows.zip invokeAI
+zip -r invokeAI-src-installer-$VERSION-windows.zip invokeAI
 
 rm -rf invokeAI
 echo "The installer zips are ready to be distributed.."

source_installer/install.bat.in

@@ -9,6 +9,9 @@
 
 @rem This enables a user to install this project without manually installing conda and git.
 
+@rem change to the script's directory
+PUSHD "%~dp0"
+
 echo "InvokeAI source installer..."
 echo ""
 echo "Some of the installation steps take a long time to run. Please be patient."

source_installer/install.sh.in

@@ -123,6 +123,8 @@ then
 else
     ln -sf ./source_installer/invoke.sh.in ./invoke.sh
     ln -sf ./source_installer/update.sh.in ./update.sh
+    chmod a+rx ./source_installer/invoke.sh.in
+    chmod a+rx ./source_installer/update.sh.in
 
     conda activate invokeai
     # configure

source_installer/invoke.sh.in

@@ -10,6 +10,11 @@ source "$CONDA_BASEPATH/etc/profile.d/conda.sh" # otherwise conda complains abou
 
 conda activate invokeai
 
+# set required env var for torch on mac MPS
+if [ "$(uname -s)" == "Darwin" ]; then
+    export PYTORCH_ENABLE_MPS_FALLBACK=1
+fi
+
 if [ "$0" != "bash" ]; then
     echo "Do you want to generate images using the"
     echo "1. command-line"