update requirements to address #1149

Taken from `main` PR #1147 
Author: eltociear

.dev_scripts/test_regression_txt2img_dream_v1_4.sh

@@ -5,8 +5,7 @@ SAMPLES_DIR=${OUT_DIR}
 python scripts/dream.py \
     --from_file ${PROMPT_FILE} \
     --outdir ${OUT_DIR} \
-    --sampler plms \
-    --full_precision
+    --sampler plms
 
 # original output by CompVis/stable-diffusion
 IMAGE1=".dev_scripts/images/v1_4_astronaut_rides_horse_plms_step50_seed42.png"

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+ldm/invoke/pngwriter.py @CapableWeb
+ldm/invoke/server_legacy.py @CapableWeb
+scripts/legacy_api.py @CapableWeb
+tests/legacy_tests.sh @CapableWeb

.github/workflows/cache-model.yml

@@ -1,64 +0,0 @@
-name: Cache Model
-on:
-  workflow_dispatch
-jobs:
-  build:
-    strategy:
-      matrix:
-        os: [ macos-12 ]
-    name: Create Caches using ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    steps:
-      - name: Checkout sources
-        uses: actions/checkout@v3
-      - name: Cache model
-        id: cache-sd-v1-4
-        uses: actions/cache@v3
-        env:
-          cache-name: cache-sd-v1-4
-        with:
-          path: models/ldm/stable-diffusion-v1/model.ckpt
-          key: ${{ env.cache-name }}
-          restore-keys: |
-            ${{ env.cache-name }}
-      - name: Download Stable Diffusion v1.4 model
-        if: ${{ steps.cache-sd-v1-4.outputs.cache-hit != 'true' }}
-        continue-on-error: true
-        run: |
-          if [ ! -e models/ldm/stable-diffusion-v1 ]; then
-              mkdir -p models/ldm/stable-diffusion-v1
-          fi
-          if [ ! -e models/ldm/stable-diffusion-v1/model.ckpt ]; then
-            curl -o models/ldm/stable-diffusion-v1/model.ckpt ${{ secrets.SD_V1_4_URL }}
-          fi
-# Uncomment this when we no longer make changes to environment-mac.yaml
-#       - name: Cache environment
-#         id: cache-conda-env-ldm
-#         uses: actions/cache@v3
-#         env:
-#           cache-name: cache-conda-env-ldm
-#         with:
-#           path: ~/.conda/envs/ldm
-#           key: ${{ env.cache-name }}
-#           restore-keys: |
-#             ${{ env.cache-name }}
-      - name: Install dependencies
-#         if: ${{ steps.cache-conda-env-ldm.outputs.cache-hit != 'true' }}
-        run: |
-          conda env create -f environment-mac.yaml
-      - name: Cache hugginface and torch models
-        id: cache-hugginface-torch
-        uses: actions/cache@v3
-        env:
-          cache-name: cache-hugginface-torch
-        with:
-          path: ~/.cache
-          key: ${{ env.cache-name }}
-          restore-keys: |
-            ${{ env.cache-name }}
-      - name: Download Huggingface and Torch models
-        if: ${{ steps.cache-hugginface-torch.outputs.cache-hit != 'true' }}
-        continue-on-error: true
-        run: |
-          export PYTHON_BIN=/usr/local/miniconda/envs/ldm/bin/python
-          $PYTHON_BIN scripts/preload_models.py

.github/workflows/create-caches.yml

@@ -0,0 +1,97 @@
+name: Create Caches
+
+on: workflow_dispatch
+
+jobs:
+  os_matrix:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        include:
+          - os: ubuntu-latest
+            environment-file: environment.yml
+            default-shell: bash -l {0}
+          - os: macos-latest
+            environment-file: environment-mac.yml
+            default-shell: bash -l {0}
+    name: Test invoke.py on ${{ matrix.os }} with conda
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: ${{ matrix.default-shell }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v3
+
+      - name: setup miniconda
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-activate-base: false
+          auto-update-conda: false
+          miniconda-version: latest
+
+      - name: set environment
+        run: |
+          [[ "$GITHUB_REF" == 'refs/heads/main' ]] \
+            && echo "TEST_PROMPTS=tests/preflight_prompts.txt" >> $GITHUB_ENV \
+            || echo "TEST_PROMPTS=tests/dev_prompts.txt" >> $GITHUB_ENV
+          echo "CONDA_ROOT=$CONDA" >> $GITHUB_ENV
+          echo "CONDA_ENV_NAME=invokeai" >> $GITHUB_ENV
+
+      - name: Use Cached Stable Diffusion v1.4 Model
+        id: cache-sd-v1-4
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-sd-v1-4
+        with:
+          path: models/ldm/stable-diffusion-v1/model.ckpt
+          key: ${{ env.cache-name }}
+          restore-keys: ${{ env.cache-name }}
+
+      - name: Download Stable Diffusion v1.4 Model
+        if: ${{ steps.cache-sd-v1-4.outputs.cache-hit != 'true' }}
+        run: |
+          [[ -d models/ldm/stable-diffusion-v1 ]] \
+            || mkdir -p models/ldm/stable-diffusion-v1
+          [[ -r models/ldm/stable-diffusion-v1/model.ckpt ]] \
+            || curl -o models/ldm/stable-diffusion-v1/model.ckpt ${{ secrets.SD_V1_4_URL }}
+
+      - name: Use cached Conda Environment
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-conda-env-${{ env.CONDA_ENV_NAME }}
+          conda-env-file: ${{ matrix.environment-file }}
+        with:
+          path: ${{ env.CONDA_ROOT }}/envs/${{ env.CONDA_ENV_NAME }}
+          key: ${{ env.cache-name }}
+          restore-keys: ${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles(env.conda-env-file) }}
+
+      - name: Use cached Conda Packages
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-conda-env-${{ env.CONDA_ENV_NAME }}
+          conda-env-file: ${{ matrix.environment-file }}
+        with:
+          path: ${{ env.CONDA_PKGS_DIR }}
+          key: ${{ env.cache-name }}
+          restore-keys: ${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles(env.conda-env-file) }}
+
+      - name: Activate Conda Env
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: ${{ env.CONDA_ENV_NAME }}
+          environment-file: ${{ matrix.environment-file }}
+
+      - name: Use Cached Huggingface and Torch models
+        id: cache-hugginface-torch
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-hugginface-torch
+        with:
+          path: ~/.cache
+          key: ${{ env.cache-name }}
+          restore-keys: |
+            ${{ env.cache-name }}-${{ hashFiles('scripts/preload_models.py') }}
+
+      - name: run preload_models.py
+        run: python scripts/preload_models.py

.github/workflows/macos12-miniconda.yml

@@ -1,80 +0,0 @@
-name: Build
-on: 
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-jobs:
-  build:
-    strategy:
-      matrix:
-        os: [ macos-12 ]
-    name: Build on ${{ matrix.os }} miniconda
-    runs-on: ${{ matrix.os }}
-    steps:
-      - name: Checkout sources
-        uses: actions/checkout@v3
-      - name: Cache model
-        id: cache-sd-v1-4
-        uses: actions/cache@v3
-        env:
-          cache-name: cache-sd-v1-4
-        with:
-          path: models/ldm/stable-diffusion-v1/model.ckpt
-          key: ${{ env.cache-name }}
-          restore-keys: |
-            ${{ env.cache-name }}
-      - name: Download Stable Diffusion v1.4 model
-        if: ${{ steps.cache-sd-v1-4.outputs.cache-hit != 'true' }}
-        continue-on-error: true
-        run: |
-          if [ ! -e models/ldm/stable-diffusion-v1 ]; then
-              mkdir -p models/ldm/stable-diffusion-v1
-          fi
-          if [ ! -e models/ldm/stable-diffusion-v1/model.ckpt ]; then
-            curl -o models/ldm/stable-diffusion-v1/model.ckpt ${{ secrets.SD_V1_4_URL }}
-          fi
-# Uncomment this when we no longer make changes to environment-mac.yaml
-#       - name: Cache environment
-#         id: cache-conda-env-ldm
-#         uses: actions/cache@v3
-#         env:
-#           cache-name: cache-conda-env-ldm
-#         with:
-#           path: ~/.conda/envs/ldm
-#           key: ${{ env.cache-name }}
-#           restore-keys: |
-#             ${{ env.cache-name }}
-      - name: Install dependencies
-#         if: ${{ steps.cache-conda-env-ldm.outputs.cache-hit != 'true' }}
-        run: |
-          conda env create -f environment-mac.yaml
-      - name: Cache hugginface and torch models
-        id: cache-hugginface-torch
-        uses: actions/cache@v3
-        env:
-          cache-name: cache-hugginface-torch
-        with:
-          path: ~/.cache
-          key: ${{ env.cache-name }}
-          restore-keys: |
-            ${{ env.cache-name }}
-      - name: Download Huggingface and Torch models
-        if: ${{ steps.cache-hugginface-torch.outputs.cache-hit != 'true' }}
-        continue-on-error: true
-        run: |
-          export PYTHON_BIN=/usr/local/miniconda/envs/ldm/bin/python
-          $PYTHON_BIN scripts/preload_models.py
-      - name: Run the tests
-        run: |
-          # Note, can't "activate" via automation, and activation is just env vars and path
-          export PYTHON_BIN=/usr/local/miniconda/envs/ldm/bin/python
-          export PYTORCH_ENABLE_MPS_FALLBACK=1
-          $PYTHON_BIN scripts/preload_models.py
-          mkdir -p outputs/img-samples
-          time $PYTHON_BIN scripts/dream.py --from_file tests/prompts.txt </dev/null 2> outputs/img-samples/err.log > outputs/img-samples/out.log
-      - name: Archive results
-        uses: actions/upload-artifact@v3
-        with:
-          name: results
-          path: outputs/img-samples

.github/workflows/mkdocs-material.yml

@@ -0,0 +1,40 @@
+name: mkdocs-material
+on:
+  push:
+    branches:
+      - 'main'
+      - 'development'
+
+jobs:
+  mkdocs-material:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout sources
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: install requirements
+        run: |
+          python -m \
+            pip install -r requirements-mkdocs.txt
+
+      - name: confirm buildability
+        run: |
+          python -m \
+            mkdocs build \
+            --clean \
+            --verbose
+
+      - name: deploy to gh-pages
+        if: ${{ github.ref == 'refs/heads/main' }}
+        run: |
+          python -m \
+            mkdocs gh-deploy \
+            --clean \
+            --force

.github/workflows/test-invoke-conda.yml

@@ -0,0 +1,126 @@
+name: Test Invoke with Conda
+on:
+  push:
+    branches:
+      - 'main'
+      - 'development'
+      - 'fix-gh-actions-fork'
+  pull_request:
+    branches:
+      - 'main'
+      - 'development'
+
+jobs:
+  os_matrix:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        include:
+          - os: ubuntu-latest
+            environment-file: environment.yml
+            default-shell: bash -l {0}
+          - os: macos-latest
+            environment-file: environment-mac.yml
+            default-shell: bash -l {0}
+    name: Test invoke.py on ${{ matrix.os }} with conda
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: ${{ matrix.default-shell }}
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v3
+
+      - name: setup miniconda
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-activate-base: false
+          auto-update-conda: false
+          miniconda-version: latest
+
+      - name: set test prompt to main branch validation
+        if: ${{ github.ref == 'refs/heads/main' }}
+        run: echo "TEST_PROMPTS=tests/preflight_prompts.txt" >> $GITHUB_ENV
+
+      - name: set test prompt to development branch validation
+        if: ${{ github.ref == 'refs/heads/development' }}
+        run: echo "TEST_PROMPTS=tests/dev_prompts.txt" >> $GITHUB_ENV
+
+      - name: set test prompt to Pull Request validation
+        if: ${{ github.ref != 'refs/heads/main' && github.ref != 'refs/heads/development' }}
+        run: echo "TEST_PROMPTS=tests/pr_prompt.txt" >> $GITHUB_ENV
+
+      - name: set conda environment name
+        run: echo "CONDA_ENV_NAME=invokeai" >> $GITHUB_ENV
+
+      - name: Use Cached Stable Diffusion v1.4 Model
+        id: cache-sd-v1-4
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-sd-v1-4
+        with:
+          path: models/ldm/stable-diffusion-v1/model.ckpt
+          key: ${{ env.cache-name }}
+          restore-keys: ${{ env.cache-name }}
+
+      - name: Download Stable Diffusion v1.4 Model
+        if: ${{ steps.cache-sd-v1-4.outputs.cache-hit != 'true' }}
+        run: |
+          [[ -d models/ldm/stable-diffusion-v1 ]] \
+            || mkdir -p models/ldm/stable-diffusion-v1
+          [[ -r models/ldm/stable-diffusion-v1/model.ckpt ]] \
+            || curl -o models/ldm/stable-diffusion-v1/model.ckpt ${{ secrets.SD_V1_4_URL }}
+
+      - name: Use cached Conda Environment
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-conda-env-${{ env.CONDA_ENV_NAME }}
+          conda-env-file: ${{ matrix.environment-file }}
+        with:
+          path: ${{ env.CONDA }}/envs/${{ env.CONDA_ENV_NAME }}
+          key: env-${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles(env.conda-env-file) }}
+
+      - name: Use cached Conda Packages
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-conda-pkgs-${{ env.CONDA_ENV_NAME }}
+          conda-env-file: ${{ matrix.environment-file }}
+        with:
+          path: ${{ env.CONDA_PKGS_DIR }}
+          key: pkgs-${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles(env.conda-env-file) }}
+
+      - name: Activate Conda Env
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: ${{ env.CONDA_ENV_NAME }}
+          environment-file: ${{ matrix.environment-file }}
+
+      - name: Use Cached Huggingface and Torch models
+        id: cache-hugginface-torch
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-hugginface-torch
+        with:
+          path: ~/.cache
+          key: ${{ env.cache-name }}
+          restore-keys: |
+            ${{ env.cache-name }}-${{ hashFiles('scripts/preload_models.py') }}
+
+      - name: run preload_models.py
+        run: python scripts/preload_models.py
+
+      - name: Run the tests
+        run: |
+          time python scripts/invoke.py \
+            --from_file ${{ env.TEST_PROMPTS }}
+
+      - name: export conda env
+        run: |
+          mkdir -p outputs/img-samples
+          conda env export --name ${{ env.CONDA_ENV_NAME }} > outputs/img-samples/environment-${{ runner.os }}.yml
+
+      - name: Archive results
+        uses: actions/upload-artifact@v3
+        with:
+          name: results_${{ matrix.os }}
+          path: outputs/img-samples

.gitignore

@@ -1,6 +1,10 @@
 # ignore default image save location and model symbolic link
 outputs/
 models/ldm/stable-diffusion-v1/model.ckpt
+**/restoration/codeformer/weights
+
+# ignore the Anaconda/Miniconda installer used while building Docker image
+anaconda.sh
 
 # ignore a directory which serves as a place for initial images
 inputs/
@@ -77,9 +81,6 @@ db.sqlite3-journal
 instance/
 .webassets-cache
 
-# WebUI temp files:
-img2img-tmp.png
-
 # Scrapy stuff:
 .scrapy
 
@@ -179,10 +180,22 @@ src
 **/__pycache__/
 outputs
 
-# Logs and associated folders 
+# Logs and associated folders
 # created from generated embeddings.
 logs
 testtube
 checkpoints
 # If it's a Mac
 .DS_Store
+
+# Let the frontend manage its own gitignore
+!frontend/*
+
+# Scratch folder
+.scratch/
+.vscode/
+gfpgan/
+models/ldm/stable-diffusion-v1/model.sha256
+
+# GFPGAN model files
+gfpgan/

.prettierrc.yaml

@@ -0,0 +1,13 @@
+endOfLine: lf
+tabWidth: 2
+useTabs: false
+singleQuote: true
+quoteProps: as-needed
+embeddedLanguageFormatting: auto
+overrides:
+  - files: '*.md'
+    options:
+      proseWrap: always
+      printWidth: 80
+      parser: markdown
+      cursorOffset: -1

LICENSE

@@ -1,17 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Lincoln D. Stein (https://github.com/lstein)
-
-This software is derived from a fork of the source code available from
-https://github.com/pesser/stable-diffusion and
-https://github.com/CompViz/stable-diffusion. They carry the following
-copyrights:
-
-Copyright (c) 2022 Machine Vision and Learning Group, LMU Munich
-Copyright (c) 2022 Robin Rombach and Patrick Esser and contributors
-
-Please see individual source code files for copyright and authorship
-attributions.
+Copyright (c) 2022 InvokeAI Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,165 +1,204 @@
-<h1 align='center'><b>Stable Diffusion Dream Script</b></h1>
+<div align="center">
 
-<p align='center'>
-<img src="docs/assets/logo.png"/>
-</p>
+# InvokeAI: A Stable Diffusion Toolkit
 
-<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/stars/lstein/stable-diffusion?logo=GitHub&style=for-the-badge" alt="stars"/>
-    <br>
-    <img src="https://img.shields.io/github/issues/lstein/stable-diffusion?logo=GitHub&style=for-the-badge" alt="issues"/>
-    <img src="https://img.shields.io/github/issues-pr/lstein/stable-diffusion?logo=GitHub&style=for-the-badge" alt="pull-requests"/>
-</p>
+_Formally known as lstein/stable-diffusion_
 
-# **Stable Diffusion Dream Script**
+![project logo](docs/assets/logo.png)
+
+[![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-invoke-conda.yml
+[discord badge]: https://flat.badgen.net/discord/members/ZmtBAhwWhy?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
+</div>
 
 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.
+generation process. It runs on Windows, Mac and Linux machines, with
+GPU cards with as little as 4 GB of RAM. It provides both a polished
+Web interface (see below), and an easy-to-use command-line interface.
+
+**Quick links**: [<a href="https://discord.gg/NwVCmKwY">Discord Server</a>] [<a href="https://invoke-ai.github.io/InvokeAI/">Documentation and Tutorials</a>] [<a href="https://github.com/invoke-ai/InvokeAI/">Code and Downloads</a>] [<a href="https://github.com/invoke-ai/InvokeAI/issues">Bug Reports</a>] [<a href="https://github.com/invoke-ai/InvokeAI/discussions">Discussion, Ideas & Q&A</a>]
+
+<div align="center"><img src="docs/assets/invoke-web-server-1.png" width=640></div>
+
 
 _Note: This fork is rapidly evolving. Please use the
-[Issues](https://github.com/lstein/stable-diffusion/issues) tab to
-report bugs and make feature requests. Be sure to use the provided
-templates. They will help aid diagnose issues faster._
+[Issues](https://github.com/invoke-ai/InvokeAI/issues) tab to report bugs and make feature
+requests. Be sure to use the provided templates. They will help aid diagnose issues faster._
 
-# **Table of Contents**
+## Table of Contents
 
 1. [Installation](#installation)
-2. [Major Features](#features)
-3. [Changelog](#latest-changes)
-4. [Troubleshooting](#troubleshooting)
-5. [Contributing](#contributing)
-6. [Support](#support)
+2. [Hardware Requirements](#hardware-requirements)
+3. [Features](#features)
+4. [Latest Changes](#latest-changes)
+5. [Troubleshooting](#troubleshooting)
+6. [Contributing](#contributing)
+7. [Contributors](#contributors)
+8. [Support](#support)
+9. [Further Reading](#further-reading)
 
-# 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](docs/installation/INSTALL_LINUX.md)
-- ## [Windows](docs/installation/INSTALL_WINDOWS.md)
-- ## [Macintosh](docs/installation/INSTALL_MAC.md)
+- #### [Linux](https://invoke-ai.github.io/InvokeAI/installation/INSTALL_LINUX/)
 
-## **Hardware Requirements**
+- #### [Windows](https://invoke-ai.github.io/InvokeAI/installation/INSTALL_WINDOWS/)
 
-**System**
+- #### [Macintosh](https://invoke-ai.github.io/InvokeAI/installation/INSTALL_MAC/)
+
+### Hardware Requirements
+
+#### System
 
 You wil need one of the following:
 
 - An NVIDIA-based graphics card with 4 GB or more VRAM memory.
 - An Apple computer with an M1 chip.
 
-**Memory**
+#### Memory
 
 - At least 12 GB Main Memory RAM.
 
-**Disk**
+#### Disk
 
-- At least 6 GB of free disk space for the machine learning model, Python, and all its dependencies.
+- At least 12 GB of free disk space for the machine learning model, Python, and all its dependencies.
 
 **Note**
 
-If you are have a Nvidia 10xx series card (e.g. the 1080ti), please
+If you have a Nvidia 10xx series card (e.g. the 1080ti), please
 run the dream script in full-precision mode as shown below.
 
 Similarly, specify full-precision mode on Apple M1 hardware.
 
-To run in full-precision mode, start `dream.py` with the
-`--full_precision` flag:
+Precision is auto configured based on the device. If however you encounter
+errors like 'expected type Float but found Half' or 'not implemented for Half'
+you can try starting `invoke.py` with the `--precision=float32` flag:
 
-```
-(ldm) ~/stable-diffusion$ python scripts/dream.py --full_precision
+```bash
+(invokeai) ~/InvokeAI$ python scripts/invoke.py --precision=float32
 ```
 
-# Features
+### Features
 
-## **Major Features**
+#### Major Features
 
-- ## [Interactive Command Line Interface](docs/features/CLI.md)
+- [Web Server](https://invoke-ai.github.io/InvokeAI/features/WEB/)
+- [Interactive Command Line Interface](https://invoke-ai.github.io/InvokeAI/features/CLI/)
+- [Image To Image](https://invoke-ai.github.io/InvokeAI/features/IMG2IMG/)
+- [Inpainting Support](https://invoke-ai.github.io/InvokeAI/features/INPAINTING/)
+- [Outpainting Support](https://invoke-ai.github.io/InvokeAI/features/OUTPAINTING/)
+- [Upscaling, face-restoration and outpainting](https://invoke-ai.github.io/InvokeAI/features/POSTPROCESS/)
+- [Reading Prompts From File](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#reading-prompts-from-a-file)
+- [Prompt Blending](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#prompt-blending)
+- [Thresholding and Perlin Noise Initialization Options](https://invoke-ai.github.io/InvokeAI/features/OTHER/#thresholding-and-perlin-noise-initialization-options)
+- [Negative/Unconditioned Prompts](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#negative-and-unconditioned-prompts)
+- [Variations](https://invoke-ai.github.io/InvokeAI/features/VARIATIONS/)
+- [Personalizing Text-to-Image Generation](https://invoke-ai.github.io/InvokeAI/features/TEXTUAL_INVERSION/)
+- [Simplified API for text to image generation](https://invoke-ai.github.io/InvokeAI/features/OTHER/#simplified-api)
 
-- ## [Image To Image](docs/features/IMG2IMG.md)
+#### Other Features
 
-- ## [Inpainting Support](docs/features/INPAINTING.md)
+- [Google Colab](https://invoke-ai.github.io/InvokeAI/features/OTHER/#google-colab)
+- [Seamless Tiling](https://invoke-ai.github.io/InvokeAI/features/OTHER/#seamless-tiling)
+- [Shortcut: Reusing Seeds](https://invoke-ai.github.io/InvokeAI/features/OTHER/#shortcuts-reusing-seeds)
+- [Preload Models](https://invoke-ai.github.io/InvokeAI/features/OTHER/#preload-models)
 
-- ## [GFPGAN and Real-ESRGAN Support](docs/features/UPSCALE.md)
+### Latest Changes
 
-- ## [Seamless Tiling](docs/features/OTHER.md#seamless-tiling)
+- v2.0.1 (13 October 2022)
+  - fix noisy images at high step count when using k* samplers
+  - dream.py script now calls invoke.py module directly rather than
+    via a new python process (which could break the environment)
 
-- ## [Google Colab](docs/features/OTHER.md#google-colab)
+- v2.0.0 (9 October 2022)
 
-- ## [Web Server](docs/features/WEB.md)
+  - `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains
+    for backward compatibility.
+  - Completely new WebGUI - launch with `python3 scripts/invoke.py --web`
+  - Support for <a href="https://invoke-ai.github.io/InvokeAI/features/INPAINTING/">inpainting</a> and <a href="https://invoke-ai.github.io/InvokeAI/features/OUTPAINTING/">outpainting</a>
+  - img2img runs on all k* samplers
+  - Support for <a href="https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#negative-and-unconditioned-prompts">negative prompts</a>
+  - Support for CodeFormer face reconstruction
+  - Support for Textual Inversion on Macintoshes
+  - Support in both WebGUI and CLI for <a href="https://invoke-ai.github.io/InvokeAI/features/POSTPROCESS/">post-processing of previously-generated images</a>
+    using facial reconstruction, ESRGAN upscaling, outcropping (similar to DALL-E infinite canvas),
+    and "embiggen" upscaling. See the `!fix` command.
+  - New `--hires` option on `invoke>` line allows <a href="https://invoke-ai.github.io/InvokeAI/features/CLI/#txt2img">larger images to be created without duplicating elements</a>, at the cost of some performance.
+  - New `--perlin` and `--threshold` options allow you to add and control variation
+    during image generation (see <a href="https://github.com/invoke-ai/InvokeAI/blob/main/docs/features/OTHER.md#thresholding-and-perlin-noise-initialization-options">Thresholding and Perlin Noise Initialization</a>
+  - Extensive metadata now written into PNG files, allowing reliable regeneration of images
+    and tweaking of previous settings.
+  - Command-line completion in `invoke.py` now works on Windows, Linux and Mac platforms.
+  - Improved <a href="https://invoke-ai.github.io/InvokeAI/features/CLI/">command-line completion behavior</a>.
+    New commands added:
+    - List command-line history with `!history`
+    - Search command-line history with `!search`
+    - Clear history with `!clear`
+  - Deprecated `--full_precision` / `-F`. Simply omit it and `invoke.py` will auto
+    configure. To switch away from auto use the new flag like `--precision=float32`.
 
-- ## [Reading Prompts From File](docs/features/OTHER.md#reading-prompts-from-a-file)
+For older changelogs, please visit the **[CHANGELOG](https://invoke-ai.github.io/InvokeAI/CHANGELOG#v114-11-september-2022)**.
 
-- ## [Shortcut: Reusing Seeds](docs/features/OTHER.md#shortcuts-reusing-seeds)
+### Troubleshooting
 
-- ## [Weighted Prompts](docs/features/OTHER.md#weighted-prompts)
-
-- ## [Variations](docs/features/VARIATIONS.md)
-
-- ## [Personalizing Text-to-Image Generation](docs/features/TEXTUAL_INVERSION.md)
-
-- ## [Simplified API for text to image generation](docs/features/OTHER.md#simplified-api)
-
-## **Other Features**
-
-- ### [Creating Transparent Regions for Inpainting](docs/features/INPAINTING.md#creating-transparent-regions-for-inpainting)
-
-- ### [Preload Models](docs/features/OTHER.md#preload-models)
-
-# Latest Changes
-
-- v1.14 (11 September 2022)
-
-  - Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs.
-  - 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)).
-  - Inpainting support.
-  - Improved web server GUI.
-  - Lots of code and documentation cleanups.
-
-- v1.13 (3 September 2022
-
-  - Support image variations (see [VARIATIONS](docs/features/VARIATIONS.md) ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers)
-  - Supports a Google Colab notebook for a standalone server running on Google hardware [Arturo Mendivil](https://github.com/artmen1516)
-  - 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)
-  - 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.
-  - Miscellaneous internal bug and stability fixes.
-  - Works on M1 Apple hardware.
-  - Multiple bug fixes.
-
-For older changelogs, please visit **[CHANGELOGS](docs/CHANGELOG.md)**.
-
-# Troubleshooting
-
-Please check out our **[Q&A](docs/help/TROUBLESHOOT.md)** to get solutions for common installation problems and other issues.
+Please check out our **[Q&A](https://invoke-ai.github.io/InvokeAI/help/TROUBLESHOOT/#faq)** to get solutions for common installation
+problems and other issues.
 
 # 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
-how to contribute to GitHub projects, here is a [Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github).
+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 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](docs/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](https://invoke-ai.github.io/InvokeAI/other/CONTRIBUTORS/). We thank them for
+their time, hard work and effort.
 
-# Support
+### Support
 
-For support,
-please use this repository's GitHub Issues tracking service. Feel free
-to send me an email if you use and like the script.
+For support, please use this repository's GitHub Issues tracking service. Feel free 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
-and underlying algorithm, located in the file [README-CompViz.md](docs/README-CompViz.md).
+Please see the original README for more information on this software and underlying algorithm,
+located in the file [README-CompViz.md](https://invoke-ai.github.io/InvokeAI/other/README-CompViz/).

backend/modules/create_cmd_parser.py

@@ -0,0 +1,55 @@
+import argparse
+import os
+from ldm.invoke.args import PRECISION_CHOICES
+
+
+def create_cmd_parser():
+    parser = argparse.ArgumentParser(description="InvokeAI web UI")
+    parser.add_argument(
+        "--host",
+        type=str,
+        help="The host to serve on",
+        default="localhost",
+    )
+    parser.add_argument("--port", type=int, help="The port to serve on", default=9090)
+    parser.add_argument(
+        "--cors",
+        nargs="*",
+        type=str,
+        help="Additional allowed origins, comma-separated",
+    )
+    parser.add_argument(
+        "--embedding_path",
+        type=str,
+        help="Path to a pre-trained embedding manager checkpoint - can only be set on command line",
+    )
+    # TODO: Can't get flask to serve images from any dir (saving to the dir does work when specified)
+    # parser.add_argument(
+    #     "--output_dir",
+    #     default="outputs/",
+    #     type=str,
+    #     help="Directory for output images",
+    # )
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        action="store_true",
+        help="Enables verbose logging",
+    )
+    parser.add_argument(
+        "--precision",
+        dest="precision",
+        type=str,
+        choices=PRECISION_CHOICES,
+        metavar="PRECISION",
+        help=f'Set model precision. Defaults to auto selected based on device. Options: {", ".join(PRECISION_CHOICES)}',
+        default="auto",
+    )
+    parser.add_argument(
+        '--free_gpu_mem',
+        dest='free_gpu_mem',
+        action='store_true',
+        help='Force free gpu memory before final decoding',
+    )
+
+    return parser

backend/modules/parameters.py

@@ -0,0 +1,69 @@
+from backend.modules.parse_seed_weights import parse_seed_weights
+import argparse
+
+SAMPLER_CHOICES = [
+    "ddim",
+    "k_dpm_2_a",
+    "k_dpm_2",
+    "k_euler_a",
+    "k_euler",
+    "k_heun",
+    "k_lms",
+    "plms",
+]
+
+
+def parameters_to_command(params):
+    """
+    Converts dict of parameters into a `invoke.py` REPL command.
+    """
+
+    switches = list()
+
+    if "prompt" in params:
+        switches.append(f'"{params["prompt"]}"')
+    if "steps" in params:
+        switches.append(f'-s {params["steps"]}')
+    if "seed" in params:
+        switches.append(f'-S {params["seed"]}')
+    if "width" in params:
+        switches.append(f'-W {params["width"]}')
+    if "height" in params:
+        switches.append(f'-H {params["height"]}')
+    if "cfg_scale" in params:
+        switches.append(f'-C {params["cfg_scale"]}')
+    if "sampler_name" in params:
+        switches.append(f'-A {params["sampler_name"]}')
+    if "seamless" in params and params["seamless"] == True:
+        switches.append(f"--seamless")
+    if "hires_fix" in params and params["hires_fix"] == True:
+        switches.append(f"--hires")
+    if "init_img" in params and len(params["init_img"]) > 0:
+        switches.append(f'-I {params["init_img"]}')
+    if "init_mask" in params and len(params["init_mask"]) > 0:
+        switches.append(f'-M {params["init_mask"]}')
+    if "init_color" in params and len(params["init_color"]) > 0:
+        switches.append(f'--init_color {params["init_color"]}')
+    if "strength" in params and "init_img" in params:
+        switches.append(f'-f {params["strength"]}')
+        if "fit" in params and params["fit"] == True:
+            switches.append(f"--fit")
+    if "facetool" in params:
+        switches.append(f'-ft {params["facetool"]}')
+    if "facetool_strength" in params and params["facetool_strength"]:
+        switches.append(f'-G {params["facetool_strength"]}')
+    elif "gfpgan_strength" in params and params["gfpgan_strength"]:
+        switches.append(f'-G {params["gfpgan_strength"]}')
+    if "codeformer_fidelity" in params:
+        switches.append(f'-cf {params["codeformer_fidelity"]}')
+    if "upscale" in params and params["upscale"]:
+        switches.append(f'-U {params["upscale"][0]} {params["upscale"][1]}')
+    if "variation_amount" in params and params["variation_amount"] > 0:
+        switches.append(f'-v {params["variation_amount"]}')
+        if "with_variations" in params:
+            seed_weight_pairs = ",".join(
+                f"{seed}:{weight}" for seed, weight in params["with_variations"]
+            )
+            switches.append(f"-V {seed_weight_pairs}")
+
+    return " ".join(switches)

backend/modules/parse_seed_weights.py

@@ -0,0 +1,47 @@
+def parse_seed_weights(seed_weights):
+    """
+    Accepts seed weights as string in "12345:0.1,23456:0.2,3456:0.3" format
+    Validates them
+    If valid: returns as [[12345, 0.1], [23456, 0.2], [3456, 0.3]]
+    If invalid: returns False
+    """
+
+    # Must be a string
+    if not isinstance(seed_weights, str):
+        return False
+    # String must not be empty
+    if len(seed_weights) == 0:
+        return False
+
+    pairs = []
+
+    for pair in seed_weights.split(","):
+        split_values = pair.split(":")
+
+        # Seed and weight are required
+        if len(split_values) != 2:
+            return False
+
+        if len(split_values[0]) == 0 or len(split_values[1]) == 1:
+            return False
+
+        # Try casting the seed to int and weight to float
+        try:
+            seed = int(split_values[0])
+            weight = float(split_values[1])
+        except ValueError:
+            return False
+
+        # Seed must be 0 or above
+        if not seed >= 0:
+            return False
+
+        # Weight must be between 0 and 1
+        if not (weight >= 0 and weight <= 1):
+            return False
+
+        # This pair is valid
+        pairs.append([seed, weight])
+
+    # All pairs are valid
+    return pairs

backend/server.py

@@ -0,0 +1,822 @@
+import mimetypes
+import transformers
+import json
+import os
+import traceback
+import eventlet
+import glob
+import shlex
+import math
+import shutil
+import sys
+
+sys.path.append(".")
+
+from argparse import ArgumentTypeError
+from modules.create_cmd_parser import create_cmd_parser
+
+parser = create_cmd_parser()
+opt = parser.parse_args()
+
+
+from flask_socketio import SocketIO
+from flask import Flask, send_from_directory, url_for, jsonify
+from pathlib import Path
+from PIL import Image
+from pytorch_lightning import logging
+from threading import Event
+from uuid import uuid4
+from send2trash import send2trash
+
+
+from ldm.generate import Generate
+from ldm.invoke.restoration import Restoration
+from ldm.invoke.pngwriter import PngWriter, retrieve_metadata
+from ldm.invoke.args import APP_ID, APP_VERSION, calculate_init_img_hash
+from ldm.invoke.conditioning import split_weighted_subprompts
+
+from modules.parameters import parameters_to_command
+
+
+"""
+USER CONFIG
+"""
+if opt.cors and "*" in opt.cors:
+    raise ArgumentTypeError('"*" is not an allowed CORS origin')
+
+
+output_dir = "outputs/"  # Base output directory for images
+host = opt.host  # Web & socket.io host
+port = opt.port  # Web & socket.io port
+verbose = opt.verbose  # enables copious socket.io logging
+precision = opt.precision
+free_gpu_mem = opt.free_gpu_mem
+embedding_path = opt.embedding_path
+additional_allowed_origins = (
+    opt.cors if opt.cors else []
+)  # additional CORS allowed origins
+model = "stable-diffusion-1.4"
+
+"""
+END USER CONFIG
+"""
+
+
+print("* Initializing, be patient...\n")
+
+
+"""
+SERVER SETUP
+"""
+
+
+# fix missing mimetypes on windows due to registry wonkiness
+mimetypes.add_type("application/javascript", ".js")
+mimetypes.add_type("text/css", ".css")
+
+app = Flask(__name__, static_url_path="", static_folder="../frontend/dist/")
+
+
+app.config["OUTPUTS_FOLDER"] = "../outputs"
+
+
+@app.route("/outputs/<path:filename>")
+def outputs(filename):
+    return send_from_directory(app.config["OUTPUTS_FOLDER"], filename)
+
+
+@app.route("/", defaults={"path": ""})
+def serve(path):
+    return send_from_directory(app.static_folder, "index.html")
+
+
+logger = True if verbose else False
+engineio_logger = True if verbose else False
+
+# default 1,000,000, needs to be higher for socketio to accept larger images
+max_http_buffer_size = 10000000
+
+cors_allowed_origins = [f"http://{host}:{port}"] + additional_allowed_origins
+
+socketio = SocketIO(
+    app,
+    logger=logger,
+    engineio_logger=engineio_logger,
+    max_http_buffer_size=max_http_buffer_size,
+    cors_allowed_origins=cors_allowed_origins,
+    ping_interval=(50, 50),
+    ping_timeout=60,
+)
+
+
+"""
+END SERVER SETUP
+"""
+
+
+"""
+APP SETUP
+"""
+
+
+class CanceledException(Exception):
+    pass
+
+
+try:
+    gfpgan, codeformer, esrgan = None, None, None
+    from ldm.invoke.restoration.base import Restoration
+
+    restoration = Restoration()
+    gfpgan, codeformer = restoration.load_face_restore_models()
+    esrgan = restoration.load_esrgan()
+
+    # coreformer.process(self, image, strength, device, seed=None, fidelity=0.75)
+
+except (ModuleNotFoundError, ImportError):
+    print(traceback.format_exc(), file=sys.stderr)
+    print(">> You may need to install the ESRGAN and/or GFPGAN modules")
+
+canceled = Event()
+
+# reduce logging outputs to error
+transformers.logging.set_verbosity_error()
+logging.getLogger("pytorch_lightning").setLevel(logging.ERROR)
+
+# Initialize and load model
+generate = Generate(
+    model,
+    precision=precision,
+    embedding_path=embedding_path,
+)
+generate.free_gpu_mem = free_gpu_mem
+generate.load_model()
+
+
+# location for "finished" images
+result_path = os.path.join(output_dir, "img-samples/")
+
+# temporary path for intermediates
+intermediate_path = os.path.join(result_path, "intermediates/")
+
+# path for user-uploaded init images and masks
+init_image_path = os.path.join(result_path, "init-images/")
+mask_image_path = os.path.join(result_path, "mask-images/")
+
+# txt log
+log_path = os.path.join(result_path, "invoke_log.txt")
+
+# make all output paths
+[
+    os.makedirs(path, exist_ok=True)
+    for path in [result_path, intermediate_path, init_image_path, mask_image_path]
+]
+
+
+"""
+END APP SETUP
+"""
+
+
+"""
+SOCKET.IO LISTENERS
+"""
+
+
+@socketio.on("requestSystemConfig")
+def handle_request_capabilities():
+    print(f">> System config requested")
+    config = get_system_config()
+    socketio.emit("systemConfig", config)
+
+
+@socketio.on("requestImages")
+def handle_request_images(page=1, offset=0, last_mtime=None):
+    chunk_size = 50
+
+    if last_mtime:
+        print(f">> Latest images requested")
+    else:
+        print(
+            f">> Page {page} of images requested (page size {chunk_size} offset {offset})"
+        )
+
+    paths = glob.glob(os.path.join(result_path, "*.png"))
+    sorted_paths = sorted(paths, key=lambda x: os.path.getmtime(x), reverse=True)
+
+    if last_mtime:
+        image_paths = filter(lambda x: os.path.getmtime(x) > last_mtime, sorted_paths)
+    else:
+
+        image_paths = sorted_paths[
+            slice(chunk_size * (page - 1) + offset, chunk_size * page + offset)
+        ]
+        page = page + 1
+
+    image_array = []
+
+    for path in image_paths:
+        metadata = retrieve_metadata(path)
+        image_array.append(
+            {
+                "url": path,
+                "mtime": os.path.getmtime(path),
+                "metadata": metadata["sd-metadata"],
+            }
+        )
+
+    socketio.emit(
+        "galleryImages",
+        {
+            "images": image_array,
+            "nextPage": page,
+            "offset": offset,
+            "onlyNewImages": True if last_mtime else False,
+        },
+    )
+
+
+@socketio.on("generateImage")
+def handle_generate_image_event(
+    generation_parameters, esrgan_parameters, gfpgan_parameters
+):
+    print(
+        f">> Image generation requested: {generation_parameters}\nESRGAN parameters: {esrgan_parameters}\nGFPGAN parameters: {gfpgan_parameters}"
+    )
+    generate_images(generation_parameters, esrgan_parameters, gfpgan_parameters)
+
+
+@socketio.on("runESRGAN")
+def handle_run_esrgan_event(original_image, esrgan_parameters):
+    print(
+        f'>> ESRGAN upscale requested for "{original_image["url"]}": {esrgan_parameters}'
+    )
+    progress = {
+        "currentStep": 1,
+        "totalSteps": 1,
+        "currentIteration": 1,
+        "totalIterations": 1,
+        "currentStatus": "Preparing",
+        "isProcessing": True,
+        "currentStatusHasSteps": False,
+    }
+
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    image = Image.open(original_image["url"])
+
+    seed = (
+        original_image["metadata"]["seed"]
+        if "seed" in original_image["metadata"]
+        else "unknown_seed"
+    )
+
+    progress["currentStatus"] = "Upscaling"
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    image = esrgan.process(
+        image=image,
+        upsampler_scale=esrgan_parameters["upscale"][0],
+        strength=esrgan_parameters["upscale"][1],
+        seed=seed,
+    )
+
+    progress["currentStatus"] = "Saving image"
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    esrgan_parameters["seed"] = seed
+    metadata = parameters_to_post_processed_image_metadata(
+        parameters=esrgan_parameters,
+        original_image_path=original_image["url"],
+        type="esrgan",
+    )
+    command = parameters_to_command(esrgan_parameters)
+
+    path = save_image(image, command, metadata, result_path, postprocessing="esrgan")
+
+    write_log_message(f'[Upscaled] "{original_image["url"]}" > "{path}": {command}')
+
+    progress["currentStatus"] = "Finished"
+    progress["currentStep"] = 0
+    progress["totalSteps"] = 0
+    progress["currentIteration"] = 0
+    progress["totalIterations"] = 0
+    progress["isProcessing"] = False
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    socketio.emit(
+        "esrganResult",
+        {
+            "url": os.path.relpath(path),
+            "mtime": os.path.getmtime(path),
+            "metadata": metadata,
+        },
+    )
+
+
+@socketio.on("runGFPGAN")
+def handle_run_gfpgan_event(original_image, gfpgan_parameters):
+    print(
+        f'>> GFPGAN face fix requested for "{original_image["url"]}": {gfpgan_parameters}'
+    )
+    progress = {
+        "currentStep": 1,
+        "totalSteps": 1,
+        "currentIteration": 1,
+        "totalIterations": 1,
+        "currentStatus": "Preparing",
+        "isProcessing": True,
+        "currentStatusHasSteps": False,
+    }
+
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    image = Image.open(original_image["url"])
+
+    seed = (
+        original_image["metadata"]["seed"]
+        if "seed" in original_image["metadata"]
+        else "unknown_seed"
+    )
+
+    progress["currentStatus"] = "Fixing faces"
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    image = gfpgan.process(
+        image=image, strength=gfpgan_parameters["facetool_strength"], seed=seed
+    )
+
+    progress["currentStatus"] = "Saving image"
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    gfpgan_parameters["seed"] = seed
+    metadata = parameters_to_post_processed_image_metadata(
+        parameters=gfpgan_parameters,
+        original_image_path=original_image["url"],
+        type="gfpgan",
+    )
+    command = parameters_to_command(gfpgan_parameters)
+
+    path = save_image(image, command, metadata, result_path, postprocessing="gfpgan")
+
+    write_log_message(f'[Fixed faces] "{original_image["url"]}" > "{path}": {command}')
+
+    progress["currentStatus"] = "Finished"
+    progress["currentStep"] = 0
+    progress["totalSteps"] = 0
+    progress["currentIteration"] = 0
+    progress["totalIterations"] = 0
+    progress["isProcessing"] = False
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    socketio.emit(
+        "gfpganResult",
+        {
+            "url": os.path.relpath(path),
+            "mtime": os.path.mtime(path),
+            "metadata": metadata,
+        },
+    )
+
+
+@socketio.on("cancel")
+def handle_cancel():
+    print(f">> Cancel processing requested")
+    canceled.set()
+    socketio.emit("processingCanceled")
+
+
+# TODO: I think this needs a safety mechanism.
+@socketio.on("deleteImage")
+def handle_delete_image(path, uuid):
+    print(f'>> Delete requested "{path}"')
+    send2trash(path)
+    socketio.emit("imageDeleted", {"url": path, "uuid": uuid})
+
+
+# TODO: I think this needs a safety mechanism.
+@socketio.on("uploadInitialImage")
+def handle_upload_initial_image(bytes, name):
+    print(f'>> Init image upload requested "{name}"')
+    uuid = uuid4().hex
+    split = os.path.splitext(name)
+    name = f"{split[0]}.{uuid}{split[1]}"
+    file_path = os.path.join(init_image_path, name)
+    os.makedirs(os.path.dirname(file_path), exist_ok=True)
+    newFile = open(file_path, "wb")
+    newFile.write(bytes)
+    socketio.emit("initialImageUploaded", {"url": file_path, "uuid": ""})
+
+
+# TODO: I think this needs a safety mechanism.
+@socketio.on("uploadMaskImage")
+def handle_upload_mask_image(bytes, name):
+    print(f'>> Mask image upload requested "{name}"')
+    uuid = uuid4().hex
+    split = os.path.splitext(name)
+    name = f"{split[0]}.{uuid}{split[1]}"
+    file_path = os.path.join(mask_image_path, name)
+    os.makedirs(os.path.dirname(file_path), exist_ok=True)
+    newFile = open(file_path, "wb")
+    newFile.write(bytes)
+    socketio.emit("maskImageUploaded", {"url": file_path, "uuid": ""})
+
+
+"""
+END SOCKET.IO LISTENERS
+"""
+
+
+"""
+ADDITIONAL FUNCTIONS
+"""
+
+
+def get_system_config():
+    return {
+        "model": "stable diffusion",
+        "model_id": model,
+        "model_hash": generate.model_hash,
+        "app_id": APP_ID,
+        "app_version": APP_VERSION,
+    }
+
+
+def parameters_to_post_processed_image_metadata(parameters, original_image_path, type):
+    # top-level metadata minus `image` or `images`
+    metadata = get_system_config()
+
+    orig_hash = calculate_init_img_hash(original_image_path)
+
+    image = {"orig_path": original_image_path, "orig_hash": orig_hash}
+
+    if type == "esrgan":
+        image["type"] = "esrgan"
+        image["scale"] = parameters["upscale"][0]
+        image["strength"] = parameters["upscale"][1]
+    elif type == "gfpgan":
+        image["type"] = "gfpgan"
+        image["strength"] = parameters["facetool_strength"]
+    else:
+        raise TypeError(f"Invalid type: {type}")
+
+    metadata["image"] = image
+    return metadata
+
+
+def parameters_to_generated_image_metadata(parameters):
+    # top-level metadata minus `image` or `images`
+
+    metadata = get_system_config()
+    # remove any image keys not mentioned in RFC #266
+    rfc266_img_fields = [
+        "type",
+        "postprocessing",
+        "sampler",
+        "prompt",
+        "seed",
+        "variations",
+        "steps",
+        "cfg_scale",
+        "threshold",
+        "perlin",
+        "step_number",
+        "width",
+        "height",
+        "extra",
+        "seamless",
+        "hires_fix",
+    ]
+
+    rfc_dict = {}
+
+    for item in parameters.items():
+        key, value = item
+        if key in rfc266_img_fields:
+            rfc_dict[key] = value
+
+    postprocessing = []
+
+    # 'postprocessing' is either null or an
+    if "facetool_strength" in parameters:
+
+        postprocessing.append(
+            {"type": "gfpgan", "strength": float(parameters["facetool_strength"])}
+        )
+
+    if "upscale" in parameters:
+        postprocessing.append(
+            {
+                "type": "esrgan",
+                "scale": int(parameters["upscale"][0]),
+                "strength": float(parameters["upscale"][1]),
+            }
+        )
+
+    rfc_dict["postprocessing"] = postprocessing if len(postprocessing) > 0 else None
+
+    # semantic drift
+    rfc_dict["sampler"] = parameters["sampler_name"]
+
+    # display weighted subprompts (liable to change)
+    subprompts = split_weighted_subprompts(parameters["prompt"])
+    subprompts = [{"prompt": x[0], "weight": x[1]} for x in subprompts]
+    rfc_dict["prompt"] = subprompts
+
+    # 'variations' should always exist and be an array, empty or consisting of {'seed': seed, 'weight': weight} pairs
+    variations = []
+
+    if "with_variations" in parameters:
+        variations = [
+            {"seed": x[0], "weight": x[1]} for x in parameters["with_variations"]
+        ]
+
+    rfc_dict["variations"] = variations
+
+    if "init_img" in parameters:
+        rfc_dict["type"] = "img2img"
+        rfc_dict["strength"] = parameters["strength"]
+        rfc_dict["fit"] = parameters["fit"]  # TODO: Noncompliant
+        rfc_dict["orig_hash"] = calculate_init_img_hash(parameters["init_img"])
+        rfc_dict["init_image_path"] = parameters["init_img"]  # TODO: Noncompliant
+        rfc_dict["sampler"] = "ddim"  # TODO: FIX ME WHEN IMG2IMG SUPPORTS ALL SAMPLERS
+        if "init_mask" in parameters:
+            rfc_dict["mask_hash"] = calculate_init_img_hash(
+                parameters["init_mask"]
+            )  # TODO: Noncompliant
+            rfc_dict["mask_image_path"] = parameters["init_mask"]  # TODO: Noncompliant
+    else:
+        rfc_dict["type"] = "txt2img"
+
+    metadata["image"] = rfc_dict
+
+    return metadata
+
+
+def make_unique_init_image_filename(name):
+    uuid = uuid4().hex
+    split = os.path.splitext(name)
+    name = f"{split[0]}.{uuid}{split[1]}"
+    return name
+
+
+def write_log_message(message, log_path=log_path):
+    """Logs the filename and parameters used to generate or process that image to log file"""
+    message = f"{message}\n"
+    with open(log_path, "a", encoding="utf-8") as file:
+        file.writelines(message)
+
+
+def save_image(
+    image, command, metadata, output_dir, step_index=None, postprocessing=False
+):
+    pngwriter = PngWriter(output_dir)
+    prefix = pngwriter.unique_prefix()
+
+    seed = "unknown_seed"
+
+    if "image" in metadata:
+        if "seed" in metadata["image"]:
+            seed = metadata["image"]["seed"]
+
+    filename = f"{prefix}.{seed}"
+
+    if step_index:
+        filename += f".{step_index}"
+    if postprocessing:
+        filename += f".postprocessed"
+
+    filename += ".png"
+
+    path = pngwriter.save_image_and_prompt_to_png(
+        image=image, dream_prompt=command, metadata=metadata, name=filename
+    )
+
+    return path
+
+
+def calculate_real_steps(steps, strength, has_init_image):
+    return math.floor(strength * steps) if has_init_image else steps
+
+
+def generate_images(generation_parameters, esrgan_parameters, gfpgan_parameters):
+    canceled.clear()
+
+    step_index = 1
+    prior_variations = (
+        generation_parameters["with_variations"]
+        if "with_variations" in generation_parameters
+        else []
+    )
+    """
+    If a result image is used as an init image, and then deleted, we will want to be
+    able to use it as an init image in the future. Need to copy it.
+
+    If the init/mask image doesn't exist in the init_image_path/mask_image_path,
+    make a unique filename for it and copy it there.
+    """
+    if "init_img" in generation_parameters:
+        filename = os.path.basename(generation_parameters["init_img"])
+        if not os.path.exists(os.path.join(init_image_path, filename)):
+            unique_filename = make_unique_init_image_filename(filename)
+            new_path = os.path.join(init_image_path, unique_filename)
+            shutil.copy(generation_parameters["init_img"], new_path)
+            generation_parameters["init_img"] = new_path
+        if "init_mask" in generation_parameters:
+            filename = os.path.basename(generation_parameters["init_mask"])
+            if not os.path.exists(os.path.join(mask_image_path, filename)):
+                unique_filename = make_unique_init_image_filename(filename)
+                new_path = os.path.join(init_image_path, unique_filename)
+                shutil.copy(generation_parameters["init_img"], new_path)
+                generation_parameters["init_mask"] = new_path
+
+    totalSteps = calculate_real_steps(
+        steps=generation_parameters["steps"],
+        strength=generation_parameters["strength"]
+        if "strength" in generation_parameters
+        else None,
+        has_init_image="init_img" in generation_parameters,
+    )
+
+    progress = {
+        "currentStep": 1,
+        "totalSteps": totalSteps,
+        "currentIteration": 1,
+        "totalIterations": generation_parameters["iterations"],
+        "currentStatus": "Preparing",
+        "isProcessing": True,
+        "currentStatusHasSteps": False,
+    }
+
+    socketio.emit("progressUpdate", progress)
+    eventlet.sleep(0)
+
+    def image_progress(sample, step):
+        if canceled.is_set():
+            raise CanceledException
+
+        nonlocal step_index
+        nonlocal generation_parameters
+        nonlocal progress
+
+        progress["currentStep"] = step + 1
+        progress["currentStatus"] = "Generating"
+        progress["currentStatusHasSteps"] = True
+
+        if (
+            generation_parameters["progress_images"]
+            and step % 5 == 0
+            and step < generation_parameters["steps"] - 1
+        ):
+            image = generate.sample_to_image(sample)
+
+            metadata = parameters_to_generated_image_metadata(generation_parameters)
+            command = parameters_to_command(generation_parameters)
+            path = save_image(image, command, metadata, intermediate_path, step_index=step_index, postprocessing=False)
+
+            step_index += 1
+            socketio.emit(
+                "intermediateResult",
+                {
+                    "url": os.path.relpath(path),
+                    "mtime": os.path.getmtime(path),
+                    "metadata": metadata,
+                },
+            )
+        socketio.emit("progressUpdate", progress)
+        eventlet.sleep(0)
+
+    def image_done(image, seed, first_seed):
+        nonlocal generation_parameters
+        nonlocal esrgan_parameters
+        nonlocal gfpgan_parameters
+        nonlocal progress
+
+        step_index = 1
+        nonlocal prior_variations
+
+        progress["currentStatus"] = "Generation complete"
+        socketio.emit("progressUpdate", progress)
+        eventlet.sleep(0)
+
+        all_parameters = generation_parameters
+        postprocessing = False
+
+        if (
+            "variation_amount" in all_parameters
+            and all_parameters["variation_amount"] > 0
+        ):
+            first_seed = first_seed or seed
+            this_variation = [[seed, all_parameters["variation_amount"]]]
+            all_parameters["with_variations"] = prior_variations + this_variation
+            all_parameters["seed"] = first_seed
+        elif ("with_variations" in all_parameters):
+            all_parameters["seed"] = first_seed
+        else:
+            all_parameters["seed"] = seed
+
+        if esrgan_parameters:
+            progress["currentStatus"] = "Upscaling"
+            progress["currentStatusHasSteps"] = False
+            socketio.emit("progressUpdate", progress)
+            eventlet.sleep(0)
+
+            image = esrgan.process(
+                image=image,
+                upsampler_scale=esrgan_parameters["level"],
+                strength=esrgan_parameters["strength"],
+                seed=seed,
+            )
+
+            postprocessing = True
+            all_parameters["upscale"] = [
+                esrgan_parameters["level"],
+                esrgan_parameters["strength"],
+            ]
+
+        if gfpgan_parameters:
+            progress["currentStatus"] = "Fixing faces"
+            progress["currentStatusHasSteps"] = False
+            socketio.emit("progressUpdate", progress)
+            eventlet.sleep(0)
+
+            image = gfpgan.process(
+                image=image, strength=gfpgan_parameters["strength"], seed=seed
+            )
+            postprocessing = True
+            all_parameters["facetool_strength"] = gfpgan_parameters["strength"]
+
+        progress["currentStatus"] = "Saving image"
+        socketio.emit("progressUpdate", progress)
+        eventlet.sleep(0)
+
+        metadata = parameters_to_generated_image_metadata(all_parameters)
+        command = parameters_to_command(all_parameters)
+
+        path = save_image(
+            image, command, metadata, result_path, postprocessing=postprocessing
+        )
+
+        print(f'>> Image generated: "{path}"')
+        write_log_message(f'[Generated] "{path}": {command}')
+
+        if progress["totalIterations"] > progress["currentIteration"]:
+            progress["currentStep"] = 1
+            progress["currentIteration"] += 1
+            progress["currentStatus"] = "Iteration finished"
+            progress["currentStatusHasSteps"] = False
+        else:
+            progress["currentStep"] = 0
+            progress["totalSteps"] = 0
+            progress["currentIteration"] = 0
+            progress["totalIterations"] = 0
+            progress["currentStatus"] = "Finished"
+            progress["isProcessing"] = False
+
+        socketio.emit("progressUpdate", progress)
+        eventlet.sleep(0)
+
+        socketio.emit(
+            "generationResult",
+            {
+                "url": os.path.relpath(path),
+                "mtime": os.path.getmtime(path),
+                "metadata": metadata,
+            },
+        )
+        eventlet.sleep(0)
+
+    try:
+        generate.prompt2image(
+            **generation_parameters,
+            step_callback=image_progress,
+            image_callback=image_done,
+        )
+
+    except KeyboardInterrupt:
+        raise
+    except CanceledException:
+        pass
+    except Exception as e:
+        socketio.emit("error", {"message": (str(e))})
+        print("\n")
+        traceback.print_exc()
+        print("\n")
+
+
+"""
+END ADDITIONAL FUNCTIONS
+"""
+
+
+if __name__ == "__main__":
+    print(f">> Starting server at http://{host}:{port}")
+    socketio.run(app, host=host, port=port)

configs/models.yaml

@@ -9,10 +9,12 @@
 laion400m:
     config:  configs/latent-diffusion/txt2img-1p4B-eval.yaml
     weights: models/ldm/text2img-large/model.ckpt
+    description: Latent Diffusion LAION400M model
     width: 256
     height: 256
 stable-diffusion-1.4:
     config:  configs/stable-diffusion/v1-inference.yaml
     weights: models/ldm/stable-diffusion-v1/model.ckpt
+    description: Stable Diffusion inference model version 1.4
     width: 512
     height: 512

configs/stable-diffusion/v1-finetune.yaml

@@ -107,4 +107,4 @@ lightning:
     benchmark: True
     max_steps: 4000000
 #    max_steps: 4000
-    
+    

configs/stable-diffusion/v1-inference.yaml

@@ -30,7 +30,7 @@ model:
       target: ldm.modules.embedding_manager.EmbeddingManager
       params:
         placeholder_strings: ["*"]
-        initializer_words: ["sculpture"]
+        initializer_words: ['face', 'man', 'photo', 'africanmale']
         per_image_tokens: false
         num_vectors_per_token: 1
         progressive_words: False

configs/stable-diffusion/v1-m1-finetune.yaml

@@ -0,0 +1,110 @@
+model:
+  base_learning_rate: 5.0e-03
+  target: ldm.models.diffusion.ddpm.LatentDiffusion
+  params:
+    linear_start: 0.00085
+    linear_end: 0.0120
+    num_timesteps_cond: 1
+    log_every_t: 200
+    timesteps: 1000
+    first_stage_key: image
+    cond_stage_key: caption
+    image_size: 64
+    channels: 4
+    cond_stage_trainable: true   # Note: different from the one we trained before
+    conditioning_key: crossattn
+    monitor: val/loss_simple_ema
+    scale_factor: 0.18215
+    use_ema: False
+    embedding_reg_weight: 0.0
+
+    personalization_config:
+      target: ldm.modules.embedding_manager.EmbeddingManager
+      params:
+        placeholder_strings: ["*"]
+        initializer_words: ['face', 'man', 'photo', 'africanmale']
+        per_image_tokens: false
+        num_vectors_per_token: 6
+        progressive_words: False
+
+    unet_config:
+      target: ldm.modules.diffusionmodules.openaimodel.UNetModel
+      params:
+        image_size: 32 # unused
+        in_channels: 4
+        out_channels: 4
+        model_channels: 320
+        attention_resolutions: [ 4, 2, 1 ]
+        num_res_blocks: 2
+        channel_mult: [ 1, 2, 4, 4 ]
+        num_heads: 8
+        use_spatial_transformer: True
+        transformer_depth: 1
+        context_dim: 768
+        use_checkpoint: True
+        legacy: False
+
+    first_stage_config:
+      target: ldm.models.autoencoder.AutoencoderKL
+      params:
+        embed_dim: 4
+        monitor: val/rec_loss
+        ddconfig:
+          double_z: true
+          z_channels: 4
+          resolution: 256
+          in_channels: 3
+          out_ch: 3
+          ch: 128
+          ch_mult:
+          - 1
+          - 2
+          - 4
+          - 4
+          num_res_blocks: 2
+          attn_resolutions: []
+          dropout: 0.0
+        lossconfig:
+          target: torch.nn.Identity
+
+    cond_stage_config:
+      target: ldm.modules.encoders.modules.FrozenCLIPEmbedder
+
+data:
+  target: main.DataModuleFromConfig
+  params:
+    batch_size: 1
+    num_workers: 2
+    wrap: false
+    train:
+      target: ldm.data.personalized.PersonalizedBase
+      params:
+        size: 512
+        set: train
+        per_image_tokens: false
+        repeats: 100
+    validation:
+      target: ldm.data.personalized.PersonalizedBase
+      params:
+        size: 512
+        set: val
+        per_image_tokens: false
+        repeats: 10
+
+lightning:
+  modelcheckpoint:
+    params:
+      every_n_train_steps: 500
+  callbacks:
+    image_logger:
+      target: main.ImageLogger
+      params:
+        batch_frequency: 500
+        max_images: 5
+        increase_log_steps: False
+
+  trainer:
+    benchmark: False
+    max_steps: 6200
+#    max_steps: 4000
+    

docker-build/Dockerfile

@@ -0,0 +1,57 @@
+FROM        debian 
+
+ARG         gsd
+ENV         GITHUB_STABLE_DIFFUSION $gsd
+
+ARG         rsd
+ENV         REQS $rsd
+
+ARG         cs
+ENV         CONDA_SUBDIR $cs
+
+ENV         PIP_EXISTS_ACTION="w"
+
+# TODO: Optimize image size
+
+SHELL       ["/bin/bash", "-c"]
+
+WORKDIR     /
+RUN         apt update && apt upgrade -y \
+            && apt install -y \
+            git \
+            libgl1-mesa-glx \
+            libglib2.0-0 \
+            pip \
+            python3 \
+            && git clone $GITHUB_STABLE_DIFFUSION
+
+# Install Anaconda or Miniconda
+COPY        anaconda.sh .
+RUN         bash anaconda.sh -b -u -p /anaconda && /anaconda/bin/conda init bash
+
+# SD 
+WORKDIR     /stable-diffusion 
+RUN         source ~/.bashrc \
+            && conda create -y --name ldm && conda activate ldm \
+            && conda config --env --set subdir $CONDA_SUBDIR \
+            && pip3 install -r $REQS \   
+            && pip3 install basicsr facexlib realesrgan \          
+            && mkdir models/ldm/stable-diffusion-v1 \
+            && ln -s "/data/sd-v1-4.ckpt" models/ldm/stable-diffusion-v1/model.ckpt 
+
+# Face restoreation
+# by default expected in a sibling directory to stable-diffusion
+WORKDIR     /       
+RUN         git clone https://github.com/TencentARC/GFPGAN.git 
+
+WORKDIR     /GFPGAN 
+RUN         pip3 install -r requirements.txt \
+            && python3 setup.py develop \
+            && ln -s "/data/GFPGANv1.4.pth" experiments/pretrained_models/GFPGANv1.4.pth
+
+WORKDIR     /stable-diffusion 
+RUN         python3 scripts/preload_models.py         
+
+WORKDIR     /
+COPY        entrypoint.sh .
+ENTRYPOINT ["/entrypoint.sh"]

docker-build/entrypoint.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+cd /stable-diffusion
+
+if [ $# -eq 0 ]; then
+    python3 scripts/dream.py --full_precision -o /data
+    # bash
+else
+    python3 scripts/dream.py --full_precision -o /data "$@"
+fi

docs/CHANGELOG.md

@@ -1,51 +1,106 @@
-# **Changelog**
+---
+title: Changelog
+---
 
-## v1.13 (in process)
+# :octicons-log-16: **Changelog**
 
-- Supports a Google Colab notebook for a standalone server running on Google hardware [Arturo Mendivil](https://github.com/artmen1516)
-- 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.
-- 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.
+## v2.0.1 (13 October 2022)
+
+- fix noisy images at high step count when using k* samplers
+- dream.py script now calls invoke.py module directly rather than
+    via a new python process (which could break the environment)
+
+## v2.0.0 <small>(9 October 2022)</small>
+
+- `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains
+    for backward compatibility.
+- Completely new WebGUI - launch with `python3 scripts/invoke.py --web`
+- Support for [inpainting](features/INPAINTING.md) and [outpainting](features/OUTPAINTING.md)
+- img2img runs on all k* samplers
+- Support for [negative prompts](features/PROMPTS.md#negative-and-unconditioned-prompts)
+- Support for CodeFormer face reconstruction
+- Support for Textual Inversion on Macintoshes
+- Support in both WebGUI and CLI for [post-processing of previously-generated images](features/POSTPROCESS.md)
+    using facial reconstruction, ESRGAN upscaling, outcropping (similar to DALL-E infinite canvas),
+    and "embiggen" upscaling. See the `!fix` command.
+- New `--hires` option on `invoke>` line allows [larger images to be created without duplicating elements](features/CLI.md#this-is-an-example-of-txt2img), at the cost of some performance.
+- New `--perlin` and `--threshold` options allow you to add and control variation
+    during image generation (see [Thresholding and Perlin Noise Initialization](features/OTHER.md#thresholding-and-perlin-noise-initialization-options))
+- Extensive metadata now written into PNG files, allowing reliable regeneration of images
+    and tweaking of previous settings.
+- Command-line completion in `invoke.py` now works on Windows, Linux and Mac platforms.
+- Improved [command-line completion behavior](features/CLI.md)
+    New commands added:
+  - List command-line history with `!history`
+  - Search command-line history with `!search`
+  - Clear history with `!clear`
+- Deprecated `--full_precision` / `-F`. Simply omit it and `invoke.py` will auto
+    configure. To switch away from auto use the new flag like `--precision=float32`.
+
+## v1.14 <small>(11 September 2022)</small>
+
+- Memory optimizations for small-RAM cards. 512x512 now possible on 4 GB GPUs.
+- 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)).
+- Inpainting support.
+- Improved web server GUI.
+- Lots of code and documentation cleanups.
+
+## v1.13 <small>(3 September 2022)</small>
+
+- Support image variations (see [VARIATIONS](features/VARIATIONS.md)
+    ([Kevin Gibbons](https://github.com/bakkot) and many contributors and reviewers)
+- Supports a Google Colab notebook for a standalone server running on Google hardware
+    [Arturo Mendivil](https://github.com/artmen1516)
+- 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)
+- 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 invoke.py command line as the default.
 - Miscellaneous internal bug and stability fixes.
+- Works on M1 Apple hardware.
+- Multiple bug fixes.
 
 ---
 
-## v1.12 (28 August 2022)
+## v1.12 <small>(28 August 2022)</small>
 
 - Improved file handling, including ability to read prompts from standard input.
   (kudos to [Yunsaki](https://github.com/yunsaki)
-- The web server is now integrated with the dream.py script. Invoke by adding --web to
-  the dream.py command arguments.
+- The web server is now integrated with the invoke.py script. Invoke by adding --web to
+  the invoke.py command arguments.
 - 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.
   VRAM requirements are modestly reduced. Thanks to both [Blessedcoolant](https://github.com/blessedcoolant) and
   [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 invoke> command line. [Blessedcoolant](https://github.com/blessedcoolant)
 
 ---
 
-## v1.11 (26 August 2022)
+## v1.11 <small>(26 August 2022)</small>
 
 - NEW FEATURE: Support upscaling and face enhancement using the GFPGAN module. (kudos to [Oceanswave](https://github.com/Oceanswave)
 - 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.
-- Created a feature branch named **yunsaki-morphing-dream** which adds experimental support for
-  iteratively modifying the prompt and its parameters. Please see[ Pull Request #86](https://github.com/lstein/stable-diffusion/pull/86)
+- Created a feature branch named **yunsaki-morphing-invoke** which adds experimental support for
+  iteratively modifying the prompt and its parameters. Please 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 <small>(25 August 2022)</small>
 
 - A barebones but fully functional interactive web server for online generation of txt2img and img2img.
 
 ---
 
-## v1.09 (24 August 2022)
+## v1.09 <small>(24 August 2022)</small>
 
 - A new -v option allows you to generate multiple variants of an initial image
   in img2img mode. (kudos to [Oceanswave](https://github.com/Oceanswave). [
@@ -55,9 +110,9 @@
 
 ---
 
-## v1.08 (24 August 2022)
+## v1.08 <small>(24 August 2022)</small>
 
-- Escape single quotes on the dream> command before trying to parse. This avoids
+- Escape single quotes on the invoke> command before trying to parse. This avoids
   parse errors.
 - Removed instruction to get Python3.8 as first step in Windows install.
   Anaconda3 does it for you.
@@ -66,7 +121,7 @@
 
 ---
 
-## v1.07 (23 August 2022)
+## v1.07 <small>(23 August 2022)</small>
 
 - Image filenames will now never fill gaps in the sequence, but will be assigned the
   next higher name in the chosen directory. This ensures that the alphabetic and chronological
@@ -74,14 +129,14 @@
 
 ---
 
-## v1.06 (23 August 2022)
+## v1.06 <small>(23 August 2022)</small>
 
 - Added weighted prompt support contributed by [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 <small>(22 August 2022 - after the drop)</small>
 
 - Filenames now use the following formats:
   000010.95183149.png -- Two files produced by the same command (e.g. -n2),
@@ -94,12 +149,12 @@
   be regenerated with the indicated key
 
 - 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 invoke> prompt to set and retrieve
   the path of the output directory.
 
 ---
 
-## v1.04 (22 August 2022 - after the drop)
+## v1.04 <small>(22 August 2022 - after the drop)</small>
 
 - Updated README to reflect installation of the released weights.
 - Suppressed very noisy and inconsequential warning when loading the frozen CLIP
@@ -107,31 +162,31 @@
 
 ---
 
-## v1.03 (22 August 2022)
+## v1.03 <small>(22 August 2022)</small>
 
 - The original txt2img and img2img scripts from the CompViz repository have been moved into
   a subfolder named "orig_scripts", to reduce confusion.
 
 ---
 
-## v1.02 (21 August 2022)
+## v1.02 <small>(21 August 2022)</small>
 
 - A copy of the prompt and all of its switches and options is now stored in the corresponding
   image in a tEXt metadata field named "Dream". You can read the prompt using scripts/images2prompt.py,
   or an image editor that allows you to explore the full metadata.
-  **Please run "conda env update -f environment.yaml" to load the k_lms dependencies!!**
+  **Please run "conda env update" to load the k_lms dependencies!!**
 
 ---
 
-## v1.01 (21 August 2022)
+## v1.01 <small>(21 August 2022)</small>
 
 - added k_lms sampling.
-  **Please run "conda env update -f environment.yaml" to load the k_lms dependencies!!**
+  **Please run "conda env update" to load the k_lms dependencies!!**
 - use half precision arithmetic by default, resulting in faster execution and lower memory requirements
-  Pass argument --full_precision to dream.py to get slower but more accurate image generation
+  Pass argument --full_precision to invoke.py to get slower but more accurate image generation
 
 ---
 
 ## Links
 
-- **[Read Me](../readme.md)**
+- **[Read Me](index.md)**

docs/features/CLI.md

@@ -1,129 +1,158 @@
-# **Interactive Command-Line Interface**
+---
+title: CLI
+hide:
+  - toc
+---
 
-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.
+# :material-bash: CLI
 
-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
-from the command-line interface is very fast.
+## **Interactive Command Line Interface**
 
-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 `invoke.py` script, located in `scripts/dream.py`, provides an interactive
+interface to image generation similar to the "invoke mothership" bot that Stable
+AI provided on its Discord server.
 
-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
+Unlike the `txt2img.py` and `img2img.py` scripts provided in the original
+[CompVis/stable-diffusion](https://github.com/CompVis/stable-diffusion) 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++), 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`
 
 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
 
-```
-(ldm) ~/stable-diffusion$ python3 ./scripts/dream.py
+    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
+(invokeai) ~/stable-diffusion$ python3 ./scripts/invoke.py
 * Initializing, be patient...
 Loading model from models/ldm/text2img-large/model.ckpt
 (...more initialization messages...)
 
 * Initialization done! Awaiting your command...
-dream> ashley judd riding a camel -n2 -s150
+invoke> ashley judd riding a camel -n2 -s150
 Outputs:
    outputs/img-samples/00009.png: "ashley judd riding a camel" -n2 -s150 -S 416354203
    outputs/img-samples/00010.png: "ashley judd riding a camel" -n2 -s150 -S 1362479620
 
-dream> "there's a fly in my soup" -n6 -g
+invoke> "there's a fly in my soup" -n6 -g
     outputs/img-samples/00011.png: "there's a fly in my soup" -n6 -g -S 2685670268
     seeds for individual rows: [2685670268, 1216708065, 2335773498, 822223658, 714542046, 3395302430]
-dream> q
+invoke> q
 
 # this shows how to retrieve the prompt stored in the saved image's metadata
-(ldm) ~/stable-diffusion$ python ./scripts/images2prompt.py outputs/img_samples/*.png
+(invokeai) ~/stable-diffusion$ python ./scripts/images2prompt.py outputs/img_samples/*.png
 00009.png: "ashley judd riding a camel" -s150 -S 416354203
 00010.png: "ashley judd riding a camel" -s150 -S 1362479620
 00011.png: "there's a fly in my soup" -n6 -g -S 2685670268
 ```
 
-<p align='center'>
-<img src="../assets/dream-py-demo.png"/>
-</p>
+![invoke-py-demo](../assets/dream-py-demo.png)
 
-The `dream>` prompt's arguments are pretty much identical to those
-used in the Discord bot, except you don't need to type "!dream" (it
-doesn't hurt if you do). A significant change is that creation of
-individual images is now the default unless --grid (-g) is given. A
-full list is given in [List of prompt arguments]
-(#list-of-prompt-arguments).
+The `invoke>` prompt's arguments are pretty much identical to those used in the
+Discord bot, except you don't need to type `!invoke` (it doesn't hurt if you do).
+A significant change is that creation of individual images is now the default
+unless `--grid` (`-g`) is given. A 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
-that will change important global defaults, such as the directory for
-image outputs and the location of the model weight files.
+The script itself also recognizes a series of command-line switches that will
+change important global defaults, such as the directory for 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
-run it from the Windows, Mac or Linux command line. Some set defaults
-that can be overridden on a per-prompt basis (see [List of prompt
-arguments] (#list-of-prompt-arguments). Others
+These command-line arguments can be passed to `invoke.py` when you first run it
+from the Windows, Mac or Linux command line. Some set defaults that can be
+overridden on a per-prompt basis (see [List of prompt arguments](#list-of-prompt-arguments). Others
 
-| Argument           |  Shortcut  |  Default            |  Description |
-|--------------------|------------|---------------------|--------------|
-| --help             | -h         |                     | Print a concise help message.  |
-| --outdir <path>    |  -o<path> | outputs/img_samples | Location for generated images. |
-| --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 |
-| --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. |
-| --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. |
-| --port <port>      |            | 9090                | Which port web server should listen for requests on. |
-| --config <path>    |            | configs/models.yaml | Configuration file for models and their weights.     |
-| --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. |
-| --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. |
-| --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_model_path|            | experiments/pretrained_models/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" |
+| Argument <img width="240" align="right"/> | Shortcut <img width="100" align="right"/> | Default <img width="320" align="right"/>       | Description                                                                                          |
+| ----------------------------------------- | ----------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| `--help`                                  | `-h`                                      |                                                | Print a concise help message.                                                                        |
+| `--outdir <path>`                         | `-o<path>`                                | `outputs/img_samples`                          | Location for generated images.                                                                       |
+| `--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                                |
+| `--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.   |
+| `--png_compression <0-9>`                 | `-z<0-9>`                                 |  6                                             | Select level of compression for output files, from 0 (no compression) to 9 (max compression)         |
+| `--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.                |
+| `--port <port>`                           |                                           | `9090`                                         | Which port web server should listen for requests on.                                                 |
+| `--config <path>`                         |                                           | `configs/models.yaml`                          | Configuration file for models and their weights.                                                     |
+| `--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.                                            |
+| `--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.                                          |
+| `--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_model_path`                     |                                           | `experiments/pretrained_models/GFPGANv1.4.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"                                                                   |
+| `--free_gpu_mem`                          |                                           | `False`                                        | Free GPU memory after sampling, to allow image decoding and saving in low VRAM conditions            |
+| `--precision`                             |                                           | `auto`                                         | Set model precision, default is selected by device. Options: auto, float32, float16, autocast        |
 
-These arguments are deprecated but still work:
+!!! warning "These arguments are deprecated but still work"
 
-| Argument           |  Shortcut  |  Default            |  Description |
-|--------------------|------------|---------------------|--------------|
-| --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 |
+    <div align="center" markdown>
 
-**A note on path names:** 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.
+    | Argument           |  Shortcut  |  Default            |  Description |
+    |--------------------|------------|---------------------|--------------|
+    | `--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 |
+
+    </div>
+
+!!! tip
+
+      On Windows systems, you may run into
+      problems when passing the invoke 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
 
-After the dream.py script initializes, it will present you with a
-**dream>** prompt. Here you can enter information to generate images
-from text (txt2img), to embellish an existing image or sketch
-(img2img), or to selectively alter chosen regions of the image
-(inpainting).
+After the invoke.py script initializes, it will present you with a
+`invoke>` prompt. Here you can enter information to generate images
+from text ([txt2img](#txt2img)), to embellish an existing image or sketch
+([img2img](#img2img)), or to selectively alter chosen regions of the image
+([inpainting](#inpainting)).
 
-### This is an example of txt2img:
+### txt2img
 
-~~~~
-dream> waterfall and rainbow -W640 -H480
-~~~~
+!!! example ""
 
-This will create the requested image with the dimensions 640 (width)
-and 480 (height).
+    ```bash
+    invoke> waterfall and rainbow -W640 -H480
+    ```
 
-Here are the dream> command that apply to txt2img:
+    This will create the requested image with the dimensions 640 (width)
+    and 480 (height).
 
-| Argument           |  Shortcut  |  Default            |  Description |
+Here are the invoke> command that apply to txt2img:
+
+| Argument <img width="680" align="right"/> | Shortcut <img width="420" align="right"/> | Default <img width="480" align="right"/> | Description |
 |--------------------|------------|---------------------|--------------|
 | "my prompt"        |            |                    | Text prompt to use. The quotation marks are optional. |
 | --width <int>      | -W<int>   | 512                 | Width 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 |
 | --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 1.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.|
 | --sampler <sampler>| -A<sampler>| k_lms              | Sampler to use. Use -h to get list of available samplers. |
+| --hires_fix        |           |                     | Larger images often have duplication artefacts. This option suppresses duplicates by generating the image at low res, and then using img2img to increase the resolution |
+| `--png_compression <0-9>` | `-z<0-9>` |  6           | Select level of compression for output files, from 0 (no compression) to 9 (max compression)         |
 | --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) |
 | --outdir <path>    |  -o<path> | outputs/img_samples  | Temporarily change the location of these images |
@@ -131,10 +160,13 @@ Here are the dream> command that apply to txt2img:
 | --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) |
 | --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) |
+| --facetool_strength <float>  | -G <float> | -G0        | Fix faces (defaults to using the GFPGAN algorithm); argument indicates how hard the algorithm should try (0.0-1.0) |
+| --facetool <name> | -ft <name> | -ft gfpgan | Select face restoration algorithm to use: gfpgan, codeformer |
+| --codeformer_fidelity | -cf <float> | 0.75 | Used along with CodeFormer. Takes values between 0 and 1. 0 produces high quality but low accuracy. 1 produces high accuracy but low quality |
 | --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). |
-| --with_variations <pattern> | -V<pattern>| None      | Combine two or more variations. See [Variations](./VARIATIONS.md) for now to use this. |
+| --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
@@ -144,7 +176,7 @@ the nearest multiple of 64.
 ### This is an example of img2img:	
 
 ~~~~
-dream> waterfall and rainbow -I./vacation-photo.png -W640 -H480 --fit
+invoke> waterfall and rainbow -I./vacation-photo.png -W640 -H480 --fit
 ~~~~
 
 This will modify the indicated vacation photograph by making it more
@@ -156,73 +188,334 @@ photo and you may run out of memory if it is large.
 In addition to the command-line options recognized by txt2img, img2img
 accepts additional options:
 
-| Argument           |  Shortcut  |  Default            |  Description |
-|--------------------|------------|---------------------|--------------|
-| --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 |
-| --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.|
+| Argument <img width="160" align="right"/> |  Shortcut   |  Default        |  Description |
+|----------------------|-------------|-----------------|--------------|
+| `--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 |
+| `--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:
+### inpainting
 
-~~~~
-dream> waterfall and rainbow -I./vacation-photo.png -M./vacation-mask.png -W640 -H480 --fit
-~~~~
+!!! example ""
 
-This will do the same thing as img2img, but image alterations will
-only occur within transparent areas defined by the mask file specified
-by -M. You may also supply just a single initial image with the areas
-to overpaint made transparent, but you must be careful not to destroy
-the pixels underneath when you create the transparent areas. See
-[Inpainting](./INPAINTING.md) for details.
+    ```bash
+    invoke> 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
+    only occur within transparent areas defined by the mask file specified
+    by `-M`. You may also supply just a single initial image with the areas
+    to overpaint made transparent, but you must be careful not to destroy
+    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
 well as the --mask (-M) argument:
 
-| Argument           |  Shortcut  |  Default            |  Description |
+| Argument <img width="100" align="right"/> |  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.|
 
+# Other Commands
 
-# Command-line editing and completion
+The CLI offers a number of commands that begin with "!".
 
-If you are on a Macintosh or Linux machine, the command-line offers
-convenient history tracking, editing, and command completion.
+## Postprocessing images
 
-- To scroll through previous commands and potentially edit/reuse them, use the up and down cursor 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 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 paste a cut section back in, position the cursor where you want to paste, and type CTRL-Y
+To postprocess a file using face restoration or upscaling, use the
+`!fix` command.
+
+### `!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` switches in order to fix faces or upscale. If you provide a
+filename, the script will look for it in the current output
+directory. Otherwise you can provide a full or partial path to the
+desired file.
+
+Some examples:
+
+!!! example ""
+
+    Upscale to 4X its original size and fix faces using codeformer:
+
+    ```bash
+    invoke> !fix 0000045.4829112.png -G1 -U4 -ft codeformer
+    ```
+
+!!! example ""
+
+    Use the GFPGAN algorithm to fix faces, then upscale to 3X using --embiggen:
+
+    ```bash
+    invoke> !fix 0000045.4829112.png -G0.8 -ft gfpgan
+    >> fixing outputs/img-samples/0000045.4829112.png
+    >> retrieved seed 4829112 and prompt "boy enjoying a banana split"
+    >> GFPGAN - Restoring Faces for image seed:4829112
+    Outputs:
+    [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
+
+# 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
+
+This prints out a list of the models defined in `config/models.yaml'.
+The active model is bold-faced
+
+Example:
+<pre>
+laion400m                 not loaded  <no description>
+<b>stable-diffusion-1.4          active  Stable Diffusion v1.4</b>
+waifu-diffusion           not loaded  Waifu Diffusion v1.3
+</pre>
+
+## !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, switching back and forth is quick. The following
+example shows this in action. Note how the second column of the 
+`!models` table changes to `cached` after a model is first loaded,
+and that the long initialization step is not needed when loading
+a cached model.
+
+<pre>
+invoke> !models
+laion400m                 not loaded  <no description>
+<b>stable-diffusion-1.4          cached  Stable Diffusion v1.4</b>
+waifu-diffusion               active  Waifu Diffusion v1.3
+
+invoke> !switch waifu-diffusion
+>> Caching model stable-diffusion-1.4 in system RAM
+>> Loading waifu-diffusion from models/ldm/stable-diffusion-v1/model-epoch08-float16.ckpt
+   | LatentDiffusion: Running in eps-prediction mode
+   | DiffusionWrapper has 859.52 M params.
+   | Making attention of type 'vanilla' with 512 in_channels
+   | Working with z of shape (1, 4, 32, 32) = 4096 dimensions.
+   | 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 
+>> Current VRAM usage:2.17G
+>> Setting Sampler to k_lms
+
+invoke> !models
+laion400m                 not loaded  <no description>
+stable-diffusion-1.4          cached  Stable Diffusion v1.4
+<b>waifu-diffusion               active  Waifu Diffusion v1.3</b>
+
+invoke> !switch stable-diffusion-1.4
+>> Caching model waifu-diffusion in system RAM
+>> Retrieving model stable-diffusion-1.4 from system RAM cache
+>> Setting Sampler to k_lms
+
+invoke> !models
+laion400m                 not loaded  <no description>
+<b>stable-diffusion-1.4          active  Stable Diffusion v1.4</b>
+waifu-diffusion               cached  Waifu Diffusion v1.3
+</pre>
+
+## !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 model into `config/models.yaml` for use in 
+subsequent sessions.
+
+Provide `!import_model` with the path to a weights file ending in
+`.ckpt`.  If you type a partial path and press tab, the CLI will
+autocomplete. Although it will also autocomplete to `.vae` files,
+these are not currenty supported (but will be soon).
+
+When you hit return, the CLI will prompt you to fill in additional
+information about the model, including the short name you wish to use
+for it with the `!switch` command, a brief description of the model,
+the default image width and height to use with this model, and the
+model's configuration file. The latter three fields are automatically
+filled with reasonable defaults. In the example below, the bold-faced
+text shows what the user typed in with the exception of the width,
+height and configuration file paths, which were filled in
+automatically.
+
+Example:
+
+<pre>
+invoke> <b>!import_model models/ldm/stable-diffusion-v1/	model-epoch08-float16.ckpt</b>
+>> Model import in process. Please enter the values needed to configure this model:
+
+Name for this model: <b>waifu-diffusion</b>
+Description of this model: <b>Waifu Diffusion v1.3</b>
+Configuration file for this model: <b>configs/stable-diffusion/v1-inference.yaml</b>
+Default image width: <b>512</b>
+Default image height: <b>512</b>
+>> New configuration:
+waifu-diffusion:
+  config: configs/stable-diffusion/v1-inference.yaml
+  description: Waifu Diffusion v1.3
+  height: 512
+  weights: models/ldm/stable-diffusion-v1/model-epoch08-float16.ckpt
+  width: 512
+OK to import [n]? <b>y</b>
+>> Caching model stable-diffusion-1.4 in system RAM
+>> Loading waifu-diffusion from models/ldm/stable-diffusion-v1/model-epoch08-float16.ckpt
+   | LatentDiffusion: Running in eps-prediction mode
+   | DiffusionWrapper has 859.52 M params.
+   | Making attention of type 'vanilla' with 512 in_channels
+   | 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> 
+</pre>
+
+##!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 modify, and it will allow you to
+modify the model's `description`, `weights` and other fields.
+
+Example:
+<pre>
+invoke> <b>!edit_model waifu-diffusion</b>
+>> Editing model waifu-diffusion from configuration file ./configs/models.yaml
+description: <b>Waifu diffusion v1.4beta</b>
+weights: models/ldm/stable-diffusion-v1/<b>model-epoch10-float16.ckpt</b>
+config: configs/stable-diffusion/v1-inference.yaml
+width: 512
+height: 512
+
+>> New configuration:
+waifu-diffusion:
+  config: configs/stable-diffusion/v1-inference.yaml
+  description: Waifu diffusion v1.4beta
+  weights: models/ldm/stable-diffusion-v1/model-epoch10-float16.ckpt
+  height: 512
+  width: 512
+
+OK to import [n]? y
+>> Caching model stable-diffusion-1.4 in system RAM
+>> Loading waifu-diffusion from models/ldm/stable-diffusion-v1/model-epoch10-float16.ckpt
+...
+</pre>
+=======
+    invoke> !fix 000017.4829112.gfpgan-00.png --embiggen 3
+    ...lots of 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
+
+The CLI provides a series of convenient commands for reviewing previous
+actions, retrieving them, modifying them, and re-running them.
+```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
+```
+
+Note that this command may behave unexpectedly if given a PNG file that
+was not generated by InvokeAI.
+
+### `!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 command-line history out to disk, giving you access to
+the most recent 1000 commands issued.
+
+The `!history` command will return a numbered list of all the commands
+issued 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
+```
+
+## !fetch
+
+This command retrieves the generation parameters from a previously
+generated image and either loads them into the command line.  You may
+provide either the name of a file in the current output directory, or
+a full file path.
+
+~~~
+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
+~~~
+
+Note that this command 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:
+
+```bash
+invoke> !search surreal
+[21] surrealist painting of beautiful woman sitting under tree wearing broad hat and flowing garment -v0.2 -n6 -S2878767194
+```
+
+### `!clear`
+
+This clears the search history from memory and disk. Be advised that
+this operation is irreversible and does not issue any warnings!
+
+## Command-line editing and completion
+
+The command-line offers convenient history tracking, editing, and
+command completion.
+
+- To scroll through previous commands and potentially edit/reuse them, use the ++up++ and ++down++ keys.
+- To edit the current command, use the ++left++ and ++right++ 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 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 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
-launch dream.py with the "winpty" program:
+launch `invoke.py` with the `winpty` program and have the `pyreadline3`
+library installed:
 
-~~~
-> winpty python scripts\dream.py
-~~~
+```batch
+> winpty python scripts\invoke.py
+```
 
-On the Mac and Linux platforms, when you exit dream.py, the last 1000
+On the Mac and Linux platforms, when you exit invoke.py, the last 1000
 lines of your command-line history will be saved. When you restart
-dream.py, you can access the saved history using the up-arrow key.
+`invoke.py`, you can access the saved history using the ++up++ key.
 
 In addition, limited command-line completion is installed. In various
-contexts, you can start typing your command and press tab. A list of
+contexts, you can start typing your command and press ++tab++. A list of
 potential completions will be presented to you. You can then 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
 will attempt to complete pathnames for you. This is most handy for the
--I (init image) and -M (init mask) paths. To initiate completion, start
-the path with a slash ("/") or "./". For example:
+`-I` (init image) and `-M` (init mask) paths. To initiate completion, start
+the path with a slash (`/`) or `./`. For example:
 
-~~~
-dream> zebra with a mustache -I./test-pictures<TAB>
+```bash
+invoke> 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/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`.
 
 More text completion features (such as autocompleting seeds) are on their way.
-

docs/features/EMBIGGEN.md

@@ -0,0 +1,158 @@
+---
+title: Embiggen
+---
+
+# :material-loupe: Embiggen
+
+**upscale your images on limited memory machines**
+
+GFPGAN and Real-ESRGAN are both memory intensive. In order to avoid
+crashes and memory overloads during the Stable Diffusion process,
+these effects are applied after Stable Diffusion has completed its
+work.
+
+In single image generations, you will see the output right away but
+when you are using multiple iterations, the images will first be
+generated and then upscaled and face restored after that process is
+complete. While the image generation is taking place, you will still
+be able to preview the base images.
+
+If you wish to stop during the image generation but want to upscale or
+face restore a particular generated image, pass it again with the same
+prompt and generated seed along with the `-U` and `-G` prompt
+arguments to perform those actions.
+
+## Embiggen
+
+If you wanted to be able to do more (pixels) without running out of VRAM,
+or you want to upscale with details that couldn't possibly appear
+without the context of a prompt, this is the feature to try out.
+
+Embiggen automates the process of taking an init image, upscaling it,
+cutting it into smaller tiles that slightly overlap, running all the
+tiles through img2img to refine details with respect to the prompt,
+and "stitching" the tiles back together into a cohesive image.
+
+It automatically computes how many tiles are needed, and so it can be fed
+*ANY* size init image and perform Img2Img on it (though it will be run only
+one tile at a time, which can cause problems, see the Note at the end).
+
+If you're familiar with "GoBig" (ala [progrock-stable](https://github.com/lowfuel/progrock-stable))
+it's similar to that, except it can work up to an arbitrarily large size
+(instead of just 2x), with tile overlaps configurable as a ratio, and
+has extra logic to re-run any number of the tile sub-sections of the image
+if for example a small part of a huge run got messed up.
+
+### Usage
+
+`-embiggen <scaling_factor> <esrgan_strength> <overlap_ratio OR overlap_pixels>`
+
+Takes a scaling factor relative to the size of the `--init_img` (`-I`), followed by
+ESRGAN upscaling strength (0 - 1.0), followed by minimum amount of overlap
+between tiles as a decimal ratio (0 - 1.0) *OR* a number of pixels.
+
+The scaling factor is how much larger than the `--init_img` the output
+should be, and will multiply both x and y axis, so an image that is a
+scaling factor of 3.0 has 3*3= 9 times as many pixels, and will take
+(at least) 9 times as long (see overlap for why it might be
+longer). If the `--init_img` is already the right size `-embiggen 1`,
+and it can also be less than one if the init_img is too big.
+
+Esrgan_strength defaults to 0.75, and the overlap_ratio defaults to
+0.25, both are optional.
+
+Unlike Img2Img, the `--width` (`-W`) and `--height` (`-H`) arguments
+do not control the size of the image as a whole, but the size of the
+tiles used to Embiggen the image.
+
+ESRGAN is used to upscale the `--init_img` prior to cutting it into
+tiles/pieces to run through img2img and then stitch back
+together. Embiggen can be run without ESRGAN; just set the strength to
+zero (e.g. `-embiggen 1.75 0`). The output of Embiggen can also be
+upscaled after it's finished (`-U`).
+
+The overlap is the minimum that tiles will overlap with adjacent
+tiles, specified as either a ratio or a number of pixels. How much the
+tiles overlap determines the likelihood the tiling will be noticable,
+really small overlaps (e.g. a couple of pixels) may produce noticeable
+grid-like fuzzy distortions in the final stitched image. Though, as
+the overlapping space doesn't contribute to making the image bigger,
+and the larger the overlap the more tiles (and the more time) it will
+take to finish.
+
+Because the overlapping parts of tiles don't "contribute" to
+increasing size, every tile after the first in a row or column
+effectively only covers an extra `1 - overlap_ratio` on each axis. If
+the input/`--init_img` is same size as a tile, the ideal (for time)
+scaling factors with the default overlap (0.25) are 1.75, 2.5, 3.25,
+4.0 etc..
+
+`-embiggen_tiles <spaced list of tiles>`
+
+An advanced usage useful if you only want to alter parts of the image
+while running Embiggen. It takes a list of tiles by number to run and
+replace onto the initial image e.g. `1 3 5`. It's useful for either
+fixing problem spots from a previous Embiggen run, or selectively
+altering the prompt for sections of an image - for creative or
+coherency reasons.
+
+Tiles are numbered starting with one, and left-to-right,
+top-to-bottom.  So, if you are generating a 3x3 tiled image, the
+middle row would be `4 5 6`.
+
+### Examples
+
+!!! example ""
+
+    Running Embiggen with 512x512 tiles on an existing image, scaling up by a factor of 2.5x;
+    and doing the same again (default ESRGAN strength is 0.75, default overlap between tiles is 0.25):
+
+    ```bash
+    invoke > a photo of a forest at sunset -s 100 -W 512 -H 512 -I outputs/forest.png -f 0.4 -embiggen 2.5
+    invoke > a photo of a forest at sunset -s 100 -W 512 -H 512 -I outputs/forest.png -f 0.4 -embiggen 2.5 0.75 0.25
+    ```
+
+    If your starting image was also 512x512 this should have taken 9 tiles.
+
+!!! example ""
+
+    If there weren't enough clouds in the sky of that forest you just made
+    (and that image is about 1280 pixels (512*2.5) wide A.K.A. three
+    512x512 tiles with 0.25 overlaps wide) we can replace that top row of
+    tiles:
+
+    ```bash
+    invoke> a photo of puffy clouds over a forest at sunset -s 100 -W 512 -H 512 -I outputs/000002.seed.png -f 0.5 -embiggen_tiles 1 2 3
+    ```
+
+## Fixing Previously-Generated Images
+
+It is easy to apply embiggen to any previously-generated file without having to
+look up the original prompt and provide an initial image. Just use the
+syntax `!fix path/to/file.png <embiggen>`. For example, you can rewrite the
+previous command to look like this:
+
+```bash
+invoke> !fix ./outputs/000002.seed.png -embiggen_tiles 1 2 3
+```
+
+A new file named `000002.seed.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.
+You do not need to provide the prompt, and `!fix` automatically selects a good strength for
+embiggen-ing.
+
+!!! note
+
+    Because the same prompt is used on all the tiled images, and the model
+    doesn't have the context of anything outside the tile being run - it
+    can end up creating repeated pattern (also called 'motifs') across all
+    the tiles based on that prompt. The best way to combat this is
+    lowering the `--strength` (`-f`) to stay more true to the init image,
+    and increasing the number of steps so there is more compute-time to
+    create the detail.  Anecdotally `--strength` 0.35-0.45 works pretty
+    well on most things. It may also work great in some examples even with
+    the `--strength` set high for patterns, landscapes, or subjects that
+    are more abstract. Because this is (relatively) fast, you can also
+    preserve the best parts from each.
+
+Author: [Travco](https://github.com/travco)

docs/features/IMG2IMG.md

@@ -1,30 +1,185 @@
-# **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:
+# :material-image-multiple: Image-to-Image
 
-```
-dream> "waterfall and rainbow" --init_img=./init-images/crude_drawing.png --strength=0.5 -s100 -n4
+## `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:
+
+```commandline
+tree on a hill with a river, nature photograph, national geographic -I./test-pictures/tree-and-river-sketch.png -f 0.85
 ```
 
-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 the original intact), to `1.0`
-(ignore the original completely). The default is `0.75`, and ranges
-from `0.25-0.75` give interesting results.
+This will take the original image shown here:
 
-You may also pass a `-v<count>` option to generate count variants on
+<figure markdown>
+<img src="https://user-images.githubusercontent.com/50542132/193946000-c42a96d8-5a74-4f8a-b4c3-5213e6cadcce.png" width=350>
+</figure>
+
+and generate a new image based on it as shown here:
+
+<figure markdown>
+<img src="https://user-images.githubusercontent.com/111189/194135515-53d4c060-e994-4016-8121-7c685e281ac9.png" width=350>
+</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 the original intact), to `1.0` (ignore the
+original completely). The default is `0.75`, and ranges from `0.25-0.90` give interesting results. 
+Other relevant options include `-C` (classification free guidance scale), and `-s` (steps). Unlike `txt2img`, 
+adding steps will continuously change the resulting image and it will not converge.
+
+You may also pass a `-v<variation_amount>` option to generate `-n<iterations>` count variants on
 the original image. This is done by passing the first generated image
 back into img2img the requested number of times. It generates
 interesting variants.
 
-If the initial image contains transparent regions, then Stable
-Diffusion will only draw within the transparent regions, a process
-called "inpainting". However, for this to work correctly, the color
-information underneath the transparent needs to be preserved, not
-erased. See [Creating Transparent Images For
-Inpainting](./INPAINTING.md#creating-transparent-regions-for-inpainting)
-for details.
+Note that the prompt makes a big difference. For example, this slight variation on the prompt produces
+a very different image:
+
+<figure markdown>
+<img src="https://user-images.githubusercontent.com/111189/194135220-16b62181-b60c-4248-8989-4834a8fd7fbd.png" width=350>
+<caption markdown>photograph of a tree on a hill with a river</caption>
+</figure>
+
+!!! tip
+
+    When designing prompts, think about how the images scraped from the internet were captioned. Very few photographs will
+    be labeled "photograph" or "photorealistic." They will, however, be captioned with the publication, photographer, camera
+    model, or film settings.
+
+If the initial image contains transparent regions, then Stable Diffusion will only draw within the
+transparent regions, a process called [`inpainting`](./INPAINTING.md#creating-transparent-regions-for-inpainting). However, for this to work correctly, the color
+information underneath the transparent needs to be preserved, not erased.
+
+!!! warning
+
+**IMPORTANT ISSUE** `img2img` does not work properly on initial images smaller than 512x512. Please scale your
+image to at least 512x512 before using it. Larger images are not a problem, but may run out of VRAM on your
+GPU card. To fix this, use the --fit option, which downscales the initial image to fit within the box specified
+by width x height:
+~~~
+tree on a hill with a river, national geographic -I./test-pictures/big-sketch.png -H512 -W512 --fit
+~~~
+
+## How does it actually work, though?
+
+The main difference between `img2img` and `prompt2img` is the starting point. While `prompt2img` always starts with pure
+gaussian noise and progressively refines it over the requested number of steps, `img2img` skips some of these earlier steps
+(how many it skips is indirectly controlled by the `--strength` parameter), and uses instead your initial image mixed with gaussian noise as the starting image.
+
+**Let's start** by thinking about vanilla `prompt2img`, just generating an image 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:
+
+```commandline
+invoke> "fire" -s10 -W384 -H384 -S1592514025
+```
+
+<figure markdown>
+![latent steps](../assets/img2img/000019.steps.png)
+</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, gradually scrubbing out the fuzz until a clear image remains.
+
+**When you use `img2img`** some of the earlier steps are cut, and instead an initial image of your choice is used. But because of how the maths behind Stable Diffusion works, this image needs to be mixed with just the right amount of noise (fuzz/static) for where it is being inserted. This is where the strength parameter comes in. Depending on the set strength, your image will be inserted 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:
+
+<figure markdown>
+![drawing of a fireplace](../assets/img2img/fire-drawing.png)
+</figure>
+
+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>
+
+With strength `0.4`, the steps look more like this:
+
+<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`:
+
+|  | strength = 0.7 | strength = 0.4 |
+| -- | -- | -- |
+| initial image that SD sees | ![](../assets/img2img/000032.step-0.png) | ![](../assets/img2img/000030.step-0.png) |
+| steps argument to `invoke>` | `-S10` | `-S10` |
+| steps actually taken | 7 | 4 |
+| latent space at each step | ![gravity32](../assets/img2img/000032.steps.gravity.png) | ![gravity30](../assets/img2img/000030.steps.gravity.png) |
+| output | ![000032.1592514025](../assets/img2img/000032.1592514025.png) | ![000030.1592514025](../assets/img2img/000030.1592514025.png) |
+
+Both of the outputs look kind of like what I was thinking of. With the strength higher, my input becomes more vague, *and* Stable Diffusion has more steps to refine its output. But it's not really making what I want, which is a picture of cheery open fire. With the strength lower, my input is more clear, *but* Stable Diffusion has less chance to refine itself, so the result ends up inheriting all the problems of my bad drawing.
+
+If you want to try this out yourself, all of these are using a seed of `1592514025` with a width/height of `384`, step count `10`, the default sampler (`k_lms`), and the single-word prompt `"fire"`:
+
+If you want to try this out yourself, all of these are using a seed of `1592514025` with a width/height of `384`, step count `10`, the default sampler (`k_lms`), and the single-word prompt `fire`:
+
+```commandline
+invoke> "fire" -s10 -W384 -H384 -S1592514025 -I /tmp/fire-drawing.png --strength 0.7
+```
+
+The code for rendering intermediates is on my (damian0815's) branch [document-img2img](https://github.com/damian0815/InvokeAI/tree/document-img2img) - run `invoke.py` and check your `outputs/img-samples/intermediates` folder while generating an image. 
+
+### Compensating for the reduced step count
+
+After putting this guide together I was curious to see how the difference would be if I increased the step count to compensate, so that SD could have the same amount of steps to develop the image regardless of the strength. So I ran the generation again using the same seed, but this time adapting the step count to give each generation 20 steps.
+
+Here's strength `0.4` (note step count `50`, which is `20 ÷ 0.4` to make sure SD does `20` steps from my image):
+
+```commandline
+invoke> "fire" -s50 -W384 -H384 -S1592514025 -I /tmp/fire-drawing.png -f 0.4
+```
+
+<figure markdown>
+![000035.1592514025](../assets/img2img/000035.1592514025.png)
+</figure>
+
+and here is strength `0.7` (note step count `30`, which is roughly `20 ÷ 0.7` to make sure SD does `20` steps from my image):
+
+```commandline
+invoke> "fire" -s30 -W384 -H384 -S1592514025 -I /tmp/fire-drawing.png -f 0.7
+```
+
+<figure markdown>
+![000046.1592514025](../assets/img2img/000046.1592514025.png)
+</figure>
+
+In both cases the image is nice and clean and "finished", but because at strength `0.7` Stable Diffusion has been give so much more freedom to improve on my badly-drawn flames, they've come out looking much better. You can really see the difference when looking at the latent steps. There's more noise on the first image with strength `0.7`:
+
+<figure markdown>
+![gravity46](../assets/img2img/000046.steps.gravity.png)
+</figure>
+
+than there is for strength `0.4`:
+
+<figure markdown>
+![gravity35](../assets/img2img/000035.steps.gravity.png)
+</figure>
+
+and that extra noise gives the algorithm more choices when it is evaluating how to denoise any particular pixel in the image.
+
+Unfortunately, it seems that `img2img` is very sensitive to the step count. Here's strength `0.7` with a step count of `29` (SD did 19 steps from my image):
+
+<figure markdown>
+![gravity45](../assets/img2img/000045.1592514025.png)
+</figure>
+
+By comparing the latents we can sort of see that something got interpreted differently enough on the third or fourth step to lead to a rather different interpretation of the flames.
+
+<figure markdown>
+![gravity46](../assets/img2img/000046.steps.gravity.png)
+</figure>
+
+<figure markdown>
+![gravity45](../assets/img2img/000045.steps.gravity.png)
+</figure>
+
+This is the result of a difference in the de-noising "schedule" - basically the noise has to be cleaned by a certain degree each step or the model won't "converge" on the image properly (see [stable diffusion blog](https://huggingface.co/blog/stable_diffusion) for more about that). A different step count means a different schedule, which means things get interpreted slightly differently at every step.

docs/features/INPAINTING.md

@@ -1,4 +1,10 @@
-# **Creating Transparent Regions for Inpainting**
+---
+title: Inpainting
+---
+
+# :octicons-paintbrush-16: Inpainting
+
+## **Creating Transparent Regions for Inpainting**
 
 Inpainting is really cool. To do it, you start with an initial image
 and use a photoeditor to make one or more regions transparent
@@ -11,8 +17,12 @@ the initial image correctly so that the underlying colors are
 preserved under the transparent area. Many imaging editing
 applications will by default erase the color information under the
 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.
+lead to suboptimal inpainting. It often helps to apply incomplete
+transparency, such as any value between 1 and 99%
+
+You also must take care to export the PNG file in such a way that the
+color information is preserved. There is often an option in the export
+dialog that lets you specify this.
 
 If your photoeditor is erasing the underlying color information,
 `dream.py` will give you a big fat warning. If you can't find a way to
@@ -20,22 +30,88 @@ 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:
 
-```
-dream> man with cat on shoulder -I./images/man.png -M./images/man-transparent.png
+```bash
+invoke> "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.
 
+### Inpainting is not changing the masked region enough!
+
+One of the things to understand about how inpainting works is that it
+is equivalent to running img2img on just the masked (transparent)
+area. img2img builds on top of the existing image data, and therefore
+will attempt to preserve colors, shapes and textures to the best of
+its ability. Unfortunately this means that if you want to make a
+dramatic change in the inpainted region, for example replacing a red
+wall with a blue one, the algorithm will fight you.
+
+You have a couple of options. The first is to increase the values of
+the requested steps (`-sXXX`), strength (`-f0.XX`), and/or
+condition-free guidance (`-CXX.X`). If this is not working for you, a
+more extreme step is to provide the `--inpaint_replace 0.X` (`-r0.X`)
+option. This value ranges from 0.0 to 1.0. The higher it is the less
+attention the algorithm will pay to the data underneath the masked
+region. At high values this will enable you to replace colored regions
+entirely, but beware that the masked region mayl not blend in with the
+surrounding unmasked regions as well.
+
+---
+
 ## Recipe for GIMP
 
 [GIMP](https://www.gimp.org/) is a popular Linux photoediting tool.
 
 1. Open image in GIMP.
 2. Layer->Transparency->Add Alpha Channel
-3. Use lasoo tool to select region to mask
+3. Use lasso tool to select region to mask
 4. Choose Select -> Float to create a floating selection
 5. Open the Layers toolbar (^L) and select "Floating Selection"
-6. Set opacity to 0%
+6. Set opacity to a value between 0% and 99%
 7. Export as PNG
 8. In the export dialogue, Make sure the "Save colour values from
    transparent pixels" checkbox is selected.
+
+---
+
+## Recipe for Adobe Photoshop
+
+1. Open image in Photoshop
+
+    <figure markdown>
+    ![step1](../assets/step1.png)
+    </figure>
+
+2. Use any of the selection tools (Marquee, Lasso, or Wand) to select the area you desire to inpaint.
+
+    <figure markdown>
+    ![step2](../assets/step2.png)
+    </figure>
+
+3. Because we'll be applying a mask over the area we want to preserve, you should now select the inverse by using the ++shift+ctrl+i++ shortcut, or right clicking and using the "Select Inverse" option.
+
+4. You'll now create a mask by selecting the image layer, and Masking the selection. Make sure that you don't delete any of the underlying image, or your inpainting results will be dramatically impacted.
+
+    <figure markdown>
+    ![step4](../assets/step4.png)
+    </figure>
+
+5. Make sure to hide any background layers that are present. You should see the mask applied to your image layer, and the image on your canvas should display the checkered background.
+
+    <figure markdown>
+    ![step5](../assets/step5.png)
+    </figure>
+
+6. Save the image as a transparent PNG by using `File`-->`Save a Copy` from the menu bar, or by using the keyboard shortcut ++alt+ctrl+s++
+
+    <figure markdown>
+    ![step6](../assets/step6.png)
+    </figure>
+
+7. After following the inpainting instructions above (either through the CLI or the Web UI), marvel at your newfound ability to selectively invoke. Lookin' good!
+
+    <figure markdown>
+   ![step7](../assets/step7.png)
+    </figure>
+
+8. In the export dialogue, Make sure the "Save colour values from transparent pixels" checkbox is selected.  

docs/features/OTHER.md

@@ -1,71 +1,51 @@
+---
+title: Others
+---
+
+# :fontawesome-regular-share-from-square: Others
+
 ## **Google Colab**
 
-Stable Diffusion AI Notebook: <a
-href="https://colab.research.google.com/github/lstein/stable-diffusion/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb"
-target="_parent"><img
-src="https://colab.research.google.com/assets/colab-badge.svg"
-alt="Open In Colab"/></a> <br> Open and follow instructions to use an
-isolated environment running Dream.<br>
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg){ align="right" }](https://colab.research.google.com/github/lstein/stable-diffusion/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb)
+
+Open and follow instructions to use an isolated environment running Dream.
 
 Output Example:
+
 ![Colab Notebook](../assets/colab_notebook.png)
 
 ---
 
 ## **Seamless Tiling**
 
-The seamless tiling mode causes generated images to seamlessly tile
-with itself. To use it, add the `--seamless` option when starting the
-script which will result in all generated images to tile, or for each
-`dream>` prompt as shown here:
+The seamless tiling mode causes generated images to seamlessly tile with itself. To use it, add the
+`--seamless` option when starting the script which will result in all generated images to tile, or
+for each `invoke>` prompt as shown here:
 
-```
-dream> "pond garden with lotus by claude monet" --seamless -s100 -n4
-```
-
----
-
-## **Reading Prompts from a File**
-
-You can automate `dream.py` by providing a text file with the prompts
-you want to run, one line per prompt. The text file must be composed
-with a text editor (e.g. Notepad) and not a word processor. Each line
-should look like what you would type at the dream> prompt:
-
-```
-a beautiful sunny day in the park, children playing -n4 -C10
-stormy weather on a mountain top, goats grazing     -s100
-innovative packaging for a squid's dinner           -S137038382
-```
-
-Then pass this file's name to `dream.py` when you invoke it:
-
-```
-(ldm) ~/stable-diffusion$ python3 scripts/dream.py --from_file "path/to/prompts.txt"
-```
-
-You may read a series of prompts from standard input by providing a filename of `-`:
-
-```
-(ldm) ~/stable-diffusion$ echo "a beautiful day" | python3 scripts/dream.py --from_file -
+```python
+invoke> "pond garden with lotus by claude monet" --seamless -s100 -n4
 ```
 
 ---
 
 ## **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**`)
-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.
+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`) 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):
 
-```
-dream> a cute child playing hopscotch -G0.5
+```bash
+invoke> 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
 
 # I wonder what it will look like if I bump up the steps and set facial enhancement to full strength?
-dream> a cute child playing hopscotch -G1.0 -s100 -S -1
+invoke> a cute child playing hopscotch -G1.0 -s100 -S -1
 reusing previous seed 3498014304
 [...]
 outputs/img-samples/000040.3498014304.png: "a cute child playing hopscotch" -G1.0 -s100 -W512 -H512 -C7.5 -mk_lms -S3498014304
@@ -76,26 +56,53 @@ outputs/img-samples/000040.3498014304.png: "a cute child playing hopscotch" -G1.
 ## **Weighted Prompts**
 
 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.
-For example consider this prompt:
+priority to them, by adding `:<percent>` to the end of the section you wish to up- or downweight. For
+example consider this prompt:
 
-```
-    tabby cat:0.25 white duck:0.75 hybrid
+```bash
+tabby cat:0.25 white duck:0.75 hybrid
 ```
 
-This will tell the sampler to invest 25% of its effort on the tabby
-cat aspect of the image and 75% on the white duck aspect
-(surprisingly, this example actually works). The prompt weights can
-use any combination of integers and floating point numbers, and they
-do not need to add up to 1.
+This will tell the sampler to invest 25% of its effort on the tabby cat aspect of the image and 75%
+on the white duck aspect (surprisingly, this example actually works). The prompt weights can use any
+combination of integers and floating point numbers, and they do not need to add up to 1.
+
+---
+
+## **Thresholding and Perlin Noise Initialization Options**
+
+Two new options are the thresholding (`--threshold`) and the perlin noise initialization (`--perlin`) options. Thresholding limits the range of the latent values during optimization, which helps combat oversaturation with higher CFG scale values. Perlin noise initialization starts with a percentage (a value ranging from 0 to 1) of perlin noise mixed into the initial noise. Both features allow for more variations and options in the course of generating images.
+
+For better intuition into what these options do in practice:
+
+![here is a graphic demonstrating them both](../assets/truncation_comparison.jpg)
+
+In generating this graphic, perlin noise at initialization was programmatically varied going across on the diagram by values 0.0, 0.1, 0.2, 0.4, 0.5, 0.6, 0.8, 0.9, 1.0; and the threshold was varied going down from
+0, 1, 2, 3, 4, 5, 10, 20, 100. The other options are fixed, so the initial prompt is as follows (no thresholding or perlin noise):
+
+```bash
+invoke> "a portrait of a beautiful young lady" -S 1950357039 -s 100 -C 20 -A k_euler_a --threshold 0 --perlin 0
+```
+
+Here's an example of another prompt used when setting the threshold to 5 and perlin noise to 0.2:
+
+```bash
+invoke> "a portrait of a beautiful young lady" -S 1950357039 -s 100 -C 20 -A k_euler_a --threshold 5 --perlin 0.2
+```
+
+!!! note
+
+    currently the thresholding feature is only implemented for the k-diffusion style samplers, and empirically appears to work best with `k_euler_a` and `k_dpm_2_a`. Using 0 disables thresholding. Using 0 for perlin noise disables using perlin noise for initialization. Finally, using 1 for perlin noise uses only perlin noise for initialization.
 
 ---
 
 ## **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
 g       = Generate()
 outputs = g.txt2img("a unicorn in manhattan")
@@ -109,17 +116,15 @@ Please see ldm/generate.py for more information. A set of example scripts is com
 
 ## **Preload Models**
 
-In situations where you have limited internet connectivity or are
-blocked behind a firewall, you can use the preload script to preload
-the required files for Stable Diffusion to run.
+In situations where you have limited internet connectivity or are blocked behind a firewall, you can
+use the preload script to preload the required files for Stable Diffusion to run.
 
-The preload script `scripts/preload_models.py` needs to be run once at
-least while connected to the internet. In the following runs, it will
-load up the cached versions of the required files from the `.cache`
-directory of the system.
+The preload script `scripts/preload_models.py` needs to be run once at least while connected to the
+internet. In the following runs, it will load up the cached versions of the required files from the
+`.cache` directory of the system.
 
-```
-(ldm) ~/stable-diffusion$ python3 ./scripts/preload_models.py
+```bash
+(invokeai) ~/stable-diffusion$ python3 ./scripts/preload_models.py
 preloading bert tokenizer...
 Downloading: 100%|██████████████████████████████████| 28.0/28.0 [00:00<00:00, 49.3kB/s]
 Downloading: 100%|██████████████████████████████████| 226k/226k [00:00<00:00, 2.79MB/s]

docs/features/OUTPAINTING.md

@@ -0,0 +1,105 @@
+---
+title: Outpainting
+---
+
+# :octicons-paintbrush-16: Outpainting
+
+## Outpainting and outcropping
+
+Outpainting is a process by which the AI generates parts of the image
+that are outside its original frame. It can be used to fix up images
+in which the subject is off center, or when some detail (often the top
+of someone's head!) is cut off.
+
+InvokeAI supports two versions of outpainting, one called "outpaint"
+and the other "outcrop." They work slightly differently and each has
+its advantages and drawbacks.
+
+### Outcrop
+
+The `outcrop` extension allows you to extend the image in 64 pixel
+increments in any dimension. You can apply the module to any image
+previously-generated by InvokeAI. Note that it will **not** work with
+arbitrary photographs or Stable Diffusion images created by other
+implementations.
+
+Consider this image:
+
+<figure markdown>
+![curly_woman](../assets/outpainting/curly.png)
+</figure>
+
+Pretty nice, but it's annoying that the top of her head is cut
+off. She's also a bit off center. Let's fix that!
+
+```bash
+invoke> !fix images/curly.png --outcrop top 64 right 64
+```
+
+This is saying to apply the `outcrop` extension by extending the top
+of the image by 64 pixels, and the right of the image by the same
+amount. You can use any combination of top|left|right|bottom, and
+specify any number of pixels to extend. You can also abbreviate
+`--outcrop` to `-c`.
+
+The result looks like this:
+
+<figure markdown>
+![curly_woman_outcrop](../assets/outpainting/curly-outcrop.png)
+</figure>
+
+The new image is actually slightly larger than the original (576x576,
+because 64 pixels were added to the top and right sides.)
+
+A number of caveats:
+
+1. Although you can specify any pixel values, they will be rounded up
+to the nearest multiple of 64. Smaller values are better. Larger
+extensions are more likely to generate artefacts. However, if you wish
+you can run the !fix command repeatedly to cautiously expand the
+image.
+
+2. The extension is stochastic, meaning that each time you run it
+you'll get a slightly different result. You can run it repeatedly
+until you get an image you like. Unfortunately `!fix` does not
+currently respect the `-n` (`--iterations`) argument.
+
+## Outpaint
+
+The `outpaint` extension does the same thing, but with subtle
+differences. Starting with the same image, here is how we would add an
+additional 64 pixels to the top of the image:
+
+```bash
+invoke> !fix images/curly.png --out_direction top 64
+```
+
+(you can abbreviate `--out_direction` as `-D`.
+
+The result is shown here:
+
+<figure markdown>
+![curly_woman_outpaint](../assets/outpainting/curly-outpaint.png)
+</figure>
+
+Although the effect is similar, there are significant differences from
+outcropping:
+
+- You can only specify one direction to extend at a time.
+- The image is **not** resized. Instead, the image is shifted by the specified
+number of pixels. If you look carefully, you'll see that less of the lady's
+torso is visible in the image.
+- Because the image dimensions remain the same, there's no rounding
+to multiples of 64.
+- Attempting to outpaint larger areas will frequently give rise to ugly
+   ghosting effects.
+- For best results, try increasing the step number.
+- If you don't specify a pixel value in `-D`, it will default to half
+   of the whole image, which is likely not what you want.
+
+!!! tip
+
+    Neither `outpaint` nor `outcrop` are perfect, but we continue to tune
+    and improve them. If one doesn't work, try the other. You may also
+    wish to experiment with other `img2img` arguments, such as `-C`, `-f`
+    and `-s`.

docs/features/POSTPROCESS.md

@@ -0,0 +1,177 @@
+---
+title: Postprocessing
+---
+
+# :material-image-edit: Postprocessing
+
+## Intro
+
+This extension provides the ability to restore faces and upscale
+images.
+
+Face restoration and upscaling can be applied at the time you generate
+the images, or at any later time against a previously-generated PNG
+file, using the [!fix](#fixing-previously-generated-images)
+command. [Outpainting and outcropping](OUTPAINTING.md) can only be
+applied after the fact.
+
+## Face Fixing
+
+The default face restoration module is GFPGAN. The default upscale is
+Real-ESRGAN. For an alternative face restoration module, see [CodeFormer
+Support] below.
+
+As of version 1.14, environment.yaml will install the Real-ESRGAN
+package into the standard install location for python packages, and
+will put GFPGAN into a subdirectory of "src" in the InvokeAI
+directory. Upscaling with Real-ESRGAN should "just work" without
+further intervention. Simply pass the --upscale (-U) option on the
+invoke> command line, or indicate the desired scale on the popup in
+the Web GUI.
+
+**GFPGAN** requires a series of downloadable model files to
+work. These are loaded when you run `scripts/preload_models.py`. If
+GFPAN is failing with an error, please run the following from the
+InvokeAI directory:
+
+```bash
+python scripts/preload_models.py
+```
+
+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.
+
+Alternatively, if you have GFPGAN installed elsewhere, or if you are
+using an earlier version of this package which asked you to install
+GFPGAN in a sibling directory, you may use the `--gfpgan_dir` argument
+with `invoke.py` to set a custom path to your GFPGAN directory. _There
+are other GFPGAN related boot arguments if you wish to customize
+further._
+
+## Usage
+
+You will now have access to two new prompt arguments.
+
+### Upscaling
+
+`-U : <upscaling_factor> <upscaling_strength>`
+
+The upscaling prompt argument takes two values. The first value is a scaling
+factor and should be set to either `2` or `4` only. This will either scale the
+image 2x or 4x respectively using different models.
+
+You can set the scaling stength between `0` and `1.0` to control intensity of
+the of the scaling. This is handy because AI upscalers generally tend to smooth
+out texture details. If you wish to retain 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 default to 0.75.
+
+### Face Restoration
+
+`-G : <facetool_strength>`
+
+This prompt argument controls the strength of the face restoration that is being
+applied. Similar to upscaling, values between `0.5 to 0.8` are recommended.
+
+You can use either one or both without any conflicts. In cases where you use
+both, the image will be first upscaled and then the face restoration process
+will be executed to ensure you get the highest quality facial features.
+
+`--save_orig`
+
+When you use either `-U` or `-G`, the final result you get is upscaled or face
+modified. If you want to save the original Stable Diffusion generation, you can
+use the `-save_orig` prompt argument to save the original unaffected version
+too.
+
+### Example Usage
+
+```bash
+invoke> "superman dancing with a panda bear" -U 2 0.6 -G 0.4
+```
+
+This also works with img2img:
+
+```bash
+invoke> "a man wearing a pineapple hat" -I path/to/your/file.png -U 2 0.5 -G 0.6
+```
+
+!!! note
+
+    GFPGAN and Real-ESRGAN are both memory intensive. In order to avoid crashes and memory overloads
+    during the Stable Diffusion process, these effects are applied after Stable Diffusion has completed
+    its work.
+
+    In single image generations, you will see the output right away but when you are using multiple
+    iterations, the images will first be generated and then upscaled and face restored after that
+    process is complete. While the image generation is taking place, you will still be able to preview
+    the base images.
+
+If you wish to stop during the image generation but want to upscale or face
+restore a particular generated image, pass it again with the same prompt and
+generated seed along with the `-U` and `-G` prompt arguments to perform those
+actions.
+
+## CodeFormer Support
+
+This repo also allows you to perform face restoration using
+[CodeFormer](https://github.com/sczhou/CodeFormer).
+
+In order to setup CodeFormer to work, you need to download the models
+like with GFPGAN. You can do this either by running
+`preload_models.py` or by manually downloading the [model
+file](https://github.com/sczhou/CodeFormer/releases/download/v0.1.0/codeformer.pth)
+and saving it to `ldm/invoke/restoration/codeformer/weights` folder.
+
+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
+
+The following command will perform face restoration with CodeFormer instead of
+the default gfpgan.
+
+`<prompt> -G 0.8 -ft codeformer`
+
+### Other Options
+
+- `-cf` - cf or CodeFormer Fidelity takes values between `0` and `1`. 0 produces
+  high quality results but low accuracy and 1 produces lower quality results but
+  higher accuacy to your original face.
+
+The following command will perform face restoration with CodeFormer. CodeFormer
+will output a result that is closely matching to the input face.
+
+`<prompt> -G 1.0 -ft codeformer -cf 0.9`
+
+The following command will perform face restoration with CodeFormer. CodeFormer
+will output a result that is the best restoration possible. This may deviate
+slightly from the original face. This is an excellent option to use in
+situations when there is very little facial data to work with.
+
+`<prompt> -G 1.0 -ft codeformer -cf 0.1`
+
+## Fixing Previously-Generated Images
+
+It is easy to apply face restoration and/or upscaling to any
+previously-generated file. Just use the syntax `!fix path/to/file.png
+<options>`. For example, to apply GFPGAN at strength 0.8 and upscale
+2X for a file named `./outputs/img-samples/000044.2945021133.png`,
+just run:
+
+```bash
+invoke> !fix ./outputs/img-samples/000044.2945021133.png -G 0.8 -U 2
+```
+
+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
+
+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
+`--no_upscale` options, respectively.

docs/features/PROMPTS.md

@@ -0,0 +1,171 @@
+---
+title: Prompting-Features
+---
+
+# :octicons-command-palette-24: Prompting-Features
+
+## **Reading Prompts from a File**
+
+You can automate `invoke.py` by providing a text file with the prompts you want to run, one line per
+prompt. The text file must be composed with a text editor (e.g. Notepad) and not a word processor.
+Each line should look like what you would type at the invoke> prompt:
+
+```bash
+a beautiful sunny day in the park, children playing -n4 -C10
+stormy weather on a mountain top, goats grazing     -s100
+innovative packaging for a squid's dinner           -S137038382
+```
+
+Then pass this file's name to `invoke.py` when you invoke it:
+
+```bash
+(invokeai) ~/stable-diffusion$ python3 scripts/invoke.py --from_file "path/to/prompts.txt"
+```
+
+You may read a series of prompts from standard input by providing a filename of `-`:
+
+```bash
+(invokeai) ~/stable-diffusion$ echo "a beautiful day" | python3 scripts/invoke.py --from_file -
+```
+
+---
+
+## **Negative and Unconditioned Prompts**
+
+Any words between a pair of square brackets will instruct Stable
+Diffusion to attempt to ban the concept from the generated image.
+
+```text
+this is a test prompt [not really] to make you understand [cool] how this works.
+```
+
+In the above statement, the words 'not really cool` will be ignored by Stable Diffusion.
+
+Here's a prompt that depicts what it does.
+
+original prompt:
+
+`#!bash "A fantastical translucent poney made of water and foam, ethereal, radiant, hyperalism, scottish folklore, digital painting, artstation, concept art, smooth, 8 k frostbite 3 engine, ultra detailed, art by artgerm and greg rutkowski and magali villeneuve" -s 20 -W 512 -H 768 -C 7.5 -A k_euler_a -S 1654590180`
+
+<figure markdown>
+![step1](../assets/negative_prompt_walkthru/step1.png)
+</figure>
+
+That image has a woman, so if we want the horse without a rider, we can influence the image not to have a woman by putting [woman] in the prompt, like this:
+
+`#!bash "A fantastical translucent poney made of water and foam, ethereal, radiant, hyperalism, scottish folklore, digital painting, artstation, concept art, smooth, 8 k frostbite 3 engine, ultra detailed, art by artgerm and greg rutkowski and magali villeneuve [woman]" -s 20 -W 512 -H 768 -C 7.5 -A k_euler_a -S 1654590180`
+
+<figure markdown>
+![step2](../assets/negative_prompt_walkthru/step2.png)
+</figure>
+
+That's nice - but say we also don't want the image to be quite so blue. We can add "blue" to the list of negative prompts, so it's now [woman blue]:
+
+`#!bash "A fantastical translucent poney made of water and foam, ethereal, radiant, hyperalism, scottish folklore, digital painting, artstation, concept art, smooth, 8 k frostbite 3 engine, ultra detailed, art by artgerm and greg rutkowski and magali villeneuve [woman blue]" -s 20 -W 512 -H 768 -C 7.5 -A k_euler_a -S 1654590180`
+
+<figure markdown>
+![step3](../assets/negative_prompt_walkthru/step3.png)
+</figure>
+
+Getting close - but there's no sense in having a saddle when our horse doesn't have a rider, so we'll add one more negative prompt: [woman blue saddle].
+
+`#!bash "A fantastical translucent poney made of water and foam, ethereal, radiant, hyperalism, scottish folklore, digital painting, artstation, concept art, smooth, 8 k frostbite 3 engine, ultra detailed, art by artgerm and greg rutkowski and magali villeneuve [woman blue saddle]" -s 20 -W 512 -H 768 -C 7.5 -A k_euler_a -S 1654590180`
+
+<figure markdown>
+![step4](../assets/negative_prompt_walkthru/step4.png)
+</figure>
+
+!!! notes "Notes about this feature:"
+
+    * The only requirement for words to be ignored is that they are in between a pair of square brackets.
+    * You can provide multiple words within the same bracket.
+    * You can provide multiple brackets with multiple words in different places of your prompt. That works just fine.
+    * To improve typical anatomy problems, you can add negative prompts like `[bad anatomy, extra legs, extra arms, extra fingers, poorly drawn hands, poorly drawn feet, disfigured, out of frame, tiling, bad art, deformed, mutated]`.
+
+---
+
+## **Prompt Blending**
+
+You may blend together different sections of the prompt to explore the
+AI's latent semantic space and generate interesting (and often
+surprising!) variations. The syntax is:
+
+```bash
+blue sphere:0.25 red cube:0.75 hybrid
+```
+
+This will tell the sampler to blend 25% of the concept of a blue
+sphere with 75% of the concept of a red cube. The blend weights can
+use any combination of integers and floating point numbers, and they
+do not need to add up to 1. Everything to the left of the `:XX` up to
+the previous `:XX` is used for merging, so the overall effect is:
+
+```bash
+0.25 * "blue sphere" + 0.75 * "white duck" + hybrid
+```
+
+Because you are exploring the "mind" of the AI, the AI's way of mixing
+two concepts may not match yours, leading to surprising effects. To
+illustrate, here are three images generated using various combinations
+of blend weights. As usual, unless you fix the seed, the prompts will give you
+different results each time you run them.
+
+---
+
+<figure markdown>
+### "blue sphere, red cube, hybrid"
+</figure>
+
+This example doesn't use melding at all and represents the default way
+of mixing concepts.
+
+<figure markdown>
+![blue-sphere-red-cube-hyprid](../assets/prompt-blending/blue-sphere-red-cube-hybrid.png)
+</figure>
+
+It's interesting to see how the AI expressed the concept of "cube" as
+the four quadrants of the enclosing frame. If you look closely, there
+is depth there, so the enclosing frame is actually a cube.
+
+<figure markdown>
+### "blue sphere:0.25 red cube:0.75 hybrid"
+
+![blue-sphere-25-red-cube-75](../assets/prompt-blending/blue-sphere-0.25-red-cube-0.75-hybrid.png)
+</figure>
+
+Now that's interesting. We get neither a blue sphere nor a red cube,
+but a red sphere embedded in a brick wall, which represents a melding
+of concepts within the AI's "latent space" of semantic
+representations. Where is Ludwig Wittgenstein when you need him?
+
+<figure markdown>
+### "blue sphere:0.75 red cube:0.25 hybrid"
+
+![blue-sphere-75-red-cube-25](../assets/prompt-blending/blue-sphere-0.75-red-cube-0.25-hybrid.png)
+</figure>
+
+Definitely more blue-spherey. The cube is gone entirely, but it's
+really cool abstract art.
+
+<figure markdown>
+### "blue sphere:0.5 red cube:0.5 hybrid"
+
+![blue-sphere-5-red-cube-5-hybrid](../assets/prompt-blending/blue-sphere-0.5-red-cube-0.5-hybrid.png)
+</figure>
+
+Whoa...! I see blue and red, but no spheres or cubes. Is the word
+"hybrid" summoning up the concept of some sort of scifi creature?
+Let's find out.
+
+<figure markdown>
+### "blue sphere:0.5 red cube:0.5"
+
+![blue-sphere-5-red-cube-5](../assets/prompt-blending/blue-sphere-0.5-red-cube-0.5.png)
+</figure>
+
+Indeed, removing the word "hybrid" produces an image that is more like
+what we'd expect.
+
+In conclusion, prompt blending is great for exploring creative space,
+but can be difficult to direct. A forthcoming release of InvokeAI will
+feature more deterministic prompt weighting.

docs/features/TEXTUAL_INVERSION.md

@@ -1,70 +1,92 @@
-# **Personalizing Text-to-Image Generation**
+---
+title: Textual-Inversion
+---
 
-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 model as a (.pt) embeddings file. Alternatively, you may use or train HuggingFace Concepts embeddings files (.bin) from https://huggingface.co/sd-concepts-library and its associated notebooks.
+# :material-file-document: Textual Inversion
 
-**Training**
+## **Personalizing Text-to-Image Generation**
 
-To train, prepare a folder that contains images sized at 512x512 and execute the following:
+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
+model as a (.pt) embeddings file. Alternatively, you may use or train
+HuggingFace Concepts embeddings files (.bin) from
+<https://huggingface.co/sd-concepts-library> and its associated notebooks.
 
-**WINDOWS**: As the default backend is not available on Windows, if you're using that platform, set the environment variable `PL_TORCH_DISTRIBUTED_BACKEND=gloo`
+## **Training**
 
-```
-(ldm) ~/stable-diffusion$ python3 ./main.py --base ./configs/stable-diffusion/v1-finetune.yaml \
-                                            -t \
-                                            --actual_resume ./models/ldm/stable-diffusion-v1/model.ckpt \
-                                            -n my_cat \
-                                            --gpus 0, \
-                                            --data_root D:/textual-inversion/my_cat \
-                                            --init_word 'cat'
+To train, prepare a folder that contains images sized at 512x512 and execute the
+following:
+
+### WINDOWS
+
+As the default backend is not available on Windows, if you're using that
+platform, set the environment variable `PL_TORCH_DISTRIBUTED_BACKEND` to `gloo`
+
+```bash
+python3 ./main.py -t \
+    --base ./configs/stable-diffusion/v1-finetune.yaml \
+    --actual_resume ./models/ldm/stable-diffusion-v1/model.ckpt \
+    -n my_cat \
+    --gpus 0 \
+    --data_root D:/textual-inversion/my_cat \
+    --init_word 'cat'
 ```
 
 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
-input images for the training epoch samples, samples scaled for a
-sample of the prompt and one with the init word provided.
+Conditioning contains the training prompts inputs, reconstruction the input
+images for the training epoch samples, samples scaled for a sample of the prompt
+and one with the init word provided.
 
 On a RTX3090, the process for SD will take ~1h @1.6 iterations/sec.
 
-_Note_: According to the associated paper, the optimal number of
-images is 3-5. Your model may not converge if you use more images than
-that.
+!!! note
 
-Training will run indefinitely, but you may wish to stop it (with
-ctrl-c) before the heat death of the universe, when you find a low
-loss epoch or around ~5000 iterations. Note that you can set a fixed
-limit on the number of training steps by decreasing the "max_steps"
-option in configs/stable_diffusion/v1-finetune.yaml (currently set to
-4000000)
+    According to the associated paper, the optimal number of
+    images is 3-5. Your model may not converge if you use more images than
+    that.
 
-**Running**
+Training will run indefinitely, but you may wish to stop it (with ctrl-c) before
+the heat death of the universe, when you find a low loss epoch or around ~5000
+iterations. Note that you can set a fixed limit on the number of training steps
+by decreasing the "max_steps" option in
+configs/stable_diffusion/v1-finetune.yaml (currently set to 4000000)
 
-Once the model is trained, specify the trained .pt or .bin file when
-starting dream using
+## **Run the Model**
 
-```
-(ldm) ~/stable-diffusion$ python3 ./scripts/dream.py --embedding_path /path/to/embedding.pt --full_precision
+Once the model is trained, specify the trained .pt or .bin file when starting
+invoke using
+
+```bash
+python3 ./scripts/invoke.py \
+    --embedding_path /path/to/embedding.pt
 ```
 
-Then, to utilize your subject at the dream prompt
+Then, to utilize your subject at the invoke prompt
 
-```
-dream> "a photo of *"
+```bash
+invoke> "a photo of *"
 ```
 
 This also works with image2image
 
-```
-dream> "waterfall and rainbow in the style of *" --init_img=./init-images/crude_drawing.png --strength=0.5 -s100 -n4
+```bash
+invoke> "waterfall and rainbow in the style of *" --init_img=./init-images/crude_drawing.png --strength=0.5 -s100 -n4
 ```
 
-For .pt files it's also possible to train multiple tokens (modify the placeholder string in `configs/stable-diffusion/v1-finetune.yaml`) and combine LDM checkpoints using:
+For .pt files it's also possible to train multiple tokens (modify the
+placeholder string in `configs/stable-diffusion/v1-finetune.yaml`) and combine
+LDM checkpoints using:
 
-```
-(ldm) ~/stable-diffusion$ python3 ./scripts/merge_embeddings.py \
-                                            --manager_ckpts /path/to/first/embedding.pt /path/to/second/embedding.pt [...] \
-                                            --output_path /path/to/output/embedding.pt
+```bash
+python3 ./scripts/merge_embeddings.py \
+    --manager_ckpts /path/to/first/embedding.pt \
+    [</path/to/second/embedding.pt>,[...]] \
+    --output_path /path/to/output/embedding.pt
 ```
 
-Credit goes to rinongal and the repository located at https://github.com/rinongal/textual_inversion Please see the repository and associated paper for details and limitations.
+Credit goes to rinongal and the repository
+
+Please see [the repository](https://github.com/rinongal/textual_inversion) and
+associated paper for details and limitations.

docs/features/UPSCALE.md

@@ -1,105 +0,0 @@
-# **GFPGAN and Real-ESRGAN Support**
-
-The script also provides the ability to do face restoration and
-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
-standard install location for python packages, and will put GFPGAN into a subdirectory of "src" 
-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 
-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**:
-~~~~
-> 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.
-
-Alternatively, if you have GFPGAN installed elsewhere, or if you are using
-an earlier version of this package which asked you to install GFPGAN in a
-sibling directory, you may use the `--gfpgan_dir` argument with `dream.py` to set a
-custom path to your GFPGAN directory. _There are other GFPGAN related
-boot arguments if you wish to customize further._
-
-**Note: Internet connection needed:**
-Users whose GPU machines are isolated from the Internet (e.g. on a
-University cluster) should be aware that the first time you run
-dream.py with GFPGAN and Real-ESRGAN turned on, it will try to
-download model files from the Internet. To rectify this, you may run
-`python3 scripts/preload_models.py` after you have installed GFPGAN
-and all its dependencies.
-
-**Usage**
-
-You will now have access to two new prompt arguments.
-
-**Upscaling**
-
-`-U : <upscaling_factor> <upscaling_strength>`
-
-The upscaling prompt argument takes two values. The first value is a
-scaling factor and should be set to either `2` or `4` only. This will
-either scale the image 2x or 4x respectively using different models.
-
-You can set the scaling stength between `0` and `1.0` to control
-intensity of the of the scaling. This is handy because AI upscalers
-generally tend to smooth out texture details. If you wish to retain
-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
-default to 0.75.
-
-**Face Restoration**
-
-`-G : <gfpgan_strength>`
-
-This prompt argument controls the strength of the face restoration
-that is being applied. Similar to upscaling, values between `0.5 to 0.8` are recommended.
-
-You can use either one or both without any conflicts. In cases where
-you use both, the image will be first upscaled and then the face
-restoration process will be executed to ensure you get the highest
-quality facial features.
-
-`--save_orig`
-
-When you use either `-U` or `-G`, the final result you get is upscaled
-or face modified. If you want to save the original Stable Diffusion
-generation, you can use the `-save_orig` prompt argument to save the
-original unaffected version too.
-
-**Example Usage**
-
-```
-dream > superman dancing with a panda bear -U 2 0.6 -G 0.4
-```
-
-This also works with img2img:
-
-```
-dream> a man wearing a pineapple hat -I path/to/your/file.png -U 2 0.5 -G 0.6
-```
-
-**Note**
-
-GFPGAN and Real-ESRGAN are both memory intensive. In order to avoid
-crashes and memory overloads during the Stable Diffusion process,
-these effects are applied after Stable Diffusion has completed its
-work.
-
-In single image generations, you will see the output right away but
-when you are using multiple iterations, the images will first be
-generated and then upscaled and face restored after that process is
-complete. While the image generation is taking place, you will still
-be able to preview the base images.
-
-If you wish to stop during the image generation but want to upscale or
-face restore a particular generated image, pass it again with the same
-prompt and generated seed along with the `-U` and `-G` prompt
-arguments to perform those actions.

docs/features/VARIATIONS.md

@@ -1,29 +1,41 @@
-# **Variations**
+---
+title: Variations
+---
+
+# :material-tune-variant: Variations
+
+## Intro
 
 Release 1.13 of SD-Dream adds support for image variations.
 
 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
 
-The prompt we will use throughout is `lucy lawless as xena, warrior princess, character portrait, high resolution.`
+The prompt we will use throughout is:
 
-This will be indicated as `prompt` in the examples below.
+`#!bash "lucy lawless as xena, warrior princess, character portrait, high resolution."`
 
-First we let SD create a series of images in the usual way, in this case requesting six iterations:
+This will be indicated as `#!bash "prompt"` in the examples below.
 
-```
-dream> lucy lawless as xena, warrior princess, character portrait, high resolution -n6
+First we let SD create a series of images in the usual way, in this case
+requesting six iterations:
+
+```bash
+invoke> lucy lawless as xena, warrior princess, character portrait, high resolution -n6
 ...
 Outputs:
 ./outputs/Xena/000001.1579445059.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -S1579445059
@@ -34,20 +46,22 @@ Outputs:
 ./outputs/Xena/000001.3357757885.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -S3357757885
 ```
 
-The one with seed 3357757885 looks nice:
-
-<img src="assets/variation_walkthru/000001.3357757885.png"/>
+<figure markdown>
+![var1](../assets/variation_walkthru/000001.3357757885.png)
+<figcaption> Seed 3357757885 looks nice </figcaption>
+</figure>
 
 ---
 
 ## 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.
 
-```
-dream> "prompt" -n6 -S3357757885 -v0.2
+```bash
+invoke> "prompt" -n6 -S3357757885 -v0.2
 ...
 Outputs:
 ./outputs/Xena/000002.784039624.png: "prompt" -s50 -W512 -H512 -C7.5 -Ak_lms -V 784039624:0.2 -S3357757885
@@ -60,33 +74,51 @@ 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.
 
-<img src="assets/variation_walkthru/000002.3647897225.png">
-<img src="assets/variation_walkthru/000002.1614299449.png">
+<figure markdown>
+![var2](../assets/variation_walkthru/000002.3647897225.png)
+<figcaption>subseed 3647897225</figcaption>
+</figure>
 
-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?
+<figure markdown>
+![var3](../assets/variation_walkthru/000002.1614299449.png)
+<figcaption>subseed 1614299449</figcaption>
+</figure>
 
-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
+invoke> "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:
 
-<img src="assets/variation_walkthru/000003.1614299449.png">
+<figure markdown>
+![var4](../assets/variation_walkthru/000003.1614299449.png)
+<figcaption> subseed 1614299449 </figcaption>
+</figure>
 
-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
+invoke> "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 +128,26 @@ 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:
 
-<img src="assets/variation_walkthru/000004.3747154981.png">
+<figure markdown>
+![var5](../assets/variation_walkthru/000004.3747154981.png)
+<figcaption> subseed 3747154981 </figcaption>
+</figure>
 
-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.
+
+## Variations and Samplers
+
+The sampler you choose has a strong effect on variation strength. Some
+samplers, such as `k_euler_a` are very "creative" and produce significant
+amounts of image-to-image variation even when the seed is fixed and the
+`-v` argument is very low. Others are more deterministic. Feel free to
+experiment until you find the combination that you like.
+
+Also be aware of the [Perlin Noise](OTHER.md#thresholding-and-perlin-noise-initialization-options)
+feature, which provides another way of introducing variability into your
+image generation requests.

docs/features/WEB.md

@@ -1,13 +1,369 @@
-# Barebones Web Server
+---
+title: InvokeAI 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: InvokeAI Web Server
 
-```
-(ldm) ~/stable-diffusion$ python3 scripts/dream.py --web
+As of version 2.0.0, this distribution comes with a full-featured web
+server (see screenshot). To use it, run the `invoke.py` script by
+adding the `--web` option:
+
+```bash
+(invokeai) ~/InvokeAI$ python3 scripts/invoke.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. To reach the server from a different machine on
+your LAN, you may launch the web server with the `--host` argument and
+either the IP address of the host you are running it on, or the
+wildcard `0.0.0.0`. For example:
 
-Kudos to [Tesseract Cat](https://github.com/TesseractCat) for contributing this code, and to [dagf2101](https://github.com/dagf2101) for refining it.
+```bash
+(invokeai) ~/InvokeAI$ python3 scripts/invoke.py --web --host 0.0.0.0
+```
 
-![Dream Web Server](../assets/dream_web_server.png)
+# Quick guided walkthrough of the WebGUI's features
+
+While most of the WebGUI's features are intuitive, here is a guided
+walkthrough through its various components.
+
+![Invoke Web Server - Major Components](../assets/invoke-web-server-1.png){:width="640px"}
+
+The screenshot above shows the Text to Image tab of the WebGUI. There
+are three main sections:
+
+1. A **control panel** on the left, which contains various settings
+for text to image generation. The most important part is the text
+field (currently showing `strawberry sushi`) for entering the text
+prompt, and the camera icon directly underneath that will render the
+image. We'll call this the *Invoke* button from now on.
+
+2. The **current image** section in the middle, which shows a large
+format version of the image you are currently working on. A series of
+buttons at the top ("image to image", "Use All", "Use Seed", etc) lets
+you modify the image in various ways.
+
+3. A **gallery* section on the left that contains a history of the
+images you have generated. These images are read and written to the
+directory specified at launch time in `--outdir`.
+
+In addition to these three elements, there are a series of icons for
+changing global settings, reporting bugs, and changing the theme on
+the upper right.
+
+There are also a series of icons to the left of the control panel (see
+highlighted area in the screenshot below) which select among a series
+of tabs for performing different types of operations.
+
+<figure markdown>
+![Invoke Web Server - Control Panel](../assets/invoke-web-server-2.png){:width="512px"}
+</figure>
+
+From top to bottom, these are:
+
+1. Text to Image  - generate images from text
+2. Image to Image - from an uploaded starting image (drawing or photograph) generate a new one, modified by the text prompt
+3. Inpainting (pending) - Interactively erase portions of a starting image and have the AI fill in the erased region from a text prompt.
+4. Outpainting (pending) - Interactively add blank space to the borders of a starting image and fill in the background from a text prompt.
+5. Postprocessing (pending) - Interactively postprocess generated images using a variety of filters.
+
+The inpainting, outpainting and postprocessing tabs are currently in
+development. However, limited versions of their features can already
+be accessed through the Text to Image and Image to Image tabs.
+
+## Walkthrough
+
+The following walkthrough will exercise most (but not all) of the
+WebGUI's feature set.
+
+### Text to Image
+
+1. Launch the WebGUI using `python scripts/invoke.py --web` and
+connect to it with your browser by accessing
+`http://localhost:9090`. If the browser and server are running on
+different machines on your LAN, add the option `--host 0.0.0.0` to the
+launch command line and connect to the machine hosting the web server
+using its IP address or domain name.
+
+2. If all goes well, the WebGUI should come up and you'll see a green
+`connected` message on the upper right.
+
+#### Basics
+
+1. Generate an image by typing *strawberry sushi* into the large
+prompt field on the upper left and then clicking on the Invoke button
+(the one with the Camera icon). After a short wait, you'll see a large
+image of sushi in the image panel, and a new thumbnail in the gallery
+on the right.
+
+    If you need more room on the screen, you can turn the gallery  off
+    by clicking on the **x** to the right of "Your Invocations". You can
+    turn it back on later by clicking the image icon that appears in the
+    gallery's place.
+
+    The images are written into the directory indicated by the `--outdir`
+    option provided at script launch time. By default, this is
+    `outputs/img-samples` under the InvokeAI directory.
+
+2. Generate a bunch of strawberry sushi images by increasing the
+number of requested images by adjusting the Images counter just below
+the Camera button. As each is generated, it will be added to the
+gallery. You can switch the active image by clicking on the gallery
+thumbnails.
+
+3. Try playing with different settings, including image width and
+height, the Sampler, the Steps and the CFG scale.
+
+    Image *Width* and *Height* do what you'd expect. However, be aware that
+    larger images consume more VRAM memory and take longer to generate.
+
+    The *Sampler* controls how the AI selects the image to display. Some
+    samplers are more "creative" than others and will produce a wider
+    range of variations (see next section). Some samplers run faster than
+    others.
+
+    *Steps* controls how many noising/denoising/sampling steps the AI will
+    take. The higher this value, the more refined the image will be, but
+    the longer the image will take to generate. A typical strategy is to
+    generate images with a low number of steps in order to select one to
+    work on further, and then regenerate it using a higher number of
+    steps.
+
+    The *CFG Scale* controls how hard the AI tries to match the generated
+    image to the input prompt. You can go as high or low as you like, but
+    generally values greater than 20 won't improve things much, and values
+    lower than 5 will produce unexpected images. There are complex
+    interactions between *Steps*, *CFG Scale* and the *Sampler*, so
+    experiment to find out what works for you.
+
+6. To regenerate a previously-generated image, select the image you
+want and click *Use All*. This loads the text prompt and other
+original settings into the control panel. If you then press *Invoke*
+it will regenerate the image exactly. You can also selectively modify
+the prompt or other settings to tweak the image.
+
+    Alternatively, you may click on *Use Seed* to load just the image's
+    seed, and leave other settings unchanged.
+
+7. To regenerate a Stable Diffusion image that was generated by
+another SD package, you need to know its text prompt and its
+*Seed*. Copy-paste the prompt into the prompt box, unset the
+*Randomize Seed* control in the control panel, and copy-paste the
+desired *Seed* into its text field. When you Invoke, you will get
+something similar to the original image. It will not be exact unless
+you also set the correct values for the original sampler, CFG,
+steps and dimensions, but it will (usually) be close.
+
+#### Variations on a theme
+
+1. Let's try generating some variations. Select your favorite sushi
+image from the gallery to load it. Then select "Use All" from the list
+of buttons above. This will load up all the settings used to generate
+this image, including its unique seed.
+
+    Go down to the Variations section of the Control Panel and set the
+    button to On. Set Variation Amount to 0.2 to generate a modest
+    number of variations on the image, and also set the Image counter to
+    `4`. Press the `invoke` button. This will generate a series of related
+    images. To obtain smaller variations, just lower the Variation
+    Amount. You may also experiment with changing the Sampler. Some
+    samplers generate more variability than others. *k_euler_a* is
+    particularly creative, while *ddim* is pretty conservative.
+
+2. For even more variations, experiment with increasing the setting
+for *Perlin*. This adds a bit of noise to the image generation
+process. Note that values of Perlin noise greater than 0.15 produce
+poor images for several of the samplers.
+
+#### Facial reconstruction and upscaling
+
+Stable Diffusion frequently produces mangled faces, particularly when
+there are multiple figures in the same scene. Stable Diffusion has
+particular issues with generating reallistic eyes. InvokeAI provides
+the ability to reconstruct faces using either the GFPGAN or CodeFormer
+libraries. For more information see [POSTPROCESS](POSTPROCESS.md).
+  
+1. Invoke a prompt that generates a mangled face. A prompt that often
+gives this is "portrait of a lawyer, 3/4 shot" (this is not intended
+as a slur against lawyers!) Once you have an image that needs some
+touching up, load it into the Image panel, and press the button with
+the face icon (highlighted in the first screenshot below). A dialog
+box will appear. Leave *Strength* at 0.8 and press *Restore Faces". If
+all goes well, the eyes and other aspects of the face will be improved
+(see the second screenshot)
+
+    ![Invoke Web Server - Original Image](../assets/invoke-web-server-3.png)
+
+    ![Invoke Web Server - Retouched Image](../assets/invoke-web-server-4.png)
+
+    The facial reconstruction *Strength* field adjusts how aggressively
+    the face library will try to alter the face. It can be as high as 1.0,
+    but be aware that this often softens the face airbrush style, losing
+    some details. The default 0.8 is usually sufficient.
+
+2. "Upscaling" is the process of increasing the size of an image while
+retaining the sharpness. InvokeAI uses an external library called
+"ESRGAN" to do this. To invoke upscaling, simply select an image and
+press the *HD* button above it. You can select between 2X and 4X
+upscaling, and adjust the upscaling strength, which has much the same
+meaning as in facial reconstruction. Try running this on one of your
+previously-generated images.
+
+3. Finally, you can run facial reconstruction and/or upscaling
+automatically after each Invocation. Go to the Advanced Options
+section of the Control Panel and turn on *Restore Face* and/or
+*Upscale*.
+
+### Image to Image
+
+InvokeAI lets you take an existing image and use it as the basis for a
+new creation. You can use any sort of image, including a photograph, a
+scanned sketch, or a digital drawing, as long as it is in PNG or JPEG
+format.
+
+For this tutorial, we'll use files named
+[Lincoln-and-Parrot-512.png](../assets/Lincoln-and-Parrot-512.png),
+and
+[Lincoln-and-Parrot-512-transparent.png](../assets/Lincoln-and-Parrot-512-transparent.png).
+Download these images to your local machine now to continue with the walkthrough.
+
+1. Click on the *Image to Image* tab icon, which is the second icon
+from the top on the left-hand side of the screen:
+
+    <figure markdown>
+    ![Invoke Web Server - Image to Image Icon](../assets/invoke-web-server-5.png)
+    </figure>
+
+    This will bring you to a screen similar to the one shown here:
+
+    <figure markdown>
+    ![Invoke Web Server - Image to Image Tab](../assets/invoke-web-server-6.png){:width="640px"}
+    </figure>
+
+2. Drag-and-drop the Lincoln-and-Parrot image into the Image panel, or
+click the blank area to get an upload dialog. The image will load into
+an area marked *Initial Image*. (The WebGUI will also load the most
+recently-generated image from the gallery into a section on the left,
+but this image will be replaced in the next step.)
+
+3. Go to the prompt box and type *old sea captain with raven on
+shoulder* and press Invoke. A derived image will appear to the right
+of the original one:
+
+    ![Invoke Web Server - Image to Image example](../assets/invoke-web-server-7.png){:width="640px"}
+
+4. Experiment with the different settings. The most influential one
+in Image to Image is *Image to Image Strength* located about midway
+down the control panel. By default it is set to 0.75, but can range
+from 0.0 to 0.99. The higher the value, the more of the original image
+the AI will replace. A value of 0 will leave the initial image
+completely unchanged, while 0.99 will replace it completely. However,
+the Sampler and CFG Scale also influence the final result. You can
+also generate variations in the same way as described in Text to
+Image.
+
+5. What if we only want to change certain part(s) of the image and
+leave the rest intact? This is called Inpainting, and a future version
+of the InvokeAI web server will provide an interactive painting canvas
+on which you can directly draw the areas you wish to Inpaint into. For
+now, you can achieve this effect by using an external photoeditor tool
+to make one or more regions of the image transparent as described in
+[INPAINTING.md] and uploading that.
+
+    The file
+    [Lincoln-and-Parrot-512-transparent.png](../assets/Lincoln-and-Parrot-512-transparent.png)
+    is a version of the earlier image in which the area around the parrot
+    has been replaced with transparency. Click on the "x" in the upper
+    right of the Initial Image and upload the transparent version. Using
+    the same prompt "old sea captain with raven on shoulder" try Invoking
+    an image. This time, only the parrot will be replaced, leaving the
+    rest of the original image intact:
+
+<figure markdown>
+![Invoke Web Server - Inpainting](../assets/invoke-web-server-8.png){:width="640px"}
+</figure>
+
+6. Would you like to modify a previously-generated image using the
+Image to Image facility? Easy! While in the Image to Image panel,
+hover over any of the gallery images to see a little menu of icons pop
+up.  Click the picture icon to instantly send the selected image to
+Image to Image as the initial image.
+
+You can do the same from the Text to Image tab by clicking on the
+picture icon above the central image panel. The screenshot below
+shows where the "use as initial image" icons are located.
+
+![Invoke Web Server - Use as Image Links](../assets/invoke-web-server-9.png){:width="640px"}
+
+## Parting remarks
+
+This concludes the walkthrough, but there are several more features that you
+can explore. Please check out the [Command Line Interface](CLI.md)
+documentation for further explanation of the advanced features that
+were not covered here.
+
+The WebGUI is only rapid development. Check back regularly for
+updates!
+
+## Reference
+
+### Additional Options
+
+ parameter <img width=160 align="right"> | effect
+-- | --
+`--web_develop` | Starts the web server in development mode.
+`--web_verbose` | Enables verbose logging
+`--cors [CORS ...]` | Additional allowed origins, comma-separated
+`--host HOST` | Web server: Host or IP to listen on. Set to 0.0.0.0 to accept traffic from other devices on your network.
+`--port PORT` | Web server: Port to listen on
+`--gui` | Start InvokeAI GUI - This is the "desktop mode" version of the web app. It uses Flask to create a desktop app experience of the webserver.
+
+### Web Specific Features
+
+The web experience offers an incredibly easy-to-use experience for interacting with the InvokeAI toolkit. 
+For detailed guidance on individual features, see the Feature-specific help documents available in this directory.
+Note that the latest functionality available in the CLI may not always be available in the Web interface.
+
+#### Dark Mode & Light Mode
+
+The InvokeAI interface is available in a nano-carbon black & purple Dark Mode, and a "burn your eyes out Nosferatu" Light Mode. These can be toggled by clicking the Sun/Moon icons at the top right of the interface. 
+
+![InvokeAI Web Server - Dark Mode](../assets/invoke_web_dark.png)
+
+![InvokeAI Web Server - Light Mode](../assets/invoke_web_light.png)
+
+#### Invocation Toolbar
+
+The left side of the InvokeAI interface is available for customizing the prompt and the settings used for invoking your new image. Typing your prompt into the open text field and clicking the Invoke button will produce the image based on the settings configured in the toolbar.
+
+See below for additional documentation related to each feature:
+
+- [Core Prompt Settings](./CLI.md)
+- [Variations](./VARIATIONS.md)
+- [Upscaling](./POSTPROCESS.md#upscaling)
+- [Image to Image](./IMG2IMG.md)
+- [Inpainting](./INPAINTING.md)
+- [Other](./OTHER.md)
+
+#### Invocation Gallery
+
+The currently selected --outdir (or the default outputs folder) will display all previously generated files on load. As new invocations are generated, these will be dynamically added to the gallery, and can be previewed by selecting them. Each image also has a simple set of actions (e.g., Delete, Use Seed, Use All Parameters, etc.) that can be accessed by hovering over the image.
+
+#### Image Workspace
+
+When an image from the Invocation Gallery is selected, or is generated, the image will be displayed within the center of the interface. A quickbar of common image interactions are displayed along the top of the image, including:
+
+- Use image in the `Image to Image` workflow
+- Initialize Face Restoration on the selected file
+- Initialize Upscaling on the selected file
+- View File metadata and details
+- Delete the file
+
+## Acknowledgements
+
+A huge shout-out to the core team working to make this vision a
+reality, including
+[psychedelicious](https://github.com/psychedelicious),
+[Kyle0654](https://github.com/Kyle0654) and
+[blessedcoolant](https://github.com/blessedcoolant). [hipsterusername](https://github.com/hipsterusername)
+was the team's unofficial cheerleader and added tooltips/docs.

docs/help/SAMPLER_CONVERGENCE.md

@@ -0,0 +1,151 @@
+---
+title: Sampler Convergence
+---
+
+# :material-palette-advanced: *Sampler Convergence*
+
+As features keep increasing, making the right choices for your needs can become increasingly difficult. What sampler to use? And for how many steps? Do you change the CFG value? Do you use prompt weighting? Do you allow variations?
+
+Even once you have a result, do you blend it with other images? Pass it through `img2img`? With what strength? Do you use inpainting to correct small details? Outpainting to extend cropped sections?
+
+The purpose of this series of documents is to help you better understand these tools, so you can make the best out of them. Feel free to contribute with your own findings!
+
+In this document, we will talk about sampler convergence.
+
+Looking for a short version? Here's a TL;DR in 3 tables.
+
+!!! note "Remember"
+
+    - Results converge as steps (`-s`) are increased (except for `K_DPM_2_A` and `K_EULER_A`). Often at ≥ `-s100`, but may require ≥ `-s700`).
+    - Producing a batch of candidate images at low (`-s8` to `-s30`) step counts can save you hours of computation.
+    - `K_HEUN` and `K_DPM_2`  converge in less steps (but are slower).
+    - `K_DPM_2_A` and `K_EULER_A` incorporate a lot of creativity/variability.
+
+<div align="center" markdown>
+
+| Sampler   | (3 sample avg) it/s (M1 Max 64GB, 512x512)  |
+|---|---|
+|  `DDIM` | 1.89  |
+|  `PLMS` | 1.86  |
+|  `K_EULER` | 1.86  |
+|  `K_LMS` | 1.91  |
+|  `K_HEUN` | 0.95 (slower)  |
+|  `K_DPM_2` | 0.95 (slower)  |
+|  `K_DPM_2_A` | 0.95 (slower)  |
+|  `K_EULER_A` | 1.86  |
+
+</div>
+
+!!! tip "suggestions"
+
+    For most use cases, `K_LMS`, `K_HEUN` and `K_DPM_2` are the best choices (the latter 2 run 0.5x as quick, but tend to converge 2x as quick as `K_LMS`). At very low steps (≤ `-s8`), `K_HEUN` and `K_DPM_2` are not recommended. Use `K_LMS` instead.
+    
+    For variability, use `K_EULER_A` (runs 2x as quick as `K_DPM_2_A`).
+
+---
+
+### *Sampler results*
+
+Let's start by choosing a prompt and using it with each of our 8 samplers, running it for 10, 20, 30, 40, 50 and 100 steps.
+
+Anime. `"an anime girl" -W512 -H512 -C7.5 -S3031912972`
+
+![191636411-083c8282-6ed1-4f78-9273-ee87c0a0f1b6-min (1)](https://user-images.githubusercontent.com/50542132/191868725-7f7af991-e254-4c1f-83e7-bed8c9b2d34f.png)
+
+### *Sampler convergence*
+
+Immediately, you can notice results tend to converge -that is, as `-s` (step) values increase, images look more and more similar until there comes a point where the image no longer changes.
+
+You can also notice how `DDIM` and `PLMS` eventually tend to converge to K-sampler results as steps are increased.
+Among K-samplers, `K_HEUN` and `K_DPM_2` seem to require the fewest steps to converge, and even at low step counts they are good indicators of the final result. And finally, `K_DPM_2_A` and `K_EULER_A` seem to do a bit of their own thing and don't keep much similarity with the rest of the samplers.
+
+### *Batch generation speedup*
+
+This realization is very useful because it means you don't need to create a batch of 100 images (`-n100`) at `-s100` to choose your favorite 2 or 3 images.
+You can produce the same 100 images at `-s10` to `-s30` using a K-sampler (since they converge faster), get a rough idea of the final result, choose your 2 or 3 favorite ones, and then run `-s100` on those images to polish some details.
+The latter technique is 3-8x as quick.
+
+!!! example
+
+    At 60s per 100 steps.
+
+    A) 60s * 100 images = 6000s (100 images at `-s100`, manually picking 3 favorites)
+
+    B) 6s *100 images + 60s* 3 images = 780s (100 images at `-s10`, manually picking 3 favorites, and running those 3 at `-s100` to polish details)
+
+    The result is __1 hour and 40 minutes__ for Variant A, vs __13 minutes__ for Variant B.
+
+### *Topic convergance*
+
+Now, these results seem interesting, but do they hold for other topics? How about nature? Food? People? Animals? Let's try!
+
+Nature. `"valley landscape wallpaper, d&d art, fantasy, painted, 4k, high detail, sharp focus, washed colors, elaborate excellent painted illustration" -W512 -H512 -C7.5 -S1458228930`
+
+![191736091-dda76929-00d1-4590-bef4-7314ea4ea419-min (1)](https://user-images.githubusercontent.com/50542132/191868763-b151c69e-0a72-4cf1-a151-5a64edd0c93e.png)
+
+With nature, you can see how initial results are even more indicative of final result -more so than with characters/people. `K_HEUN` and `K_DPM_2` are again the quickest indicators, almost right from the start. Results also converge faster (e.g. `K_HEUN` converged at `-s21`).
+
+Food. `"a hamburger with a bowl of french fries" -W512 -H512 -C7.5 -S4053222918`
+
+![191639011-f81d9d38-0a15-45f0-9442-a5e8d5c25f1f-min (1)](https://user-images.githubusercontent.com/50542132/191868898-98801a62-885f-4ea1-aee8-563503522aa9.png)
+
+Again, `K_HEUN` and `K_DPM_2` take the fewest number of steps to be good indicators of the final result. `K_DPM_2_A` and `K_EULER_A` seem to incorporate a lot of creativity/variability, capable of producing rotten hamburgers, but also of adding lettuce to the mix. And they're the only samplers that produced an actual 'bowl of fries'!
+
+Animals. `"grown tiger, full body" -W512 -H512 -C7.5 -S3721629802`
+
+![191771922-6029a4f5-f707-4684-9011-c6f96e25fe56-min (1)](https://user-images.githubusercontent.com/50542132/191868870-9e3b7d82-b909-429f-893a-13f6ec343454.png)
+
+`K_HEUN` and `K_DPM_2` once again require the least number of steps to be indicative of the final result (around `-s30`), while other samplers are still struggling with several tails or malformed back legs.
+
+It also takes longer to converge (for comparison, `K_HEUN` required around 150 steps to converge). This is normal, as producing human/animal faces/bodies is one of the things the model struggles the most with. For these topics, running for more steps will often increase coherence within the composition.
+
+People. `"Ultra realistic photo, (Miranda Bloom-Kerr), young, stunning model, blue eyes, blond hair, beautiful face, intricate, highly detailed, smooth, art by artgerm and greg rutkowski and alphonse mucha, stained glass" -W512 -H512 -C7.5 -S2131956332`. This time, we will go up to 300 steps.
+
+![Screenshot 2022-09-23 at 02 05 48-min (1)](https://user-images.githubusercontent.com/50542132/191871743-6802f199-0ffd-4986-98c5-df2d8db30d18.png)
+
+Observing the results, it again takes longer for all samplers to converge (`K_HEUN` took around 150 steps), but we can observe good indicative results much earlier (see: `K_HEUN`). Conversely, `DDIM` and `PLMS` are still undergoing moderate changes (see: lace around her neck), even at `-s300`.
+
+In fact, as we can see in this other experiment, some samplers can take 700+ steps to converge when generating people.
+
+![191988191-c586b75a-2d7f-4351-b705-83cc1149881a-min (1)](https://user-images.githubusercontent.com/50542132/191992123-7e0759d6-6220-42c4-a961-88c7071c5ee6.png)
+
+Note also the point of convergence may not be the most desirable state (e.g. I prefer an earlier version of the face, more rounded), but it will probably be the most coherent arms/hands/face attributes-wise. You can always merge different images with a photo editing tool and pass it through `img2img` to smoothen the composition.
+
+### *Sampler generation times*
+
+Once we understand the concept of sampler convergence, we must look into the performance of each sampler in terms of steps (iterations) per second, as not all samplers run at the same speed.
+
+<div align="center" markdown>
+
+On my M1 Max with 64GB of RAM, for a 512x512 image
+
+| Sampler | (3 sample average) it/s |
+| :--- | :--- |
+|  `DDIM` | 1.89  |
+|  `PLMS` | 1.86  |
+|  `K_EULER` | 1.86  |
+|  `K_LMS` | 1.91  |
+|  `K_HEUN` | 0.95 (slower)  |
+|  `K_DPM_2` | 0.95 (slower)  |
+|  `K_DPM_2_A` | 0.95 (slower)  |
+|  `K_EULER_A` | 1.86  |
+
+</div>
+
+Combining our results with the steps per second of each sampler, three choices come out on top: `K_LMS`, `K_HEUN` and `K_DPM_2` (where the latter two run 0.5x as quick but tend to converge 2x as quick as `K_LMS`). For creativity and a lot of variation between iterations, `K_EULER_A` can be a good choice (which runs 2x as quick as `K_DPM_2_A`).
+
+Additionally, image generation at very low steps (≤ `-s8`) is not recommended for `K_HEUN` and `K_DPM_2`. Use `K_LMS` instead.
+
+![K-compare](https://user-images.githubusercontent.com/50542132/192046823-2714cb29-bbf3-4eb1-9213-e27a0963905c.png){ width=600}
+
+### *Three key points*
+
+Finally, it is relevant to mention that, in general, there are 3 important moments in the process of image formation as steps increase:
+
+* The (earliest) point at which an image becomes a good indicator of the final result (useful for batch generation at low step values, to then improve the quality/coherence of the chosen images via running the same prompt and seed for more steps).
+
+* The (earliest) point at which an image becomes coherent, even if different from the result if steps are increased (useful for batch generation at low step values, where quality/coherence is improved via techniques other than increasing the steps -e.g. via inpainting).
+
+* The point at which an image fully converges.
+
+Hence, remember that your workflow/strategy should define your optimal number of steps, even for the same prompt and seed (for example, if you seek full convergence, you may run `K_LMS` for `-s200` in the case of the red-haired girl, but `K_LMS` and `-s20`-taking one tenth the time- may do as well if your workflow includes adding small details, such as the missing shoulder strap, via `img2img`).

docs/help/TROUBLESHOOT.md

@@ -1,68 +1,127 @@
-# **Frequently Asked Questions**
+---
+title: F.A.Q.
+hide:
+  - toc
+---
 
-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.
+During `conda env create`, conda hangs indefinitely.
+
+If it is because of the last PIP step (usually stuck in the Git Clone step, you can check the detailed log by this method):
+```bash
+export PIP_LOG="/tmp/pip_log.txt"
+touch ${PIP_LOG}
+tail -f ${PIP_LOG} & 
+conda env create -f environment-mac.yaml --debug --verbose
+killall tail
+rm ${PIP_LOG}
+```
 
 **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.
+Conda sometimes gets stuck  at the last PIP step, in which several git repositories are
+cloned and built.
+
+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.
+
+To further understand the problem to checking the install lot using this method:
+
+```bash
+export PIP_LOG="/tmp/pip_log.txt"
+touch ${PIP_LOG}
+tail -f ${PIP_LOG} & 
+conda env create -f environment-mac.yaml --debug --verbose
+killall tail
+rm ${PIP_LOG}
+```
 
 ---
 
-**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.
+`invoke.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``.
+`invoke.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 `InvokeAI` directory, run `conda env update` 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 `pip install -e .`
+and/or `conda env update` (These commands won't break anything.)
 
-**Sub Branch**
+`pip install -e .` and/or `conda env update -f environment.yaml`
 
-If the feature/fix is on a branch (e.g. "_foo-bugfix_"), the recipe is similar, but do a `git pull <name of branch>`.
+(These commands won't break anything.)
 
-**Not Committed**
+#### **Sub Branch**
 
-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>`
+If the feature/fix is on a branch (e.g. "_foo-bugfix_"), the recipe is similar, but do a
+`git pull <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:
+#### **Not Committed**
 
-```
-git clone https://github.com/<name of contributor>/stable-diffusion/tree/<name
-of branch>
-```
+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
 
-You will need to go through the install procedure again, but it should be fast because all the dependencies are already loaded.
+`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.
 
 ---
+
+### **QUESTION**
+
+Image generation crashed with CUDA out of memory error after successful sampling. 
+
+### **SOLUTION**
+
+Try to run script with option `--free_gpu_mem` This will free memory before image decoding step.

docs/index.html

@@ -0,0 +1,19 @@
+<!-- HTML for static distribution bundle build -->
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Swagger UI</title>
+    <link rel="stylesheet" type="text/css" href="swagger-ui/swagger-ui.css" />
+    <link rel="stylesheet" type="text/css" href="swagger-ui/index.css" />
+    <link rel="icon" type="image/png" href="swagger-ui/favicon-32x32.png" sizes="32x32" />
+    <link rel="icon" type="image/png" href="swagger-ui/favicon-16x16.png" sizes="16x16" />
+  </head>
+
+  <body>
+    <div id="swagger-ui"></div>
+    <script src="swagger-ui/swagger-ui-bundle.js" charset="UTF-8"> </script>
+    <script src="swagger-ui/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
+    <script src="swagger-ui/swagger-initializer.js" charset="UTF-8"> </script>
+  </body>
+</html>

docs/index.md

@@ -0,0 +1,175 @@
+---
+title: Home
+---
+
+<!--
+  The Docs you find here (/docs/*) are built and deployed via mkdocs. If you want to run a local version to verify your changes, it's as simple as::
+
+  ```bash
+  pip install -r requirements-mkdocs.txt
+  mkdocs serve
+  ```
+-->
+<div align="center" markdown>
+
+# ^^**InvokeAI: A Stable Diffusion Toolkit**^^ :tools: <br> <small>Formerly known as lstein/stable-diffusion</small>
+
+![project logo](assets/logo.png)
+
+[![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-invoke-conda.yml
+[discord badge]: https://flat.badgen.net/discord/members/ZmtBAhwWhy?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=lstein%2Fstable-diffusion
+[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
+
+</div>
+
+<a href="https://github.com/invoke-ai/InvokeAI">InvokeAI</a> is an
+implementation of Stable Diffusion, the open source text-to-image and
+image-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.
+
+**Quick links**: [<a href="https://discord.gg/NwVCmKwY">Discord Server</a>] [<a href="https://github.com/invoke-ai/InvokeAI/">Code and Downloads</a>] [<a href="https://github.com/invoke-ai/InvokeAI/issues">Bug Reports</a>] [<a href="https://github.com/invoke-ai/InvokeAI/discussions">Discussion, Ideas & Q&A</a>]
+
+<div align="center"><img src="assets/invoke-web-server-1.png" width=640></div>
+
+!!! note
+
+    This fork is rapidly evolving. Please use the [Issues tab](https://github.com/invoke-ai/InvokeAI/issues) to report bugs and make feature requests. Be sure to use the provided templates. They will help aid diagnose issues faster.
+
+## :octicons-package-dependencies-24: Installation
+
+This fork is supported across multiple platforms. You can find individual installation instructions
+below.
+
+- :fontawesome-brands-linux: [Linux](installation/INSTALL_LINUX.md)
+- :fontawesome-brands-windows: [Windows](installation/INSTALL_WINDOWS.md)
+- :fontawesome-brands-apple: [Macintosh](installation/INSTALL_MAC.md)
+
+## :fontawesome-solid-computer: Hardware Requirements
+
+### :octicons-cpu-24: System
+
+You wil need one of the following:
+
+- :simple-nvidia: An NVIDIA-based graphics card with 4 GB or more VRAM memory.
+- :fontawesome-brands-apple: An Apple computer with an M1 chip.
+
+### :fontawesome-solid-memory: Memory
+
+- At least 12 GB Main Memory RAM.
+
+### :fontawesome-regular-hard-drive: Disk
+
+- At least 12 GB of free disk space for the machine learning model, Python, and all its dependencies.
+
+!!! info
+
+    If you are have a Nvidia 10xx series card (e.g. the 1080ti), please run the invoke script in
+    full-precision mode as shown below.
+
+    Similarly, specify full-precision mode on Apple M1 hardware.
+
+    Precision is auto configured based on the device. If however you encounter errors like 
+    `expected type Float but found Half` or `not implemented for Half` you can try starting 
+    `invoke.py` with the `--precision=float32` flag:
+
+    ```bash
+    (invokeai) ~/InvokeAI$ python scripts/invoke.py --full_precision
+    ```
+
+## :octicons-log-16: Latest Changes
+
+### v2.0.1 <small>(13 October 2022)</small>
+
+- fix noisy images at high step count when using k* samplers
+- dream.py script now calls invoke.py module directly rather than
+  via a new python process (which could break the environment)
+
+### v2.0.0 <small>(9 October 2022)</small>
+
+- `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains
+  for backward compatibility.
+- Completely new WebGUI - launch with `python3 scripts/invoke.py --web`
+- Support for <a href="https://invoke-ai.github.io/InvokeAI/features/INPAINTING/">inpainting</a> and <a href="https://invoke-ai.github.io/InvokeAI/features/OUTPAINTING/">outpainting</a>
+- img2img runs on all k* samplers
+- Support for <a href="https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#negative-and-unconditioned-prompts">negative prompts</a>
+- Support for CodeFormer face reconstruction
+- Support for Textual Inversion on Macintoshes
+- Support in both WebGUI and CLI for <a href="https://invoke-ai.github.io/InvokeAI/features/POSTPROCESS/">post-processing of previously-generated images</a>
+  using facial reconstruction, ESRGAN upscaling, outcropping (similar to DALL-E infinite canvas),
+  and "embiggen" upscaling. See the `!fix` command.
+- New `--hires` option on `invoke>` line allows <a href="https://invoke-ai.github.io/InvokeAI/features/CLI/#txt2img">larger images to be created without duplicating elements</a>, at the cost of some performance.
+- New `--perlin` and `--threshold` options allow you to add and control variation
+  during image generation (see <a href="https://github.com/invoke-ai/InvokeAI/blob/main/docs/features/OTHER.md#thresholding-and-perlin-noise-initialization-options">Thresholding and Perlin Noise Initialization</a>
+- Extensive metadata now written into PNG files, allowing reliable regeneration of images
+  and tweaking of previous settings.
+- Command-line completion in `invoke.py` now works on Windows, Linux and Mac platforms.
+- Improved <a href="https://invoke-ai.github.io/InvokeAI/features/CLI/">command-line completion behavior</a>.
+  New commands added:
+  - List command-line history with `!history`
+  - Search command-line history with `!search`
+  - Clear history with `!clear`
+- Deprecated `--full_precision` / `-F`. Simply omit it and `invoke.py` will auto
+  configure. To switch away from auto use the new flag like `--precision=float32`.
+
+For older changelogs, please visit the **[CHANGELOG](CHANGELOG.md#v114-11-september-2022)**.
+
+## :material-target: Troubleshooting
+
+Please check out our **[:material-frequently-asked-questions: Q&A](help/TROUBLESHOOT.md)** to get solutions for common installation
+problems and other issues.
+
+## :octicons-repo-push-24: 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 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.
+
+## :octicons-person-24: Contributors
+
+This fork is a combined effort of various people from across the world.
+[Check out the list of all these amazing people](other/CONTRIBUTORS.md). We thank them for their
+time, hard work and effort.
+
+## :octicons-question-24: Support
+
+For support, please use this repository's GitHub Issues tracking service. Feel free 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)
+
+## :octicons-book-24: Further Reading
+
+Please see the original README for more information on this software and underlying algorithm,
+located in the file [README-CompViz.md](other/README-CompViz.md).

docs/installation/INSTALL_DOCKER.md

@@ -0,0 +1,261 @@
+---
+title: Docker
+---
+
+# :fontawesome-brands-docker: Docker
+
+## Before you begin
+
+- For end users: Install Stable Diffusion locally using the instructions for
+  your OS.
+- For developers: For container-related development tasks or for enabling easy
+  deployment to other environments (on-premises or cloud), follow these
+  instructions. For general use, install locally to leverage your machine's GPU.
+
+## Why containers?
+
+They provide a flexible, reliable way to build and deploy Stable Diffusion.
+You'll also use a Docker volume to store the largest model files and image
+outputs as a first step in decoupling storage and compute. Future enhancements
+can do this for other assets. See [Processes](https://12factor.net/processes)
+under the Twelve-Factor App methodology for details on why running applications
+in such a stateless fashion is important.
+
+You can specify the target platform when building the image and running the
+container. You'll also need to specify the Stable Diffusion requirements file
+that matches the container's OS and the architecture it will run on.
+
+Developers on Apple silicon (M1/M2): You
+[can't access your GPU cores from Docker containers](https://github.com/pytorch/pytorch/issues/81224)
+and performance is reduced compared with running it directly on macOS but for
+development purposes it's fine. Once you're done with development tasks on your
+laptop you can build for the target platform and architecture and deploy to
+another environment with NVIDIA GPUs on-premises or in the cloud.
+
+## Installation on a Linux container
+
+### Prerequisites
+
+#### Get the data files
+
+Go to
+[Hugging Face](https://huggingface.co/CompVis/stable-diffusion-v-1-4-original),
+and click "Access repository" to Download the model file `sd-v1-4.ckpt` (~4 GB)
+to `~/Downloads`. You'll need to create an account but it's quick and free.
+
+Also download the face restoration model.
+
+```Shell
+cd ~/Downloads
+wget https://github.com/TencentARC/GFPGAN/releases/download/v1.3.0/GFPGANv1.4.pth
+```
+
+#### Install [Docker](https://github.com/santisbon/guides#docker)
+
+On the Docker Desktop app, go to Preferences, Resources, Advanced. Increase the
+CPUs and Memory to avoid this
+[Issue](https://github.com/invoke-ai/InvokeAI/issues/342). You may need to
+increase Swap and Disk image size too.
+
+### Setup
+
+Set the fork you want to use and other variables.
+
+```Shell
+TAG_STABLE_DIFFUSION="santisbon/stable-diffusion"
+PLATFORM="linux/arm64"
+GITHUB_STABLE_DIFFUSION="-b orig-gfpgan https://github.com/santisbon/stable-diffusion.git"
+REQS_STABLE_DIFFUSION="requirements-linux-arm64.txt"
+CONDA_SUBDIR="osx-arm64"
+
+echo $TAG_STABLE_DIFFUSION
+echo $PLATFORM
+echo $GITHUB_STABLE_DIFFUSION
+echo $REQS_STABLE_DIFFUSION
+echo $CONDA_SUBDIR
+```
+
+Create a Docker volume for the downloaded model files.
+
+```Shell
+docker volume create my-vol
+```
+
+Copy the data files to the Docker volume using a lightweight Linux container.
+We'll need the models at run time. You just need to create the container with
+the mountpoint; no need to run this dummy container.
+
+```Shell
+cd ~/Downloads # or wherever you saved the files
+
+docker create --platform $PLATFORM --name dummy --mount source=my-vol,target=/data alpine
+
+docker cp sd-v1-4.ckpt dummy:/data
+docker cp GFPGANv1.4.pth dummy:/data
+```
+
+Get the repo and download the Miniconda installer (we'll need it at build time).
+Replace the URL with the version matching your container OS and the architecture
+it will run on.
+
+```Shell
+cd ~
+git clone $GITHUB_STABLE_DIFFUSION
+
+cd stable-diffusion/docker-build
+chmod +x entrypoint.sh
+wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-aarch64.sh -O anaconda.sh && chmod +x anaconda.sh
+```
+
+Build the Docker image. Give it any tag `-t` that you want.  
+Choose the Linux container's host platform: x86-64/Intel is `amd64`. Apple
+silicon is `arm64`. If deploying the container to the cloud to leverage powerful
+GPU instances you'll be on amd64 hardware but if you're just trying this out
+locally on Apple silicon choose arm64.  
+The application uses libraries that need to match the host environment so use
+the appropriate requirements file.  
+Tip: Check that your shell session has the env variables set above.
+
+```Shell
+docker build -t $TAG_STABLE_DIFFUSION \
+--platform $PLATFORM \
+--build-arg gsd=$GITHUB_STABLE_DIFFUSION \
+--build-arg rsd=$REQS_STABLE_DIFFUSION \
+--build-arg cs=$CONDA_SUBDIR \
+.
+```
+
+Run a container using your built image.  
+Tip: Make sure you've created and populated the Docker volume (above).
+
+```Shell
+docker run -it \
+--rm \
+--platform $PLATFORM \
+--name stable-diffusion \
+--hostname stable-diffusion \
+--mount source=my-vol,target=/data \
+$TAG_STABLE_DIFFUSION
+```
+
+## Usage (time to have fun)
+
+### Startup
+
+If you're on a **Linux container** the `invoke` script is **automatically
+started** and the output dir set to the Docker volume you created earlier.
+
+If you're **directly on macOS follow these startup instructions**.  
+With the Conda environment activated (`conda activate ldm`), run the interactive
+interface that combines the functionality of the original scripts `txt2img` and
+`img2img`:  
+Use the more accurate but VRAM-intensive full precision math because
+half-precision requires autocast and won't work.  
+By default the images are saved in `outputs/img-samples/`.
+
+```Shell
+python3 scripts/invoke.py --full_precision
+```
+
+You'll get the script's prompt. You can see available options or quit.
+
+```Shell
+invoke> -h
+invoke> q
+```
+
+### Text to Image
+
+For quick (but bad) image results test with 5 steps (default 50) and 1 sample
+image. This will let you know that everything is set up correctly.  
+Then increase steps to 100 or more for good (but slower) results.  
+The prompt can be in quotes or not.
+
+```Shell
+invoke> The hulk fighting with sheldon cooper -s5 -n1
+invoke> "woman closeup highly detailed"  -s 150
+# Reuse previous seed and apply face restoration
+invoke> "woman closeup highly detailed"  --steps 150 --seed -1 -G 0.75
+```
+
+You'll need to experiment to see if face restoration is making it better or
+worse for your specific prompt.
+
+If you're on a container the output is set to the Docker volume. You can copy it
+wherever you want.  
+You can download it from the Docker Desktop app, Volumes, my-vol, data.  
+Or you can copy it from your Mac terminal. Keep in mind `docker cp` can't expand
+`*.png` so you'll need to specify the image file name.
+
+On your host Mac (you can use the name of any container that mounted the
+volume):
+
+```Shell
+docker cp dummy:/data/000001.928403745.png /Users/<your-user>/Pictures
+```
+
+### Image to Image
+
+You can also do text-guided image-to-image translation. For example, turning a
+sketch into a detailed drawing.
+
+`strength` is a value between 0.0 and 1.0 that controls the amount of noise 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. 0.0 preserves image exactly, 1.0 replaces it completely.
+
+Make sure your input image size dimensions are multiples of 64 e.g. 512x512.
+Otherwise you'll get `Error: product of dimension sizes > 2**31'`. If you still
+get the error
+[try a different size](https://support.apple.com/guide/preview/resize-rotate-or-flip-an-image-prvw2015/mac#:~:text=image's%20file%20size-,In%20the%20Preview%20app%20on%20your%20Mac%2C%20open%20the%20file,is%20shown%20at%20the%20bottom.)
+like 512x256.
+
+If you're on a Docker container, copy your input image into the Docker volume
+
+```Shell
+docker cp /Users/<your-user>/Pictures/sketch-mountains-input.jpg dummy:/data/
+```
+
+Try it out generating an image (or more). The `invoke` script needs absolute
+paths to find the image so don't use `~`.
+
+If you're on your Mac
+
+```Shell
+invoke> "A fantasy landscape, trending on artstation" -I /Users/<your-user>/Pictures/sketch-mountains-input.jpg --strength 0.75  --steps 100 -n4
+```
+
+If you're on a Linux container on your Mac
+
+```Shell
+invoke> "A fantasy landscape, trending on artstation" -I /data/sketch-mountains-input.jpg --strength 0.75  --steps 50 -n1
+```
+
+### Web Interface
+
+You can use the `invoke` script with a graphical web interface. Start the web
+server with:
+
+```Shell
+python3 scripts/invoke.py --full_precision --web
+```
+
+If it's running on your Mac point your Mac web browser to http://127.0.0.1:9090
+
+Press Control-C at the command line to stop the web server.
+
+### Notes
+
+Some text you can add at the end of the prompt to make it very pretty:
+
+```Shell
+cinematic photo, highly detailed, cinematic lighting, ultra-detailed, ultrarealistic, photorealism, Octane Rendering, cyberpunk lights, Hyper Detail, 8K, HD, Unreal Engine, V-Ray, full hd, cyberpunk, abstract, 3d octane render + 4k UHD + immense detail + dramatic lighting + well lit + black, purple, blue, pink, cerulean, teal, metallic colours, + fine details, ultra photoreal, photographic, concept art, cinematic composition, rule of thirds, mysterious, eerie, photorealism, breathtaking detailed, painting art deco pattern, by hsiao, ron cheng, john james audubon, bizarre compositions, exquisite detail, extremely moody lighting, painted by greg rutkowski makoto shinkai takashi takeuchi studio ghibli, akihiko yoshida
+```
+
+The original scripts should work as well.
+
+```Shell
+python3 scripts/orig_scripts/txt2img.py --help
+python3 scripts/orig_scripts/txt2img.py --ddim_steps 100 --n_iter 1 --n_samples 1  --plms --prompt "new born baby kitten. Hyper Detail, Octane Rendering, Unreal Engine, V-Ray"
+python3 scripts/orig_scripts/txt2img.py --ddim_steps 5   --n_iter 1 --n_samples 1  --plms --prompt "ocean" # or --klms
+```

docs/installation/INSTALL_LINUX.md

@@ -1,89 +1,109 @@
-# **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
+# :fontawesome-brands-linux: Linux
 
-- Python (version 3.8.5 recommended; higher may work)
-- git
+## Installation
+
+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)
+    - git
 
 2. Install the Python Anaconda environment manager.
 
-```
-~$  wget https://repo.anaconda.com/archive/Anaconda3-2022.05-Linux-x86_64.sh
-~$  chmod +x Anaconda3-2022.05-Linux-x86_64.sh
-~$  ./Anaconda3-2022.05-Linux-x86_64.sh
-```
+    ```bash
+    ~$  wget https://repo.anaconda.com/archive/Anaconda3-2022.05-Linux-x86_64.sh
+    ~$  chmod +x 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
-worked, your command prompt will be prefixed by the name of the current anaconda environment - `(base)`.
+    After installing anaconda, you should log out of your system and log back in. If
+    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 InvokeAI source code from GitHub:
 
-```
-(base) ~$ git clone https://github.com/lstein/stable-diffusion.git
-```
+    ```bash
+    (base) ~$ git clone https://github.com/invoke-ai/InvokeAI.git
+    ```
 
-This will create stable-diffusion folder where you will follow the rest of the steps.
+    This will create InvokeAI 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 InvokeAI folder. From this step forward make sure that you are working in the InvokeAI directory!
 
-```
-(base) ~$ cd stable-diffusion
-(base) ~/stable-diffusion$
-```
+    ```bash
+    (base) ~$ cd InvokeAI
+    (base) ~/InvokeAI$
+    ```
 
-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 `invokeai` and activate the environment.
 
-```
-(base) ~/stable-diffusion$ conda env create -f environment.yaml
-(base) ~/stable-diffusion$ conda activate ldm
-(ldm) ~/stable-diffusion$
-```
+    ```bash
+    (base) ~/InvokeAI$ conda env create
+    (base) ~/InvokeAI$ conda activate invokeai
+    (invokeai) ~/InvokeAI$
+    ```
 
-After these steps, your command prompt will be prefixed by `(ldm)` as shown above.
+    After these steps, your command prompt will be prefixed by `(invokeai)` as shown
+    above.
 
 6. Load a couple of small machine-learning models required by stable diffusion:
 
-```
-(ldm) ~/stable-diffusion$ python3 scripts/preload_models.py
-```
+    ```bash
+    (invokeai) ~/InvokeAI$ 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
+
+        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.
 
-- For running with the released weights, you will first need to set up an acount with Hugging Face (https://huggingface.co).
-- Use your credentials to log in, and then point your browser at https://huggingface.co/CompVis/stable-diffusion-v-1-4-original.
-- 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.
+      - For running with the released weights, you will first need to set up an acount
+        with [Hugging Face](https://huggingface.co).
+      - Use your credentials to log in, and then point your browser [here](https://huggingface.co/CompVis/stable-diffusion-v-1-4-original).
+      - 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.
 
-```
-(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
-```
+    ```bash
+    (invokeai) ~/InvokeAI$ mkdir -p models/ldm/stable-diffusion-v1
+    (invokeai) ~/InvokeAI$ ln -sf /path/to/sd-v1-4.ckpt models/ldm/stable-diffusion-v1/model.ckpt
+    ```
 
 8. Start generating images!
 
-```
-# for the pre-release weights use the -l or --liaon400m switch
-(ldm) ~/stable-diffusion$ python3 scripts/dream.py -l
+    ```bash
+    # for the pre-release weights use the -l or --liaon400m switch
+    (invokeai) ~/InvokeAI$ python3 scripts/invoke.py -l
 
-# for the post-release weights do not use the switch
-(ldm) ~/stable-diffusion$ python3 scripts/dream.py
+    # for the post-release weights do not use the switch
+    (invokeai) ~/InvokeAI$ python3 scripts/invoke.py
 
-# for additional configuration switches and arguments, use -h or --help
-(ldm) ~/stable-diffusion$ python3 scripts/dream.py -h
-```
+    # for additional configuration switches and arguments, use -h or --help
+    (invokeai) ~/InvokeAI$ python3 scripts/invoke.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 invokeai" (step 5, second command), enter the `InvokeAI` directory, and then launch the invoke script (step 8). If you forget to activate the 'invokeai' 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 InvokeAI directory, then to update to the latest and greatest version, launch the Anaconda window, enter `InvokeAI` and type:
 
-```
-(ldm) ~/stable-diffusion$ git pull
+```bash
+(invokeai) ~/InvokeAI$ git pull
+(invokeai) ~/InvokeAI$ conda env update -f environment.yml
 ```
 
 This will bring your local copy into sync with the remote one.