add locales to frontend dist package

- bump to patchlevel 6

.dockerignore

@@ -1,12 +1,19 @@
 *
 !backend
-!configs
 !environments-and-requirements
 !frontend
-!installer
 !ldm
 !main.py
 !scripts
 !server
 !static
 !setup.py
+
+# Guard against pulling in any models that might exist in the directory tree
+**/*.pt*
+
+# unignore configs, but only ignore the custom models.yaml, in case it exists
+!configs
+configs/models.yaml
+
+**/__pycache__

.github/workflows/build-cloud-img.yml

@@ -0,0 +1,87 @@
+name: Build and push cloud image
+on:
+  workflow_dispatch:
+  # push:
+  #   branches:
+  #   - main
+  #   tags:
+  #     - v*
+  # # we will NOT push the image on pull requests, only test buildability.
+  # pull_request:
+  #   branches:
+  #   - main
+
+permissions:
+  contents: read
+  packages: write
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  docker:
+    strategy:
+      fail-fast: false
+      matrix:
+        arch:
+        - x86_64
+        # requires resolving a patchmatch issue
+        # - aarch64
+    runs-on: ubuntu-latest
+    name: ${{ matrix.arch }}
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v2
+      if: matrix.arch == 'aarch64'
+
+    - name: Docker meta
+      id: meta
+      uses: docker/metadata-action@v4
+      with:
+        images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+        # see https://github.com/docker/metadata-action
+        # will push the following tags:
+        # :edge
+        # :main (+ any other branches enabled in the workflow)
+        # :<tag>
+        # :1.2.3 (for semver tags)
+        # :1.2 (for semver tags)
+        # :<sha>
+        tags: |
+          type=edge,branch=main
+          type=ref,event=branch
+          type=ref,event=tag
+          type=semver,pattern={{version}}
+          type=semver,pattern={{major}}.{{minor}}
+          type=sha
+        # suffix image tags with architecture
+        flavor: |
+          latest=auto
+          suffix=-${{ matrix.arch }},latest=true
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v2
+
+    # do not login to container registry on PRs
+    - if: github.event_name != 'pull_request'
+      name: Docker login
+      uses: docker/login-action@v2
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Build and push cloud image
+      uses: docker/build-push-action@v3
+      with:
+        context: .
+        file: docker-build/Dockerfile.cloud
+        platforms: Linux/${{ matrix.arch }}
+        # do not push the image on PRs
+        push: false
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}

.github/workflows/build-container.yml

@@ -1,43 +1,74 @@
-# Building the Image without pushing to confirm it is still buildable
-# confirum functionality would unfortunately need way more resources
 name: build container image
 on:
   push:
     branches:
       - 'main'
-      - 'development'
-      - 'update-dockerfile'
 
 jobs:
   docker:
     strategy:
       fail-fast: false
       matrix:
-        arch:
-          - x86_64
-          - aarch64
-        pip-requirements:
-          - requirements-lin-amd.txt
-          - requirements-lin-cuda.txt
+        registry:
+          - ghcr.io
+        flavor:
+          - amd
+          - cuda
+          # - cloud
+        include:
+          - flavor: amd
+            pip-requirements: requirements-lin-amd.txt
+            dockerfile: docker-build/Dockerfile
+            platforms: linux/amd64,linux/arm64
+          - flavor: cuda
+            pip-requirements: requirements-lin-cuda.txt
+            dockerfile: docker-build/Dockerfile
+            platforms: linux/amd64,linux/arm64
+          # - flavor: cloud
+          #   pip-requirements: requirements-lin-cuda.txt
+          #   dockerfile: docker-build/Dockerfile.cloud
+          #   platforms: linux/amd64
     runs-on: ubuntu-latest
-    name: ${{ matrix.pip-requirements }} ${{ matrix.arch }}
+    name: ${{ matrix.flavor }}
     steps:
-      - name: prepare docker-tag
-        env:
-          repository: ${{ github.repository }}
-        run: echo "dockertag=${repository,,}" >> $GITHUB_ENV
       - name: Checkout
         uses: actions/checkout@v3
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ matrix.registry }}/${{ github.repository }}-${{ matrix.flavor }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=tag
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=sha
+          flavor: |
+            latest=true
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
+
+      - if: github.event_name != 'pull_request'
+        name: Docker login
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ matrix.registry }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
       - name: Build container
         uses: docker/build-push-action@v3
         with:
           context: .
-          file: docker-build/Dockerfile
-          platforms: Linux/${{ matrix.arch }}
-          push: false
-          tags: ${{ env.dockertag }}:${{ matrix.pip-requirements }}-${{ matrix.arch }}
+          file: ${{ matrix.dockerfile }}
+          platforms: ${{ matrix.platforms }}
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
           build-args: pip_requirements=${{ matrix.pip-requirements }}

.github/workflows/lint-frontend.yml

@@ -0,0 +1,28 @@
+name: Lint frontend
+
+on:
+  pull_request:
+    paths:
+      - 'frontend/**'
+  push:
+    paths:
+      - 'frontend/**'
+
+defaults:
+  run:
+    working-directory: frontend
+
+jobs:
+  lint-frontend:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Setup Node 18
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+      - uses: actions/checkout@v3
+      - run: 'yarn install --frozen-lockfile'
+      - run: 'yarn tsc'
+      - run: 'yarn run madge'
+      - run: 'yarn run lint --max-warnings=0'
+      - run: 'yarn run prettier --check'

.github/workflows/pyflakes.yml

@@ -0,0 +1,19 @@
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - development
+      - 'release-candidate-*'
+
+jobs:
+  pyflakes:
+    name: runner / pyflakes
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: pyflakes
+        uses: reviewdog/action-pyflakes@v1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review

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

@@ -3,15 +3,29 @@ on:
   push:
     branches:
       - 'main'
-      - 'development'
-      - 'fix-gh-actions-fork'
   pull_request:
     branches:
       - 'main'
-      - 'development'
+    types:
+      - 'ready_for_review'
+      - 'opened'
+      - 'synchronize'
+      - 'converted_to_draft'
+
+concurrency:
+   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+   cancel-in-progress: true
 
 jobs:
+  fail_if_pull_request_is_draft:
+    if: github.event.pull_request.draft == true
+    runs-on: ubuntu-22.04
+    steps:
+    - name: Fails in order to indicate that pull request needs to be marked as ready to review and unit tests workflow needs to pass.
+      run: exit 1
+
   matrix:
+    if: github.event.pull_request.draft == false
     strategy:
       matrix:
         stable-diffusion-model:
@@ -20,16 +34,28 @@ jobs:
           - environment-lin-amd.yml
           - environment-lin-cuda.yml
           - environment-mac.yml
+          - environment-win-cuda.yml
         include:
           - environment-yaml: environment-lin-amd.yml
-            os: ubuntu-latest
+            os: ubuntu-22.04
+            curl-command: curl
+            github-env: $GITHUB_ENV
             default-shell: bash -l {0}
           - environment-yaml: environment-lin-cuda.yml
-            os: ubuntu-latest
+            os: ubuntu-22.04
+            curl-command: curl
+            github-env: $GITHUB_ENV
             default-shell: bash -l {0}
           - environment-yaml: environment-mac.yml
             os: macos-12
+            curl-command: curl
+            github-env: $GITHUB_ENV
             default-shell: bash -l {0}
+          - environment-yaml: environment-win-cuda.yml
+            os: windows-2022
+            curl-command: curl.exe
+            github-env: $env:GITHUB_ENV
+            default-shell: pwsh
           - stable-diffusion-model: stable-diffusion-1.5
             stable-diffusion-model-url: https://huggingface.co/runwayml/stable-diffusion-v1-5/resolve/main/v1-5-pruned-emaonly.ckpt
             stable-diffusion-model-dl-path: models/ldm/stable-diffusion-v1
@@ -72,15 +98,15 @@ jobs:
 
       - name: set test prompt to main branch validation
         if: ${{ github.ref == 'refs/heads/main' }}
-        run: echo "TEST_PROMPTS=tests/preflight_prompts.txt" >> $GITHUB_ENV
+        run: echo "TEST_PROMPTS=tests/preflight_prompts.txt" >> ${{ matrix.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
+        run: echo "TEST_PROMPTS=tests/dev_prompts.txt" >> ${{ matrix.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/validate_pr_prompt.txt" >> $GITHUB_ENV
+        run: echo "TEST_PROMPTS=tests/validate_pr_prompt.txt" >> ${{ matrix.github-env }}
 
       - name: Use Cached Stable Diffusion Model
         id: cache-sd-model
@@ -96,22 +122,20 @@ jobs:
         if: ${{ steps.cache-sd-model.outputs.cache-hit != 'true' }}
         run: |
           mkdir -p "${{ env.INVOKEAI_ROOT }}/${{ matrix.stable-diffusion-model-dl-path }}"
-          curl \
-            -H "Authorization: Bearer ${{ secrets.HUGGINGFACE_TOKEN }}" \
-            -o "${{ env.INVOKEAI_ROOT }}/${{ matrix.stable-diffusion-model-dl-path }}/${{ matrix.stable-diffusion-model-dl-name }}" \
-            -L ${{ matrix.stable-diffusion-model-url }}
+          ${{ matrix.curl-command }} -H "Authorization: Bearer ${{ secrets.HUGGINGFACE_TOKEN }}" -o "${{ env.INVOKEAI_ROOT }}/${{ matrix.stable-diffusion-model-dl-path }}/${{ matrix.stable-diffusion-model-dl-name }}" -L ${{ matrix.stable-diffusion-model-url }}
 
       - name: run configure_invokeai.py
         id: run-preload-models
         run: |
-          python scripts/configure_invokeai.py --no-interactive --yes
+          python scripts/configure_invokeai.py --skip-sd-weights --yes
 
-      - name: cat ~/.invokeai
+      - name: cat invokeai.init
         id: cat-invokeai
-        run: cat ~/.invokeai
+        run: cat ${{ env.INVOKEAI_ROOT }}/invokeai.init
 
       - name: Run the tests
         id: run-tests
+        if: matrix.os != 'windows-2022'
         run: |
           time python scripts/invoke.py \
             --no-patchmatch \
@@ -123,11 +147,13 @@ jobs:
 
       - name: export conda env
         id: export-conda-env
+        if: matrix.os != 'windows-2022'
         run: |
           mkdir -p outputs/img-samples
-          conda env export --name ${{ env.CONDA_ENV_NAME }} > outputs/img-samples/environment-${{ runner.os }}-${{ runner.arch }}.yml
+          conda env export --name ${{ env.CONDA_ENV_NAME }} > ${{ env.INVOKEAI_ROOT }}/outputs/environment-${{ runner.os }}-${{ runner.arch }}.yml
 
       - name: Archive results
+        if: matrix.os != 'windows-2022'
         id: archive-results
         uses: actions/upload-artifact@v3
         with:

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

@@ -3,14 +3,28 @@ on:
   push:
     branches:
       - 'main'
-      - 'development'
   pull_request:
     branches:
       - 'main'
-      - 'development'
+    types:
+      - 'ready_for_review'
+      - 'opened'
+      - 'synchronize'
+      - 'converted_to_draft'
+
+concurrency:
+   group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+   cancel-in-progress: true
 
 jobs:
+  fail_if_pull_request_is_draft:
+    if: github.event.pull_request.draft == true
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Fails in order to indicate that pull request needs to be marked as ready to review and unit tests workflow needs to pass.
+      run: exit 1
   matrix:
+    if: github.event.pull_request.draft == false
     strategy:
       matrix:
         stable-diffusion-model:
@@ -19,35 +33,50 @@ jobs:
           - requirements-lin-cuda.txt
           - requirements-lin-amd.txt
           - requirements-mac-mps-cpu.txt
+          - requirements-win-colab-cuda.txt
         python-version:
           # - '3.9'
           - '3.10'
         include:
           - requirements-file: requirements-lin-cuda.txt
-            os: ubuntu-latest
-            default-shell: bash -l {0}
+            os: ubuntu-22.04
+            curl-command: curl
+            github-env: $GITHUB_ENV
           - requirements-file: requirements-lin-amd.txt
-            os: ubuntu-latest
-            default-shell: bash -l {0}
+            os: ubuntu-22.04
+            curl-command: curl
+            github-env: $GITHUB_ENV
           - requirements-file: requirements-mac-mps-cpu.txt
             os: macOS-12
-            default-shell: bash -l {0}
+            curl-command: curl
+            github-env: $GITHUB_ENV
+          - requirements-file: requirements-win-colab-cuda.txt
+            os: windows-2022
+            curl-command: curl.exe
+            github-env: $env:GITHUB_ENV
           - stable-diffusion-model: stable-diffusion-1.5
             stable-diffusion-model-url: https://huggingface.co/runwayml/stable-diffusion-v1-5/resolve/main/v1-5-pruned-emaonly.ckpt
             stable-diffusion-model-dl-path: models/ldm/stable-diffusion-v1
             stable-diffusion-model-dl-name: v1-5-pruned-emaonly.ckpt
     name: ${{ matrix.requirements-file }} on ${{ matrix.python-version }}
     runs-on: ${{ matrix.os }}
-    defaults:
-      run:
-        shell: ${{ matrix.default-shell }}
-    env:
-      INVOKEAI_ROOT: '${{ github.workspace }}/invokeai'
     steps:
       - name: Checkout sources
         id: checkout-sources
         uses: actions/checkout@v3
 
+      - name: set INVOKEAI_ROOT Windows
+        if: matrix.os == 'windows-2022'
+        run: |
+          echo "INVOKEAI_ROOT=${{ github.workspace }}\invokeai" >> ${{ matrix.github-env }}
+          echo "INVOKEAI_OUTDIR=${{ github.workspace }}\invokeai\outputs" >> ${{ matrix.github-env }}
+
+      - name: set INVOKEAI_ROOT others
+        if: matrix.os != 'windows-2022'
+        run: |
+          echo "INVOKEAI_ROOT=${{ github.workspace }}/invokeai" >> ${{ matrix.github-env }}
+          echo "INVOKEAI_OUTDIR=${{ github.workspace }}/invokeai/outputs" >> ${{ matrix.github-env }}
+
       - name: create models.yaml from example
         run: |
           mkdir -p ${{ env.INVOKEAI_ROOT }}/configs
@@ -55,15 +84,15 @@ jobs:
 
       - name: set test prompt to main branch validation
         if: ${{ github.ref == 'refs/heads/main' }}
-        run: echo "TEST_PROMPTS=tests/preflight_prompts.txt" >> $GITHUB_ENV
+        run: echo "TEST_PROMPTS=tests/preflight_prompts.txt" >> ${{ matrix.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
+        run: echo "TEST_PROMPTS=tests/dev_prompts.txt" >> ${{ matrix.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/validate_pr_prompt.txt" >> $GITHUB_ENV
+        run: echo "TEST_PROMPTS=tests/validate_pr_prompt.txt" >> ${{ matrix.github-env }}
 
       - name: create requirements.txt
         run: cp 'environments-and-requirements/${{ matrix.requirements-file }}' '${{ matrix.requirements-file }}'
@@ -72,14 +101,14 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-          cache: 'pip'
-          cache-dependency-path: ${{ matrix.requirements-file }}
+          # cache: 'pip'
+          # cache-dependency-path: ${{ matrix.requirements-file }}
 
-      # - name: install dependencies
-      #   run: ${{ env.pythonLocation }}/bin/pip install --upgrade pip setuptools wheel
+      - name: install dependencies
+        run: pip3 install --upgrade pip setuptools wheel
 
       - name: install requirements
-        run: ${{ env.pythonLocation }}/bin/pip install -r '${{ matrix.requirements-file }}'
+        run: pip3 install -r '${{ matrix.requirements-file }}'
 
       - name: Use Cached Stable Diffusion Model
         id: cache-sd-model
@@ -95,33 +124,20 @@ jobs:
         if: ${{ steps.cache-sd-model.outputs.cache-hit != 'true' }}
         run: |
           mkdir -p "${{ env.INVOKEAI_ROOT }}/${{ matrix.stable-diffusion-model-dl-path }}"
-          curl \
-            -H "Authorization: Bearer ${{ secrets.HUGGINGFACE_TOKEN }}" \
-            -o "${{ env.INVOKEAI_ROOT }}/${{ matrix.stable-diffusion-model-dl-path }}/${{ matrix.stable-diffusion-model-dl-name }}" \
-            -L ${{ matrix.stable-diffusion-model-url }}
+          ${{ matrix.curl-command }} -H "Authorization: Bearer ${{ secrets.HUGGINGFACE_TOKEN }}" -o "${{ env.INVOKEAI_ROOT }}/${{ matrix.stable-diffusion-model-dl-path }}/${{ matrix.stable-diffusion-model-dl-name }}" -L ${{ matrix.stable-diffusion-model-url }}
 
       - name: run configure_invokeai.py
         id: run-preload-models
-        run: |
-          ${{ env.pythonLocation }}/bin/python scripts/configure_invokeai.py --no-interactive --yes
-
-      - name: cat ~/.invokeai
-        id: cat-invokeai
-        run: cat ~/.invokeai
+        run: python3 scripts/configure_invokeai.py --skip-sd-weights --yes
 
       - name: Run the tests
         id: run-tests
-        run: |
-          time ${{ env.pythonLocation }}/bin/python scripts/invoke.py \
-            --no-patchmatch \
-            --no-nsfw_checker \
-            --model ${{ matrix.stable-diffusion-model }} \
-            --from_file ${{ env.TEST_PROMPTS }} \
-            --root="${{ env.INVOKEAI_ROOT }}" \
-            --outdir="${{ env.INVOKEAI_ROOT }}/outputs"
+        if: matrix.os != 'windows-2022'
+        run: python3 scripts/invoke.py --no-patchmatch --no-nsfw_checker --model ${{ matrix.stable-diffusion-model }} --from_file ${{ env.TEST_PROMPTS }} --root="${{ env.INVOKEAI_ROOT }}" --outdir="${{ env.INVOKEAI_OUTDIR }}"
 
       - name: Archive results
         id: archive-results
+        if: matrix.os != 'windows-2022'
         uses: actions/upload-artifact@v3
         with:
           name: results_${{ matrix.requirements-file }}_${{ matrix.python-version }}

.gitignore

@@ -6,6 +6,7 @@ models/ldm/stable-diffusion-v1/model.ckpt
 # ignore user models config
 configs/models.user.yaml
 config/models.user.yml
+invokeai.init
 
 # ignore the Anaconda/Miniconda installer used while building Docker image
 anaconda.sh
@@ -222,12 +223,11 @@ environment.yml
 requirements.txt
 
 # source installer files
-source_installer/*zip
-source_installer/invokeAI
-install.bat
-install.sh
-update.bat
-update.sh
+installer/*zip
+installer/install.bat
+installer/install.sh
+installer/update.bat
+installer/update.sh
 
 # this may be present if the user created a venv
 invokeai

InvokeAI_Statement_of_Values.md

@@ -1,4 +1,4 @@
-<img src="docs/assets/invoke_ai_banner.png" align="center">
+<img src="docs/assets/invoke_ai_banner.png" align="center">
 
 Invoke-AI is a community of software developers, researchers, and user
 interface experts who have come together on a voluntary basis to build
@@ -81,5 +81,4 @@ area. Disputes are resolved by open and honest communication.
 
 ## Signature
 
-This document has been collectively crafted and approved by the current InvokeAI team members, as of 28 Nov 2022: **lstein** (Lincoln Stein), **blessedcoolant**, **hipsterusername** (Kent Keirsey), **Kyle0654** (Kyle Schouviller), **damian0815**, **mauwii** (Matthias Wild), **Netsvetaev** (Artur Netsvetaev), **psychedelicious**, **tildebyte**, and **keturn**. Although individuals within the group may hold differing views on particular details and/or their implications, we are all in agreement about its fundamental statements, as well as their significance and importance to this project moving forward.  
-
+This document has been collectively crafted and approved by the current InvokeAI team members, as of 28 Nov 2022: **lstein** (Lincoln Stein), **blessedcoolant**, **hipsterusername** (Kent Keirsey), **Kyle0654** (Kyle Schouviller), **damian0815**, **mauwii** (Matthias Wild), **Netsvetaev** (Artur Netsvetaev), **psychedelicious**, **tildebyte**, **keturn**, and **ebr** (Eugene Brodsky). Although individuals within the group may hold differing views on particular details and/or their implications, we are all in agreement about its fundamental statements, as well as their significance and importance to this project moving forward.

README.md

@@ -1,11 +1,9 @@
 <div align="center">
 
+![project logo](docs/assets/invoke_ai_banner.png)
+
 # InvokeAI: A Stable Diffusion Toolkit
 
-_Formerly known as lstein/stable-diffusion_
-
-![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]
@@ -38,18 +36,33 @@ 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, with
+generation process. It runs on Windows, macOS 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/ZmtBAhwWhy">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>]
+**Quick links**: [[How to Install](#installation)] [<a href="https://discord.gg/ZmtBAhwWhy">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>]
+
+_Note: InvokeAI is rapidly evolving. Please use the
+[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 us diagnose issues faster._
+
+# Getting Started with InvokeAI
+
+For full installation and upgrade instructions, please see:
+[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/)
+
+1. Go to the bottom of the [Latest Release Page](https://github.com/invoke-ai/InvokeAI/releases/latest)
+2. Download the .zip file for your OS (Windows/macOS/Linux).
+3. Unzip the file.
+4. If you are on Windows, double-click on the `install.bat` script. On macOS, open a Terminal window, drag the file `install.sh` from Finder into the Terminal, and press return. On Linux, run `install.sh`.
+5. Wait a while, until it is done.
+6. The folder where you ran the installer from will now be filled with lots of files. If you are on Windows, double-click on the `invoke.bat` file. On macOS, open a Terminal window, drag `invoke.sh` from the folder into the Terminal, and press return. On Linux, run `invoke.sh`
+7. Press 2 to open the "browser-based UI", press enter/return, wait a minute or two for Stable Diffusion to start up, then open your browser and go to http://localhost:9090.
+8. Type `banana sushi` in the box on the top left and click `Invoke`:
 
 <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/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
 
@@ -69,10 +82,13 @@ This fork is supported across Linux, Windows and Macintosh. Linux
 users can use either an Nvidia-based card (with CUDA support) or an
 AMD card (using the ROCm driver). For full installation and upgrade
 instructions, please see:
-[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/)
+[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/INSTALL_SOURCE/)
 
 ### Hardware Requirements
 
+InvokeAI is supported across Linux, Windows and macOS. Linux
+users can use either an Nvidia-based card (with CUDA support) or an
+AMD card (using the ROCm driver).
 #### System
 
 You wil need one of the following:
@@ -80,6 +96,10 @@ 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.
 
+We do not recommend the GTX 1650 or 1660 series video cards. They are
+unable to run in half-precision mode and do not have sufficient VRAM
+to render 512x512 images.
+
 #### Memory
 
 - At least 12 GB Main Memory RAM.
@@ -97,11 +117,12 @@ 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:
+you can try starting `invoke.py` with the `--precision=float32` flag to your initialization command
 
 ```bash
 (invokeai) ~/InvokeAI$ python scripts/invoke.py --precision=float32
 ```
+Or by updating your InvokeAI configuration file with this argument.
 
 ### Features
 
@@ -130,39 +151,7 @@ you can try starting `invoke.py` with the `--precision=float32` flag:
 
 ### Latest Changes
 
-- 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 (9 October 2022)
-
-  - `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](https://invoke-ai.github.io/InvokeAI/CHANGELOG#v114-11-september-2022)**.
+For our latest changes, view our [Release Notes](https://github.com/invoke-ai/InvokeAI/releases)
 
 ### Troubleshooting
 
@@ -172,15 +161,13 @@ 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. To join, just raise your hand on the InvokeAI
-Discord server or discussion board. 
+cleanup, testing, or code reviews, is very much encouraged to do so.
+
+To join, just raise your hand on the InvokeAI Discord server (#dev-chat) or the GitHub discussion board.
 
 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.
+[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. You can **make your pull request against the "main" branch**. 
 
 We hope you enjoy using our software as much as we enjoy creating it,
 and we hope that some of those of you who are reading this will elect
@@ -199,7 +186,7 @@ their time, hard work and effort.
 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
+Original portions of the software are Copyright (c) 2022
 [Lincoln D. Stein](https://github.com/lstein)
 
 ### Further Reading

backend/invoke_ai_web_server.py

@@ -18,9 +18,12 @@ from PIL.Image import Image as ImageType
 from uuid import uuid4
 from threading import Event
 
+from ldm.generate import Generate
 from ldm.invoke.args import Args, APP_ID, APP_VERSION, calculate_init_img_hash
+from ldm.invoke.conditioning import get_tokens_for_prompt, get_prompt_structure
+from ldm.invoke.globals import Globals
 from ldm.invoke.pngwriter import PngWriter, retrieve_metadata
-from ldm.invoke.prompt_parser import split_weighted_subprompts
+from ldm.invoke.prompt_parser import split_weighted_subprompts, Blend
 from ldm.invoke.generator.inpaint import infill_methods
 
 from backend.modules.parameters import parameters_to_command
@@ -37,9 +40,12 @@ args.root_dir = os.path.expanduser(args.root_dir or "..")
 if not os.path.isabs(args.outdir):
     args.outdir = os.path.join(args.root_dir, args.outdir)
 
+# normalize the config directory relative to root
+if not os.path.isabs(opt.conf):
+    opt.conf = os.path.normpath(os.path.join(Globals.root,opt.conf))
 
 class InvokeAIWebServer:
-    def __init__(self, generate, gfpgan, codeformer, esrgan) -> None:
+    def __init__(self, generate: Generate, gfpgan, codeformer, esrgan) -> None:
         self.host = args.host
         self.port = args.port
 
@@ -243,14 +249,16 @@ class InvokeAIWebServer:
 
     def find_frontend(self):
         my_dir = os.path.dirname(__file__)
+        # LS: setup.py seems to put the frontend in different places on different systems, so
+        # this is fragile and needs to be replaced with a better way of finding the front end.
         for candidate in (os.path.join(my_dir,'..','frontend','dist'),          # pip install -e .
-                          os.path.join(my_dir,'../../../../frontend','dist')   # pip install .
+                          os.path.join(my_dir,'../../../../frontend','dist'),   # pip install . (Linux, Mac)
+                          os.path.join(my_dir,'../../../frontend','dist'),      # pip install . (Windows)
         ):
             if os.path.exists(candidate):
                 return candidate
         assert "Frontend files cannot be found. Cannot continue"
 
-                                        
     def setup_app(self):
         self.result_url = "outputs/"
         self.init_image_url = "outputs/init-images/"
@@ -290,9 +298,81 @@ class InvokeAIWebServer:
             print(f">> System config requested")
             config = self.get_system_config()
             config["model_list"] = self.generate.model_cache.list_models()
-            config["infill_methods"] = infill_methods
+            config["infill_methods"] = infill_methods()
             socketio.emit("systemConfig", config)
 
+        @socketio.on('searchForModels')
+        def handle_search_models(search_folder: str):
+            try:
+                if not search_folder:
+                    socketio.emit(
+                    "foundModels",
+                    {'search_folder': None, 'found_models': None},
+                )
+                else:
+                    search_folder, found_models = self.generate.model_cache.search_models(search_folder)
+                    socketio.emit(
+                        "foundModels",
+                        {'search_folder': search_folder, 'found_models': found_models},
+                    )            
+            except Exception as e:
+                self.socketio.emit("error", {"message": (str(e))})
+                print("\n")
+
+                traceback.print_exc()
+                print("\n")
+
+        @socketio.on("addNewModel")
+        def handle_add_model(new_model_config: dict):
+            try:
+                model_name = new_model_config['name']
+                del new_model_config['name']
+                model_attributes = new_model_config
+                update = False
+                current_model_list = self.generate.model_cache.list_models()
+                if model_name in current_model_list:
+                    update = True
+
+                print(f">> Adding New Model: {model_name}")
+
+                self.generate.model_cache.add_model(
+                    model_name=model_name, model_attributes=model_attributes, clobber=True)
+                self.generate.model_cache.commit(opt.conf)
+
+                new_model_list = self.generate.model_cache.list_models()
+                socketio.emit(
+                    "newModelAdded",
+                    {"new_model_name": model_name,
+                     "model_list": new_model_list, 'update': update},
+                )
+                print(f">> New Model Added: {model_name}")
+            except Exception as e:
+                self.socketio.emit("error", {"message": (str(e))})
+                print("\n")
+
+                traceback.print_exc()
+                print("\n")
+
+        @socketio.on("deleteModel")
+        def handle_delete_model(model_name: str):
+            try:
+                print(f">> Deleting Model: {model_name}")
+                self.generate.model_cache.del_model(model_name)
+                self.generate.model_cache.commit(opt.conf)
+                updated_model_list = self.generate.model_cache.list_models()
+                socketio.emit(
+                    "modelDeleted",
+                    {"deleted_model_name": model_name,
+                     "model_list": updated_model_list},
+                )
+                print(f">> Model Deleted: {model_name}")
+            except Exception as e:
+                self.socketio.emit("error", {"message": (str(e))})
+                print("\n")
+
+                traceback.print_exc()
+                print("\n")
+
         @socketio.on("requestModelChange")
         def handle_set_model(model_name: str):
             try:
@@ -589,11 +669,11 @@ class InvokeAIWebServer:
                     pass
 
                 if postprocessing_parameters["type"] == "esrgan":
-                    progress.set_current_status("Upscaling (ESRGAN)")
+                    progress.set_current_status("common:statusUpscalingESRGAN")
                 elif postprocessing_parameters["type"] == "gfpgan":
-                    progress.set_current_status("Restoring Faces (GFPGAN)")
+                    progress.set_current_status("common:statusRestoringFacesGFPGAN")
                 elif postprocessing_parameters["type"] == "codeformer":
-                    progress.set_current_status("Restoring Faces (Codeformer)")
+                    progress.set_current_status("common:statusRestoringFacesCodeFormer")
 
                 socketio.emit("progressUpdate", progress.to_formatted_dict())
                 eventlet.sleep(0)
@@ -626,7 +706,7 @@ class InvokeAIWebServer:
                         f'{postprocessing_parameters["type"]} is not a valid postprocessing type'
                     )
 
-                progress.set_current_status("Saving Image")
+                progress.set_current_status("common:statusSavingImage")
                 socketio.emit("progressUpdate", progress.to_formatted_dict())
                 eventlet.sleep(0)
 
@@ -856,15 +936,15 @@ class InvokeAIWebServer:
                 nonlocal progress
 
                 generation_messages = {
-                    "txt2img": "Text to Image",
-                    "img2img": "Image to Image",
-                    "inpainting": "Inpainting",
-                    "outpainting": "Outpainting",
+                    "txt2img": "common:statusGeneratingTextToImage",
+                    "img2img": "common:statusGeneratingImageToImage",
+                    "inpainting": "common:statusGeneratingInpainting",
+                    "outpainting": "common:statusGeneratingOutpainting",
                 }
 
                 progress.set_current_step(step + 1)
                 progress.set_current_status(
-                    f"Generating ({generation_messages[actual_generation_mode]})"
+                    f"{generation_messages[actual_generation_mode]}"
                 )
                 progress.set_current_status_has_steps(True)
 
@@ -904,16 +984,13 @@ class InvokeAIWebServer:
                         },
                     )
 
+
                 if generation_parameters["progress_latents"]:
                     image = self.generate.sample_to_lowres_estimated_image(sample)
                     (width, height) = image.size
                     width *= 8
                     height *= 8
-                    buffered = io.BytesIO()
-                    image.save(buffered, format="PNG")
-                    img_base64 = "data:image/png;base64," + base64.b64encode(
-                        buffered.getvalue()
-                    ).decode("UTF-8")
+                    img_base64 = image_to_dataURL(image)
                     self.socketio.emit(
                         "intermediateResult",
                         {
@@ -931,7 +1008,7 @@ class InvokeAIWebServer:
                 self.socketio.emit("progressUpdate", progress.to_formatted_dict())
                 eventlet.sleep(0)
 
-            def image_done(image, seed, first_seed):
+            def image_done(image, seed, first_seed, attention_maps_image=None):
                 if self.canceled.is_set():
                     raise CanceledException
 
@@ -954,7 +1031,7 @@ class InvokeAIWebServer:
                         **generation_parameters["bounding_box"],
                     )
 
-                progress.set_current_status("Generation Complete")
+                progress.set_current_status("common:statusGenerationComplete")
 
                 self.socketio.emit("progressUpdate", progress.to_formatted_dict())
                 eventlet.sleep(0)
@@ -981,7 +1058,7 @@ class InvokeAIWebServer:
                     raise CanceledException
 
                 if esrgan_parameters:
-                    progress.set_current_status("Upscaling")
+                    progress.set_current_status("common:statusUpscaling")
                     progress.set_current_status_has_steps(False)
                     self.socketio.emit("progressUpdate", progress.to_formatted_dict())
                     eventlet.sleep(0)
@@ -1004,9 +1081,9 @@ class InvokeAIWebServer:
 
                 if facetool_parameters:
                     if facetool_parameters["type"] == "gfpgan":
-                        progress.set_current_status("Restoring Faces (GFPGAN)")
+                        progress.set_current_status("common:statusRestoringFacesGFPGAN")
                     elif facetool_parameters["type"] == "codeformer":
-                        progress.set_current_status("Restoring Faces (Codeformer)")
+                        progress.set_current_status("common:statusRestoringFacesCodeFormer")
 
                     progress.set_current_status_has_steps(False)
                     self.socketio.emit("progressUpdate", progress.to_formatted_dict())
@@ -1038,7 +1115,7 @@ class InvokeAIWebServer:
                     ]
                     all_parameters["facetool_type"] = facetool_parameters["type"]
 
-                progress.set_current_status("Saving Image")
+                progress.set_current_status("common:statusSavingImage")
                 self.socketio.emit("progressUpdate", progress.to_formatted_dict())
                 eventlet.sleep(0)
 
@@ -1085,7 +1162,7 @@ class InvokeAIWebServer:
 
                 if progress.total_iterations > progress.current_iteration:
                     progress.set_current_step(1)
-                    progress.set_current_status("Iteration complete")
+                    progress.set_current_status("common:statusIterationComplete")
                     progress.set_current_status_has_steps(False)
                 else:
                     progress.mark_complete()
@@ -1093,6 +1170,12 @@ class InvokeAIWebServer:
                 self.socketio.emit("progressUpdate", progress.to_formatted_dict())
                 eventlet.sleep(0)
 
+                parsed_prompt, _ = get_prompt_structure(generation_parameters["prompt"])
+                tokens = None if type(parsed_prompt) is Blend else \
+                    get_tokens_for_prompt(self.generate.model, parsed_prompt)
+                attention_maps_image_base64_url = None if attention_maps_image is None \
+                    else image_to_dataURL(attention_maps_image)
+
                 self.socketio.emit(
                     "generationResult",
                     {
@@ -1105,6 +1188,8 @@ class InvokeAIWebServer:
                         "height": height,
                         "boundingBox": original_bounding_box,
                         "generationMode": generation_parameters["generation_mode"],
+                        "attentionMaps": attention_maps_image_base64_url,
+                        "tokens": tokens,
                     },
                 )
                 eventlet.sleep(0)
@@ -1116,7 +1201,7 @@ class InvokeAIWebServer:
             self.generate.prompt2image(
                 **generation_parameters,
                 step_callback=image_progress,
-                image_callback=image_done,
+                image_callback=image_done
             )
 
         except KeyboardInterrupt:
@@ -1471,7 +1556,7 @@ class Progress:
         self.total_iterations = (
             generation_parameters["iterations"] if generation_parameters else 1
         )
-        self.current_status = "Preparing"
+        self.current_status = "common:statusPreparing"
         self.is_processing = True
         self.current_status_has_steps = False
         self.has_error = False
@@ -1501,7 +1586,7 @@ class Progress:
         self.has_error = has_error
 
     def mark_complete(self):
-        self.current_status = "Processing Complete"
+        self.current_status = "common:statusProcessingComplete"
         self.current_step = 0
         self.total_steps = 0
         self.current_iteration = 0
@@ -1563,6 +1648,19 @@ def dataURL_to_image(dataURL: str) -> ImageType:
     )
     return image
 
+"""
+Converts an image into a base64 image dataURL.
+"""
+
+def image_to_dataURL(image: ImageType) -> str:
+    buffered = io.BytesIO()
+    image.save(buffered, format="PNG")
+    image_base64 = "data:image/png;base64," + base64.b64encode(
+        buffered.getvalue()
+    ).decode("UTF-8")
+    return image_base64
+
+
 
 """
 Converts a base64 image dataURL into bytes.

binary_installer/install.bat.in

@@ -10,21 +10,21 @@
 
 @rem This enables a user to install this project without manually installing git or Python
 
+@rem change to the script's directory
+PUSHD "%~dp0"
+
 set "no_cache_dir=--no-cache-dir"
 if "%1" == "use-cache" (
     set "no_cache_dir="
 )
 
 echo ***** Installing InvokeAI.. *****
-echo "USING development BRANCH. REMEMBER TO CHANGE TO main BEFORE RELEASE"
 @rem Config
 set INSTALL_ENV_DIR=%cd%\installer_files\env
 @rem https://mamba.readthedocs.io/en/latest/installation.html
 set MICROMAMBA_DOWNLOAD_URL=https://github.com/cmdr2/stable-diffusion-ui/releases/download/v1.1/micromamba.exe
 set RELEASE_URL=https://github.com/invoke-ai/InvokeAI
-#set RELEASE_SOURCEBALL=/archive/refs/heads/main.tar.gz
-# RELEASE_SOURCEBALL=/archive/refs/heads/test-installer.tar.gz
-RELEASE_SOURCEBALL=/archive/refs/heads/development.tar.gz
+set RELEASE_SOURCEBALL=/archive/refs/heads/main.tar.gz
 set PYTHON_BUILD_STANDALONE_URL=https://github.com/indygreg/python-build-standalone/releases/download
 set PYTHON_BUILD_STANDALONE=20221002/cpython-3.10.7+20221002-x86_64-pc-windows-msvc-shared-install_only.tar.gz
 
@@ -127,7 +127,7 @@ if %errorlevel% neq 0 goto err_exit
 echo ***** Updated pip and wheel *****
 
 set err_msg=----- requirements file copy failed -----
-copy installer\py3.10-windows-x86_64-cuda-reqs.txt requirements.txt
+copy binary_installer\py3.10-windows-x86_64-cuda-reqs.txt requirements.txt
 if %errorlevel% neq 0 goto err_exit
 
 set err_msg=----- main pip install failed -----
@@ -140,11 +140,11 @@ set err_msg=----- InvokeAI setup failed -----
 .venv\Scripts\python -m pip install %no_cache_dir% --no-warn-script-location -e .
 if %errorlevel% neq 0 goto err_exit
 
-copy installer\invoke.bat .\invoke.bat
+copy binary_installer\invoke.bat.in .\invoke.bat
 echo ***** Installed invoke launcher script ******
 
 @rem more cleanup
-rd /s /q installer installer_files
+rd /s /q binary_installer installer_files
 
 @rem preload the models
 call .venv\Scripts\python scripts\configure_invokeai.py

binary_installer/install.sh.in

@@ -1,5 +1,9 @@
 #!/usr/bin/env bash
 
+# ensure we're in the correct folder in case user's CWD is somewhere else
+scriptdir=$(dirname "$0")
+cd "$scriptdir"
+
 set -euo pipefail
 IFS=$'\n\t'
 
@@ -22,6 +26,8 @@ function _err_exit {
 
 # This enables a user to install this project without manually installing git or Python
 
+echo -e "\n***** Installing InvokeAI into $(pwd)... *****\n"
+
 export no_cache_dir="--no-cache-dir"
 if [ $# -ge 1 ]; then
     if [ "$1" = "use-cache" ]; then
@@ -29,10 +35,6 @@ if [ $# -ge 1 ]; then
     fi
 fi
 
-echo "$no_cache_dir"
-
-echo -e "\n***** Installing InvokeAI... *****\n"
-
 
 OS_NAME=$(uname -s)
 case "${OS_NAME}" in
@@ -80,19 +82,17 @@ if [ "$OS_NAME" == "darwin" ] && [ "$OS_ARCH" == "arm64" ]; then
 fi
 
 # config
-echo "USING development BRANCH. REMEMBER TO CHANGE TO main BEFORE RELEASE"
 INSTALL_ENV_DIR="$(pwd)/installer_files/env"
 MICROMAMBA_DOWNLOAD_URL="https://micro.mamba.pm/api/micromamba/${MAMBA_OS_NAME}-${MAMBA_ARCH}/latest"
 RELEASE_URL=https://github.com/invoke-ai/InvokeAI
-# RELEASE_SOURCEBALL=/archive/refs/heads/main.tar.gz
-# RELEASE_SOURCEBALL=/archive/refs/heads/test-installer.tar.gz
-RELEASE_SOURCEBALL=/archive/refs/heads/development.tar.gz
+RELEASE_SOURCEBALL=/archive/refs/heads/main.tar.gz
 PYTHON_BUILD_STANDALONE_URL=https://github.com/indygreg/python-build-standalone/releases/download
 if [ "$OS_NAME" == "darwin" ]; then
     PYTHON_BUILD_STANDALONE=20221002/cpython-3.10.7+20221002-${PY_ARCH}-apple-darwin-install_only.tar.gz
 elif [ "$OS_NAME" == "linux" ]; then
     PYTHON_BUILD_STANDALONE=20221002/cpython-3.10.7+20221002-${PY_ARCH}-unknown-linux-gnu-install_only.tar.gz
 fi
+echo "INSTALLING $RELEASE_SOURCEBALL FROM $RELEASE_URL"
 
 PACKAGES_TO_INSTALL=""
 
@@ -192,32 +192,33 @@ echo -e "We're running under"
 _err_exit $? _err_msg
 
 _err_msg="\n----- pip update failed -----\n"
-.venv/bin/python3 -m pip install "$no_cache_dir" --no-warn-script-location --upgrade pip wheel
+.venv/bin/python3 -m pip install $no_cache_dir --no-warn-script-location --upgrade pip
 _err_exit $? _err_msg
 
-echo -e "\n***** Updated pip and wheel *****\n"
+echo -e "\n***** Updated pip *****\n"
 
 _err_msg="\n----- requirements file copy failed -----\n"
-cp installer/py3.10-${OS_NAME}-"${OS_ARCH}"-${CD}-reqs.txt requirements.txt
+cp binary_installer/py3.10-${OS_NAME}-"${OS_ARCH}"-${CD}-reqs.txt requirements.txt
 _err_exit $? _err_msg
 
 _err_msg="\n----- main pip install failed -----\n"
-.venv/bin/python3 -m pip install "$no_cache_dir" --no-warn-script-location -r requirements.txt
+.venv/bin/python3 -m pip install $no_cache_dir --no-warn-script-location -r requirements.txt
 _err_exit $? _err_msg
 
 echo -e "\n***** Installed Python dependencies *****\n"
 
 _err_msg="\n----- InvokeAI setup failed -----\n"
-.venv/bin/python3 -m pip install "$no_cache_dir" --no-warn-script-location -e .
+.venv/bin/python3 -m pip install $no_cache_dir --no-warn-script-location -e .
 _err_exit $? _err_msg
 
 echo -e "\n***** Installed InvokeAI *****\n"
 
-cp installer/invoke.sh .
+cp binary_installer/invoke.sh.in ./invoke.sh
+chmod a+rx ./invoke.sh
 echo -e "\n***** Installed invoke launcher script ******\n"
 
 # more cleanup
-rm -rf installer/ installer_files/
+rm -rf binary_installer/ installer_files/
 
 # preload the models
 .venv/bin/python3 scripts/configure_invokeai.py
@@ -227,6 +228,8 @@ deactivate
 
 echo -e "\n***** Finished downloading models *****\n"
 
-echo "All done! Run the command './invoke.sh' to start InvokeAI."
+echo "All done! Run the command"
+echo "  $scriptdir/invoke.sh"
+echo "to start InvokeAI."
 read -p "Press any key to exit..."
 exit

binary_installer/invoke.bat.in

@@ -1,5 +1,6 @@
 @echo off
 
+PUSHD "%~dp0"
 call .venv\Scripts\activate.bat
 
 echo Do you want to generate images using the
@@ -10,10 +11,10 @@ echo 3. open the developer console
 set /p choice="Please enter 1, 2 or 3: "
 if /i "%choice%" == "1" (
     echo Starting the InvokeAI command-line.
-    .venv\Scripts\python scripts\invoke.py
+    .venv\Scripts\python scripts\invoke.py %*
 ) else if /i "%choice%" == "2" (
     echo Starting the InvokeAI browser-based UI.
-    .venv\Scripts\python scripts\invoke.py --web
+    .venv\Scripts\python scripts\invoke.py --web %*
 ) else if /i "%choice%" == "3" (
     echo Developer Console
     echo Python command is:

binary_installer/invoke.sh.in

@@ -4,6 +4,11 @@ set -eu
 
 . .venv/bin/activate
 
+# set required env var for torch on mac MPS
+ if [ "$(uname -s)" == "Darwin" ]; then
+     export PYTORCH_ENABLE_MPS_FALLBACK=1
+ fi
+
 echo "Do you want to generate images using the"
 echo "1. command-line"
 echo "2. browser-based UI"
@@ -15,11 +20,11 @@ read choice
 case $choice in
     1)
         printf "\nStarting the InvokeAI command-line..\n";
-        .venv/bin/python scripts/invoke.py;
+        .venv/bin/python scripts/invoke.py $*;
     ;;
     2)
         printf "\nStarting the InvokeAI browser-based UI..\n";
-        .venv/bin/python scripts/invoke.py --web;
+        .venv/bin/python scripts/invoke.py --web $*;
     ;;
     3)
         printf "\nDeveloper Console:\n";

binary_installer/py3.10-darwin-arm64-mps-reqs.txt

@@ -2,9 +2,10 @@
 # This file is autogenerated by pip-compile with python 3.10
 # To update, run:
 #
-#    pip-compile --allow-unsafe --generate-hashes --output-file=installer/py3.10-darwin-x86_64-cpu-reqs.txt installer/requirements.in
+#    pip-compile --allow-unsafe --generate-hashes --output-file=installer/py3.10-darwin-arm64-mps-reqs.txt installer/requirements.in
 #
 --extra-index-url https://download.pytorch.org/whl/torch_stable.html
+--extra-index-url https://download.pytorch.org/whl/cu116
 --trusted-host https
 
 absl-py==1.3.0 \
@@ -150,6 +151,10 @@ blinker==1.5 \
     --hash=sha256:1eb563df6fdbc39eeddc177d953203f99f097e9bf0e2b8f9f3cf18b6ca425e36 \
     --hash=sha256:923e5e2f69c155f2cc42dafbbd70e16e3fde24d2d4aa2ab72fbe386238892462
     # via streamlit
+boltons==21.0.0 \
+    --hash=sha256:65e70a79a731a7fe6e98592ecfb5ccf2115873d01dbc576079874629e5c90f13 \
+    --hash=sha256:b9bb7b58b2b420bbe11a6025fdef6d3e5edc9f76a42fb467afe7ca212ef9948b
+    # via torchsde
 cachetools==5.2.0 \
     --hash=sha256:6a94c6402995a99c3970cc7e4884bb60b4a8639938157eeed436098bf9831757 \
     --hash=sha256:f9f17d2aec496a9aa6b76f53e3b614c965223c061982d434d160f930c698a9db
@@ -608,8 +613,8 @@ jsonschema==4.17.0 \
     # via
     #   altair
     #   jsonmerge
-k-diffusion @ https://github.com/invoke-ai/k-diffusion/archive/7f16b2c33411f26b3eae78d10648d625cb0c1095.zip \
-    --hash=sha256:c3f2c84036aa98c3abf4552fafab04df5ca472aa639982795e05bb1db43ce5e4
+k-diffusion @ https://github.com/Birch-san/k-diffusion/archive/363386981fee88620709cf8f6f2eea167bd6cd74.zip \
+    --hash=sha256:8eac5cdc08736e6d61908a1b2948f2b2f62691b01dc1aab978bddb3451af0d66
     # via -r installer/requirements.in
 kiwisolver==1.4.4 \
     --hash=sha256:02f79693ec433cb4b5f51694e8477ae83b3205768a6fb48ffba60549080e295b \
@@ -1003,6 +1008,7 @@ numpy==1.23.4 \
     #   tifffile
     #   torch-fidelity
     #   torchmetrics
+    #   torchsde
     #   torchvision
     #   transformers
 oauthlib==3.2.2 \
@@ -1654,6 +1660,7 @@ scipy==1.9.3 \
     #   scikit-learn
     #   torch-fidelity
     #   torchdiffeq
+    #   torchsde
 semver==2.13.0 \
     --hash=sha256:ced8b23dceb22134307c1b8abfa523da14198793d9787ac838e70e29e77458d4 \
     --hash=sha256:fa0fe2722ee1c3f57eac478820c3a5ae2f624af8264cbdf9000c980ff7f75e3f
@@ -1869,6 +1876,7 @@ torch==1.12.1 ; platform_system == "Darwin" \
     #   torch-fidelity
     #   torchdiffeq
     #   torchmetrics
+    #   torchsde
     #   torchvision
 torch-fidelity==0.3.0 \
     --hash=sha256:3d3e33db98919759cc4f3f24cb27e1e74bdc7c905d90a780630e4e1c18492b66 \
@@ -1882,6 +1890,10 @@ torchmetrics==0.10.2 \
     --hash=sha256:43757d82266969906fc74b6e80766fcb2a0d52d6c3d09e3b7c98cf3b733fd20c \
     --hash=sha256:daa29d96bff5cff04d80eec5b9f5076993d6ac9c2d2163e88b6b31f8d38f7c25
     # via pytorch-lightning
+torchsde==0.2.5 \
+    --hash=sha256:222be9e15610d37a4b5a71cfa0c442178f9fd9ca02f6522a3e11c370b3d0906b \
+    --hash=sha256:4c34373a94a357bdf60bbfee00c850f3563d634491555820b900c9a4f7eff300
+    # via k-diffusion
 torchvision==0.13.1 ; platform_system == "Darwin" \
     --hash=sha256:0298bae3b09ac361866088434008d82b99d6458fe8888c8df90720ef4b347d44 \
     --hash=sha256:08f592ea61836ebeceb5c97f4d7a813b9d7dc651bbf7ce4401563ccfae6a21fc \
@@ -1942,6 +1954,9 @@ tqdm==4.64.1 \
     #   taming-transformers-rom1504
     #   torch-fidelity
     #   transformers
+trampoline==0.1.2 \
+    --hash=sha256:36cc9a4ff9811843d177fc0e0740efbd7da39eadfe6e50c9e2937cbc06d899d9
+    # via torchsde
 transformers==4.24.0 \
     --hash=sha256:486f353a8e594002e48be0e2aba723d96eda839e63bfe274702a4b5eda85559b \
     --hash=sha256:b7ab50039ef9bf817eff14ab974f306fd20a72350bdc9df3a858fd009419322e

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

@@ -1,9 +1,10 @@
 #
-# This file is autogenerated by pip-compile with python 3.9
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.9
+# by the following command:
 #
-#    pip-compile --allow-unsafe --generate-hashes --output-file=installer/py3.10-linux-x86_64-cuda-reqs.txt installer/requirements.in
+#    pip-compile --allow-unsafe --generate-hashes --output-file=binary_installer/py3.10-linux-x86_64-cuda-reqs.txt binary_installer/requirements.in
 #
+--extra-index-url https://download.pytorch.org/whl/torch_stable.html
 --extra-index-url https://download.pytorch.org/whl/cu116
 --trusted-host https
 
@@ -17,7 +18,7 @@ accelerate==0.14.0 \
     --hash=sha256:31c5bcc40564ef849b5bc1c4424a43ccaf9e26413b7df89c2e36bf81f070fd44 \
     --hash=sha256:b15d562c0889d0cf441b01faa025dfc29b163d061b6cc7d489c2c83b0a55ffab
     # via
-    #   -r installer/requirements.in
+    #   -r binary_installer/requirements.in
     #   k-diffusion
 addict==2.4.0 \
     --hash=sha256:249bb56bbfd3cdc2a004ea0ff4c2b6ddc84d53bc2194761636eb314d5cfa5dfc \
@@ -119,7 +120,7 @@ aiosignal==1.2.0 \
 albumentations==1.3.0 \
     --hash=sha256:294165d87d03bc8323e484927f0a5c1a3c64b0e7b9c32a979582a6c93c363bdf \
     --hash=sha256:be1af36832c8893314f2a5550e8ac19801e04770734c1b70fa3c996b41f37bed
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 altair==4.2.0 \
     --hash=sha256:0c724848ae53410c13fa28be2b3b9a9dcb7b5caa1a70f7f217bd663bb419935a \
     --hash=sha256:d87d9372e63b48cd96b2a6415f0cf9457f50162ab79dc7a31cd7e024dd840026
@@ -150,6 +151,10 @@ blinker==1.5 \
     --hash=sha256:1eb563df6fdbc39eeddc177d953203f99f097e9bf0e2b8f9f3cf18b6ca425e36 \
     --hash=sha256:923e5e2f69c155f2cc42dafbbd70e16e3fde24d2d4aa2ab72fbe386238892462
     # via streamlit
+boltons==21.0.0 \
+    --hash=sha256:65e70a79a731a7fe6e98592ecfb5ccf2115873d01dbc576079874629e5c90f13 \
+    --hash=sha256:b9bb7b58b2b420bbe11a6025fdef6d3e5edc9f76a42fb467afe7ca212ef9948b
+    # via torchsde
 cachetools==5.2.0 \
     --hash=sha256:6a94c6402995a99c3970cc7e4884bb60b4a8639938157eeed436098bf9831757 \
     --hash=sha256:f9f17d2aec496a9aa6b76f53e3b614c965223c061982d434d160f930c698a9db
@@ -183,11 +188,11 @@ click==8.1.3 \
 clip @ https://github.com/openai/CLIP/archive/d50d76daa670286dd6cacf3bcd80b5e4823fc8e1.zip \
     --hash=sha256:b5842c25da441d6c581b53a5c60e0c2127ebafe0f746f8e15561a006c6c3be6a
     # via
-    #   -r installer/requirements.in
+    #   -r binary_installer/requirements.in
     #   clipseg
 clipseg @ https://github.com/invoke-ai/clipseg/archive/1f754751c85d7d4255fa681f4491ff5711c1c288.zip \
     --hash=sha256:14f43ed42f90be3fe57f06de483cb8be0f67f87a6f62a011339d45a39f4b4189
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 commonmark==0.9.1 \
     --hash=sha256:452f9dc859be7f06631ddcb328b6919c67984aca654e5fefb3914d54691aed60 \
     --hash=sha256:da2f38c92590f83de410ba1a3cbceafbc74fee9def35f9251ba9a971d6d66fd9
@@ -274,7 +279,7 @@ decorator==5.1.1 \
 diffusers==0.7.2 \
     --hash=sha256:4a5f8b3a5fbd936bba7d459611cb35ec62875030367be32b232f9e19543e25a9 \
     --hash=sha256:fb814ffd150cc6f470380b8c6a521181a77beb2f44134d2aad2e4cd8aa2ced0e
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 dnspython==2.2.1 \
     --hash=sha256:0f7569a4a6ff151958b64304071d370daa3243d15941a7beedf0c9fe5105603e \
     --hash=sha256:a851e51367fb93e9e1361732c1d60dab63eff98712e503ea7d92e6eccb109b4f
@@ -294,7 +299,7 @@ entrypoints==0.4 \
 eventlet==0.33.1 \
     --hash=sha256:a085922698e5029f820cf311a648ac324d73cec0e4792877609d978a4b5bbf31 \
     --hash=sha256:afbe17f06a58491e9aebd7a4a03e70b0b63fd4cf76d8307bae07f280479b1515
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 facexlib==0.2.5 \
     --hash=sha256:31e20cc4ed5d63562d380e4564bae14ac0d5d1899a079bad87621e13564567e4 \
     --hash=sha256:cc7ceb56c5424319c47223cf75eef6828c34c66082707c6eb35b95d39779f02d
@@ -320,15 +325,15 @@ flask==2.2.2 \
 flask-cors==3.0.10 \
     --hash=sha256:74efc975af1194fc7891ff5cd85b0f7478be4f7f59fe158102e91abb72bb4438 \
     --hash=sha256:b60839393f3b84a0f3746f6cdca56c1ad7426aa738b70d6c61375857823181de
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 flask-socketio==5.3.1 \
     --hash=sha256:fd0ed0fc1341671d92d5f5b2f5503916deb7aa7e2940e6636cfa2c087c828bf9 \
     --hash=sha256:ff0c721f20bff1e2cfba77948727a8db48f187e89a72fe50c34478ce6efb3353
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 flaskwebgui==0.3.7 \
     --hash=sha256:4a69955308eaa8bb256ba04a994dc8f58a48dcd6f9599694ab1bcd9f43d88a5d \
     --hash=sha256:535974ce2672dcc74787c254de24cceed4101be75d96952dae82014dd57f061e
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 fonttools==4.38.0 \
     --hash=sha256:2bb244009f9bf3fa100fc3ead6aeb99febe5985fa20afbfbaa2f8946c2fbdaf1 \
     --hash=sha256:820466f43c8be8c3009aef8b87e785014133508f0de64ec469e4efb643ae54fb
@@ -412,11 +417,11 @@ future==0.18.2 \
 getpass-asterisk==1.0.1 \
     --hash=sha256:20d45cafda0066d761961e0919728526baf7bb5151fbf48a7d5ea4034127d857 \
     --hash=sha256:7cc357a924cf62fa4e15b73cb4e5e30685c9084e464ffdc3fd9000a2b54ea9e9
-    # via -r installer/requirements.in
-gfpgan @ https://github.com/TencentARC/GFPGAN/archive/2eac2033893ca7f427f4035d80fe95b92649ac56.zip \
-    --hash=sha256:79e6d71c8f1df7c7ccb0ac6b9a2ccb615ad5cde818c8b6f285a8711c05aebf85
+    # via -r binary_installer/requirements.in
+gfpgan @ https://github.com/invoke-ai/GFPGAN/archive/c796277a1cf77954e5fc0b288d7062d162894248.zip ; platform_system == "Linux" or platform_system == "Darwin" \
+    --hash=sha256:4155907b8b7db3686324554df7007eedd245cdf8656c21da9d9a3f44bef2fcaa
     # via
-    #   -r installer/requirements.in
+    #   -r binary_installer/requirements.in
     #   realesrgan
 gitdb==4.0.9 \
     --hash=sha256:8033ad4e853066ba6ca92050b9df2f89301b8fc8bf7e9324d412a63f8bf1a8fd \
@@ -577,7 +582,7 @@ imageio-ffmpeg==0.4.7 \
     --hash=sha256:7a08838f97f363e37ca41821b864fd3fdc99ab1fe2421040c78eb5f56a9e723e \
     --hash=sha256:8e724d12dfe83e2a6eb39619e820243ca96c81c47c2648e66e05f7ee24e14312 \
     --hash=sha256:fc60686ef03c2d0f842901b206223c30051a6a120384458761390104470846fd
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 importlib-metadata==5.0.0 \
     --hash=sha256:da31db32b304314d044d3c12c79bd59e307889b287ad12ff387b3500835fc2ab \
     --hash=sha256:ddb0e35065e8938f867ed4928d0ae5bf2a53b7773871bfe6bcc7e4fcdc7dea43
@@ -610,9 +615,9 @@ jsonschema==4.17.0 \
     # via
     #   altair
     #   jsonmerge
-k-diffusion @ https://github.com/invoke-ai/k-diffusion/archive/7f16b2c33411f26b3eae78d10648d625cb0c1095.zip \
-    --hash=sha256:c3f2c84036aa98c3abf4552fafab04df5ca472aa639982795e05bb1db43ce5e4
-    # via -r installer/requirements.in
+k-diffusion @ https://github.com/Birch-san/k-diffusion/archive/363386981fee88620709cf8f6f2eea167bd6cd74.zip \
+    --hash=sha256:8eac5cdc08736e6d61908a1b2948f2b2f62691b01dc1aab978bddb3451af0d66
+    # via -r binary_installer/requirements.in
 kiwisolver==1.4.4 \
     --hash=sha256:02f79693ec433cb4b5f51694e8477ae83b3205768a6fb48ffba60549080e295b \
     --hash=sha256:03baab2d6b4a54ddbb43bba1a3a2d1627e82d205c5cf8f4c924dc49284b87166 \
@@ -1005,6 +1010,7 @@ numpy==1.23.4 \
     #   tifffile
     #   torch-fidelity
     #   torchmetrics
+    #   torchsde
     #   torchvision
     #   transformers
 oauthlib==3.2.2 \
@@ -1091,7 +1097,7 @@ pathtools==0.1.2 \
 picklescan==0.0.5 \
     --hash=sha256:368cf1b9a075bc1b6460ad82b694f260532b836c82f99d13846cd36e1bbe7f9a \
     --hash=sha256:57153eca04d5df5009f2cdd595aef261b8a6f27e03046a1c84f672aa6869c592
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 pillow==9.3.0 \
     --hash=sha256:03150abd92771742d4a8cd6f2fa6246d847dcd2e332a18d0c15cc75bf6703040 \
     --hash=sha256:073adb2ae23431d3b9bcbcff3fe698b62ed47211d0716b067385538a1b0f28b8 \
@@ -1300,11 +1306,11 @@ pyparsing==3.0.9 \
     #   packaging
 pypatchmatch @ https://github.com/invoke-ai/PyPatchMatch/archive/129863937a8ab37f6bbcec327c994c0f932abdbc.zip \
     --hash=sha256:4ad6ec95379e7d122d494ff76633cc7cf9b71330d5efda147fceba81e3dc6cd2
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 pyreadline3==3.4.1 \
     --hash=sha256:6f3d1f7b8a31ba32b73917cefc1f28cc660562f39aea8646d30bd6eff21f7bae \
     --hash=sha256:b0efb6516fd4fb07b45949053826a62fa4cb353db5be2bbb4a7aa1fdd1e345fb
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 pyrsistent==0.19.2 \
     --hash=sha256:055ab45d5911d7cae397dc418808d8802fb95262751872c841c170b0dbf51eed \
     --hash=sha256:111156137b2e71f3a9936baf27cb322e8024dac3dc54ec7fb9f0bcf3249e68bb \
@@ -1441,7 +1447,7 @@ qudida==0.0.4 \
 realesrgan==0.3.0 \
     --hash=sha256:0d36da96ab9f447071606e91f502ccdfb08f80cc82ee4f8caf720c7745ccec7e \
     --hash=sha256:59336c16c30dd5130eff350dd27424acb9b7281d18a6810130e265606c9a6088
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 regex==2022.10.31 \
     --hash=sha256:052b670fafbe30966bbe5d025e90b2a491f85dfe5b2583a163b5e60a85a321ad \
     --hash=sha256:0653d012b3bf45f194e5e6a41df9258811ac8fc395579fa82958a8b76286bea4 \
@@ -1656,6 +1662,7 @@ scipy==1.9.3 \
     #   scikit-learn
     #   torch-fidelity
     #   torchdiffeq
+    #   torchsde
 semver==2.13.0 \
     --hash=sha256:ced8b23dceb22134307c1b8abfa523da14198793d9787ac838e70e29e77458d4 \
     --hash=sha256:fa0fe2722ee1c3f57eac478820c3a5ae2f624af8264cbdf9000c980ff7f75e3f
@@ -1663,7 +1670,7 @@ semver==2.13.0 \
 send2trash==1.8.0 \
     --hash=sha256:d2c24762fd3759860a0aff155e45871447ea58d2be6bdd39b5c8f966a0c99c2d \
     --hash=sha256:f20eaadfdb517eaca5ce077640cb261c7d2698385a6a0f072a4a5447fd49fa08
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 sentry-sdk==1.10.1 \
     --hash=sha256:06c0fa9ccfdc80d7e3b5d2021978d6eb9351fa49db9b5847cf4d1f2a473414ad \
     --hash=sha256:105faf7bd7b7fa25653404619ee261527266b14103fe1389e0ce077bd23a9691
@@ -1754,11 +1761,11 @@ smmap==5.0.0 \
 streamlit==1.14.0 \
     --hash=sha256:62556d873567e1b3427bcd118a57ee6946619f363bd6bba38df2d1f8225ecba0 \
     --hash=sha256:e078b8143d150ba721bdb9194218e311c5fe1d6d4156473a2dea6cc848a6c9fc
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 taming-transformers-rom1504==0.0.6 \
     --hash=sha256:051b5804c58caa247bcd51d17ddb525b4d5f892a29d42dc460f40e3e9e34e5d8 \
     --hash=sha256:73fe5fc1108accee4236ee6976e0987ab236afad0af06cb9f037641a908d2c32
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 tb-nightly==2.11.0a20221106 \
     --hash=sha256:8940457ee42db92f01da8bcdbbea1a476735eda559dde5976f5728919960af4a
     # via
@@ -1783,7 +1790,7 @@ tensorboard-plugin-wit==1.8.1 \
     #   tensorboard
 test-tube==0.7.5 \
     --hash=sha256:1379c33eb8cde3e9b36610f87da0f16c2e06496b1cfebac473df4e7be2faa124
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 threadpoolctl==3.1.0 \
     --hash=sha256:8b99adda265feb6773280df41eece7b2e6561b772d21ffd52e372f999024907b \
     --hash=sha256:a335baacfaa4400ae1f0d8e3a58d6674d2f8828e3716bb2802c44955ad391380
@@ -1843,7 +1850,7 @@ torch==1.12.0+cu116 ; platform_system == "Linux" or platform_system == "Windows"
     --hash=sha256:aa43d7b54b86f723f17c5c44df1078c59a6149fc4d42fbef08aafab9d61451c9 \
     --hash=sha256:f772be831447dd01ebd26cbedf619e668d1b269d69bf6b4ff46b1378362bff26
     # via
-    #   -r installer/requirements.in
+    #   -r binary_installer/requirements.in
     #   accelerate
     #   basicsr
     #   clean-fid
@@ -1859,11 +1866,12 @@ torch==1.12.0+cu116 ; platform_system == "Linux" or platform_system == "Windows"
     #   torch-fidelity
     #   torchdiffeq
     #   torchmetrics
+    #   torchsde
     #   torchvision
 torch-fidelity==0.3.0 \
     --hash=sha256:3d3e33db98919759cc4f3f24cb27e1e74bdc7c905d90a780630e4e1c18492b66 \
     --hash=sha256:d01284825595feb7dc3eae3dc9a0d8ced02be764813a3483f109bc142b52a1d3
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 torchdiffeq==0.2.3 \
     --hash=sha256:b5b01ec1294a2d8d5f77e567bf17c5de1237c0573cb94deefa88326f0e18c338 \
     --hash=sha256:fe75f434b9090ac0c27702e02bed21472b0f87035be6581f51edc5d4013ea31a
@@ -1872,6 +1880,10 @@ torchmetrics==0.10.2 \
     --hash=sha256:43757d82266969906fc74b6e80766fcb2a0d52d6c3d09e3b7c98cf3b733fd20c \
     --hash=sha256:daa29d96bff5cff04d80eec5b9f5076993d6ac9c2d2163e88b6b31f8d38f7c25
     # via pytorch-lightning
+torchsde==0.2.5 \
+    --hash=sha256:222be9e15610d37a4b5a71cfa0c442178f9fd9ca02f6522a3e11c370b3d0906b \
+    --hash=sha256:4c34373a94a357bdf60bbfee00c850f3563d634491555820b900c9a4f7eff300
+    # via k-diffusion
 torchvision==0.13.0+cu116 ; platform_system == "Linux" or platform_system == "Windows" \
     --hash=sha256:1696feadf1921c8fa1549bad774221293298288ebedaa14e44bc3e57e964a369 \
     --hash=sha256:572544b108eaf12638f3dca0f496a453c4b8d8256bcc8333d5355df641c0380c \
@@ -1882,7 +1894,7 @@ torchvision==0.13.0+cu116 ; platform_system == "Linux" or platform_system == "Wi
     --hash=sha256:cb6bf0117b8f4b601baeae54e8a6bb5c4942b054835ba997f438ddcb7adcfb90 \
     --hash=sha256:d1a3c124645e3460b3e50b54eb89a2575a5036bfa618f15dc4f5d635c716069d
     # via
-    #   -r installer/requirements.in
+    #   -r binary_installer/requirements.in
     #   basicsr
     #   clean-fid
     #   clip
@@ -1921,10 +1933,13 @@ tqdm==4.64.1 \
     #   taming-transformers-rom1504
     #   torch-fidelity
     #   transformers
+trampoline==0.1.2 \
+    --hash=sha256:36cc9a4ff9811843d177fc0e0740efbd7da39eadfe6e50c9e2937cbc06d899d9
+    # via torchsde
 transformers==4.24.0 \
     --hash=sha256:486f353a8e594002e48be0e2aba723d96eda839e63bfe274702a4b5eda85559b \
     --hash=sha256:b7ab50039ef9bf817eff14ab974f306fd20a72350bdc9df3a858fd009419322e
-    # via -r installer/requirements.in
+    # via -r binary_installer/requirements.in
 typing-extensions==4.4.0 \
     --hash=sha256:1511434bb92bf8dd198c12b1cc812e800d4181cfcb867674e0f8279cc93087aa \
     --hash=sha256:16fa4864408f655d35ec496218b85f79b3437c829e93320c7c9215ccfd92489e

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

@@ -4,6 +4,7 @@
 #
 #    pip-compile --allow-unsafe --generate-hashes --output-file=installer/py3.10-windows-x86_64-cuda-reqs.txt installer/requirements.in
 #
+--extra-index-url https://download.pytorch.org/whl/torch_stable.html
 --extra-index-url https://download.pytorch.org/whl/cu116
 --trusted-host https
 
@@ -150,6 +151,10 @@ blinker==1.5 \
     --hash=sha256:1eb563df6fdbc39eeddc177d953203f99f097e9bf0e2b8f9f3cf18b6ca425e36 \
     --hash=sha256:923e5e2f69c155f2cc42dafbbd70e16e3fde24d2d4aa2ab72fbe386238892462
     # via streamlit
+boltons==21.0.0 \
+    --hash=sha256:65e70a79a731a7fe6e98592ecfb5ccf2115873d01dbc576079874629e5c90f13 \
+    --hash=sha256:b9bb7b58b2b420bbe11a6025fdef6d3e5edc9f76a42fb467afe7ca212ef9948b
+    # via torchsde
 cachetools==5.2.0 \
     --hash=sha256:6a94c6402995a99c3970cc7e4884bb60b4a8639938157eeed436098bf9831757 \
     --hash=sha256:f9f17d2aec496a9aa6b76f53e3b614c965223c061982d434d160f930c698a9db
@@ -614,8 +619,8 @@ jsonschema==4.17.0 \
     # via
     #   altair
     #   jsonmerge
-k-diffusion @ https://github.com/invoke-ai/k-diffusion/archive/7f16b2c33411f26b3eae78d10648d625cb0c1095.zip \
-    --hash=sha256:c3f2c84036aa98c3abf4552fafab04df5ca472aa639982795e05bb1db43ce5e4
+k-diffusion @ https://github.com/Birch-san/k-diffusion/archive/363386981fee88620709cf8f6f2eea167bd6cd74.zip \
+    --hash=sha256:8eac5cdc08736e6d61908a1b2948f2b2f62691b01dc1aab978bddb3451af0d66
     # via -r installer/requirements.in
 kiwisolver==1.4.4 \
     --hash=sha256:02f79693ec433cb4b5f51694e8477ae83b3205768a6fb48ffba60549080e295b \
@@ -1009,6 +1014,7 @@ numpy==1.23.4 \
     #   tifffile
     #   torch-fidelity
     #   torchmetrics
+    #   torchsde
     #   torchvision
     #   transformers
 oauthlib==3.2.2 \
@@ -1660,6 +1666,7 @@ scipy==1.9.3 \
     #   scikit-learn
     #   torch-fidelity
     #   torchdiffeq
+    #   torchsde
 semver==2.13.0 \
     --hash=sha256:ced8b23dceb22134307c1b8abfa523da14198793d9787ac838e70e29e77458d4 \
     --hash=sha256:fa0fe2722ee1c3f57eac478820c3a5ae2f624af8264cbdf9000c980ff7f75e3f
@@ -1863,6 +1870,7 @@ torch==1.12.0+cu116 ; platform_system == "Linux" or platform_system == "Windows"
     #   torch-fidelity
     #   torchdiffeq
     #   torchmetrics
+    #   torchsde
     #   torchvision
 torch-fidelity==0.3.0 \
     --hash=sha256:3d3e33db98919759cc4f3f24cb27e1e74bdc7c905d90a780630e4e1c18492b66 \
@@ -1876,6 +1884,10 @@ torchmetrics==0.10.2 \
     --hash=sha256:43757d82266969906fc74b6e80766fcb2a0d52d6c3d09e3b7c98cf3b733fd20c \
     --hash=sha256:daa29d96bff5cff04d80eec5b9f5076993d6ac9c2d2163e88b6b31f8d38f7c25
     # via pytorch-lightning
+torchsde==0.2.5 \
+    --hash=sha256:222be9e15610d37a4b5a71cfa0c442178f9fd9ca02f6522a3e11c370b3d0906b \
+    --hash=sha256:4c34373a94a357bdf60bbfee00c850f3563d634491555820b900c9a4f7eff300
+    # via k-diffusion
 torchvision==0.13.0+cu116 ; platform_system == "Linux" or platform_system == "Windows" \
     --hash=sha256:1696feadf1921c8fa1549bad774221293298288ebedaa14e44bc3e57e964a369 \
     --hash=sha256:572544b108eaf12638f3dca0f496a453c4b8d8256bcc8333d5355df641c0380c \
@@ -1925,6 +1937,9 @@ tqdm==4.64.1 \
     #   taming-transformers-rom1504
     #   torch-fidelity
     #   transformers
+trampoline==0.1.2 \
+    --hash=sha256:36cc9a4ff9811843d177fc0e0740efbd7da39eadfe6e50c9e2937cbc06d899d9
+    # via torchsde
 transformers==4.24.0 \
     --hash=sha256:486f353a8e594002e48be0e2aba723d96eda839e63bfe274702a4b5eda85559b \
     --hash=sha256:b7ab50039ef9bf817eff14ab974f306fd20a72350bdc9df3a858fd009419322e

binary_installer/readme.txt

@@ -0,0 +1,17 @@
+InvokeAI
+
+Project homepage: https://github.com/invoke-ai/InvokeAI
+
+Installation on Windows:
+    NOTE: You might need to enable Windows Long Paths. If you're not sure,
+    then you almost certainly need to. Simply double-click the 'WinLongPathsEnabled.reg'
+    file. Note that you will need to have admin privileges in order to
+    do this.
+
+    Please double-click the 'install.bat' file (while keeping it inside the invokeAI folder).
+
+Installation on Linux and Mac:
+    Please open the terminal, and run './install.sh' (while keeping it inside the invokeAI folder).
+
+After installation, please run the 'invoke.bat' file (on Windows) or 'invoke.sh'
+file (on Linux/Mac) to start InvokeAI.

binary_installer/requirements.in

@@ -1,5 +1,6 @@
 --prefer-binary
 --extra-index-url https://download.pytorch.org/whl/torch_stable.html
+--extra-index-url https://download.pytorch.org/whl/cu116
 --trusted-host https://download.pytorch.org
 accelerate~=0.14
 albumentations
@@ -7,7 +8,7 @@ diffusers
 eventlet
 flask_cors
 flask_socketio
-flaskwebgui
+flaskwebgui==1.0.3
 getpass_asterisk
 imageio-ffmpeg
 pyreadline3
@@ -25,6 +26,7 @@ transformers
 picklescan
 https://github.com/openai/CLIP/archive/d50d76daa670286dd6cacf3bcd80b5e4823fc8e1.zip
 https://github.com/invoke-ai/clipseg/archive/1f754751c85d7d4255fa681f4491ff5711c1c288.zip
-https://github.com/TencentARC/GFPGAN/archive/2eac2033893ca7f427f4035d80fe95b92649ac56.zip
-https://github.com/invoke-ai/k-diffusion/archive/7f16b2c33411f26b3eae78d10648d625cb0c1095.zip
+https://github.com/invoke-ai/GFPGAN/archive/3f5d2397361199bc4a91c08bb7d80f04d7805615.zip ; platform_system=='Windows'
+https://github.com/invoke-ai/GFPGAN/archive/c796277a1cf77954e5fc0b288d7062d162894248.zip ; platform_system=='Linux' or platform_system=='Darwin'
+https://github.com/Birch-san/k-diffusion/archive/363386981fee88620709cf8f6f2eea167bd6cd74.zip
 https://github.com/invoke-ai/PyPatchMatch/archive/129863937a8ab37f6bbcec327c994c0f932abdbc.zip

configs/INITIAL_MODELS.yaml

@@ -31,7 +31,7 @@ stable-diffusion-1.4:
    width: 512
    height: 512
 waifu-diffusion-1.3:
-   description: Stable Diffusion 1.4 fine tuned on anime-styled images (4.27)
+   description: Stable Diffusion 1.4 fine tuned on anime-styled images (4.27 GB)
    repo_id: hakurei/waifu-diffusion-v1-3
    config: v1-inference.yaml
    file: model-epoch09-float32.ckpt

configs/models.yaml.example

@@ -25,3 +25,5 @@ inpainting-1.5:
   config: configs/stable-diffusion/v1-inpainting-inference.yaml
   vae: models/ldm/stable-diffusion-v1/vae-ft-mse-840000-ema-pruned.ckpt
   description: RunwayML SD 1.5 model optimized for inpainting
+  width: 512
+  height: 512

configs/stable-diffusion/v1-inference.yaml

@@ -32,7 +32,7 @@ model:
         placeholder_strings: ["*"]
         initializer_words: ['sculpture']
         per_image_tokens: false
-        num_vectors_per_token: 8
+        num_vectors_per_token: 1
         progressive_words: False
 
     unet_config:

docker-build/Dockerfile

@@ -1,4 +1,4 @@
-FROM ubuntu:22.10
+FROM python:3.10-slim AS builder
 
 # use bash
 SHELL [ "/bin/bash", "-c" ]
@@ -7,28 +7,59 @@ SHELL [ "/bin/bash", "-c" ]
 RUN apt-get update \
   && apt-get install -y \
     --no-install-recommends \
-    build-essential \
-    gcc \
-    git \
-    libgl1-mesa-glx \
-    libglib2.0-0 \
-    pip \
-    python3 \
-    python3-dev \
+    gcc=4:10.2.* \
+    libgl1-mesa-glx=20.3.* \
+    libglib2.0-0=2.66.* \
+    python3-dev=3.9.* \
   && apt-get clean \
   && rm -rf /var/lib/apt/lists/*
 
-# set workdir and copy sources
-WORKDIR /invokeai
+# set WORKDIR, PATH and copy sources
+ARG APPDIR=/usr/src/app
+WORKDIR ${APPDIR}
+ENV PATH ${APPDIR}/.venv/bin:$PATH
 ARG PIP_REQUIREMENTS=requirements-lin-cuda.txt
 COPY . ./environments-and-requirements/${PIP_REQUIREMENTS} ./
 
-# install requirements and link outputs folder
-RUN pip install \
+# install requirements
+RUN python3 -m venv .venv \
+  && pip install \
+    --upgrade \
+    --no-cache-dir \
+    'wheel>=0.38.4' \
+  && pip install \
     --no-cache-dir \
     -r ${PIP_REQUIREMENTS}
 
-# set Environment, Entrypoint and default CMD
-ENV INVOKEAI_ROOT /data
-ENTRYPOINT [ "python3", "scripts/invoke.py", "--outdir=/data/outputs" ]
+FROM python:3.10-slim AS runtime
+
+# setup environment
+ARG APPDIR=/usr/src/app
+WORKDIR ${APPDIR}
+COPY --from=builder ${APPDIR} .
+ENV \
+  PATH=${APPDIR}/.venv/bin:$PATH \
+  INVOKEAI_ROOT=/data \
+  INVOKE_MODEL_RECONFIGURE=--yes
+
+# Install necesarry packages
+RUN apt-get update \
+  && apt-get install -y \
+    --no-install-recommends \
+    build-essential=12.9 \
+    libgl1-mesa-glx=20.3.* \
+    libglib2.0-0=2.66.* \
+    libopencv-dev=4.5.* \
+  && ln -sf \
+    /usr/lib/"$(arch)"-linux-gnu/pkgconfig/opencv4.pc \
+    /usr/lib/"$(arch)"-linux-gnu/pkgconfig/opencv.pc \
+  && python3 -c "from patchmatch import patch_match" \
+  && apt-get remove -y \
+    --autoremove \
+    build-essential \
+  && apt-get autoclean \
+  && rm -rf /var/lib/apt/lists/*
+
+# set Entrypoint and default CMD
+ENTRYPOINT [ "python3", "scripts/invoke.py" ]
 CMD [ "--web", "--host=0.0.0.0" ]

docker-build/Dockerfile.cloud

@@ -0,0 +1,86 @@
+#######################
+#### Builder stage ####
+
+FROM library/ubuntu:22.04 AS builder
+
+ARG DEBIAN_FRONTEND=noninteractive
+RUN rm -f /etc/apt/apt.conf.d/docker-clean; echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' > /etc/apt/apt.conf.d/keep-cache
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked \
+    apt update && apt-get install -y \
+        git \
+        libglib2.0-0 \
+        libgl1-mesa-glx \
+        python3-venv \
+        python3-pip \
+        build-essential \
+        python3-opencv \
+        libopencv-dev
+
+# This is needed for patchmatch support
+RUN cd /usr/lib/x86_64-linux-gnu/pkgconfig/ &&\
+   ln -sf opencv4.pc opencv.pc
+
+ARG WORKDIR=/invokeai
+WORKDIR ${WORKDIR}
+
+ENV VIRTUAL_ENV=${WORKDIR}/.venv
+ENV PATH="$VIRTUAL_ENV/bin:$PATH"
+
+RUN --mount=type=cache,target=/root/.cache/pip \
+    python3 -m venv ${VIRTUAL_ENV} &&\
+    pip install --extra-index-url https://download.pytorch.org/whl/cu116 \
+        torch==1.12.0+cu116 \
+        torchvision==0.13.0+cu116 &&\
+    pip install -e git+https://github.com/invoke-ai/PyPatchMatch@0.1.3#egg=pypatchmatch
+
+COPY . .
+RUN --mount=type=cache,target=/root/.cache/pip \
+    cp environments-and-requirements/requirements-lin-cuda.txt requirements.txt && \
+    pip install -r requirements.txt &&\
+    pip install -e .
+
+
+#######################
+#### Runtime stage ####
+
+FROM library/ubuntu:22.04 as runtime
+
+ARG DEBIAN_FRONTEND=noninteractive
+ENV PYTHONUNBUFFERED=1
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked \
+    apt update && apt install -y --no-install-recommends \
+        git \
+        curl \
+        ncdu \
+        iotop \
+        bzip2 \
+        libglib2.0-0 \
+        libgl1-mesa-glx \
+        python3-venv \
+        python3-pip \
+        build-essential \
+        python3-opencv \
+        libopencv-dev &&\
+    apt-get clean && apt-get autoclean
+
+ARG WORKDIR=/invokeai
+WORKDIR ${WORKDIR}
+
+ENV INVOKEAI_ROOT=/mnt/invokeai
+ENV VIRTUAL_ENV=${WORKDIR}/.venv
+ENV PATH="$VIRTUAL_ENV/bin:$PATH"
+
+COPY --from=builder ${WORKDIR} ${WORKDIR}
+COPY --from=builder /usr/lib/x86_64-linux-gnu/pkgconfig /usr/lib/x86_64-linux-gnu/pkgconfig
+
+# build patchmatch
+RUN python -c "from patchmatch import patch_match"
+
+## workaround for non-existent initfile when runtime directory is mounted; see #1613
+RUN touch /root/.invokeai
+
+ENTRYPOINT ["bash"]
+
+CMD ["-c", "python3 scripts/invoke.py --web --host 0.0.0.0"]

docker-build/Makefile

@@ -0,0 +1,44 @@
+# Directory in the container where the INVOKEAI_ROOT (runtime dir) will be mounted
+INVOKEAI_ROOT=/mnt/invokeai
+# Host directory to contain the runtime dir. Will be mounted at INVOKEAI_ROOT path in the container
+HOST_MOUNT_PATH=${HOME}/invokeai
+
+IMAGE=local/invokeai:latest
+
+USER=$(shell id -u)
+GROUP=$(shell id -g)
+
+# All downloaded models, config, etc will end up in ${HOST_MOUNT_PATH} on the host.
+# This is consistent with the expected non-Docker behaviour.
+# Contents can be moved to a persistent storage and used to prime the cache on another host.
+
+build:
+	DOCKER_BUILDKIT=1 docker build -t local/invokeai:latest -f Dockerfile.cloud ..
+
+configure:
+	docker run --rm -it --runtime=nvidia --gpus=all \
+		-v ${HOST_MOUNT_PATH}:${INVOKEAI_ROOT} \
+		-e INVOKEAI_ROOT=${INVOKEAI_ROOT} \
+		${IMAGE} -c "python scripts/configure_invokeai.py"
+
+# Run the container with the runtime dir mounted and the web server exposed on port 9090
+web:
+	docker run --rm -it --runtime=nvidia --gpus=all \
+		-v ${HOST_MOUNT_PATH}:${INVOKEAI_ROOT} \
+		-e INVOKEAI_ROOT=${INVOKEAI_ROOT} \
+		-p 9090:9090 \
+		${IMAGE} -c "python scripts/invoke.py --web --host 0.0.0.0"
+
+# Run the cli with the runtime dir mounted
+cli:
+	docker run --rm -it --runtime=nvidia --gpus=all \
+		-v ${HOST_MOUNT_PATH}:${INVOKEAI_ROOT} \
+		-e INVOKEAI_ROOT=${INVOKEAI_ROOT} \
+		${IMAGE} -c "python scripts/invoke.py"
+
+# Run the container with the runtime dir mounted and open a bash shell
+shell:
+	docker run --rm -it --runtime=nvidia --gpus=all \
+		-v ${HOST_MOUNT_PATH}:${INVOKEAI_ROOT} ${IMAGE} --
+
+.PHONY: build configure web cli shell

docker-build/build.sh

@@ -1,49 +1,35 @@
 #!/usr/bin/env bash
 set -e
 
-# IMPORTANT: You need to have a token on huggingface.co to be able to download the checkpoints!!!
-# configure values by using env when executing build.sh f.e. `env ARCH=aarch64 ./build.sh`
+# How to use: https://invoke-ai.github.io/InvokeAI/installation/INSTALL_DOCKER/#setup
 
 source ./docker-build/env.sh \
   || echo "please execute docker-build/build.sh from repository root" \
   || exit 1
 
-pip_requirements=${PIP_REQUIREMENTS:-requirements-lin-cuda.txt}
-dockerfile=${INVOKE_DOCKERFILE:-docker-build/Dockerfile}
+PIP_REQUIREMENTS=${PIP_REQUIREMENTS:-requirements-lin-cuda.txt}
+DOCKERFILE=${INVOKE_DOCKERFILE:-docker-build/Dockerfile}
 
 # print the settings
-echo "You are using these values:"
-echo -e "Dockerfile:\t\t ${dockerfile}"
-echo -e "requirements:\t\t ${pip_requirements}"
-echo -e "volumename:\t\t ${volumename}"
-echo -e "arch:\t\t\t ${arch}"
-echo -e "platform:\t\t ${platform}"
-echo -e "invokeai_tag:\t\t ${invokeai_tag}\n"
+echo -e "You are using these values:\n"
+echo -e "Dockerfile:\t ${DOCKERFILE}"
+echo -e "Requirements:\t ${PIP_REQUIREMENTS}"
+echo -e "Volumename:\t ${VOLUMENAME}"
+echo -e "arch:\t\t ${ARCH}"
+echo -e "Platform:\t ${PLATFORM}"
+echo -e "Invokeai_tag:\t ${INVOKEAI_TAG}\n"
 
-if [[ -n "$(docker volume ls -f name="${volumename}" -q)" ]]; then
-  echo "Volume already exists"
-  echo
+if [[ -n "$(docker volume ls -f name="${VOLUMENAME}" -q)" ]]; then
+  echo -e "Volume already exists\n"
 else
   echo -n "createing docker volume "
-  docker volume create "${volumename}"
+  docker volume create "${VOLUMENAME}"
 fi
 
 # Build Container
 docker build \
-  --platform="${platform}" \
-  --tag="${invokeai_tag}" \
-  --build-arg="PIP_REQUIREMENTS=${pip_requirements}" \
-  --file="${dockerfile}" \
+  --platform="${PLATFORM}" \
+  --tag="${INVOKEAI_TAG}" \
+  --build-arg="PIP_REQUIREMENTS=${PIP_REQUIREMENTS}" \
+  --file="${DOCKERFILE}" \
   .
-
-docker run \
-  --rm \
-  --platform="$platform" \
-  --name="$project_name" \
-  --hostname="$project_name" \
-  --mount="source=$volumename,target=/data" \
-  --mount="type=bind,source=$HOME/.huggingface,target=/root/.huggingface" \
-  --env="HUGGINGFACE_TOKEN=${HUGGINGFACE_TOKEN}" \
-  --entrypoint="python3" \
-  "${invokeai_tag}" \
-  scripts/configure_invokeai.py --yes

docker-build/env.sh

@@ -1,13 +1,10 @@
 #!/usr/bin/env bash
 
-project_name=${PROJECT_NAME:-invokeai}
-volumename=${VOLUMENAME:-${project_name}_data}
-arch=${ARCH:-x86_64}
-platform=${PLATFORM:-Linux/${arch}}
-invokeai_tag=${INVOKEAI_TAG:-${project_name}:${arch}}
-
-export project_name
-export volumename
-export arch
-export platform
-export invokeai_tag
+# Variables shared by build.sh and run.sh
+REPOSITORY_NAME=${REPOSITORY_NAME:-$(basename "$(git rev-parse --show-toplevel)")}
+VOLUMENAME=${VOLUMENAME:-${REPOSITORY_NAME,,}_data}
+ARCH=${ARCH:-$(uname -m)}
+PLATFORM=${PLATFORM:-Linux/${ARCH}}
+CONTAINER_FLAVOR=${CONTAINER_FLAVOR:-cuda}
+INVOKEAI_BRANCH=$(git branch --show)
+INVOKEAI_TAG=${REPOSITORY_NAME,,}-${CONTAINER_FLAVOR}:${INVOKEAI_TAG:-${INVOKEAI_BRANCH/\//-}}

docker-build/run.sh

@@ -1,15 +1,31 @@
 #!/usr/bin/env bash
 set -e
 
-source ./docker-build/env.sh || echo "please run from repository root" || exit 1
+# How to use: https://invoke-ai.github.io/InvokeAI/installation/INSTALL_DOCKER/#run-the-container
+# IMPORTANT: You need to have a token on huggingface.co to be able to download the checkpoints!!!
+
+source ./docker-build/env.sh \
+  || echo "please run from repository root" \
+  || exit 1
+
+# check if HUGGINGFACE_TOKEN is available
+# You must have accepted the terms of use for required models
+HUGGINGFACE_TOKEN=${HUGGINGFACE_TOKEN:?Please set your token for Huggingface as HUGGINGFACE_TOKEN}
+
+echo -e "You are using these values:\n"
+echo -e "Volumename:\t ${VOLUMENAME}"
+echo -e "Invokeai_tag:\t ${INVOKEAI_TAG}\n"
 
 docker run \
   --interactive \
   --tty \
   --rm \
-  --platform="$platform" \
-  --name="$project_name" \
-  --hostname="$project_name" \
-  --mount="source=$volumename,target=/data" \
+  --platform="$PLATFORM" \
+  --name="${REPOSITORY_NAME,,}" \
+  --hostname="${REPOSITORY_NAME,,}" \
+  --mount="source=$VOLUMENAME,target=/data" \
+  --env="HUGGINGFACE_TOKEN=${HUGGINGFACE_TOKEN}" \
   --publish=9090:9090 \
-  "$invokeai_tag" ${1:+$@}
+  --cap-add=sys_nice \
+  ${GPU_FLAGS:+--gpus=${GPU_FLAGS}} \
+  "$INVOKEAI_TAG" ${1:+$@}

docs/CHANGELOG.md

@@ -4,180 +4,275 @@ title: Changelog
 
 # :octicons-log-16: **Changelog**
 
+## v2.2.4 <small>(11 December 2022)</small>
+
+**the `invokeai` directory**
+
+Previously there were two directories to worry about, the directory that
+contained the InvokeAI source code and the launcher scripts, and the `invokeai`
+directory that contained the models files, embeddings, configuration and
+outputs. With the 2.2.4 release, this dual system is done away with, and
+everything, including the `invoke.bat` and `invoke.sh` launcher scripts, now
+live in a directory named `invokeai`. By default this directory is located in
+your home directory (e.g. `\Users\yourname` on Windows), but you can select
+where it goes at install time.
+
+After installation, you can delete the install directory (the one that the zip
+file creates when it unpacks). Do **not** delete or move the `invokeai`
+directory!
+
+**Initialization file `invokeai/invokeai.init`**
+
+You can place frequently-used startup options in this file, such as the default
+number of steps or your preferred sampler. To keep everything in one place, this
+file has now been moved into the `invokeai` directory and is named
+`invokeai.init`.
+
+**To update from Version 2.2.3**
+
+The easiest route is to download and unpack one of the 2.2.4 installer files.
+When it asks you for the location of the `invokeai` runtime directory, respond
+with the path to the directory that contains your 2.2.3 `invokeai`. That is, if
+`invokeai` lives at `C:\Users\fred\invokeai`, then answer with `C:\Users\fred`
+and answer "Y" when asked if you want to reuse the directory.
+
+The `update.sh` (`update.bat`) script that came with the 2.2.3 source installer
+does not know about the new directory layout and won't be fully functional.
+
+**To update to 2.2.5 (and beyond) there's now an update path**
+
+As they become available, you can update to more recent versions of InvokeAI
+using an `update.sh` (`update.bat`) script located in the `invokeai` directory.
+Running it without any arguments will install the most recent version of
+InvokeAI. Alternatively, you can get set releases by running the `update.sh`
+script with an argument in the command shell. This syntax accepts the path to
+the desired release's zip file, which you can find by clicking on the green
+"Code" button on this repository's home page.
+
+**Other 2.2.4 Improvements**
+
+- Fix InvokeAI GUI initialization by @addianto in #1687
+- fix link in documentation by @lstein in #1728
+- Fix broken link by @ShawnZhong in #1736
+- Remove reference to binary installer by @lstein in #1731
+- documentation fixes for 2.2.3 by @lstein in #1740
+- Modify installer links to point closer to the source installer by @ebr in
+  #1745
+- add documentation warning about 1650/60 cards by @lstein in #1753
+- Fix Linux source URL in installation docs by @andybearman in #1756
+- Make install instructions discoverable in readme by @damian0815 in #1752
+- typo fix by @ofirkris in #1755
+- Non-interactive model download (support HUGGINGFACE_TOKEN) by @ebr in #1578
+- fix(srcinstall): shell installer - cp scripts instead of linking by @tildebyte
+  in #1765
+- stability and usage improvements to binary & source installers by @lstein in
+  #1760
+- fix off-by-one bug in cross-attention-control by @damian0815 in #1774
+- Eventually update APP_VERSION to 2.2.3 by @spezialspezial in #1768
+- invoke script cds to its location before running by @lstein in #1805
+- Make PaperCut and VoxelArt models load again by @lstein in #1730
+- Fix --embedding_directory / --embedding_path not working by @blessedcoolant in
+  #1817
+- Clean up readme by @hipsterusername in #1820
+- Optimized Docker build with support for external working directory by @ebr in
+  #1544
+- disable pushing the cloud container by @mauwii in #1831
+- Fix docker push github action and expand with additional metadata by @ebr in
+  #1837
+- Fix Broken Link To Notebook by @VedantMadane in #1821
+- Account for flat models by @spezialspezial in #1766
+- Update invoke.bat.in isolate environment variables by @lynnewu in #1833
+- Arch Linux Specific PatchMatch Instructions & fixing conda install on linux by
+  @SammCheese in #1848
+- Make force free GPU memory work in img2img by @addianto in #1844
+- New installer by @lstein
+
+## v2.2.3 <small>(2 December 2022)</small>
+
+!!! Note
+
+    This point release removes references to the binary installer from the
+    installation guide. The binary installer is not stable at the current
+    time. First time users are encouraged to use the "source" installer as
+    described in [Installing InvokeAI with the Source Installer](installation/INSTALL_SOURCE.md)
+
+With InvokeAI 2.2, this project now provides enthusiasts and professionals a
+robust workflow solution for creating AI-generated and human facilitated
+compositions. Additional enhancements have been made as well, improving safety,
+ease of use, and installation.
+
+Optimized for efficiency, InvokeAI needs only ~3.5GB of VRAM to generate a
+512x768 image (and less for smaller images), and is compatible with
+Windows/Linux/Mac (M1 & M2).
+
+You can see the [release video](https://youtu.be/hIYBfDtKaus) here, which
+introduces the main WebUI enhancement for version 2.2 -
+[The Unified Canvas](features/UNIFIED_CANVAS.md). This new workflow is the
+biggest enhancement added to the WebUI to date, and unlocks a stunning amount of
+potential for users to create and iterate on their creations. The following
+sections describe what's new for InvokeAI.
+
+## v2.2.2 <small>(30 November 2022)</small>
+
+!!! note
+
+    The binary installer is not ready for prime time. First time users are recommended to install via the "source" installer accessible through the links at the bottom of this page.****
+
+With InvokeAI 2.2, this project now provides enthusiasts and professionals a
+robust workflow solution for creating AI-generated and human facilitated
+compositions. Additional enhancements have been made as well, improving safety,
+ease of use, and installation.
+
+Optimized for efficiency, InvokeAI needs only ~3.5GB of VRAM to generate a
+512x768 image (and less for smaller images), and is compatible with
+Windows/Linux/Mac (M1 & M2).
+
+You can see the [release video](https://youtu.be/hIYBfDtKaus) here, which
+introduces the main WebUI enhancement for version 2.2 -
+[The Unified Canvas](https://invoke-ai.github.io/InvokeAI/features/UNIFIED_CANVAS/).
+This new workflow is the biggest enhancement added to the WebUI to date, and
+unlocks a stunning amount of potential for users to create and iterate on their
+creations. The following sections describe what's new for InvokeAI.
+
+## v2.2.0 <small>(2 December 2022)</small>
+
+With InvokeAI 2.2, this project now provides enthusiasts and professionals a
+robust workflow solution for creating AI-generated and human facilitated
+compositions. Additional enhancements have been made as well, improving safety,
+ease of use, and installation.
+
+Optimized for efficiency, InvokeAI needs only ~3.5GB of VRAM to generate a
+512x768 image (and less for smaller images), and is compatible with
+Windows/Linux/Mac (M1 & M2).
+
+You can see the [release video](https://youtu.be/hIYBfDtKaus) here, which
+introduces the main WebUI enhancement for version 2.2 -
+[The Unified Canvas](features/UNIFIED_CANVAS.md). This new workflow is the
+biggest enhancement added to the WebUI to date, and unlocks a stunning amount of
+potential for users to create and iterate on their creations. The following
+sections describe what's new for InvokeAI.
+
+## v2.1.3 <small>(13 November 2022)</small>
+
+- A choice of installer scripts that automate installation and configuration.
+  See
+  [Installation](installation/index.md).
+- A streamlined manual installation process that works for both Conda and
+  PIP-only installs. See
+  [Manual Installation](installation/INSTALL_MANUAL.md).
+- The ability to save frequently-used startup options (model to load, steps,
+  sampler, etc) in a `.invokeai` file. See
+  [Client](features/CLI.md)
+- Support for AMD GPU cards (non-CUDA) on Linux machines.
+- Multiple bugs and edge cases squashed.
+
 ## v2.1.0 <small>(2 November 2022)</small>
 
-- update mac instructions to use invokeai for env name by @willwillems in
-  https://github.com/invoke-ai/InvokeAI/pull/1030
-- Update .gitignore by @blessedcoolant in
-  https://github.com/invoke-ai/InvokeAI/pull/1040
-- reintroduce fix for m1 from https://github.com/invoke-ai/InvokeAI/pull/579
-  missing after merge by @skurovec in
-  https://github.com/invoke-ai/InvokeAI/pull/1056
-- Update Stable_Diffusion_AI_Notebook.ipynb (Take 2) by @ChloeL19 in
-  https://github.com/invoke-ai/InvokeAI/pull/1060
-- Print out the device type which is used by @manzke in
-  https://github.com/invoke-ai/InvokeAI/pull/1073
-- Hires Addition by @hipsterusername in
-  https://github.com/invoke-ai/InvokeAI/pull/1063
+- update mac instructions to use invokeai for env name by @willwillems in #1030
+- Update .gitignore by @blessedcoolant in #1040
+- reintroduce fix for m1 from #579 missing after merge by @skurovec in #1056
+- Update Stable_Diffusion_AI_Notebook.ipynb (Take 2) by @ChloeL19 in #1060
+- Print out the device type which is used by @manzke in #1073
+- Hires Addition by @hipsterusername in #1063
 - fix for "1 leaked semaphore objects to clean up at shutdown" on M1 by
-  @skurovec in https://github.com/invoke-ai/InvokeAI/pull/1081
+  @skurovec in #1081
 - Forward dream.py to invoke.py using the same interpreter, add deprecation
-  warning by @db3000 in https://github.com/invoke-ai/InvokeAI/pull/1077
-- fix noisy images at high step counts by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1086
-- Generalize facetool strength argument by @db3000 in
-  https://github.com/invoke-ai/InvokeAI/pull/1078
+  warning by @db3000 in #1077
+- fix noisy images at high step counts by @lstein in #1086
+- Generalize facetool strength argument by @db3000 in #1078
 - Enable fast switching among models at the invoke> command line by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1066
-- Fix Typo, committed changing ldm environment to invokeai by @jdries3 in
-  https://github.com/invoke-ai/InvokeAI/pull/1095
-- Update generate.py by @unreleased in
-  https://github.com/invoke-ai/InvokeAI/pull/1109
-- Update 'ldm' env to 'invokeai' in troubleshooting steps by @19wolf in
-  https://github.com/invoke-ai/InvokeAI/pull/1125
-- Fixed documentation typos and resolved merge conflicts by @rupeshs in
-  https://github.com/invoke-ai/InvokeAI/pull/1123
-- Fix broken doc links, fix malaprop in the project subtitle by @majick in
-  https://github.com/invoke-ai/InvokeAI/pull/1131
-- Only output facetool parameters if enhancing faces by @db3000 in
-  https://github.com/invoke-ai/InvokeAI/pull/1119
+  #1066
+- Fix Typo, committed changing ldm environment to invokeai by @jdries3 in #1095
+- Update generate.py by @unreleased in #1109
+- Update 'ldm' env to 'invokeai' in troubleshooting steps by @19wolf in #1125
+- Fixed documentation typos and resolved merge conflicts by @rupeshs in #1123
+- Fix broken doc links, fix malaprop in the project subtitle by @majick in #1131
+- Only output facetool parameters if enhancing faces by @db3000 in #1119
 - Update gitignore to ignore codeformer weights at new location by
-  @spezialspezial in https://github.com/invoke-ai/InvokeAI/pull/1136
-- fix links to point to invoke-ai.github.io #1117 by @mauwii in
-  https://github.com/invoke-ai/InvokeAI/pull/1143
-- Rework-mkdocs by @mauwii in https://github.com/invoke-ai/InvokeAI/pull/1144
+  @spezialspezial in #1136
+- fix links to point to invoke-ai.github.io #1117 by @mauwii in #1143
+- Rework-mkdocs by @mauwii in #1144
 - add option to CLI and pngwriter that allows user to set PNG compression level
-  by @lstein in https://github.com/invoke-ai/InvokeAI/pull/1127
-- Fix img2img DDIM index out of bound by @wfng92 in
-  https://github.com/invoke-ai/InvokeAI/pull/1137
-- Fix gh actions by @mauwii in https://github.com/invoke-ai/InvokeAI/pull/1128
-- update mac instructions to use invokeai for env name by @willwillems in
-  https://github.com/invoke-ai/InvokeAI/pull/1030
-- Update .gitignore by @blessedcoolant in
-  https://github.com/invoke-ai/InvokeAI/pull/1040
-- reintroduce fix for m1 from https://github.com/invoke-ai/InvokeAI/pull/579
-  missing after merge by @skurovec in
-  https://github.com/invoke-ai/InvokeAI/pull/1056
-- Update Stable_Diffusion_AI_Notebook.ipynb (Take 2) by @ChloeL19 in
-  https://github.com/invoke-ai/InvokeAI/pull/1060
-- Print out the device type which is used by @manzke in
-  https://github.com/invoke-ai/InvokeAI/pull/1073
-- Hires Addition by @hipsterusername in
-  https://github.com/invoke-ai/InvokeAI/pull/1063
+  by @lstein in #1127
+- Fix img2img DDIM index out of bound by @wfng92 in #1137
+- Fix gh actions by @mauwii in #1128
+- update mac instructions to use invokeai for env name by @willwillems in #1030
+- Update .gitignore by @blessedcoolant in #1040
+- reintroduce fix for m1 from #579 missing after merge by @skurovec in #1056
+- Update Stable_Diffusion_AI_Notebook.ipynb (Take 2) by @ChloeL19 in #1060
+- Print out the device type which is used by @manzke in #1073
+- Hires Addition by @hipsterusername in #1063
 - fix for "1 leaked semaphore objects to clean up at shutdown" on M1 by
-  @skurovec in https://github.com/invoke-ai/InvokeAI/pull/1081
+  @skurovec in #1081
 - Forward dream.py to invoke.py using the same interpreter, add deprecation
-  warning by @db3000 in https://github.com/invoke-ai/InvokeAI/pull/1077
-- fix noisy images at high step counts by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1086
-- Generalize facetool strength argument by @db3000 in
-  https://github.com/invoke-ai/InvokeAI/pull/1078
+  warning by @db3000 in #1077
+- fix noisy images at high step counts by @lstein in #1086
+- Generalize facetool strength argument by @db3000 in #1078
 - Enable fast switching among models at the invoke> command line by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1066
-- Fix Typo, committed changing ldm environment to invokeai by @jdries3 in
-  https://github.com/invoke-ai/InvokeAI/pull/1095
-- Fixed documentation typos and resolved merge conflicts by @rupeshs in
-  https://github.com/invoke-ai/InvokeAI/pull/1123
-- Only output facetool parameters if enhancing faces by @db3000 in
-  https://github.com/invoke-ai/InvokeAI/pull/1119
+  #1066
+- Fix Typo, committed changing ldm environment to invokeai by @jdries3 in #1095
+- Fixed documentation typos and resolved merge conflicts by @rupeshs in #1123
+- Only output facetool parameters if enhancing faces by @db3000 in #1119
 - add option to CLI and pngwriter that allows user to set PNG compression level
-  by @lstein in https://github.com/invoke-ai/InvokeAI/pull/1127
-- Fix img2img DDIM index out of bound by @wfng92 in
-  https://github.com/invoke-ai/InvokeAI/pull/1137
-- Add text prompt to inpaint mask support by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1133
+  by @lstein in #1127
+- Fix img2img DDIM index out of bound by @wfng92 in #1137
+- Add text prompt to inpaint mask support by @lstein in #1133
 - Respect http[s] protocol when making socket.io middleware by @damian0815 in
-  https://github.com/invoke-ai/InvokeAI/pull/976
-- WebUI: Adds Codeformer support by @psychedelicious in
-  https://github.com/invoke-ai/InvokeAI/pull/1151
-- Skips normalizing prompts for web UI metadata by @psychedelicious in
-  https://github.com/invoke-ai/InvokeAI/pull/1165
-- Add Asymmetric Tiling by @carson-katri in
-  https://github.com/invoke-ai/InvokeAI/pull/1132
-- Web UI: Increases max CFG Scale to 200 by @psychedelicious in
-  https://github.com/invoke-ai/InvokeAI/pull/1172
+  #976
+- WebUI: Adds Codeformer support by @psychedelicious in #1151
+- Skips normalizing prompts for web UI metadata by @psychedelicious in #1165
+- Add Asymmetric Tiling by @carson-katri in #1132
+- Web UI: Increases max CFG Scale to 200 by @psychedelicious in #1172
 - Corrects color channels in face restoration; Fixes #1167 by @psychedelicious
-  in https://github.com/invoke-ai/InvokeAI/pull/1175
+  in #1175
 - Flips channels using array slicing instead of using OpenCV by @psychedelicious
-  in https://github.com/invoke-ai/InvokeAI/pull/1178
-- Fix typo in docs: s/Formally/Formerly by @noodlebox in
-  https://github.com/invoke-ai/InvokeAI/pull/1176
-- fix clipseg loading problems by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1177
-- Correct color channels in upscale using array slicing by @wfng92 in
-  https://github.com/invoke-ai/InvokeAI/pull/1181
+  in #1178
+- Fix typo in docs: s/Formally/Formerly by @noodlebox in #1176
+- fix clipseg loading problems by @lstein in #1177
+- Correct color channels in upscale using array slicing by @wfng92 in #1181
 - Web UI: Filters existing images when adding new images; Fixes #1085 by
-  @psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/1171
-- fix a number of bugs in textual inversion by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1190
-- Improve !fetch, add !replay command by @ArDiouscuros in
-  https://github.com/invoke-ai/InvokeAI/pull/882
-- Fix generation of image with s>1000 by @holstvoogd in
-  https://github.com/invoke-ai/InvokeAI/pull/951
-- Web UI: Gallery improvements by @psychedelicious in
-  https://github.com/invoke-ai/InvokeAI/pull/1198
-- Update CLI.md by @krummrey in https://github.com/invoke-ai/InvokeAI/pull/1211
-- outcropping improvements by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1207
-- add support for loading VAE autoencoders by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1216
-- remove duplicate fix_func for MPS by @wfng92 in
-  https://github.com/invoke-ai/InvokeAI/pull/1210
-- Metadata storage and retrieval fixes by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1204
-- nix: add shell.nix file by @Cloudef in
-  https://github.com/invoke-ai/InvokeAI/pull/1170
-- Web UI: Changes vite dist asset paths to relative by @psychedelicious in
-  https://github.com/invoke-ai/InvokeAI/pull/1185
-- Web UI: Removes isDisabled from PromptInput by @psychedelicious in
-  https://github.com/invoke-ai/InvokeAI/pull/1187
+  @psychedelicious in #1171
+- fix a number of bugs in textual inversion by @lstein in #1190
+- Improve !fetch, add !replay command by @ArDiouscuros in #882
+- Fix generation of image with s>1000 by @holstvoogd in #951
+- Web UI: Gallery improvements by @psychedelicious in #1198
+- Update CLI.md by @krummrey in #1211
+- outcropping improvements by @lstein in #1207
+- add support for loading VAE autoencoders by @lstein in #1216
+- remove duplicate fix_func for MPS by @wfng92 in #1210
+- Metadata storage and retrieval fixes by @lstein in #1204
+- nix: add shell.nix file by @Cloudef in #1170
+- Web UI: Changes vite dist asset paths to relative by @psychedelicious in #1185
+- Web UI: Removes isDisabled from PromptInput by @psychedelicious in #1187
 - Allow user to generate images with initial noise as on M1 / mps system by
-  @ArDiouscuros in https://github.com/invoke-ai/InvokeAI/pull/981
-- feat: adding filename format template by @plucked in
-  https://github.com/invoke-ai/InvokeAI/pull/968
-- Web UI: Fixes broken bundle by @psychedelicious in
-  https://github.com/invoke-ai/InvokeAI/pull/1242
-- Support runwayML custom inpainting model by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1243
-- Update IMG2IMG.md by @talitore in
-  https://github.com/invoke-ai/InvokeAI/pull/1262
+  @ArDiouscuros in #981
+- feat: adding filename format template by @plucked in #968
+- Web UI: Fixes broken bundle by @psychedelicious in #1242
+- Support runwayML custom inpainting model by @lstein in #1243
+- Update IMG2IMG.md by @talitore in #1262
 - New dockerfile - including a build- and a run- script as well as a GH-Action
-  by @mauwii in https://github.com/invoke-ai/InvokeAI/pull/1233
+  by @mauwii in #1233
 - cut over from karras to model noise schedule for higher steps by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1222
-- Prompt tweaks by @lstein in https://github.com/invoke-ai/InvokeAI/pull/1268
-- Outpainting implementation by @Kyle0654 in
-  https://github.com/invoke-ai/InvokeAI/pull/1251
-- fixing aspect ratio on hires by @tjennings in
-  https://github.com/invoke-ai/InvokeAI/pull/1249
-- Fix-build-container-action by @mauwii in
-  https://github.com/invoke-ai/InvokeAI/pull/1274
-- handle all unicode characters by @damian0815 in
-  https://github.com/invoke-ai/InvokeAI/pull/1276
-- adds models.user.yml to .gitignore by @JakeHL in
-  https://github.com/invoke-ai/InvokeAI/pull/1281
-- remove debug branch, set fail-fast to false by @mauwii in
-  https://github.com/invoke-ai/InvokeAI/pull/1284
-- Protect-secrets-on-pr by @mauwii in
-  https://github.com/invoke-ai/InvokeAI/pull/1285
-- Web UI: Adds initial inpainting implementation by @psychedelicious in
-  https://github.com/invoke-ai/InvokeAI/pull/1225
-- fix environment-mac.yml - tested on x64 and arm64 by @mauwii in
-  https://github.com/invoke-ai/InvokeAI/pull/1289
-- Use proper authentication to download model by @mauwii in
-  https://github.com/invoke-ai/InvokeAI/pull/1287
-- Prevent indexing error for mode RGB by @spezialspezial in
-  https://github.com/invoke-ai/InvokeAI/pull/1294
+  #1222
+- Prompt tweaks by @lstein in #1268
+- Outpainting implementation by @Kyle0654 in #1251
+- fixing aspect ratio on hires by @tjennings in #1249
+- Fix-build-container-action by @mauwii in #1274
+- handle all unicode characters by @damian0815 in #1276
+- adds models.user.yml to .gitignore by @JakeHL in #1281
+- remove debug branch, set fail-fast to false by @mauwii in #1284
+- Protect-secrets-on-pr by @mauwii in #1285
+- Web UI: Adds initial inpainting implementation by @psychedelicious in #1225
+- fix environment-mac.yml - tested on x64 and arm64 by @mauwii in #1289
+- Use proper authentication to download model by @mauwii in #1287
+- Prevent indexing error for mode RGB by @spezialspezial in #1294
 - Integrate sd-v1-5 model into test matrix (easily expandable), remove
-  unecesarry caches by @mauwii in
-  https://github.com/invoke-ai/InvokeAI/pull/1293
-- add --no-interactive to preload_models step by @mauwii in
-  https://github.com/invoke-ai/InvokeAI/pull/1302
+  unecesarry caches by @mauwii in #1293
+- add --no-interactive to configure_invokeai step by @mauwii in #1302
 - 1-click installer and updater. Uses micromamba to install git and conda into a
   contained environment (if necessary) before running the normal installation
-  script by @cmdr2 in https://github.com/invoke-ai/InvokeAI/pull/1253
-- preload_models.py script downloads the weight files by @lstein in
-  https://github.com/invoke-ai/InvokeAI/pull/1290
+  script by @cmdr2 in #1253
+- configure_invokeai.py script downloads the weight files by @lstein in #1290
 
 ## v2.0.1 <small>(13 October 2022)</small>
 

docs/features/CLI.md

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

docs/features/CONCEPTS.md

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

docs/features/IMG2IMG.md

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

docs/features/INPAINTING.md

@@ -158,7 +158,7 @@ when filling in missing regions. It has an almost uncanny ability to blend the
 new regions with existing ones in a semantically coherent way.
 
 To install the inpainting model, follow the
-[instructions](../installation/INSTALLING_MODELS.md) for installing a new model.
+[instructions](../installation/050_INSTALLING_MODELS.md) for installing a new model.
 You may use either the CLI (`invoke.py` script) or directly edit the
 `configs/models.yaml` configuration file to do this. The main thing to watch out
 for is that the the model `config` option must be set up to use

docs/features/OUTPAINTING.md

@@ -120,7 +120,7 @@ A number of caveats:
    (`--iterations`) argument.
 
 3. Your results will be _much_ better if you use the `inpaint-1.5` model
-   released by runwayML and installed by default by `scripts/preload_models.py`.
+   released by runwayML and installed by default by `scripts/configure_invokeai.py`.
    This model was trained specifically to harmoniously fill in image gaps. The
    standard model will work as well, but you may notice color discontinuities at
    the border.

docs/features/POSTPROCESS.md

@@ -28,21 +28,17 @@ should "just work" without further intervention. Simply pass the `--upscale`
 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
+loaded when you run `scripts/configure_invokeai.py`. If GFPAN is failing with an
 error, please run the following from the InvokeAI directory:
 
 ```bash
-python scripts/preload_models.py
+python scripts/configure_invokeai.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.
 
-## Usage
-
-You will now have access to two new prompt arguments.
-
 ### Upscaling
 
 `-U : <upscaling_factor> <upscaling_strength>`
@@ -110,7 +106,7 @@ 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
+GFPGAN. You can do this either by running `configure_invokeai.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.
@@ -119,7 +115,7 @@ You can use `-ft` prompt argument to swap between CodeFormer and the default
 GFPGAN. The above mentioned `-G` prompt argument will allow you to control the
 strength of the restoration effect.
 
-### Usage
+### CodeFormer Usage
 
 The following command will perform face restoration with CodeFormer instead of
 the default gfpgan.
@@ -160,7 +156,7 @@ A new file named `000044.2945021133.fixed.png` will be created in the output
 directory. Note that the `!fix` command does not replace the original file,
 unlike the behavior at generate time.
 
-### Disabling
+## How to disable
 
 If, for some reason, you do not wish to load the GFPGAN and/or ESRGAN libraries,
 you can disable them on the invoke.py command line with the `--no_restore` and

docs/features/PROMPTS.md

@@ -20,16 +20,55 @@ would type at the invoke> prompt:
 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"
+python scripts/invoke.py --from_file "/path/to/prompts.txt"
 ```
 
-You may read a series of prompts from standard input by providing a filename of
-`-`:
+You may also read a series of prompts from standard input by providing
+a filename of `-`. For example, here is a python script that creates a
+matrix of prompts, each one varying slightly:
 
 ```bash
-(invokeai) ~/stable-diffusion$ echo "a beautiful day" | python3 scripts/invoke.py --from_file -
+#!/usr/bin/env python
+
+adjectives = ['sunny','rainy','overcast']
+samplers = ['k_lms','k_euler_a','k_heun']
+cfg = [7.5, 9, 11]
+
+for adj in adjectives:
+    for samp in samplers:
+        for cg in cfg:
+            print(f'a {adj} day -A{samp} -C{cg}')
 ```
 
+It's output looks like this (abbreviated):
+
+```bash
+a sunny day -Aklms -C7.5
+a sunny day -Aklms -C9
+a sunny day -Aklms -C11
+a sunny day -Ak_euler_a -C7.5
+a sunny day -Ak_euler_a -C9
+...
+a overcast day -Ak_heun -C9
+a overcast day -Ak_heun -C11
+```
+
+To feed it to invoke.py, pass the filename of "-"
+
+```bash
+python matrix.py | python scripts/invoke.py --from_file -
+```
+
+When the script is finished, each of the 27 combinations
+of adjective, sampler and CFG will be executed.
+
+The command-line interface provides `!fetch` and `!replay` commands
+which allow you to read the prompts from a single previously-generated
+image or a whole directory of them, write the prompts to a file, and
+then replay them. Or you can create your own file of prompts and feed
+them to the command-line client from within an interactive session.
+See [Command-Line Interface](CLI.md) for details.
+
 ---
 
 ## **Negative and Unconditioned Prompts**
@@ -51,7 +90,9 @@ original prompt:
 `#!bash "A fantastical translucent pony 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
@@ -61,7 +102,9 @@ 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
@@ -70,7 +113,9 @@ 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
@@ -79,7 +124,9 @@ 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:"
@@ -124,8 +171,12 @@ this prompt of `a man picking apricots from a tree`, let's see what happens if
 we increase and decrease how much attention we want Stable Diffusion to pay to
 the word `apricots`:
 
+<figure markdown>
+
 ![an AI generated image of a man picking apricots from a tree](../assets/prompt_syntax/apricots-0.png)
 
+</figure>
+
 Using `-` to reduce apricot-ness:
 
 | `a man picking apricots- from a tree`                                                                                          | `a man picking apricots-- from a tree`                                                                                                        | `a man picking apricots--- from a tree`                                                                                                    |
@@ -141,8 +192,12 @@ Using `+` to increase apricot-ness:
 You can also change the balance between different parts of a prompt. For
 example, below is a `mountain man`:
 
+<figure markdown>
+
 ![an AI generated image of a mountain man](../assets/prompt_syntax/mountain-man.png)
 
+</figure>
+
 And here he is with more mountain:
 
 | `mountain+ man`                                | `mountain++ man`                               | `mountain+++ man`                              |
@@ -259,14 +314,18 @@ 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
@@ -274,6 +333,7 @@ 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)
@@ -286,6 +346,7 @@ 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)
@@ -296,6 +357,7 @@ 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)
@@ -306,6 +368,7 @@ 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)

docs/features/UNIFIED_CANVAS.md

@@ -1,117 +1,284 @@
-The Unified Canvas is a tool designed to streamline and simplify the process of composing an image using Stable Diffusion. It offers artists all of the available Stable Diffusion generation modes (Text To Image, Image To Image, Inpainting, and Outpainting) as a single unified workflow. The flexibility of the tool allows you to tweak and edit image generations, extend images beyond their initial size, and to create new content in a freeform way both inside and outside of existing images. 
+---
+title: Unified Canvas
+---
 
-This document explains the basics of using the Unified Canvas, introducing you to its features and tools one by one. It also describes some of the more advanced tools available to power users of the Canvas.
+The Unified Canvas is a tool designed to streamline and simplify the process of
+composing an image using Stable Diffusion. It offers artists all of the
+available Stable Diffusion generation modes (Text To Image, Image To Image,
+Inpainting, and Outpainting) as a single unified workflow. The flexibility of
+the tool allows you to tweak and edit image generations, extend images beyond
+their initial size, and to create new content in a freeform way both inside and
+outside of existing images.
 
-# Basics
-The Unified Canvas consists of two layers: the **Base Layer** and the **Mask Layer**. You can swap from one layer to the other by selecting the layer you want in the drop-down menu on the top left corner of the Unified Canvas, or by pressing the (Q) hotkey.
+This document explains the basics of using the Unified Canvas, introducing you
+to its features and tools one by one. It also describes some of the more
+advanced tools available to power users of the Canvas.
+
+## Basics
+
+The Unified Canvas consists of two layers: the **Base Layer** and the **Mask
+Layer**. You can swap from one layer to the other by selecting the layer you
+want in the drop-down menu on the top left corner of the Unified Canvas, or by
+pressing the (Q) hotkey.
 
 ### Base Layer
-The **Base Layer** is the image content currently managed by the Canvas, and can be exported at any time to the gallery by using the **Save to Gallery** option. When the Base Layer is selected, the Brush (B) and Eraser (E) tools will directly manipulate the base layer. Any images uploaded to the Canvas, or sent to the Unified Canvas from the gallery, will clear out all existing content and set the Base layer to the new image.
+
+The **Base Layer** is the image content currently managed by the Canvas, and can
+be exported at any time to the gallery by using the **Save to Gallery** option.
+When the Base Layer is selected, the Brush (B) and Eraser (E) tools will
+directly manipulate the base layer. Any images uploaded to the Canvas, or sent
+to the Unified Canvas from the gallery, will clear out all existing content and
+set the Base layer to the new image.
 
 ### Staging Area
-When you generate images, they will display in the Canvas's **Staging Area**, alongside the Staging Area toolbar buttons. While the Staging Area is active, you cannot interact with the Canvas itself.
+
+When you generate images, they will display in the Canvas's **Staging Area**,
+alongside the Staging Area toolbar buttons. While the Staging Area is active,
+you cannot interact with the Canvas itself.
 
 <figure markdown>
+
 ![staging area](../assets/canvas/staging_area.png)
+
 </figure>
 
-Accepting generations will commit the new generation to the **Base Layer**. You can review all generated images using the Prev/Next arrows, save any individual generations to your gallery (without committing to the Base layer) or discard generations. While you can Undo a discard in an individual Canvas session, any generations that are not saved will be lost when the Canvas resets.
+Accepting generations will commit the new generation to the **Base Layer**. You
+can review all generated images using the Prev/Next arrows, save any individual
+generations to your gallery (without committing to the Base layer) or discard
+generations. While you can Undo a discard in an individual Canvas session, any
+generations that are not saved will be lost when the Canvas resets.
 
 ### Mask Layer
-The **Mask Layer** consists of any masked sections that have been created to inform Inpainting generations. You can paint a new mask, or edit an existing mask, using the Brush tool and the Eraser with the Mask layer set as your Active layer. Any masked areas will only affect generation inside of the current bounding box.
+
+The **Mask Layer** consists of any masked sections that have been created to
+inform Inpainting generations. You can paint a new mask, or edit an existing
+mask, using the Brush tool and the Eraser with the Mask layer set as your Active
+layer. Any masked areas will only affect generation inside of the current
+bounding box.
 
 ### Bounding Box
-When generating a new image, Invoke will process and apply new images within the area denoted by the **Bounding Box**. The Width & Height settings of the Bounding Box, as well as its location within the Unified Canvas and pixels or empty space that it encloses, determine how new invocations are generated - see [Inpainting & Outpainting](#inpainting-and-outpainting) below. The Bounding Box can be moved and resized using the Move (V) tool. It can also be resized using the Bounding Box options in the Options Panel. By using these controls you can generate larger or smaller images, control which sections of the image are being processed, as well as control Bounding Box tools like the Bounding Box fill/erase. 
+
+When generating a new image, Invoke will process and apply new images within the
+area denoted by the **Bounding Box**. The Width & Height settings of the
+Bounding Box, as well as its location within the Unified Canvas and pixels or
+empty space that it encloses, determine how new invocations are generated - see
+[Inpainting & Outpainting](#inpainting-and-outpainting) below. The Bounding Box
+can be moved and resized using the Move (V) tool. It can also be resized using
+the Bounding Box options in the Options Panel. By using these controls you can
+generate larger or smaller images, control which sections of the image are being
+processed, as well as control Bounding Box tools like the Bounding Box
+fill/erase.
 
 ### <a name="inpainting-and-outpainting"></a> Inpainting & Outpainting
-"Inpainting" means asking the AI to refine part of an image while leaving the rest alone. For example, updating a portrait of your grandmother to have her wear a biker's jacket.
+
+"Inpainting" means asking the AI to refine part of an image while leaving the
+rest alone. For example, updating a portrait of your grandmother to have her
+wear a biker's jacket.
+
+|                         masked original                         |                                       inpaint result                                       |
+| :-------------------------------------------------------------: | :----------------------------------------------------------------------------------------: |
+| ![granny with a mask applied](../assets/canvas/mask_granny.png) | ![just like magic, granny with a biker's jacket](../assets/canvas/biker_jacket_granny.png) |
+
+"Outpainting" means asking the AI to expand the original image beyond its
+original borders, making a bigger image that's still based on the original. For
+example, extending the above image of your Grandmother in a biker's jacket to
+include her wearing jeans (and while we're at it, a motorcycle!)
 
 <figure markdown>
-![granny with a mask applied](../assets/canvas/mask_granny.png)
+
+![more magic - granny with a tattooed arm, denim pants, and an obscured motorcycle](../assets/canvas/biker_granny.png)
+
 </figure>
 
-<figure markdown>
-![just like magic, granny with a biker's jacket](../assets/canvas/biker_jacket_granny.png)
-</figure>
+When you are using the Unified Canvas, Invoke decides automatically whether to
+do Inpainting, Outpainting, ImageToImage, or TextToImage by looking inside the
+area enclosed by the Bounding Box. It chooses the appropriate type of generation
+based on whether the Bounding Box contains empty (transparent) areas on the Base
+layer, or whether it contains colored areas from previous generations (or from
+painted brushstrokes) on the Base layer, and/or whether the Mask layer contains
+any brushstrokes. See [Generation Methods](#generation-methods) below for more
+information.
 
-"Outpainting" means asking the AI to expand the original image beyond its original borders, making a bigger image that's still based on the original. For example, extending the above image of your Grandmother in a biker's jacket to include her wearing jeans (and while we're at it, a motorcycle!)
+## Getting Started
 
-<figure markdown>
-![more magic - granny with a tattooed arm, denim pants, and an obscured motorcycle](../assets/canvas/biker_jacket_granny.png)
-</figure>
-
-When you are using the Unified Canvas, Invoke decides automatically whether to do Inpainting, Outpainting, ImageToImage, or TextToImage by looking inside the area enclosed by the Bounding Box. It chooses the appropriate type of generation based on whether the Bounding Box contains empty (transparent) areas on the Base layer, or whether it contains colored areas from previous generations (or from painted brushstrokes) on the Base layer, and/or whether the Mask layer contains any brushstrokes. See [Generation Methods](#generation-methods) below for more information.
-
-# Getting Started
-
-To get started with the Unified Canvas, you will want to generate a new base layer using Txt2Img or importing an initial image. We'll refer to either of these methods as the "initial image" in the below guide.
+To get started with the Unified Canvas, you will want to generate a new base
+layer using Txt2Img or importing an initial image. We'll refer to either of
+these methods as the "initial image" in the below guide.
 
 From there, you can consider the following techniques to augment your image:
-* **New Images**: Move the bounding box to an empty area of the Canvas, type in your prompt, and Invoke, to generate a new image using the Text to Image function.
-* **Image Correction**: Use the color picker and brush tool to paint corrections on the image, switch to the Mask layer, and brush a mask over your painted area to use **Inpainting**. You can also use the **ImageToImage** generation method to invoke new interpretations of the image. 
-* **Image Expansion**: Move the bounding box to include a portion of your initial image, and a portion of transparent/empty pixels, then Invoke using a prompt that describes what you'd like to see in that area. This will Outpaint the image. You'll typically find more coherent results if you keep about 50-60% of the original image in the bounding box. Make sure that the Image To Image Strength slider is set to a high value - you may need to set it higher than you are used to.
-* **New Content on Existing Images**: If you want to add new details or objects into your image, use the brush tool to paint a sketch of what you'd like to see on the image, switch to the Mask layer, and brush a mask over your painted area to use **Inpainting**. If the masked area is small, consider using a smaller bounding box to take advantage of Invoke's automatic Scaling features, which can help to produce better details. 
-* **And more**: There are a number of creative ways to use the Canvas, and the above are just starting points. We're excited to see what you come up with!
 
+- **New Images**: Move the bounding box to an empty area of the Canvas, type in
+  your prompt, and Invoke, to generate a new image using the Text to Image
+  function.
+- **Image Correction**: Use the color picker and brush tool to paint corrections
+  on the image, switch to the Mask layer, and brush a mask over your painted
+  area to use **Inpainting**. You can also use the **ImageToImage** generation
+  method to invoke new interpretations of the image.
+- **Image Expansion**: Move the bounding box to include a portion of your
+  initial image, and a portion of transparent/empty pixels, then Invoke using a
+  prompt that describes what you'd like to see in that area. This will Outpaint
+  the image. You'll typically find more coherent results if you keep about
+  50-60% of the original image in the bounding box. Make sure that the Image To
+  Image Strength slider is set to a high value - you may need to set it higher
+  than you are used to.
+- **New Content on Existing Images**: If you want to add new details or objects
+  into your image, use the brush tool to paint a sketch of what you'd like to
+  see on the image, switch to the Mask layer, and brush a mask over your painted
+  area to use **Inpainting**. If the masked area is small, consider using a
+  smaller bounding box to take advantage of Invoke's automatic Scaling features,
+  which can help to produce better details.
+- **And more**: There are a number of creative ways to use the Canvas, and the
+  above are just starting points. We're excited to see what you come up with!
 
-# <a name="generation-methods"></a> Generation Methods
-The Canvas can use all generation methods available (Txt2Img, Img2Img, Inpainting, and Outpainting), and these will be automatically selected and used based on the current selection area within the Bounding Box.
+## <a name="generation-methods"></a> Generation Methods
 
-## Text to Image
-If the Bounding Box is placed over an area of Canvas with an **empty Base Layer**, invoking a new image will use **TextToImage**. This generates an entirely new image based on your prompt.
+The Canvas can use all generation methods available (Txt2Img, Img2Img,
+Inpainting, and Outpainting), and these will be automatically selected and used
+based on the current selection area within the Bounding Box.
 
-## Image to Image
-If the Bounding Box is placed over an area of Canvas with an **existing Base Layer area with no transparent pixels or masks**, invoking a new image will use **ImageToImage**. This uses the image within the bounding box and your prompt to interpret a new image. The image will be closer to your original image at lower Image to Image strengths.
+### Text to Image
 
-## Inpainting
-If the Bounding Box is placed over an area of Canvas with an **existing Base Layer and any pixels selected using the Mask layer**, invoking a new image will use **Inpainting**. Inpainting uses the existing colors/forms in the masked area in order to generate a new image for the masked area only. The unmasked portion of the image will remain the same. Image to Image strength applies to the inpainted area.
+If the Bounding Box is placed over an area of Canvas with an **empty Base
+Layer**, invoking a new image will use **TextToImage**. This generates an
+entirely new image based on your prompt.
 
-If you desire something completely different from the original image in your new generation (i.e., if you want Invoke to ignore existing colors/forms), consider toggling the Inpaint Replace setting on, and use high values for both Inpaint Replace and Image To Image Strength.
+### Image to Image
 
-> Note: By default, the **Scale Before Processing** option &mdash; which inpaints more coherent details by generating at a larger resolution and then scaling &mdash; is only activated when the Bounding Box is relatively small. To get the best inpainting results you should therefore resize your Bounding Box to the smallest area that contains your mask and enough surrounding detail to help Stable Diffusion understand the context of what you want it to draw. You should also update your prompt so that it describes *just* the area within the Bounding Box.
+If the Bounding Box is placed over an area of Canvas with an **existing Base
+Layer area with no transparent pixels or masks**, invoking a new image will use
+**ImageToImage**. This uses the image within the bounding box and your prompt to
+interpret a new image. The image will be closer to your original image at lower
+Image to Image strengths.
 
-## Outpainting
-If the Bounding Box is placed over an area of Canvas partially filled by an existing Base Layer area and partially by transparent pixels or masks, invoking a new image will use **Outpainting**, as well as **Inpainting** any masked areas.
+### Inpainting
 
-____
+If the Bounding Box is placed over an area of Canvas with an **existing Base
+Layer and any pixels selected using the Mask layer**, invoking a new image will
+use **Inpainting**. Inpainting uses the existing colors/forms in the masked area
+in order to generate a new image for the masked area only. The unmasked portion
+of the image will remain the same. Image to Image strength applies to the
+inpainted area.
 
-# Advanced Features
+If you desire something completely different from the original image in your new
+generation (i.e., if you want Invoke to ignore existing colors/forms), consider
+toggling the Inpaint Replace setting on, and use high values for both Inpaint
+Replace and Image To Image Strength.
 
-Features with non-obvious behavior are detailed below, in order to provide clarity on the intent and common use cases we expect for utilizing them.
+!!! note
 
-## Toolbar
+    By default, the **Scale Before Processing** option &mdash; which
+    inpaints more coherent details by generating at a larger resolution and then
+    scaling &mdash; is only activated when the Bounding Box is relatively small.
+    To get the best inpainting results you should therefore resize your Bounding
+    Box to the smallest area that contains your mask and enough surrounding detail
+    to help Stable Diffusion understand the context of what you want it to draw.
+    You should also update your prompt so that it describes _just_ the area within
+    the Bounding Box.
 
-### Mask Options
-* **Enable Mask** - This flag can be used to Enable or Disable the currently painted mask. If you have painted a mask, but you don't want it affect the next invocation, but you *also* don't want to delete it, then you can set this option to Disable. When you want the mask back, set this back to Enable. 
-* **Preserve Masked Area** - When enabled, Preserve Masked Area inverts the effect of the Mask on the Inpainting process. Pixels in masked areas will be kept unchanged, and unmasked areas will be regenerated.
+### Outpainting
 
-### Creative Tools
-* **Brush - Base/Mask Modes** - The Brush tool switches automatically between different modes of operation for the Base and Mask layers respectively. 
-  * On the Base layer, the brush will directly paint on the Canvas using the color selected on the Brush Options menu. 
-  * On the Mask layer, the brush will create a new mask. If you're finding the mask difficult to see over the existing content of the Unified Canvas, you can change the color it is drawn with using the color selector on the Mask Options dropdown.
-* **Erase Bounding Box** - On the Base layer, erases all pixels within the Bounding Box.
-* **Fill Bounding Box** - On the Base layer, fills all pixels within the Bounding Box with the currently selected color.
+If the Bounding Box is placed over an area of Canvas partially filled by an
+existing Base Layer area and partially by transparent pixels or masks, invoking
+a new image will use **Outpainting**, as well as **Inpainting** any masked
+areas.
 
-### Canvas Tools
-* **Move Tool** - Allows for manipulation of the Canvas view (by dragging on the Canvas, outside the bounding box), the Bounding Box (by dragging the edges of the box), or the Width/Height of the Bounding Box (by dragging one of the 9 directional handles).
-* **Reset View** - Click to re-orients the view to the center of the Bounding Box. 
-* **Merge Visible** - If your browser is having performance problems drawing the image in the Unified Canvas, click this to consolidate all of the information currently being rendered by your browser into a merged copy of the image. This lowers the resource requirements and should improve performance.
+---
 
-## Seam Correction
-When doing Inpainting or Outpainting, Invoke needs to merge the pixels generated by Stable Diffusion into your existing image. To do this, the area around the `seam` at the boundary between your image and the new generation is automatically blended to produce a seamless output. In a fully automatic process, a mask is generated to cover the seam, and then the area of the seam is Inpainted. 
+## Advanced Features
 
-Although the default options should work well most of the time, sometimes it can help to alter the parameters that control the seam Inpainting. A wider seam and a blur setting of about 1/3 of the seam have been noted as producing consistently strong results (e.g. 96 wide and 16 blur - adds up to 32 blur with both sides). Seam strength of 0.7 is best for reducing hard seams.
-* **Seam Size** - The size of the seam masked area. Set higher to make a larger mask around the seam.
-* **Seam Blur** - The size of the blur that is applied on *each* side of the masked area. 
-* **Seam Strength** - The Image To Image Strength parameter used for the Inpainting generation that is applied to the seam area.
-* **Seam Steps** - The number of generation steps that should be used to Inpaint the seam.
+Features with non-obvious behavior are detailed below, in order to provide
+clarity on the intent and common use cases we expect for utilizing them.
 
-## Infill & Scaling
-* **Scale Before Processing & W/H**: When generating images with a bounding box smaller than the optimized W/H of the model (e.g., 512x512 for SD1.5), this feature first generates at a larger size with the same aspect ratio, and then scales that image down to fill the selected area. This is particularly useful when inpainting very small details. Scaling is optional but is enabled by default.
-* **Inpaint Replace**: When Inpainting, the default method is to utilize the existing RGB values of the Base layer to inform the generation process. If Inpaint Replace is enabled, noise is generated and blended with the existing pixels (completely replacing the original RGB values at an Inpaint Replace value of 1). This can help generate more variation from the pixels on the Base layers.
-  * > When using Inpaint Replace you should use a higher Image To Image Strength value, especially at higher Inpaint Replace values
-* **Infill Method**: Invoke currently supports two methods for producing RGB values for use in the Outpainting process: Patchmatch and Tile. We believe that Patchmatch is the superior method, however we provide support for Tile in case Patchmatch cannot be installed or is unavailable on your computer.
-  * **Tile Size**: The Tile method for Outpainting sources small portions of the original image and randomly place these into the areas being Outpainted. This value sets the size of those tiles.
+### Toolbar
 
-# Hot Keys
-The Unified Canvas is a tool that excels when you use hotkeys. You can view the full list of keyboard shortcuts, updated with all new features, by clicking the Keyboard Shortcuts icon at the top right of the InvokeAI WebUI.
+#### Mask Options
+
+- **Enable Mask** - This flag can be used to Enable or Disable the currently
+  painted mask. If you have painted a mask, but you don't want it affect the
+  next invocation, but you _also_ don't want to delete it, then you can set this
+  option to Disable. When you want the mask back, set this back to Enable.
+- **Preserve Masked Area** - When enabled, Preserve Masked Area inverts the
+  effect of the Mask on the Inpainting process. Pixels in masked areas will be
+  kept unchanged, and unmasked areas will be regenerated.
+
+#### Creative Tools
+
+- **Brush - Base/Mask Modes** - The Brush tool switches automatically between
+  different modes of operation for the Base and Mask layers respectively.
+    - On the Base layer, the brush will directly paint on the Canvas using the
+      color selected on the Brush Options menu.
+    - On the Mask layer, the brush will create a new mask. If you're finding the
+      mask difficult to see over the existing content of the Unified Canvas, you
+      can change the color it is drawn with using the color selector on the Mask
+      Options dropdown.
+- **Erase Bounding Box** - On the Base layer, erases all pixels within the
+  Bounding Box.
+- **Fill Bounding Box** - On the Base layer, fills all pixels within the
+  Bounding Box with the currently selected color.
+
+#### Canvas Tools
+
+- **Move Tool** - Allows for manipulation of the Canvas view (by dragging on the
+  Canvas, outside the bounding box), the Bounding Box (by dragging the edges of
+  the box), or the Width/Height of the Bounding Box (by dragging one of the 9
+  directional handles).
+- **Reset View** - Click to re-orients the view to the center of the Bounding
+  Box.
+- **Merge Visible** - If your browser is having performance problems drawing the
+  image in the Unified Canvas, click this to consolidate all of the information
+  currently being rendered by your browser into a merged copy of the image. This
+  lowers the resource requirements and should improve performance.
+
+### Seam Correction
+
+When doing Inpainting or Outpainting, Invoke needs to merge the pixels generated
+by Stable Diffusion into your existing image. To do this, the area around the
+`seam` at the boundary between your image and the new generation is
+automatically blended to produce a seamless output. In a fully automatic
+process, a mask is generated to cover the seam, and then the area of the seam is
+Inpainted.
+
+Although the default options should work well most of the time, sometimes it can
+help to alter the parameters that control the seam Inpainting. A wider seam and
+a blur setting of about 1/3 of the seam have been noted as producing
+consistently strong results (e.g. 96 wide and 16 blur - adds up to 32 blur with
+both sides). Seam strength of 0.7 is best for reducing hard seams.
+
+- **Seam Size** - The size of the seam masked area. Set higher to make a larger
+  mask around the seam.
+- **Seam Blur** - The size of the blur that is applied on _each_ side of the
+  masked area.
+- **Seam Strength** - The Image To Image Strength parameter used for the
+  Inpainting generation that is applied to the seam area.
+- **Seam Steps** - The number of generation steps that should be used to Inpaint
+  the seam.
+
+### Infill & Scaling
+
+- **Scale Before Processing & W/H**: When generating images with a bounding box
+  smaller than the optimized W/H of the model (e.g., 512x512 for SD1.5), this
+  feature first generates at a larger size with the same aspect ratio, and then
+  scales that image down to fill the selected area. This is particularly useful
+  when inpainting very small details. Scaling is optional but is enabled by
+  default.
+- **Inpaint Replace**: When Inpainting, the default method is to utilize the
+  existing RGB values of the Base layer to inform the generation process. If
+  Inpaint Replace is enabled, noise is generated and blended with the existing
+  pixels (completely replacing the original RGB values at an Inpaint Replace
+  value of 1). This can help generate more variation from the pixels on the Base
+  layers.
+    - When using Inpaint Replace you should use a higher Image To Image Strength
+      value, especially at higher Inpaint Replace values
+- **Infill Method**: Invoke currently supports two methods for producing RGB
+  values for use in the Outpainting process: Patchmatch and Tile. We believe
+  that Patchmatch is the superior method, however we provide support for Tile in
+  case Patchmatch cannot be installed or is unavailable on your computer.
+- **Tile Size**: The Tile method for Outpainting sources small portions of the
+  original image and randomly place these into the areas being Outpainted. This
+  value sets the size of those tiles.
+
+## Hot Keys
+
+The Unified Canvas is a tool that excels when you use hotkeys. You can view the
+full list of keyboard shortcuts, updated with all new features, by clicking the
+Keyboard Shortcuts icon at the top right of the InvokeAI WebUI.

docs/features/WEBUIHOTKEYS.md

@@ -4,59 +4,72 @@ title: WebUI Hotkey List
 
 # :material-keyboard: **WebUI Hotkey List**
 
-## General
+## App Hotkeys
 
 | Setting           | Hotkey             |
-| ----------------- | ---------------------- |
-| ++a++             | Set All Parameters     |
-| ++s++             | Set Seed               |
-| ++u++             | Upscale                |
-| ++r++             | Restoration            |
-| ++i++             | Show Metadata          |
-| ++d++ ++d++ ++l++ | Delete Image           |
-| ++alt+a++         | Focus prompt input     |
-| ++shift+i++       | Send To Image to Image |
-| ++ctrl+enter++    | Start processing       |
-| ++shift+x++       | cancel Processing      |
-| ++shift+d++       | Toggle Dark Mode       |
-| ++"`"++           | Toggle console         |
+| ----------------- | ------------------ |
+| ++"Ctrl\+Enter"++ | Invoke             |
+| ++"Shift\+X"++    | Cancel             |
+| ++"Alt\+A"++      | Focus Prompt       |
+| ++"O"++           | Toggle Options     |
+| ++"Shift\+O"++    | Pin Options        |
+| ++"Z"++           | Toggle Viewer      |
+| ++"G"++           | Toggle Gallery     |
+| ++"F"++           | Maximize Workspace |
+| ++"1-5"++         | Change Tabs        |
+| ++"`"++           | Toggle Console     |
 
-## Tabs
+## General Hotkeys
 
 | Setting         | Hotkey                 |
-| ------- | ------------------------- |
-| ++1++   | Go to Text To Image Tab   |
-| ++2++   | Go to Image to Image Tab  |
-| ++3++   | Go to Inpainting Tab      |
-| ++4++   | Go to Outpainting Tab     |
-| ++5++   | Go to Nodes Tab           |
-| ++6++   | Go to Post Processing Tab |
+| --------------- | ---------------------- |
+| ++"P"++         | Set Prompt             |
+| ++"S"++         | Set Seed               |
+| ++"A"++         | Set Parameters         |
+| ++"Shift\+R"++  | Restore Faces          |
+| ++"Shift\+U"++  | Upscale                |
+| ++"I"++         | Show Info              |
+| ++"Shift\+I"++  | Send To Image To Image |
+| ++"Del"++       | Delete Image           |
+| ++"Esc"++       | Close Panels           |
 
-## Gallery
+## Gallery Hotkeys
 
 | Setting            | Hotkey                      |
-| -------------- | ------------------------------- |
-| ++g++          | Toggle Gallery                  |
-| ++left++       | Go to previous image in gallery |
-| ++right++      | Go to next image in gallery     |
-| ++shift+p++    | Pin gallery                     |
-| ++shift+up++   | Increase gallery image size     |
-| ++shift+down++ | Decrease gallery image size     |
-| ++shift+r++    | Reset image gallery size        |
+| ------------------ | --------------------------- |
+| ++"Arrow Left"++   | Previous Image              |
+| ++"Arrow Right"++  | Next Image                  |
+| ++"Shift\+G"++     | Toggle Gallery Pin          |
+| ++"Shift\+Up"++    | Increase Gallery Image Size |
+| ++"Shift\+Down"++  | Decrease Gallery Image Size |
 
-## Inpainting
+## Unified Canvas Hotkeys
 
 | Setting                        | Hotkey                 |
-| ---------------------------- | --------------------- |
-| ++"["++                      | Decrease brush size   |
-| ++"]"++                      | Increase brush size   |
-| ++alt+"["++                  | Decrease mask opacity |
-| ++alt+"]"++                  | Increase mask opacity |
-| ++b++                        | Select brush          |
-| ++e++                        | Select eraser         |
-| ++ctrl+z++                   | Undo brush stroke     |
-| ++ctrl+shift+z++, ++ctrl+y++ | Redo brush stroke     |
-| ++h++                        | Hide mask             |
-| ++shift+m++                  | Invert mask           |
-| ++shift+c++                  | Clear mask            |
-| ++shift+j++                  | Expand canvas         |
+| ------------------------------ | ---------------------- |
+| ++"B"++                        | Select Brush           |
+| ++"E"++                        | Select Eraser          |
+| ++"["++                        | Decrease Brush Size    |
+| ++"]"++                        | Increase Brush Size    |
+| ++"Shift\+["++                 | Decrease Brush Opacity |
+| ++"Shift\+]"++                 | Increase Brush Opacity |
+| ++"V"++                        | Move Tool              |
+| ++"Shift\+F"++                 | Fill Bounding Box      |
+| ++"Delete/Backspace"++         | Erase Bounding Box     |
+| ++"C"++                        | Select Color Picker    |
+| ++"N"++                        | Toggle Snap            |
+| ++"Hold Space"++               | Quick Toggle Move      |
+| ++"Q"++                        | Toggle Layer           |
+| ++"Shift\+C"++                 | Clear Mask             |
+| ++"H"++                        | Hide Mask              |
+| ++"Shift\+H"++                 | Show/Hide Bounding Box |
+| ++"Shift\+M"++                 | Merge Visible          |
+| ++"Shift\+S"++                 | Save To Gallery        |
+| ++"Ctrl\+C"++                  | Copy To Clipboard      |
+| ++"Shift\+D"++                 | Download Image         |
+| ++"Ctrl\+Z"++                  | Undo                   |
+| ++"Ctrl\+Y / Ctrl\+Shift\+Z"++ | Redo                   |
+| ++"R"++                        | Reset View             |
+| ++"Arrow Left"++               | Previous Staging Image |
+| ++"Arrow Right"++              | Next Staging Image     |
+| ++"Enter"++                    | Accept Staging Image   |

docs/features/index.md

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

docs/index.md

@@ -6,15 +6,14 @@ 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
+  pip install -r docs/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)](https://github.com/invoke-ai/InvokeAI)
+[![project logo](assets/invoke_ai_banner.png)](https://github.com/invoke-ai/InvokeAI)
 
 [![discord badge]][discord link]
 
@@ -70,7 +69,11 @@ 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/ZmtBAhwWhy">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>]
+**Quick links**: [<a href="https://discord.gg/ZmtBAhwWhy">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>
 
@@ -80,11 +83,19 @@ Mac and Linux machines, and runs on GPU cards with as little as 4 GB or RAM.
 
 ## :octicons-package-dependencies-24: Installation
 
-This fork is supported across Linux, Windows and Macintosh. Linux
-users can use either an Nvidia-based card (with CUDA support) or an
-AMD card (using the ROCm driver). For full installation and upgrade
-instructions, please see:
-[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/)
+This fork is supported across Linux, Windows and Macintosh. Linux users can use
+either an Nvidia-based card (with CUDA support) or an AMD card (using the ROCm
+driver).
+
+First time users, please see
+[Automated Installer](installation/INSTALL_AUTOMATED.md) for a walkthrough of
+getting InvokeAI up and running on your system. For alternative installation and
+upgrade instructions, please see:
+[InvokeAI Installation Overview](installation/)
+
+Linux users who wish to make use of the PyPatchMatch inpainting functions will
+need to perform a bit of extra work to enable this module. Instructions can be
+found at [Installing PyPatchMatch](installation/060_INSTALL_PATCHMATCH.md).
 
 ## :fontawesome-solid-computer: Hardware Requirements
 
@@ -93,25 +104,29 @@ instructions, please see:
 You wil need one of the following:
 
 - :simple-nvidia: An NVIDIA-based graphics card with 4 GB or more VRAM memory.
-- :simple-amd: An AMD-based graphics card with 4 GB or more VRAM memory (Linux only)
+- :simple-amd: An AMD-based graphics card with 4 GB or more VRAM memory (Linux
+  only)
 - :fontawesome-brands-apple: An Apple computer with an M1 chip.
 
+We do **not recommend** the following video cards due to issues with their
+running in half-precision mode and having insufficient VRAM to render 512x512
+images in full-precision mode:
+
+- NVIDIA 10xx series cards such as the 1080ti
+- GTX 1650 series cards
+- GTX 1660 series cards
+
 ### :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
+- At least 18 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:
@@ -119,121 +134,115 @@ You wil need one of the following:
     ```bash
     (invokeai) ~/InvokeAI$ python scripts/invoke.py --full_precision
     ```
+
 ## :octicons-gift-24: InvokeAI Features
 
-- [The InvokeAI Web Interface](features/WEB.md)
-    - [WebGUI hotkey reference guide](features/WEBUIHOTKEYS.md)
-<!-- this link does not exist    - [WebGUI Unified Canvas for Img2Img, inpainting and outpainting](features/UNIFIED_CANVAS.md) -->
-- [The Command Line Interace](features/CLI.md)
-    - [Image2Image](features/IMG2IMG.md)
-    - [Inpainting](features/INPAINTING.md)
-    - [Outpainting](features/OUTPAINTING.md)
-    - [Adding custom styles and subjects](features/CONCEPTS.md)
-    - [Upscaling and Face Reconstruction](features/POSTPROCESS.md)
+- [The InvokeAI Web Interface](features/WEB.md) -
+[WebGUI hotkey reference guide](features/WEBUIHOTKEYS.md) -
+[WebGUI Unified Canvas for Img2Img, inpainting and outpainting](features/UNIFIED_CANVAS.md)
+<!-- seperator -->
+- [The Command Line Interace](features/CLI.md) -
+[Image2Image](features/IMG2IMG.md) - [Inpainting](features/INPAINTING.md) -
+[Outpainting](features/OUTPAINTING.md) -
+[Adding custom styles and subjects](features/CONCEPTS.md) -
+[Upscaling and Face Reconstruction](features/POSTPROCESS.md)
 <!-- seperator -->
 - [Generating Variations](features/VARIATIONS.md)
 <!-- seperator -->
 - [Prompt Engineering](features/PROMPTS.md)
 <!-- seperator -->
 - Miscellaneous
+  - [NSFW Checker](features/NSFW.md)
   - [Embiggen upscaling](features/EMBIGGEN.md)
   - [Other](features/OTHER.md)
 
 ## :octicons-log-16: Latest Changes
 
-### v2.1.3 <small>(13 November 2022)</small>
+### v2.2.4 <small>(11 December 2022)</small>
 
-- A choice of installer scripts that automate installation and configuration. See [Installation](https://github.com/invoke-ai/InvokeAI/blob/2.1.3-rc6/docs/installation/INSTALL.md).
-- A streamlined manual installation process that works for both Conda and PIP-only installs. See [Manual Installation](https://github.com/invoke-ai/InvokeAI/blob/2.1.3-rc6/docs/installation/INSTALL_MANUAL.md).
-- The ability to save frequently-used startup options (model to load, steps, sampler, etc) in a `.invokeai` file. See [Client](https://github.com/invoke-ai/InvokeAI/blob/2.1.3-rc6/docs/features/CLI.md)
-- Support for AMD GPU cards (non-CUDA) on Linux machines.
-- Multiple bugs and edge cases squashed.
+#### the `invokeai` directory
 
-### v2.1.0 <small>(2 November 2022)</small>
+Previously there were two directories to worry about, the directory that
+contained the InvokeAI source code and the launcher scripts, and the `invokeai`
+directory that contained the models files, embeddings, configuration and
+outputs. With the 2.2.4 release, this dual system is done away with, and
+everything, including the `invoke.bat` and `invoke.sh` launcher scripts, now
+live in a directory named `invokeai`. By default this directory is located in
+your home directory (e.g. `\Users\yourname` on Windows), but you can select
+where it goes at install time.
 
-- [Inpainting](https://invoke-ai.github.io/InvokeAI/features/INPAINTING/)
-  support in the WebGUI
-- Greatly improved navigation and user experience in the
-  [WebGUI](https://invoke-ai.github.io/InvokeAI/features/WEB/)
-- The prompt syntax has been enhanced with
-  [prompt weighting, cross-attention and prompt merging](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/).
-- You can now load
-  [multiple models and switch among them quickly](https://docs.google.com/presentation/d/1WywGA1rny7bpFh7CLSdTr4nNpVKdlUeT0Bj0jCsILyU/edit?usp=sharing)
-  without leaving the CLI.
-- The installation process (via `scripts/preload_models.py`) now lets you select
-  among several popular
-  [Stable Diffusion models](https://invoke-ai.github.io/InvokeAI/installation/INSTALLING_MODELS/)
-  and downloads and installs them on your behalf. Among other models, this
-  script will install the current Stable Diffusion 1.5 model as well as a
-  StabilityAI variable autoencoder (VAE) which improves face generation.
-- Tired of struggling with photoeditors to get the masked region of for
-  inpainting just right? Let the AI make the mask for you using
-  [text masking](https://docs.google.com/presentation/d/1pWoY510hCVjz0M6X9CBbTznZgW2W5BYNKrmZm7B45q8/edit#slide=id.p).
-  This feature allows you to specify the part of the image to paint over using
-  just English-language phrases.
-- Tired of seeing the head of your subjects cropped off? Uncrop them in the CLI
-  with the
-  [outcrop feature](https://invoke-ai.github.io/InvokeAI/features/OUTPAINTING/#outcrop).
-- Tired of seeing your subject's bodies duplicated or mangled when generating
-  larger-dimension images? Check out the `--hires` option in the CLI, or select
-  the corresponding toggle in the WebGUI.
-- We now support textual inversion and fine-tune .bin styles and subjects from
-  the Hugging Face archive of
-  [SD Concepts](https://huggingface.co/sd-concepts-library). Load the .bin file
-  using the `--embedding_path` option. (The next version will support merging
-  and loading of multiple simultaneous models).
-- ...
+After installation, you can delete the install directory (the one that the zip
+file creates when it unpacks). Do **not** delete or move the `invokeai`
+directory!
 
-### v2.0.1 <small>(13 October 2022)</small>
+##### Initialization file `invokeai/invokeai.init`
 
-- 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)
+You can place frequently-used startup options in this file, such as the default
+number of steps or your preferred sampler. To keep everything in one place, this
+file has now been moved into the `invokeai` directory and is named
+`invokeai.init`.
 
-### v2.0.0 <small>(9 October 2022)</small>
+#### To update from Version 2.2.3
 
-- `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`.
+The easiest route is to download and unpack one of the 2.2.4 installer files.
+When it asks you for the location of the `invokeai` runtime directory, respond
+with the path to the directory that contains your 2.2.3 `invokeai`. That is, if
+`invokeai` lives at `C:\Users\fred\invokeai`, then answer with `C:\Users\fred`
+and answer "Y" when asked if you want to reuse the directory.
+
+The `update.sh` (`update.bat`) script that came with the 2.2.3 source installer
+does not know about the new directory layout and won't be fully functional.
+
+#### To update to 2.2.5 (and beyond) there's now an update path.
+
+As they become available, you can update to more recent versions of InvokeAI
+using an `update.sh` (`update.bat`) script located in the `invokeai` directory.
+Running it without any arguments will install the most recent version of
+InvokeAI. Alternatively, you can get set releases by running the `update.sh`
+script with an argument in the command shell. This syntax accepts the path to
+the desired release's zip file, which you can find by clicking on the green
+"Code" button on this repository's home page.
+
+#### Other 2.2.4 Improvements
+
+- Fix InvokeAI GUI initialization by @addianto in #1687
+- fix link in documentation by @lstein in #1728
+- Fix broken link by @ShawnZhong in #1736
+- Remove reference to binary installer by @lstein in #1731
+- documentation fixes for 2.2.3 by @lstein in #1740
+- Modify installer links to point closer to the source installer by @ebr in
+  #1745
+- add documentation warning about 1650/60 cards by @lstein in #1753
+- Fix Linux source URL in installation docs by @andybearman in #1756
+- Make install instructions discoverable in readme by @damian0815 in #1752
+- typo fix by @ofirkris in #1755
+- Non-interactive model download (support HUGGINGFACE_TOKEN) by @ebr in #1578
+- fix(srcinstall): shell installer - cp scripts instead of linking by @tildebyte
+  in #1765
+- stability and usage improvements to binary & source installers by @lstein in
+  #1760
+- fix off-by-one bug in cross-attention-control by @damian0815 in #1774
+- Eventually update APP_VERSION to 2.2.3 by @spezialspezial in #1768
+- invoke script cds to its location before running by @lstein in #1805
+- Make PaperCut and VoxelArt models load again by @lstein in #1730
+- Fix --embedding_directory / --embedding_path not working by @blessedcoolant in
+  #1817
+- Clean up readme by @hipsterusername in #1820
+- Optimized Docker build with support for external working directory by @ebr in
+  #1544
+- disable pushing the cloud container by @mauwii in #1831
+- Fix docker push github action and expand with additional metadata by @ebr in
+  #1837
+- Fix Broken Link To Notebook by @VedantMadane in #1821
+- Account for flat models by @spezialspezial in #1766
+- Update invoke.bat.in isolate environment variables by @lynnewu in #1833
+- Arch Linux Specific PatchMatch Instructions & fixing conda install on linux by
+  @SammCheese in #1848
+- Make force free GPU memory work in img2img by @addianto in #1844
+- New installer by @lstein
 
 For older changelogs, please visit the
-**[CHANGELOG](CHANGELOG/#v114-11-september-2022)**.
+**[CHANGELOG](CHANGELOG/#v223-2-december-2022)**.
 
 ## :material-target: Troubleshooting
 

docs/installation/010_INSTALL_AUTOMATED.md

@@ -0,0 +1,315 @@
+---
+title: Installing with the Automated Installer
+---
+
+# InvokeAI Automated Installation
+
+## Introduction
+
+The automated installer is a shell script that attempts to automate every step
+needed to install and run InvokeAI on a stock computer running recent versions
+of Linux, MacOS or Windows. It will leave you with a version that runs a stable
+version of InvokeAI with the option to upgrade to experimental versions later.
+
+## Walk through
+
+1.  Make sure that your system meets the
+    [hardware requirements](../index.md#hardware-requirements) and has the
+    appropriate GPU drivers installed. In particular, if you are a Linux user
+    with an AMD GPU installed, you may need to install the
+    [ROCm driver](https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html).
+
+    !!! info "Required Space"
+
+        Installation requires roughly 18G of free disk space to load the libraries and
+        recommended model weights files.
+
+        Regardless of your destination disk, your *system drive* (`C:\` on Windows, `/` on macOS/Linux) requires at least 6GB of free disk space to download and cache python dependencies. NOTE for Linux users: if your temporary directory is mounted as a `tmpfs`, ensure it has sufficient space.
+
+2.  Check that your system has an up-to-date Python installed. To do this, open
+    up a command-line window ("Terminal" on Linux and Macintosh, "Command" or
+    "Powershell" on Windows) and type `python --version`. If Python is
+    installed, it will print out the version number. If it is version `3.9.1` or
+    higher, you meet requirements.
+
+    !!! warning "If you see an older version, or get a command not found error"
+
+        Go to [Python Downloads](https://www.python.org/downloads/) and
+        download the appropriate installer package for your platform. We recommend
+        [Version 3.10.9](https://www.python.org/downloads/release/python-3109/),
+        which has been extensively tested with InvokeAI.
+
+    !!! warning "At this time we do not recommend Python 3.11"
+
+    _Please select your platform in the section below for platform-specific
+    setup requirements._
+
+    === "Windows users"
+
+        - During the Python configuration process,
+        look out for a checkbox to add Python to your PATH
+        and select it. If the install script complains that it can't
+        find python, then open the Python installer again and choose
+        "Modify" existing installation.
+
+        - Installation requires an up to date version of the Microsoft Visual C libraries. Please install the 2015-2022 libraries available here: https://learn.microsoft.com/en-us/cpp/windows/deploying-native-desktop-applications-visual-cpp?view=msvc-170
+
+    === "Mac users"
+
+        - After installing Python, you may need to run the
+        following command from the Terminal in order to install the Web
+        certificates needed to download model data from https sites. If
+        you see lots of CERTIFICATE ERRORS during the last part of the
+        install, this is the problem, and you can fix it with this command:
+
+            `/Applications/Python\ 3.10/Install\ Certificates.command`
+
+        -  You may need to install the Xcode command line tools. These
+        are a set of tools that are needed to run certain applications in a
+        Terminal, including InvokeAI. This package is provided directly by Apple.
+
+              - To install, open a terminal window and run `xcode-select
+              --install`. You will get a macOS system popup guiding you through the
+              install. If you already have them installed, you will instead see some
+              output in the Terminal advising you that the tools are already installed.
+
+              - More information can be found here:
+                https://www.freecodecamp.org/news/install-xcode-command-line-tools/
+
+    === "Linux users"
+
+        For reasons that are not entirely clear, installing the correct version of Python can be a bit of a challenge on Ubuntu, Linux Mint, Pop!_OS, and other Debian-derived distributions.
+
+        On Ubuntu 22.04 and higher, run the following:
+
+        ```
+        sudo apt update
+        sudo apt install -y python3 python3-pip python3-venv
+        sudo update-alternatives --install /usr/local/bin/python python /usr/bin/python3.10 3
+        ```
+
+        On Ubuntu 20.04, the process is slightly different:
+
+        ```
+        sudo apt update
+        sudo apt install -y software-properties-common
+        sudo add-apt-repository -y ppa:deadsnakes/ppa
+        sudo apt install python3.10 python3-pip python3.10-venv
+        sudo update-alternatives --install /usr/local/bin/python python /usr/bin/python3.10 3
+        ```
+
+        Both `python` and `python3` commands are now pointing at Python3.10. You can still access older versions of Python by calling `python2`, `python3.8`, etc.
+
+        Linux systems require a couple of additional graphics libraries to be installed for proper functioning of `python3-opencv`. Please run the following:
+
+        `sudo apt update && sudo apt install -y libglib2.0-0 libgl1-mesa-glx`
+
+3.  The source installer is distributed in ZIP files. Go to the
+    [latest release](https://github.com/invoke-ai/InvokeAI/releases/latest), and
+    look for a series of files named:
+
+    - [InvokeAI-installer-2.2.4-p5-mac.zip](https://github.com/invoke-ai/InvokeAI/files/10254728/InvokeAI-installer-2.2.4-p5-mac.zip)
+    - [InvokeAI-installer-2.2.4-p5-windows.zip](https://github.com/invoke-ai/InvokeAI/files/10254729/InvokeAI-installer-2.2.4-p5-windows.zip)
+    - [InvokeAI-installer-2.2.4-p5-linux.zip](https://github.com/invoke-ai/InvokeAI/files/10254727/InvokeAI-installer-2.2.4-p5-linux.zip)
+
+    Download the one that is appropriate for your operating system.
+
+4.  Unpack the zip file into a convenient directory. This will create a new
+    directory named "InvokeAI-Installer". This example shows how this would look
+    using the `unzip` command-line tool, but you may use any graphical or
+    command-line Zip extractor:
+
+    ```cmd
+    C:\Documents\Linco> unzip InvokeAI-installer-2.2.4-windows.zip
+    Archive:  C: \Linco\Downloads\InvokeAI-installer-2.2.4-windows.zip
+    creating: InvokeAI-Installer\
+    inflating: InvokeAI-Installer\install.bat
+    inflating: InvokeAI-Installer\readme.txt
+    ...
+    ```
+
+    After successful installation, you can delete the `InvokeAI-Installer`
+    directory.
+
+5.  **Windows only** Please double-click on the file WinLongPathsEnabled.reg and
+    accept the dialog box that asks you if you wish to modify your registry.
+    This activates long filename support on your system and will prevent
+    mysterious errors during installation.
+
+6.  If you are using a desktop GUI, double-click the installer file. It will be
+    named `install.bat` on Windows systems and `install.sh` on Linux and
+    Macintosh systems.
+
+    On Windows systems you will probably get an "Untrusted Publisher" warning.
+    Click on "More Info" and select "Run Anyway." You trust us, right?
+
+7.  Alternatively, from the command line, run the shell script or .bat file:
+
+    ```cmd
+    C:\Documents\Linco> cd InvokeAI-Installer
+    C:\Documents\Linco\invokeAI> install.bat
+    ```
+
+8.  The script will ask you to choose where to install InvokeAI. Select a
+    directory with at least 18G of free space for a full install. InvokeAI and
+    all its support files will be installed into a new directory named
+    `invokeai` located at the location you specify.
+
+    - The default is to install the `invokeai` directory in your home directory,
+      usually `C:\Users\YourName\invokeai` on Windows systems,
+      `/home/YourName/invokeai` on Linux systems, and `/Users/YourName/invokeai`
+      on Macintoshes, where "YourName" is your login name.
+
+    - The script uses tab autocompletion to suggest directory path completions.
+      Type part of the path (e.g. "C:\Users") and press ++tab++ repeatedly
+      to suggest completions.
+
+9.  Sit back and let the install script work. It will install the third-party
+    libraries needed by InvokeAI, then download the current InvokeAI release and
+    install it.
+
+    Be aware that some of the library download and install steps take a long
+    time. In particular, the `pytorch` package is quite large and often appears
+    to get "stuck" at 99.9%. Have patience and the installation step will
+    eventually resume. However, there are occasions when the library install
+    does legitimately get stuck. If you have been waiting for more than ten
+    minutes and nothing is happening, you can interrupt the script with ^C. You
+    may restart it and it will pick up where it left off.
+
+10. After installation completes, the installer will launch a script called
+    `configure_invokeai.py`, which will guide you through the first-time process
+    of selecting one or more Stable Diffusion model weights files, downloading
+    and configuring them. We provide a list of popular models that InvokeAI
+    performs well with. However, you can add more weight files later on using
+    the command-line client or the Web UI. See
+    [Installing Models](050_INSTALLING_MODELS.md) for details.
+
+    Note that the main Stable Diffusion weights file is protected by a license
+    agreement that you must agree to in order to use. The script will list the
+    steps you need to take to create an account on the official site that hosts
+    the weights files, accept the agreement, and provide an access token that
+    allows InvokeAI to legally download and install the weights files.
+
+    If you have already downloaded the weights file(s) for another Stable
+    Diffusion distribution, you may skip this step (by selecting "skip" when
+    prompted) and configure InvokeAI to use the previously-downloaded files. The
+    process for this is described in [Installing Models](050_INSTALLING_MODELS.md).
+
+11. The script will now exit and you'll be ready to generate some images. Look
+    for the directory `invokeai` installed in the location you chose at the
+    beginning of the install session. Look for a shell script named `invoke.sh`
+    (Linux/Mac) or `invoke.bat` (Windows). Launch the script by double-clicking
+    it or typing its name at the command-line:
+
+    ```cmd
+    C:\Documents\Linco> cd invokeai
+    C:\Documents\Linco\invokeAI> invoke.bat
+    ```
+
+    - The `invoke.bat` (`invoke.sh`) script will give you the choice of starting
+      (1) the command-line interface, or (2) the web GUI. If you start the
+      latter, you can load the user interface by pointing your browser at
+      http://localhost:9090.
+
+    - The script also offers you a third option labeled "open the developer
+      console". If you choose this option, you will be dropped into a
+      command-line interface in which you can run python commands directly,
+      access developer tools, and launch InvokeAI with customized options.
+
+12. You can launch InvokeAI with several different command-line arguments that
+    customize its behavior. For example, you can change the location of the
+    image output directory, or select your favorite sampler. See the
+    [Command-Line Interface](../features/CLI.md) for a full list of the options.
+
+        - To set defaults that will take effect every time you launch InvokeAI,
+        use a text editor (e.g. Notepad) to exit the file
+        `invokeai\invokeai.init`. It contains a variety of examples that you can
+        follow to add and modify launch options.
+
+!!! warning "The `invokeai` directory contains the `invoke` application, its
+configuration files, the model weight files, and outputs of image generation.
+Once InvokeAI is installed, do not move or remove this directory."
+
+## Troubleshooting
+
+### _Package dependency conflicts_
+
+If you have previously installed InvokeAI or another Stable Diffusion package,
+the installer may occasionally pick up outdated libraries and either the
+installer or `invoke` will fail with complaints about library conflicts. You can
+address this by entering the `invokeai` directory and running `update.sh`, which
+will bring InvokeAI up to date with the latest libraries.
+
+### ldm from pypi
+
+!!! warning
+
+    Some users have tried to correct dependency problems by installing
+    the `ldm` package from PyPi.org. Unfortunately this is an unrelated package that
+    has nothing to do with the 'latent diffusion model' used by InvokeAI. Installing
+    ldm will make matters worse. If you've installed ldm, uninstall it with
+    `pip uninstall ldm`.
+
+### Corrupted configuration file
+
+Everything seems to install ok, but `invoke` complains of a corrupted
+configuration file and goes back into the configuration process (asking you to
+download models, etc), but this doesn't fix the problem.
+
+This issue is often caused by a misconfigured configuration directive in the
+`invokeai\invokeai.init` initialization file that contains startup settings. The
+easiest way to fix the problem is to move the file out of the way and re-run
+`configure_invokeai.py`. Enter the developer's console (option 3 of the launcher
+script) and run this command:
+
+```cmd
+configure_invokeai.py --root=.
+```
+
+Note the dot (.) after `--root`. It is part of the command.
+
+_If none of these maneuvers fixes the problem_ then please report the problem to
+the [InvokeAI Issues](https://github.com/invoke-ai/InvokeAI/issues) section, or
+visit our [Discord Server](https://discord.gg/ZmtBAhwWhy) for interactive
+assistance.
+
+### other problems
+
+If you run into problems during or after installation, the InvokeAI team is
+available to help you. Either create an
+[Issue](https://github.com/invoke-ai/InvokeAI/issues) at our GitHub site, or
+make a request for help on the "bugs-and-support" channel of our
+[Discord server](https://discord.gg/ZmtBAhwWhy). We are a 100% volunteer
+organization, but typically somebody will be available to help you within 24
+hours, and often much sooner.
+
+## Updating to newer versions
+
+This distribution is changing rapidly, and we add new features on a daily basis.
+To update to the latest released version (recommended), run the `update.sh`
+(Linux/Mac) or `update.bat` (Windows) scripts. This will fetch the latest
+release and re-run the `configure_invokeai` script to download any updated
+models files that may be needed. You can also use this to add additional models
+that you did not select at installation time.
+
+You can now close the developer console and run `invoke` as before. If you get
+complaints about missing models, then you may need to do the additional step of
+running `configure_invokeai.py`. This happens relatively infrequently. To do
+this, simply open up the developer's console again and type
+`python scripts/configure_invokeai.py`.
+
+You may also use the `update` script to install any selected version of
+InvokeAI. From https://github.com/invoke-ai/InvokeAI, navigate to the zip file
+link of the version you wish to install. You can find the zip links by going to
+the one of the release pages and looking for the **Assets** section at the
+bottom. Alternatively, you can browse "branches" and "tags" at the top of the
+big code directory on the InvokeAI welcome page. When you find the version you
+want to install, go to the green "<> Code" button at the top, and copy the
+"Download ZIP" link.
+
+Now run `update.sh` (or `update.bat`) with the URL of the desired InvokeAI
+version as its argument. For example, this will install the old 2.2.0 release.
+
+```cmd
+update.sh https://github.com/invoke-ai/InvokeAI/archive/refs/tags/v2.2.0.zip
+```

docs/installation/020_INSTALL_MANUAL.md

@@ -0,0 +1,589 @@
+---
+title: Installing Manually
+---
+
+<figure markdown>
+# :fontawesome-brands-linux: Linux | :fontawesome-brands-apple: macOS | :fontawesome-brands-windows: Windows
+</figure>
+
+!!! warning "This is for advanced Users"
+
+    who are already experienced with using conda or pip
+
+## Introduction
+
+You have two choices for manual installation, the [first
+one](#PIP_method) uses basic Python virtual environment (`venv`)
+commands and the PIP package manager. The [second one](#Conda_method)
+based on the Anaconda3 package manager (`conda`). Both methods require
+you to enter commands on the terminal, also known as the "console".
+
+Note that the conda install method is currently deprecated and will not
+be supported at some point in the future.
+
+On Windows systems you are encouraged to install and use the
+[Powershell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3),
+which provides compatibility with Linux and Mac shells and nice
+features such as command-line completion.
+
+## pip Install
+
+To install InvokeAI with virtual environments and the PIP package
+manager, please follow these steps:
+
+1.  Make sure you are using Python 3.9 or 3.10. The rest of the install
+    procedure depends on this:
+
+    ```bash
+    python -V
+    ```
+    
+2.  Clone the [InvokeAI](https://github.com/invoke-ai/InvokeAI) source code from
+    GitHub:
+
+    ```bash
+    git clone https://github.com/invoke-ai/InvokeAI.git
+    ```
+
+    This will create InvokeAI folder where you will follow the rest of the
+    steps.
+
+3.  From within the InvokeAI top-level directory, create and activate a virtual
+    environment named `invokeai`:
+
+    ```bash
+    python -mvenv invokeai
+    source invokeai/bin/activate
+    ```
+
+4. Make sure that pip is installed in your virtual environment an up to date:
+
+    ```bash
+    python -mensurepip --upgrade
+    python -mpip install --upgrade pip
+    ```
+
+5.  Pick the correct `requirements*.txt` file for your hardware and operating
+    system.
+
+    We have created a series of environment files suited for different operating
+    systems and GPU hardware. They are located in the
+    `environments-and-requirements` directory:
+
+    <figure markdown>
+
+    |              filename               |                               OS                                |
+    | :---------------------------------: | :-------------------------------------------------------------: |
+    |      requirements-lin-amd.txt       |                  Linux with an AMD (ROCm) GPU                   |
+    |     requirements-lin-arm64.txt      |                 Linux running on arm64 systems                  |
+    |      requirements-lin-cuda.txt      |                 Linux with an NVIDIA (CUDA) GPU                 |
+    |    requirements-mac-mps-cpu.txt     |                Macintoshes with MPS acceleration                |
+    | requirements-lin-win-colab-cuda.txt | Windows with an NVIDA (CUDA) GPU<br>(supports Google Colab too) |
+
+    </figure>
+
+    Select the appropriate requirements file, and make a link to it from
+    `requirements.txt` in the top-level InvokeAI directory. The command to do
+    this from the top-level directory is:
+
+    !!! example ""
+
+        === "Macintosh and Linux"
+
+            !!! info "Replace `xxx` and `yyy` with the appropriate OS and GPU codes."
+
+            ```bash
+            ln -sf environments-and-requirements/requirements-xxx-yyy.txt requirements.txt
+            ```
+
+        === "Windows"
+
+            !!! info "on Windows, admin privileges are required to make links, so we use the copy command instead"
+
+            ```cmd
+            copy environments-and-requirements\requirements-lin-win-colab-cuda.txt requirements.txt
+            ```
+
+        !!! warning
+
+            Please do not link or copy `environments-and-requirements/requirements-base.txt`.
+            This is a base requirements file that does not have the platform-specific
+            libraries. Also, be sure to link or copy the platform-specific file to
+            a top-level file named `requirements.txt` as shown here. Running pip on
+            a requirements file in a subdirectory will not work as expected.
+
+    When this is done, confirm that a file named `requirements.txt` has been
+    created in the InvokeAI root directory and that it points to the correct
+    file in `environments-and-requirements`.
+
+6.  Run PIP
+
+    Be sure that the `invokeai` environment is active before doing this:
+
+    ```bash
+    pip install --prefer-binary -r requirements.txt
+    ```
+
+7.  Set up the runtime directory
+
+    In this step you will initialize a runtime directory that will
+    contain the models, model config files, directory for textual
+    inversion embeddings, and your outputs. This keeps the runtime
+    directory separate from the source code and aids in updating.
+
+    You may pick any location for this directory using the `--root_dir`
+    option (abbreviated --root). If you don't pass this option, it will
+    default to `invokeai` in your home directory.
+
+    ```bash
+    configure_invokeai.py --root_dir ~/Programs/invokeai
+    ```
+
+    The script `configure_invokeai.py` will interactively guide you through the
+    process of downloading and installing the weights files needed for InvokeAI.
+    Note that the main Stable Diffusion weights file is protected by a license
+    agreement that you have to agree to. The script will list the steps you need
+    to take to create an account on the site that hosts the weights files,
+    accept the agreement, and provide an access token that allows InvokeAI to
+    legally download and install the weights files.
+
+    If you get an error message about a module not being installed, check that
+    the `invokeai` environment is active and if not, repeat step 5.
+
+    Note that `configure_invokeai.py` and `invoke.py` should be installed
+    under your virtual environment directory and the system should find them
+    on the PATH. If this isn't working on your system, you can call the
+    scripts directory using `python scripts/configure_invokeai.py` and
+    `python scripts/invoke.py`.
+
+    !!! tip
+
+        If you have already downloaded the weights file(s) for another Stable
+        Diffusion distribution, you may skip this step (by selecting "skip" when
+        prompted) and configure InvokeAI to use the previously-downloaded files. The
+        process for this is described in [here](050_INSTALLING_MODELS.md).
+
+8.  Run the command-line- or the web- interface:
+
+    Activate the environment (with `source invokeai/bin/activate`), and then
+    run the script `invoke.py`. If you selected a non-default location
+    for the runtime directory, please specify the path with the `--root_dir`
+    option (abbreviated below as `--root`):
+
+    !!! example ""
+
+        !!! warning "Make sure that the virtual environment is activated, which should create `(invokeai)` in front of your prompt!"
+
+        === "CLI"
+
+            ```bash
+            invoke.py --root ~/Programs/invokeai
+            ```
+
+        === "local Webserver"
+
+            ```bash
+            invoke.py --web --root ~/Programs/invokeai
+            ```
+
+        === "Public Webserver"
+
+            ```bash
+            invoke.py --web --host 0.0.0.0 --root ~/Programs/invokeai
+            ```
+
+        If you choose the run the web interface, point your browser at
+        http://localhost:9090 in order to load the GUI.
+
+    !!! tip
+
+        You can permanently set the location of the runtime directory by setting the environment variable INVOKEAI_ROOT to the path of the directory.
+
+9. Render away!
+
+    Browse the [features](../features/CLI.md) section to learn about all the things you
+    can do with InvokeAI.
+
+    Note that some GPUs are slow to warm up. In particular, when using an AMD
+    card with the ROCm driver, you may have to wait for over a minute the first
+    time you try to generate an image. Fortunately, after the warm up period
+    rendering will be fast.
+
+10. Subsequently, to relaunch the script, be sure to run "conda activate
+    invokeai", enter the `InvokeAI` directory, and then launch the invoke
+    script. If you forget to activate the 'invokeai' environment, the script
+    will fail with multiple `ModuleNotFound` errors.
+
+    !!! tip
+
+    Do not move the source code repository after installation. The virtual environment directory has absolute paths in it that get confused if the directory is moved.
+
+---
+
+### Conda method
+
+1.  Check that your system meets the
+    [hardware requirements](index.md#Hardware_Requirements) and has the
+    appropriate GPU drivers installed. In particular, if you are a Linux user
+    with an AMD GPU installed, you may need to install the
+    [ROCm driver](https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html).
+
+    InvokeAI does not yet support Windows machines with AMD GPUs due to the lack
+    of ROCm driver support on this platform.
+
+    To confirm that the appropriate drivers are installed, run `nvidia-smi` on
+    NVIDIA/CUDA systems, and `rocm-smi` on AMD systems. These should return
+    information about the installed video card.
+
+    Macintosh users with MPS acceleration, or anybody with a CPU-only system,
+    can skip this step.
+
+2.  You will need to install Anaconda3 and Git if they are not already
+    available. Use your operating system's preferred package manager, or
+    download the installers manually. You can find them here:
+
+    - [Anaconda3](https://www.anaconda.com/)
+    - [git](https://git-scm.com/downloads)
+
+3.  Clone the [InvokeAI](https://github.com/invoke-ai/InvokeAI) source code from
+    GitHub:
+
+    ```bash
+    git clone https://github.com/invoke-ai/InvokeAI.git
+    ```
+
+    This will create InvokeAI folder where you will follow the rest of the
+    steps.
+
+4.  Enter the newly-created InvokeAI folder:
+
+    ```bash
+    cd InvokeAI
+    ```
+
+    From this step forward make sure that you are working in the InvokeAI
+    directory!
+
+5.  Select the appropriate environment file:
+
+    We have created a series of environment files suited for different operating
+    systems and GPU hardware. They are located in the
+    `environments-and-requirements` directory:
+
+    <figure markdown>
+
+    |         filename         |               OS               |
+    | :----------------------: | :----------------------------: |
+    | environment-lin-amd.yml  |  Linux with an AMD (ROCm) GPU  |
+    | environment-lin-cuda.yml | Linux with an NVIDIA CUDA GPU  |
+    | environment-mac.yml    |   Macintosh            |
+    | environment-win-cuda.yml | Windows with an NVIDA CUDA GPU |
+
+    </figure>
+
+    Choose the appropriate environment file for your system and link or copy it
+    to `environment.yml` in InvokeAI's top-level directory. To do so, run
+    following command from the repository-root:
+
+    !!! Example ""
+
+        === "Macintosh and Linux"
+
+            !!! todo "Replace `xxx` and `yyy` with the appropriate OS and GPU codes as seen in the table above"
+
+            ```bash
+            ln -sf environments-and-requirements/environment-xxx-yyy.yml environment.yml
+            ```
+
+            When this is done, confirm that a file `environment.yml` has been linked in
+            the InvokeAI root directory and that it points to the correct file in the
+            `environments-and-requirements`.
+
+            ```bash
+            ls -la
+            ```
+
+        === "Windows"
+
+            !!! todo " Since it requires admin privileges to create links, we will use the copy command to create your `environment.yml`"
+
+            ```cmd
+            copy environments-and-requirements\environment-win-cuda.yml environment.yml
+            ```
+
+            Afterwards verify that the file `environment.yml` has been created, either via the
+            explorer or by using the command `dir` from the terminal
+
+            ```cmd
+            dir
+            ```
+
+    !!! warning "Do not try to run conda on directly on the subdirectory environments file. This won't work. Instead, copy or link it to the top-level directory as shown."
+
+6.  Create the conda environment:
+
+    ```bash
+    conda env update
+    ```
+
+    This will create a new environment named `invokeai` and install all InvokeAI
+    dependencies into it. If something goes wrong you should take a look at
+    [troubleshooting](#troubleshooting).
+
+7.  Activate the `invokeai` environment:
+
+    In order to use the newly created environment you will first need to
+    activate it
+
+    ```bash
+    conda activate invokeai
+    ```
+
+    Your command-line prompt should change to indicate that `invokeai` is active
+    by prepending `(invokeai)`.
+
+8.  Set up the runtime directory
+
+    In this step you will initialize a runtime directory that will
+    contain the models, model config files, directory for textual
+    inversion embeddings, and your outputs. This keeps the runtime
+    directory separate from the source code and aids in updating.
+
+    You may pick any location for this directory using the `--root_dir`
+    option (abbreviated --root). If you don't pass this option, it will
+    default to `invokeai` in your home directory.
+
+    ```bash
+    python scripts/configure_invokeai.py --root_dir ~/Programs/invokeai
+    ```
+
+    The script `configure_invokeai.py` will interactively guide you through the
+    process of downloading and installing the weights files needed for InvokeAI.
+    Note that the main Stable Diffusion weights file is protected by a license
+    agreement that you have to agree to. The script will list the steps you need
+    to take to create an account on the site that hosts the weights files,
+    accept the agreement, and provide an access token that allows InvokeAI to
+    legally download and install the weights files.
+
+    If you get an error message about a module not being installed, check that
+    the `invokeai` environment is active and if not, repeat step 5.
+
+    Note that `configure_invokeai.py` and `invoke.py` should be
+    installed under your conda directory and the system should find
+    them automatically on the PATH. If this isn't working on your
+    system, you can call the scripts directory using `python
+    scripts/configure_invoke.py` and `python scripts/invoke.py`.
+
+    !!! tip
+
+        If you have already downloaded the weights file(s) for another Stable
+        Diffusion distribution, you may skip this step (by selecting "skip" when
+        prompted) and configure InvokeAI to use the previously-downloaded files. The
+        process for this is described in [here](050_INSTALLING_MODELS.md).
+
+9.  Run the command-line- or the web- interface:
+
+    Activate the environment (with `source invokeai/bin/activate`), and then
+    run the script `invoke.py`. If you selected a non-default location
+    for the runtime directory, please specify the path with the `--root_dir`
+    option (abbreviated below as `--root`):
+
+    !!! example ""
+
+        !!! warning "Make sure that the conda environment is activated, which should create `(invokeai)` in front of your prompt!"
+
+        === "CLI"
+
+            ```bash
+            invoke.py --root ~/Programs/invokeai
+            ```
+
+        === "local Webserver"
+
+            ```bash
+            invoke.py --web --root ~/Programs/invokeai
+            ```
+
+        === "Public Webserver"
+
+            ```bash
+            invoke.py --web --host 0.0.0.0 --root ~/Programs/invokeai
+            ```
+
+        If you choose the run the web interface, point your browser at
+        http://localhost:9090 in order to load the GUI.
+
+    !!! tip
+
+        You can permanently set the location of the runtime directory by setting the environment variable INVOKEAI_ROOT to the path of your choice.
+
+10. Render away!
+
+    Browse the [features](../features/CLI.md) section to learn about all the things you
+    can do with InvokeAI.
+
+    Note that some GPUs are slow to warm up. In particular, when using an AMD
+    card with the ROCm driver, you may have to wait for over a minute the first
+    time you try to generate an image. Fortunately, after the warm up period
+    rendering will be fast.
+
+11. Subsequently, to relaunch the script, be sure to run "conda activate
+    invokeai", enter the `InvokeAI` directory, and then launch the invoke
+    script. If you forget to activate the 'invokeai' environment, the script
+    will fail with multiple `ModuleNotFound` errors.
+
+## Creating an "install" version of InvokeAI
+
+If you wish you can install InvokeAI and all its dependencies in the
+runtime directory. This allows you to delete the source code
+repository and eliminates the need to provide `--root_dir` at startup
+time. Note that this method only works with the PIP method.
+
+1. Follow the instructions for the PIP install, but in step #2 put the
+   virtual environment into the runtime directory. For example, assuming the
+   runtime directory lives in `~/Programs/invokeai`, you'd run:
+
+   ```bash
+   python -menv ~/Programs/invokeai
+   ```
+
+2. Now follow steps 3 to 5 in the PIP recipe, ending with the `pip install`
+   step.
+
+3. Run one additional step while you are in the source code repository
+   directory `pip install .` (note the dot at the end).
+
+4. That's all! Now, whenever you activate the virtual environment,
+   `invoke.py` will know where to look for the runtime directory without
+   needing a `--root_dir` argument. In addition, you can now move or
+   delete the source code repository entirely.
+
+   (Don't move the runtime directory!)
+
+## Updating to newer versions of the script
+
+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:
+
+```bash
+git pull
+conda env update
+python scripts/configure_invokeai.py --skip-sd-weights #optional
+```
+
+This will bring your local copy into sync with the remote one. The last step may
+be needed to take advantage of new features or released models. The
+`--skip-sd-weights` flag will prevent the script from prompting you to download
+the big Stable Diffusion weights files.
+
+## Troubleshooting
+
+Here are some common issues and their suggested solutions.
+
+### Conda
+
+#### Conda fails before completing `conda update`
+
+The usual source of these errors is a package incompatibility. While we have
+tried to minimize these, over time packages get updated and sometimes introduce
+incompatibilities.
+
+We suggest that you search
+[Issues](https://github.com/invoke-ai/InvokeAI/issues) or the "bugs-and-support"
+channel of the [InvokeAI Discord](https://discord.gg/ZmtBAhwWhy).
+
+You may also try to install the broken packages manually using PIP. To do this,
+activate the `invokeai` environment, and run `pip install` with the name and
+version of the package that is causing the incompatibility. For example:
+
+```bash
+pip install test-tube==0.7.5
+```
+
+You can keep doing this until all requirements are satisfied and the `invoke.py`
+script runs without errors. Please report to
+[Issues](https://github.com/invoke-ai/InvokeAI/issues) what you were able to do
+to work around the problem so that others can benefit from your investigation.
+
+### Create Conda Environment fails on MacOS
+
+If conda create environment fails with lmdb error, this is most likely caused by Clang.
+Run brew config to see which Clang is installed on your Mac. If Clang isn't installed, that's causing the error.
+Start by installing additional XCode command line tools, followed by brew install llvm.
+
+```bash
+xcode-select --install
+brew install llvm
+```
+
+If brew config has Clang installed, update to the latest llvm and try creating the environment again.
+
+#### `configure_invokeai.py` or `invoke.py` crashes at an early stage
+
+This is usually due to an incomplete or corrupted Conda install. Make sure you
+have linked to the correct environment file and run `conda update` again.
+
+If the problem persists, a more extreme measure is to clear Conda's caches and
+remove the `invokeai` environment:
+
+```bash
+conda deactivate
+conda env remove -n invokeai
+conda clean -a
+conda update
+```
+
+This removes all cached library files, including ones that may have been
+corrupted somehow. (This is not supposed to happen, but does anyway).
+
+#### `invoke.py` crashes at a later stage
+
+If the CLI or web site had been working ok, but something unexpected happens
+later on during the session, you've encountered a code bug that is probably
+unrelated to an install issue. Please search
+[Issues](https://github.com/invoke-ai/InvokeAI/issues), file a bug report, or
+ask for help on [Discord](https://discord.gg/ZmtBAhwWhy)
+
+#### My renders are running very slowly
+
+You may have installed the wrong torch (machine learning) package, and the
+system is running on CPU rather than the GPU. To check, look at the log messages
+that appear when `invoke.py` is first starting up. One of the earlier lines
+should say `Using device type cuda`. On AMD systems, it will also say "cuda",
+and on Macintoshes, it should say "mps". If instead the message says it is
+running on "cpu", then you may need to install the correct torch library.
+
+You may be able to fix this by installing a different torch library. Here are
+the magic incantations for Conda and PIP.
+
+!!! todo "For CUDA systems"
+
+    - conda
+
+      ```bash
+      conda install pytorch torchvision torchaudio pytorch-cuda=11.6 -c pytorch -c nvidia
+      ```
+
+    - pip
+
+      ```bash
+      pip3 install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cu116
+      ```
+
+!!! todo "For AMD systems"
+
+    - conda
+
+      ```bash
+      conda activate invokeai
+      pip3 install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/rocm5.2/
+      ```
+
+    - pip
+
+      ```bash
+      pip3 install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/rocm5.2/
+      ```
+
+More information and troubleshooting tips can be found at https://pytorch.org.

docs/installation/040_INSTALL_DOCKER.md

@@ -1,12 +1,12 @@
 ---
-title: Docker
+title: Installing with Docker
 ---
 
 # :fontawesome-brands-docker: Docker
 
 !!! warning "For end users"
 
-    We highly recommend to Install InvokeAI locally using [these instructions](index.md)"
+    We highly recommend to Install InvokeAI locally using [these instructions](index.md)
 
 !!! tip "For developers"
 
@@ -16,6 +16,10 @@ title: Docker
 
     For general use, install locally to leverage your machine's GPU.
 
+!!! tip "For running on a cloud instance/service"
+
+    Check out the [Running InvokeAI in the cloud with Docker](#running-invokeai-in-the-cloud-with-docker) section below
+
 ## Why containers?
 
 They provide a flexible, reliable way to build and deploy InvokeAI. You'll also
@@ -36,7 +40,7 @@ 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
+## Installation in a Linux container (desktop)
 
 ### Prerequisites
 
@@ -77,11 +81,12 @@ Some Suggestions of variables you may want to change besides the Token:
 | Environment-Variable | Default value                   | Description                                                                                  |
 | -------------------- | -----------------------------   | -------------------------------------------------------------------------------------------- |
 | `HUGGINGFACE_TOKEN`  | No default, but **required**!   | This is the only **required** variable, without it you can't download the huggingface models |
-| `PROJECT_NAME`       | `invokeai`                    | affects the project folder, tag- and volume name                                             |
-| `VOLUMENAME`         | `${PROJECT_NAME}_data`        | Name of the Docker Volume where model files will be stored                                   |
-| `ARCH`               | `x86_64`                      | can be changed to f.e. aarch64 if you are using a ARM based CPU                              |
-| `INVOKEAI_TAG`       | `${PROJECT_NAME}:${ARCH}`     | the Container Repository / Tag which will be used                                            |
+| `REPOSITORY_NAME`    | The Basename of the Repo folder | This name will used as the container repository/image name                                   |
+| `VOLUMENAME`         | `${REPOSITORY_NAME,,}_data`     | Name of the Docker Volume where model files will be stored                                   |
+| `ARCH`               | arch of the build machine       | can be changed if you want to build the image for another arch                               |
+| `INVOKEAI_TAG`       | latest                          | the Container Repository / Tag which will be used                                            |
 | `PIP_REQUIREMENTS`   | `requirements-lin-cuda.txt`     | the requirements file to use (from `environments-and-requirements`)                          |
+| `CONTAINER_FLAVOR`   | cuda                            | the flavor of the image, which can be changed if you build f.e. with amd requirements file.  |
 | `INVOKE_DOCKERFILE`  | `docker-build/Dockerfile`       | the Dockerfile which should be built, handy for development                                  |
 
 </figure>
@@ -123,6 +128,106 @@ also do so.
 
 ---
 
+## Running the container on your GPU
+
+If you have an Nvidia GPU, you can enable InvokeAI to run on the GPU by running the container with an extra
+environment variable to enable GPU usage and have the process run much faster:
+
+```bash
+GPU_FLAGS=all ./docker-build/run.sh
+```
+
+This passes the `--gpus all` to docker and uses the GPU.
+
+If you don't have a GPU (or your host is not yet setup to use it) you will see a message like this:
+
+`docker: Error response from daemon: could not select device driver "" with capabilities: [[gpu]].`
+
+You can use the full set of GPU combinations documented here:
+
+https://docs.docker.com/config/containers/resource_constraints/#gpu
+
+For example, use `GPU_FLAGS=device=GPU-3a23c669-1f69-c64e-cf85-44e9b07e7a2a` to choose a specific device identified by a UUID.
+
+## Running InvokeAI in the cloud with Docker
+
+We offer an optimized Ubuntu-based image that has been well-tested in cloud deployments. Note: it also works well locally on Linux x86_64 systems with an Nvidia GPU. It *may* also work on Windows under WSL2 and on Intel Mac (not tested).
+
+An advantage of this method is that it does not need any local setup or additional dependencies.
+
+See the `docker-build/Dockerfile.cloud` file to familizarize yourself with the image's content.
+
+### Prerequisites
+
+- a `docker` runtime
+- `make` (optional but helps for convenience)
+- Huggingface token to download models, or an existing InvokeAI runtime directory from a previous installation
+
+ Neither local Python nor any dependencies are required. If you don't have `make` (part of `build-essentials` on Ubuntu), or do not wish to install it, the commands from the `docker-build/Makefile` are readily adaptable to be executed directly.
+
+### Building and running the image locally
+
+1. Clone this repo and `cd docker-build`
+1. `make build` - this will build the image. (This does *not* require a GPU-capable system).
+1. _(skip this step if you already have a complete InvokeAI runtime directory)_
+    - `make configure` (This does *not* require a GPU-capable system)
+    - this will create a local cache of models and configs (a.k.a the _runtime dir_)
+    - enter your Huggingface token when prompted
+1. `make web`
+1. Open the `http://localhost:9090` URL in your browser, and enjoy the banana sushi!
+
+To use InvokeAI on the cli, run `make cli`. To open a Bash shell in the container for arbitraty advanced use, `make shell`.
+
+#### Building and running without `make`
+
+(Feel free to adapt paths such as `${HOME}/invokeai` to your liking, and modify the CLI arguments as necessary).
+
+!!! example "Build the image and configure the runtime directory"
+    ```Shell
+    cd docker-build
+
+    DOCKER_BUILDKIT=1 docker build -t local/invokeai:latest -f Dockerfile.cloud ..
+
+    docker run --rm -it -v ${HOME}/invokeai:/mnt/invokeai local/invokeai:latest -c "python scripts/configure_invokeai.py"
+    ```
+
+!!! example "Run the web server"
+    ```Shell
+    docker run --runtime=nvidia --gpus=all --rm -it -v ${HOME}/invokeai:/mnt/invokeai -p9090:9090 local/invokeai:latest
+    ```
+
+    Access the Web UI at http://localhost:9090
+
+!!! example "Run the InvokeAI interactive CLI"
+    ```
+    docker run --runtime=nvidia --gpus=all --rm -it -v ${HOME}/invokeai:/mnt/invokeai local/invokeai:latest -c "python scripts/invoke.py"
+    ```
+
+### Running the image in the cloud
+
+This image works anywhere you can run a container with a mounted Docker volume. You may either build this image on a cloud instance, or build and push it to your Docker registry. To manually run this on a cloud instance (such as AWS EC2, GCP or Azure VM):
+
+1. build this image either in the cloud (you'll need to pull the repo), or locally
+1. `docker tag` it as `your-registry/invokeai` and push to your registry (i.e. Dockerhub)
+1. `docker pull` it on your cloud instance
+1. configure the runtime directory as per above example, using `docker run ... configure_invokeai.py` script
+1. use either one of the `docker run` commands above, substituting the image name for your own image.
+
+To run this on Runpod, please refer to the following Runpod template: https://www.runpod.io/console/gpu-secure-cloud?template=vm19ukkycf (you need a Runpod subscription). When launching the template, feel free to set the image to pull your own build.
+
+The template's `README` provides ample detail, but at a high level, the process is as follows:
+
+1. create a pod using this Docker image
+1. ensure the pod has an `INVOKEAI_ROOT=<path_to_your_persistent_volume>` environment variable, and that it corresponds to the path to your pod's persistent volume mount
+1. Run the pod with `sleep infinity` as the Docker command
+1. Use Runpod basic SSH to connect to the pod, and run `python scripts/configure_invokeai.py` script
+1. Stop the pod, and change the Docker command to `python scripts/invoke.py --web --host 0.0.0.0`
+1. Run the pod again, connect to your pod on HTTP port 9090, and enjoy the banana sushi!
+
+Running on other cloud providers such as Vast.ai will likely work in a similar fashion.
+
+---
+
 !!! warning "Deprecated"
 
     From here on you will find the the previous Docker-Docs, which will still

docs/installation/050_INSTALLING_MODELS.md

@@ -56,7 +56,7 @@ unofficial Stable Diffusion models and where they can be obtained.
 
 There are three ways to install weights files:
 
-1. During InvokeAI installation, the `preload_models.py` script can download
+1. During InvokeAI installation, the `configure_invokeai.py` script can download
    them for you.
 
 2. You can use the command-line interface (CLI) to import, configure and modify
@@ -65,13 +65,13 @@ There are three ways to install weights files:
 3. You can download the files manually and add the appropriate entries to
    `models.yaml`.
 
-### Installation via `preload_models.py`
+### Installation via `configure_invokeai.py`
 
-This is the most automatic way. Run `scripts/preload_models.py` from the
+This is the most automatic way. Run `scripts/configure_invokeai.py` from the
 console. It will ask you to select which models to download and lead you through
 the steps of setting up a Hugging Face account if you haven't done so already.
 
-To start, run `python scripts/preload_models.py` from within the InvokeAI:
+To start, run `python scripts/configure_invokeai.py` from within the InvokeAI:
 directory
 
 !!! example ""
@@ -100,7 +100,7 @@ directory
         The original Stable Diffusion version 1.4 weight file (4.27 GB)
         Download? [n] n
     [4] waifu-diffusion-1.3:
-        Stable Diffusion 1.4 fine tuned on anime-styled images (4.27)
+        Stable Diffusion 1.4 fine tuned on anime-styled images (4.27 GB)
         Download? [n] y
     [5] ft-mse-improved-autoencoder-840000:
         StabilityAI improved autoencoder fine-tuned for human faces (recommended; 335 MB) (recommended)
@@ -162,6 +162,12 @@ the command-line client's `!import_model` command.
          Type a bit of the path name and hit ++tab++ in order to get a choice of
          possible completions.
 
+    !!! tip "on Windows, you can drag model files onto the command-line"
+
+         Once you have typed in `!import_model `, you can drag the model `.ckpt` file
+         onto the command-line to insert the model path. This way, you don't need to
+         type it or copy/paste.
+
 4.  Follow the wizard's instructions to complete installation as shown in the
     example here:
 
@@ -238,7 +244,7 @@ arabian-nights-1.0:
 | arabian-nights-1.0 | This is the name of the model that you will refer to from within the CLI and the WebGUI when you need to load and use the model.                                                                                                                                                                                                                                                                                                                                                                                                  |
 | description        | Any description that you want to add to the model to remind you what it is.                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | weights            | Relative path to the .ckpt weights file for this model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| config             | This is the confusingly-named configuration file for the model itself. Use `./configs/stable-diffusion/v1-inference.yaml` unless the model happens to need a custom configuration, in which case the place you downloaded it from will tell you what to use instead. For example, the runwayML custom inpainting model requires the file `configs/stable-diffusion/v1-inpainting-inference.yaml`. This is already inclued in the InvokeAI distribution and is configured automatically for you by the `preload_models.py` script. |
+| config             | This is the confusingly-named configuration file for the model itself. Use `./configs/stable-diffusion/v1-inference.yaml` unless the model happens to need a custom configuration, in which case the place you downloaded it from will tell you what to use instead. For example, the runwayML custom inpainting model requires the file `configs/stable-diffusion/v1-inpainting-inference.yaml`. This is already inclued in the InvokeAI distribution and is configured automatically for you by the `configure_invokeai.py` script. |
 | vae                | If you want to add a VAE file to the model, then enter its path here.                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | width, height      | This is the width and height of the images used to train the model. Currently they are always 512 and 512.                                                                                                                                                                                                                                                                                                                                                                                                                        |
 

docs/installation/060_INSTALL_PATCHMATCH.md

@@ -0,0 +1,115 @@
+---
+title: Installing PyPatchMatch
+---
+
+# :octicons-paintbrush-16: Installing PyPatchMatch
+
+pypatchmatch is a Python module for inpainting images. It is not
+needed to run InvokeAI, but it greatly improves the quality of
+inpainting and outpainting and is recommended.
+
+Unfortunately, it is a C++ optimized module and installation
+can be somewhat challenging. This guide leads you through the steps.
+
+## Windows
+
+You're in luck! On Windows platforms PyPatchMatch will install
+automatically on Windows systems with no extra intervention.
+
+## Macintosh
+
+PyPatchMatch is not currently supported, but the team is working on
+it.
+
+## Linux
+
+Prior to installing PyPatchMatch, you need to take the following
+steps:
+
+### Debian Based Distros
+
+
+1. Install the `build-essential` tools:
+
+   ```
+   sudo apt update
+   sudo apt install build-essential
+   ```
+
+2. Install `opencv`:
+
+   ```
+   sudo apt install python3-opencv libopencv-dev
+   ```
+
+3. Fix the naming of the `opencv` package configuration file:
+
+   ```
+   cd /usr/lib/x86_64-linux-gnu/pkgconfig/
+   ln -sf opencv4.pc opencv.pc
+   ```
+
+4. Activate the environment you use for invokeai, either with
+`conda` or with a virtual environment.
+
+5. Do a "develop" install of pypatchmatch:
+
+   ```
+   pip install "git+https://github.com/invoke-ai/PyPatchMatch@0.1.3#egg=pypatchmatch"
+   ```
+
+6. Confirm that pypatchmatch is installed.
+   At the command-line prompt enter `python`, and
+   then at the `>>>` line type `from patchmatch import patch_match`:
+   It should look like the follwing:
+
+   ```
+   Python 3.9.5 (default, Nov 23 2021, 15:27:38)
+   [GCC 9.3.0] on linux
+   Type "help", "copyright", "credits" or "license" for more information.
+   >>> from patchmatch import patch_match
+   Compiling and loading c extensions from "/home/lstein/Projects/InvokeAI/.invokeai-env/src/pypatchmatch/patchmatch".
+   rm -rf build/obj libpatchmatch.so
+   mkdir: created directory 'build/obj'
+   mkdir: created directory 'build/obj/csrc/'
+   [dep] csrc/masked_image.cpp ...
+   [dep] csrc/nnf.cpp ...
+   [dep] csrc/inpaint.cpp ...
+   [dep] csrc/pyinterface.cpp ...
+   [CC] csrc/pyinterface.cpp ...
+   [CC] csrc/inpaint.cpp ...
+   [CC] csrc/nnf.cpp ...
+   [CC] csrc/masked_image.cpp ...
+   [link] libpatchmatch.so ...
+   ```
+
+
+### Arch Based Distros
+
+1. Install the `base-devel` package:
+   ```
+   sudo pacman -Syu
+   sudo pacman -S --needed base-devel
+   ```
+
+2. Install `opencv`:
+   ```
+   sudo pacman -S opencv
+   ```
+   or for CUDA support
+   ```
+   sudo pacman -S opencv-cuda
+   ```
+
+3. Fix the naming of the `opencv` package configuration file:
+   ```
+   cd /usr/lib/pkgconfig/
+   ln -sf opencv4.pc opencv.pc
+   ```
+
+**Next, Follow Steps 4-6 from the Debian Section above**
+
+
+If you see no errors, then you're ready to go!
+
+

docs/installation/Developers_documentation/BUILDING_BINARY_INSTALLERS.md

@@ -0,0 +1,89 @@
+---
+title: build binary installers
+---
+
+# :simple-buildkite: How to build "binary" installers (InvokeAI-mac/windows/linux_on_*.zip)
+
+## 1. Ensure `installers/requirements.in` is correct
+
+and up to date on the branch to be installed.
+
+## <a name="step-2"></a> 2. Run `pip-compile` on each platform.
+
+On each target platform, in the branch that is to be installed, and
+inside the InvokeAI git root folder, run the following commands:
+
+```commandline
+conda activate invokeai # or however you activate python
+pip install pip-tools
+pip-compile --allow-unsafe --generate-hashes --output-file=binary_installer/<reqsfile>.txt binary_installer/requirements.in
+```
+where `<reqsfile>.txt` is whichever of
+```commandline
+py3.10-darwin-arm64-mps-reqs.txt
+py3.10-darwin-x86_64-reqs.txt
+py3.10-linux-x86_64-cuda-reqs.txt
+py3.10-windows-x86_64-cuda-reqs.txt
+```
+matches the current OS and architecture.
+> There is no way to cross-compile these. They must be done on a system matching the target OS and arch.
+
+## <a name="step-3"></a> 3. Set github repository and branch
+
+Once all reqs files have been collected and committed **to the branch
+to be installed**, edit `binary_installer/install.sh.in` and `binary_installer/install.bat.in` so that `RELEASE_URL`
+and `RELEASE_SOURCEBALL` point to the github repo and branch that is
+to be installed.
+
+For example, to install `main` branch of `InvokeAI`, they should be
+set as follows:
+
+`install.sh.in`:
+```commandline
+RELEASE_URL=https://github.com/invoke-ai/InvokeAI
+RELEASE_SOURCEBALL=/archive/refs/heads/main.tar.gz
+```
+
+`install.bat.in`:
+```commandline
+set RELEASE_URL=https://github.com/invoke-ai/InvokeAI
+set RELEASE_SOURCEBALL=/archive/refs/heads/main.tar.gz
+```
+
+Or, to install `damians-cool-feature` branch of `damian0815`, set them
+as follows:
+
+`install.sh.in`:
+```commandline
+RELEASE_URL=https://github.com/damian0815/InvokeAI
+RELEASE_SOURCEBALL=/archive/refs/heads/damians-cool-feature.tar.gz
+```
+
+`install.bat.in`:
+```commandline
+set RELEASE_URL=https://github.com/damian0815/InvokeAI
+set RELEASE_SOURCEBALL=/archive/refs/heads/damians-cool-feature.tar.gz
+```
+
+The branch and repo specified here **must** contain the correct reqs
+files. The installer zip files **do not** contain requirements files,
+they are pulled from the specified branch during the installation
+process.
+
+## 4. Create zip files.
+
+cd into the `installers/` folder and run
+`./create_installers.sh`. This will create
+`InvokeAI-mac_on_<branch>.zip`,
+`InvokeAI-windows_on_<branch>.zip` and
+`InvokeAI-linux_on_<branch>.zip`. These files can be distributed to end users.
+
+These zips will continue to function as installers for all future
+pushes to those branches, as long as necessary changes to
+`requirements.in` are propagated in a timely manner to the
+`py3.10-*-reqs.txt` files using pip-compile as outlined in [step
+2](#step-2).
+
+To actually install, users should unzip the appropriate zip file into an empty
+folder and run `install.sh` on macOS/Linux or `install.bat` on
+Windows.

docs/installation/INSTALL_AUTOMATED.md

@@ -0,0 +1 @@
+010_INSTALL_AUTOMATED.md

docs/installation/INSTALL_JUPYTER.md

@@ -1,27 +0,0 @@
----
-title: Running InvokeAI on Google Colab using a Jupyter Notebook
----
-
-# THIS NEEDS TO BE FLESHED OUT
-
-## Introduction
-
-We have a [Jupyter
-notebook](https://github.com/invoke-ai/InvokeAI/blob/main/notebooks/Stable-Diffusion-local-Windows.ipynb)
-with cell-by-cell installation steps. It will download the code in
-this repo as one of the steps, so instead of cloning this repo, simply
-download the notebook from the link above and load it up in VSCode
-(with the appropriate extensions installed)/Jupyter/JupyterLab and
-start running the cells one-by-one.
-
-!!! Note "you will need NVIDIA drivers, Python 3.10, and Git installed beforehand"
-
-## Walkthrough
-
-## Updating to newer versions
-
-### Updating the stable version
-
-### Updating to the development version
-
-## Troubleshooting

docs/installation/INSTALL_MANUAL.md

@@ -8,7 +8,7 @@ title: Manual Installation
 
 !!! warning "This is for advanced Users"
 
-    who are already expirienced with using conda or pip
+    who are already experienced with using conda or pip
 
 ## Introduction
 
@@ -155,10 +155,10 @@ command-line completion.
         process for this is described in [here](INSTALLING_MODELS.md).
 
     ```bash
-    python scripts/preload_models.py
+    python scripts/configure_invokeai.py
     ```
 
-    The script `preload_models.py` will interactively guide you through the
+    The script `configure_invokeai.py` will interactively guide you through the
     process of downloading and installing the weights files needed for InvokeAI.
     Note that the main Stable Diffusion weights file is protected by a license
     agreement that you have to agree to. The script will list the steps you need
@@ -220,7 +220,7 @@ greatest version, launch the Anaconda window, enter `InvokeAI` and type:
 ```bash
 git pull
 conda env update
-python scripts/preload_models.py --no-interactive  #optional
+python scripts/configure_invokeai.py --no-interactive  #optional
 ```
 
 This will bring your local copy into sync with the remote one. The last step may
@@ -359,7 +359,7 @@ brew install llvm
 
 If brew config has Clang installed, update to the latest llvm and try creating the environment again.
 
-#### `preload_models.py` or `invoke.py` crashes at an early stage
+#### `configure_invokeai.py` or `invoke.py` crashes at an early stage
 
 This is usually due to an incomplete or corrupted Conda install. Make sure you
 have linked to the correct environment file and run `conda update` again.

docs/installation/INSTALL_SOURCE.md

@@ -1,156 +0,0 @@
----
-title: Source Installer
----
-
-# The InvokeAI Source Installer
-
-## Introduction
-
-The source installer is a shell script that attempts to automate every step
-needed to install and run InvokeAI on a stock computer running recent versions
-of Linux, MacOS or Windows. It will leave you with a version that runs a stable
-version of InvokeAI with the option to upgrade to experimental versions later.
-It is not as foolproof as the [InvokeAI installer](INSTALL_INVOKE.md)
-
-Before you begin, make sure that you meet the
-[hardware requirements](index.md#Hardware_Requirements) and has the appropriate
-GPU drivers installed. In particular, if you are a Linux user with an AMD GPU
-installed, you may need to install the
-[ROCm driver](https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html).
-
-Installation requires roughly 18G of free disk space to load the libraries and
-recommended model weights files.
-
-## Walk through
-
-Though there are multiple steps, there really is only one click involved to kick
-off the process.
-
-1.  The source installer is distributed in ZIP files. Go to the
-    [latest release](https://github.com/invoke-ai/InvokeAI/releases/latest), and
-    look for a series of files named:
-
-    - invokeAI-src-installer-mac.zip
-    - invokeAI-src-installer-windows.zip
-    - invokeAI-src-installer-linux.zip
-
-    Download the one that is appropriate for your operating system.
-
-2.  Unpack the zip file into a directory that has at least 18G of free space. Do
-    _not_ unpack into a directory that has an earlier version of InvokeAI.
-
-    This will create a new directory named "InvokeAI". This example shows how
-    this would look using the `unzip` command-line tool, but you may use any
-    graphical or command-line Zip extractor:
-
-    ```cmd
-    C:\Documents\Linco> unzip invokeAI-windows.zip
-    Archive:  C: \Linco\Downloads\invokeAI-linux.zip
-    creating: invokeAI\
-    inflating: invokeAI\install.bat
-    inflating: invokeAI\readme.txt
-    ```
-
-3.  If you are using a desktop GUI, double-click the installer file. It will be
-    named `install.bat` on Windows systems and `install.sh` on Linux and
-    Macintosh systems.
-
-4.  Alternatively, form the command line, run the shell script or .bat file:
-
-    ```cmd
-    C:\Documents\Linco> cd invokeAI
-    C:\Documents\Linco\invokeAI> install.bat
-    ```
-
-5.  Sit back and let the install script work. It will install various binary
-    requirements including Conda, Git and Python, then download the current
-    InvokeAI code and install it along with its dependencies.
-
-6.  After installation completes, the installer will launch a script called
-    `preload_models.py`, which will guide you through the first-time process of
-    selecting one or more Stable Diffusion model weights files, downloading and
-    configuring them.
-
-    Note that the main Stable Diffusion weights file is protected by a license
-    agreement that you must agree to in order to use. The script will list the
-    steps you need to take to create an account on the official site that hosts
-    the weights files, accept the agreement, and provide an access token that
-    allows InvokeAI to legally download and install the weights files.
-
-    If you have already downloaded the weights file(s) for another Stable
-    Diffusion distribution, you may skip this step (by selecting "skip" when
-    prompted) and configure InvokeAI to use the previously-downloaded files. The
-    process for this is described in [Installing Models](INSTALLING_MODELS.md).
-
-7.  The script will now exit and you'll be ready to generate some images. The
-    invokeAI directory will contain numerous files. Look for a shell script
-    named `invoke.sh` (Linux/Mac) or `invoke.bat` (Windows). Launch the script
-    by double-clicking it or typing its name at the command-line:
-
-    ```cmd
-    C:\Documents\Linco> cd invokeAI
-    C:\Documents\Linco\invokeAI> invoke.bat
-    ```
-
-The `invoke.bat` (`invoke.sh`) script will give you the choice of starting (1)
-the command-line interface, or (2) the web GUI. If you start the latter, you can
-load the user interface by pointing your browser at http://localhost:9090.
-
-The `invoke` script also offers you a third option labeled "open the developer
-console". If you choose this option, you will be dropped into a command-line
-interface in which you can run python commands directly, access developer tools,
-and launch InvokeAI with customized options. To do the latter, you would launch
-the script `scripts/invoke.py` as shown in this example:
-
-```cmd
-python scripts/invoke.py --web --max_load_models=3 \
-    --model=waifu-1.3 --steps=30 --outdir=C:/Documents/AIPhotos
-```
-
-These options are described in detail in the
-[Command-Line Interface](../features/CLI.md) documentation.
-
-## Updating to newer versions
-
-This section describes how to update InvokeAI to new versions of the software.
-
-### Updating the stable version
-
-This distribution is changing rapidly, and we add new features on a daily basis.
-To update to the latest released version (recommended), run the `update.sh`
-(Linux/Mac) or `update.bat` (Windows) scripts. This will fetch the latest
-release and re-run the `preload_models` script to download any updated models
-files that may be needed. You can also use this to add additional models that
-you did not select at installation time.
-
-### Updating to the development version
-
-There may be times that there is a feature in the `development` branch of
-InvokeAI that you'd like to take advantage of. Or perhaps there is a branch that
-corrects an annoying bug. To do this, you will use the developer's console.
-
-From within the invokeAI directory, run the command `invoke.sh` (Linux/Mac) or
-`invoke.bat` (Windows) and selection option (3) to open the developers console.
-Then run the following command to get the `development branch`:
-
-```bash
-git checkout development
-git pull
-conda env update
-```
-
-You can now close the developer console and run `invoke` as before. If you get
-complaints about missing models, then you may need to do the additional step of
-running `preload_models.py`. This happens relatively infrequently. To do this,
-simply open up the developer's console again and type
-`python scripts/preload_models.py`.
-
-## Troubleshooting
-
-If you run into problems during or after installation, the InvokeAI team is
-available to help you. Either create an
-[Issue](https://github.com/invoke-ai/InvokeAI/issues) at our GitHub site, or
-make a request for help on the "bugs-and-support" channel of our
-[Discord server](https://discord.gg/ZmtBAhwWhy). We are a 100% volunteer
-organization, but typically somebody will be available to help you within 24
-hours, and often much sooner.

docs/installation/deprecated_documentation/INSTALL_BINARY.md

@@ -1,8 +1,8 @@
 ---
-title: InvokeAI Installer
+title: InvokeAI Binary Installer
 ---
 
-The InvokeAI installer is a shell script that will install InvokeAI onto a stock
+The InvokeAI binary installer is a shell script that will install InvokeAI onto a stock
 computer running recent versions of Linux, MacOSX or Windows. It will leave you
 with a version that runs a stable version of InvokeAI. When a new version of
 InvokeAI is released, you will download and reinstall the new version.
@@ -10,7 +10,7 @@ InvokeAI is released, you will download and reinstall the new version.
 If you wish to tinker with unreleased versions of InvokeAI that introduce
 potentially unstable new features, you should consider using the
 [source installer](INSTALL_SOURCE.md) or one of the
-[manual install](INSTALL_MANUAL.md) methods.
+[manual install](../020_INSTALL_MANUAL.md) methods.
 
 **Important Caveats**
   - This script does not support AMD GPUs. For Linux AMD support,
@@ -36,7 +36,7 @@ recommended model weights files.
 
 1. Download the
    [latest release](https://github.com/invoke-ai/InvokeAI/releases/latest) of
-   InvokeAI's installer for your platform
+   InvokeAI's installer for your platform. Look for a file named `InvokeAI-binary-<your platform>.zip`
 
 2. Place the downloaded package someplace where you have plenty of HDD space,
    and have full permissions (i.e. `~/` on Lin/Mac; your home folder on Windows)

docs/installation/deprecated_documentation/INSTALL_JUPYTER.md

@@ -0,0 +1,32 @@
+---
+title: Running InvokeAI on Google Colab using a Jupyter Notebook
+---
+
+## Introduction
+
+We have a [Jupyter
+notebook](https://github.com/invoke-ai/InvokeAI/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb)
+with cell-by-cell installation steps. It will download the code in
+this repo as one of the steps, so instead of cloning this repo, simply
+download the notebook from the link above and load it up in VSCode
+(with the appropriate extensions installed)/Jupyter/JupyterLab and
+start running the cells one-by-one.
+
+!!! Note "you will need NVIDIA drivers, Python 3.10, and Git installed beforehand"
+
+## Running Online On Google Colabotary
+[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/invoke-ai/InvokeAI/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb)
+
+## Running Locally (Cloning)
+
+1. Install the Jupyter Notebook python library (one-time):
+pip install jupyter
+
+2. Clone the InvokeAI repository:
+git clone https://github.com/invoke-ai/InvokeAI.git
+cd invoke-ai
+3. Create a virtual environment using conda:
+conda create -n invoke jupyter
+4. Activate the environment and start the Jupyter notebook:
+conda activate invoke
+jupyter notebook

docs/installation/deprecated_documentation/INSTALL_LINUX.md

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

docs/installation/deprecated_documentation/INSTALL_MAC.md

@@ -111,7 +111,7 @@ will do our best to help.
 
 !!! todo "Download the model weight files"
 
-    The `preload_models.py` script downloads and installs the model weight
+    The `configure_invokeai.py` script downloads and installs the model weight
     files for you. It will lead you through the process of getting a Hugging Face
     account, accepting the Stable Diffusion model weight license agreement, and
     creating a download token:
@@ -119,7 +119,7 @@ will do our best to help.
     ```bash
     # This will take some time, depending on the speed of your internet connection
     # and will consume about 10GB of space
-    python scripts/preload_models.py
+    python scripts/configure_invokeai.py
     ```
 
 !!! todo "Run InvokeAI!"
@@ -150,7 +150,7 @@ will do our best to help.
     To use an alternative model you may invoke the `!switch` command in
     the CLI, or pass `--model <model_name>` during `invoke.py` launch for
     either the CLI or the Web UI. See [Command Line
-    Client](../features/CLI.md#model-selection-and-importation). The
+    Client](../../features/CLI.md#model-selection-and-importation). The
     model names are defined in `configs/models.yaml`.
 
 ---
@@ -220,8 +220,8 @@ There are several causes of these errors:
    with "(invokeai)" then you activated it. If it begins with "(base)" or
    something else you haven't.
 
-2. You might've run `./scripts/preload_models.py` or `./scripts/invoke.py`
-   instead of `python ./scripts/preload_models.py` or
+2. You might've run `./scripts/configure_invokeai.py` or `./scripts/invoke.py`
+   instead of `python ./scripts/configure_invokeai.py` or
    `python ./scripts/invoke.py`. The cause of this error is long so it's below.
 
     <!-- I could not find out where the error is, otherwise would have marked it as a footnote -->
@@ -359,7 +359,7 @@ python ./scripts/txt2img.py \
 ### OSError: Can't load tokenizer for 'openai/clip-vit-large-patch14'
 
 ```bash
-python scripts/preload_models.py
+python scripts/configure_invokeai.py
 ```
 
 ---

docs/installation/deprecated_documentation/INSTALL_SOURCE.md

@@ -0,0 +1,225 @@
+---
+title: Source Installer
+---
+
+# The InvokeAI Source Installer
+
+## Introduction
+
+The source installer is a shell script that attempts to automate every step
+needed to install and run InvokeAI on a stock computer running recent versions
+of Linux, MacOS or Windows. It will leave you with a version that runs a stable
+version of InvokeAI with the option to upgrade to experimental versions later.
+
+Before you begin, make sure that you meet the
+[hardware requirements](../../index.md#hardware-requirements) and has the appropriate
+GPU drivers installed. In particular, if you are a Linux user with an AMD GPU
+installed, you may need to install the
+[ROCm driver](https://rocmdocs.amd.com/en/latest/Installation_Guide/Installation-Guide.html).
+
+Installation requires roughly 18G of free disk space to load the libraries and
+recommended model weights files.
+
+## Walk through
+
+Though there are multiple steps, there really is only one click involved to kick
+off the process.
+
+1.  The source installer is distributed in ZIP files. Go to the
+    [latest release](https://github.com/invoke-ai/InvokeAI/releases/latest), and
+    look for a series of files named:
+
+    - [invokeAI-src-installer-2.2.3-mac.zip](https://github.com/invoke-ai/InvokeAI/releases/latest/download/invokeAI-src-installer-2.2.3-mac.zip)
+    - [invokeAI-src-installer-2.2.3-windows.zip](https://github.com/invoke-ai/InvokeAI/releases/latest/download/invokeAI-src-installer-2.2.3-windows.zip)
+    - [invokeAI-src-installer-2.2.3-linux.zip](https://github.com/invoke-ai/InvokeAI/releases/latest/download/invokeAI-src-installer-2.2.3-linux.zip)
+
+    Download the one that is appropriate for your operating system.
+
+2.  Unpack the zip file into a directory that has at least 18G of free space. Do
+    _not_ unpack into a directory that has an earlier version of InvokeAI.
+
+    This will create a new directory named "InvokeAI". This example shows how
+    this would look using the `unzip` command-line tool, but you may use any
+    graphical or command-line Zip extractor:
+
+    ```cmd
+    C:\Documents\Linco> unzip invokeAI-windows.zip
+    Archive:  C: \Linco\Downloads\invokeAI-linux.zip
+    creating: invokeAI\
+    inflating: invokeAI\install.bat
+    inflating: invokeAI\readme.txt
+    ```
+
+3. If you are a macOS user, you may need to install the Xcode command line tools.
+   These are a set of tools that are needed to run certain applications in a Terminal,
+   including InvokeAI. This package is provided directly by Apple.
+
+   To install, open a terminal window and run `xcode-select --install`. You will get
+   a macOS system popup guiding you through the install. If you already have them
+   installed, you will instead see some output in the Terminal advising you that the
+   tools are already installed.
+
+   More information can be found here:
+   https://www.freecodecamp.org/news/install-xcode-command-line-tools/
+
+4.  If you are using a desktop GUI, double-click the installer file. It will be
+    named `install.bat` on Windows systems and `install.sh` on Linux and
+    Macintosh systems.
+
+5.  Alternatively, from the command line, run the shell script or .bat file:
+
+    ```cmd
+    C:\Documents\Linco> cd invokeAI
+    C:\Documents\Linco\invokeAI> install.bat
+    ```
+
+6.  Sit back and let the install script work. It will install various binary
+    requirements including Conda, Git and Python, then download the current
+    InvokeAI code and install it along with its dependencies.
+
+    Be aware that some of the library download and install steps take a long time.
+    In particular, the `pytorch` package is quite large and often appears to get
+    "stuck" at 99.9%. Similarly, the `pip installing requirements` step may
+    appear to hang. Have patience and the installation step will eventually
+    resume. However, there are occasions when the library install does
+    legitimately get stuck. If you have been waiting for more than ten minutes
+    and nothing is happening, you can interrupt the script with ^C. You may restart
+    it and it will pick up where it left off.
+
+7.  After installation completes, the installer will launch a script called
+    `configure_invokeai.py`, which will guide you through the first-time process of
+    selecting one or more Stable Diffusion model weights files, downloading and
+    configuring them.
+
+    Note that the main Stable Diffusion weights file is protected by a license
+    agreement that you must agree to in order to use. The script will list the
+    steps you need to take to create an account on the official site that hosts
+    the weights files, accept the agreement, and provide an access token that
+    allows InvokeAI to legally download and install the weights files.
+
+    If you have already downloaded the weights file(s) for another Stable
+    Diffusion distribution, you may skip this step (by selecting "skip" when
+    prompted) and configure InvokeAI to use the previously-downloaded files. The
+    process for this is described in [Installing Models](../050_INSTALLING_MODELS.md).
+
+8.  The script will now exit and you'll be ready to generate some images. The
+    invokeAI directory will contain numerous files. Look for a shell script
+    named `invoke.sh` (Linux/Mac) or `invoke.bat` (Windows). Launch the script
+    by double-clicking it or typing its name at the command-line:
+
+    ```cmd
+    C:\Documents\Linco> cd invokeAI
+    C:\Documents\Linco\invokeAI> invoke.bat
+    ```
+
+The `invoke.bat` (`invoke.sh`) script will give you the choice of starting (1)
+the command-line interface, or (2) the web GUI. If you start the latter, you can
+load the user interface by pointing your browser at http://localhost:9090.
+
+The `invoke` script also offers you a third option labeled "open the developer
+console". If you choose this option, you will be dropped into a command-line
+interface in which you can run python commands directly, access developer tools,
+and launch InvokeAI with customized options. To do the latter, you would launch
+the script `scripts/invoke.py` as shown in this example:
+
+```cmd
+python scripts/invoke.py --web --max_load_models=3 \
+    --model=waifu-1.3 --steps=30 --outdir=C:/Documents/AIPhotos
+```
+
+These options are described in detail in the
+[Command-Line Interface](../../features/CLI.md) documentation.
+
+## Troubleshooting
+
+_Package dependency conflicts_ If you have previously installed
+InvokeAI or another Stable Diffusion package, the installer may
+occasionally pick up outdated libraries and either the installer or
+`invoke` will fail with complaints out library conflicts. There are
+two steps you can take to clear this problem. Both of these are done
+from within the "developer's console", which you can get to by
+launching `invoke.sh` (or `invoke.bat`) and selecting launch option
+#3:
+
+1. Remove the previous `invokeai` environment completely. From within
+   the developer's console, give the command `conda env remove -n
+   invokeai`. This will delete previous files installed by `invoke`.
+
+   Then exit from the developer's console and launch the script
+   `update.sh` (or `update.bat`). This will download the most recent
+   InvokeAI (including bug fixes) and reinstall the environment.
+   You should then be able to run `invoke.sh`/`invoke.bat`.
+
+2. If this doesn't work, you can try cleaning your system's conda
+   cache. This is slightly more extreme, but won't interfere with
+   any other python-based programs installed on your computer.
+   From the developer's console, run the command `conda clean -a`
+   and answer "yes" to all prompts.
+
+   After this is done, run `update.sh` and try again as before.
+
+_"Corrupted configuration file."__ Everything seems to install ok, but
+`invoke` complains of a corrupted configuration file and goes calls
+`configure_invokeai.py` to fix, but this doesn't fix the problem.
+
+This issue is often caused by a misconfigured configuration directive
+in the `.invokeai` initialization file that contains startup settings.
+This can be corrected by fixing the offending line.
+
+First find `.invokeai`. It is a small text file located in your home
+directory, `~/.invokeai` on Mac and Linux systems, and `C:\Users\*your
+name*\.invokeai` on Windows systems. Open it with a text editor
+(e.g. Notepad on Windows, TextEdit on Macs, or `nano` on Linux)
+and look for the lines starting with `--root` and `--outdir`.
+
+An example is here:
+
+```cmd
+--root="/home/lstein/invokeai"
+--outdir="/home/lstein/invokeai/outputs"
+```
+
+There should not be whitespace before or after the directory paths,
+and the paths should not end with slashes:
+
+```cmd
+--root="/home/lstein/invokeai "     # wrong! no whitespace here
+--root="/home\lstein\invokeai\"     # wrong! shouldn't end in a slash
+```
+
+Fix the problem with your text editor and save as a **plain text**
+file. This should clear the issue.
+
+_If none of these maneuvers fixes the problem_ then please report the
+problem to the [InvokeAI
+Issues](https://github.com/invoke-ai/InvokeAI/issues) section, or
+visit our [Discord Server](https://discord.gg/ZmtBAhwWhy) for interactive assistance.
+
+## Updating to newer versions
+
+This section describes how to update InvokeAI to new versions of the software.
+
+### Updating the stable version
+
+This distribution is changing rapidly, and we add new features on a daily basis.
+To update to the latest released version (recommended), run the `update.sh`
+(Linux/Mac) or `update.bat` (Windows) scripts. This will fetch the latest
+release and re-run the `configure_invokeai` script to download any updated models
+files that may be needed. You can also use this to add additional models that
+you did not select at installation time.
+
+You can now close the developer console and run `invoke` as before. If you get
+complaints about missing models, then you may need to do the additional step of
+running `configure_invokeai.py`. This happens relatively infrequently. To do this,
+simply open up the developer's console again and type
+`python scripts/configure_invokeai.py`.
+
+## Troubleshooting
+
+If you run into problems during or after installation, the InvokeAI team is
+available to help you. Either create an
+[Issue](https://github.com/invoke-ai/InvokeAI/issues) at our GitHub site, or
+make a request for help on the "bugs-and-support" channel of our
+[Discord server](https://discord.gg/ZmtBAhwWhy). We are a 100% volunteer
+organization, but typically somebody will be available to help you within 24
+hours, and often much sooner.

docs/installation/deprecated_documentation/INSTALL_WINDOWS.md

@@ -7,7 +7,7 @@ title: Manual Installation, Windows
 ## **Notebook install (semi-automated)**
 
 We have a
-[Jupyter notebook](https://github.com/invoke-ai/InvokeAI/blob/main/notebooks/Stable-Diffusion-local-Windows.ipynb)
+[Jupyter notebook](https://github.com/invoke-ai/InvokeAI/blob/main/notebooks/Stable_Diffusion_AI_Notebook.ipynb)
 with cell-by-cell installation steps. It will download the code in this repo as
 one of the steps, so instead of cloning this repo, simply download the notebook
 from the link above and load it up in VSCode (with the appropriate extensions
@@ -65,7 +65,7 @@ Note that you will need NVIDIA drivers, Python 3.10, and Git installed beforehan
 7. Load the big stable diffusion weights files and a couple of smaller machine-learning models:
 
     ```bash
-    python scripts/preload_models.py
+    python scripts/configure_invokeai.py
     ```
 
     !!! note
@@ -75,7 +75,7 @@ Note that you will need NVIDIA drivers, Python 3.10, and Git installed beforehan
           obtaining an access token for downloading. It will then download and install the
           weights files for you.
 
-          Please look [here](INSTALLING_MODELS.md) for a manual process for doing the
+          Please look [here](../INSTALL_MANUAL.md) for a manual process for doing the
           same thing.
 
 8. Start generating images!
@@ -108,7 +108,7 @@ Note that you will need NVIDIA drivers, Python 3.10, and Git installed beforehan
         To use an alternative model you may invoke the `!switch` command in
         the CLI, or pass `--model <model_name>` during `invoke.py` launch for
         either the CLI or the Web UI. See [Command Line
-        Client](../features/CLI.md#model-selection-and-importation). The
+        Client](../../features/CLI.md#model-selection-and-importation). The
         model names are defined in `configs/models.yaml`.
 
 9. Subsequently, to relaunch the script, first activate the Anaconda

docs/installation/index.md

@@ -5,58 +5,29 @@ title: Overview
 We offer several ways to install InvokeAI, each one suited to your
 experience and preferences.
 
-1. [InvokeAI installer](INSTALL_INVOKE.md)
+1. [Automated Installer](010_INSTALL_AUTOMATED.md)
 
-    This is a installer script that installs InvokeAI and all the
-    third party libraries it depends on. When a new version of
-    InvokeAI is released, you will download and reinstall the new
-    version.
+    This is a script that will install all of InvokeAI's essential
+    third party libraries and InvokeAI itself. It includes access to a
+    "developer console" which will help us debug problems with you and
+    give you to access experimental features.
 
-    This installer is designed for people who want the system to "just
-    work", don't have an interest in tinkering with it, and do not
-    care about upgrading to unreleased experimental features.
-
-    **Important Caveats**
-    - This script does not support AMD GPUs. For Linux AMD support,
-    please use the manual or source code installer methods.
-    - This script has difficulty on some Macintosh machines
-    that have previously been used for Python development due to
-    conflicting development tools versions. Mac developers may wish
-    to try the source code installer or one of the manual methods instead.
-
-2. [Source code installer](INSTALL_SOURCE.md)
-
-    This is a script that will install InvokeAI and all its essential
-    third party libraries. In contrast to the previous installer, it
-    includes access to a "developer console" which will allow you to
-    access experimental features on the development branch.
-
-    This method is recommended for individuals who are wish to stay
-    on the cutting edge of InvokeAI development and are not afraid
-    of occasional breakage.
-
-3. [Manual Installation](INSTALL_MANUAL.md)
+2. [Manual Installation](020_INSTALL_MANUAL.md)
 
     In this method you will manually run the commands needed to install
     InvokeAI and its dependencies. We offer two recipes: one suited to
     those who prefer the `conda` tool, and one suited to those who prefer
-    `pip` and Python virtual environments.
+    `pip` and Python virtual environments. In our hands the pip install
+    is faster and more reliable, but your mileage may vary.
 
     This method is recommended for users who have previously used `conda`
     or `pip` in the past, developers, and anyone who wishes to remain on
     the cutting edge of future InvokeAI development and is willing to put
     up with occasional glitches and breakage.
 
-4. [Docker Installation](INSTALL_DOCKER.md)
+3. [Docker Installation](040_INSTALL_DOCKER.md)
 
     We also offer a method for creating Docker containers containing
     InvokeAI and its dependencies. This method is recommended for
     individuals with experience with Docker containers and understand
     the pluses and minuses of a container-based install.
-
-5. [Jupyter Notebooks Installation](INSTALL_JUPYTER.md)
-
-    This method is suitable for running InvokeAI on a Google Colab
-    account. It is recommended for individuals who have previously
-    worked on the Colab and are comfortable with the Jupyter notebook
-    environment.

docs/other/CONTRIBUTORS.md

@@ -15,16 +15,17 @@ We thank them for all of their time and hard work.
 
 ## **Current core team**
 
-* lstein (Lincoln Stein) - Co-maintainer
-* blessedcoolant - Co-maintainer
-* hipsterusername (Kent Keirsey) - Product Manager
-* psychedelicious - Web Team Leader
-* Kyle0654 (Kyle Schouviller) - Node Architect and General Backend Wizard
-* damian0815 - Attention Systems and Gameplay Engineer
-* mauwii (Matthias Wild) - Continuous integration and product maintenance engineer
-* Netsvetaev (Artur Netsvetaev) - UI/UX Developer
-* tildebyte - general gadfly and resident (self-appointed) know-it-all
-* keturn - Lead for Diffusers port
+* @lstein (Lincoln Stein) - Co-maintainer
+* @blessedcoolant - Co-maintainer
+* @hipsterusername (Kent Keirsey) - Product Manager
+* @psychedelicious - Web Team Leader
+* @Kyle0654 (Kyle Schouviller) - Node Architect and General Backend Wizard
+* @damian0815 - Attention Systems and Gameplay Engineer
+* @mauwii (Matthias Wild) - Continuous integration and product maintenance engineer
+* @Netsvetaev (Artur Netsvetaev) - UI/UX Developer
+* @tildebyte - general gadfly and resident (self-appointed) know-it-all
+* @keturn - Lead for Diffusers port
+* @ebr (Eugene Brodsky) - Cloud/DevOps/Sofware engineer; your friendly neighbourhood cluster-autoscaler
 
 ## **Contributions by**
 
@@ -74,6 +75,7 @@ We thank them for all of their time and hard work.
 - [Kent Keirsey](https://github.com/hipsterusername)
 - [psychedelicious](https://github.com/psychedelicious)
 - [damian0815](https://github.com/damian0815)
+- [Eugene Brodsky](https://github.com/ebr)
 
 ## **Original CompVis Authors**
 

docs/requirements-mkdocs.txt

@@ -1,3 +1,5 @@
 mkdocs
 mkdocs-material>=8, <9
 mkdocs-git-revision-date-localized-plugin
+mkdocs-redirects==1.2.0
+

environments-and-requirements/environment-lin-aarch64.yml

@@ -30,7 +30,6 @@ dependencies:
   - torchvision
   - transformers=4.21.3
   - pip:
-      - dependency_injector==4.40.0
       - getpass_asterisk
       - omegaconf==2.1.1
       - picklescan
@@ -42,5 +41,5 @@ dependencies:
       - git+https://github.com/Birch-san/k-diffusion.git@mps#egg=k_diffusion
       - git+https://github.com/invoke-ai/clipseg.git@relaxed-python-requirement#egg=clipseg
       - git+https://github.com/invoke-ai/GFPGAN@basicsr-1.4.2#egg=gfpgan
-      - -e git+https://github.com/invoke-ai/PyPatchMatch@0.1.4#egg=pypatchmatch
+      - git+https://github.com/invoke-ai/PyPatchMatch@0.1.5#egg=pypatchmatch
       - -e .

environments-and-requirements/environment-lin-amd.yml

@@ -10,7 +10,6 @@ dependencies:
   - pip:
     - --extra-index-url  https://download.pytorch.org/whl/rocm5.2/
     - albumentations==0.4.3
-    - dependency_injector==4.40.0
     - diffusers==0.6.0
     - einops==0.3.0
     - eventlet
@@ -44,5 +43,5 @@ dependencies:
     - git+https://github.com/Birch-san/k-diffusion.git@mps#egg=k-diffusion
     - git+https://github.com/invoke-ai/clipseg.git@relaxed-python-requirement#egg=clipseg
     - git+https://github.com/invoke-ai/GFPGAN@basicsr-1.4.2#egg=gfpgan
-    - -e git+https://github.com/invoke-ai/PyPatchMatch@0.1.4#egg=pypatchmatch
+    - git+https://github.com/invoke-ai/PyPatchMatch@0.1.5#egg=pypatchmatch
     - -e .

environments-and-requirements/environment-lin-cuda.yml

@@ -13,7 +13,6 @@ dependencies:
   - cudatoolkit=11.6
   - pip:
     - albumentations==0.4.3
-    - dependency_injector==4.40.0
     - diffusers==0.6.0
     - einops==0.3.0
     - eventlet
@@ -43,5 +42,5 @@ dependencies:
     - git+https://github.com/Birch-san/k-diffusion.git@mps#egg=k-diffusion
     - git+https://github.com/invoke-ai/clipseg.git@relaxed-python-requirement#egg=clipseg
     - git+https://github.com/invoke-ai/GFPGAN@basicsr-1.4.2#egg=gfpgan
-    - -e git+https://github.com/invoke-ai/PyPatchMatch@0.1.4#egg=pypatchmatch
+    - git+https://github.com/invoke-ai/PyPatchMatch@0.1.5#egg=pypatchmatch
     - -e .

environments-and-requirements/environment-mac.yml

@@ -59,7 +59,7 @@ dependencies:
       - git+https://github.com/Birch-san/k-diffusion.git@mps#egg=k-diffusion
       - git+https://github.com/invoke-ai/clipseg.git@relaxed-python-requirement#egg=clipseg
       - git+https://github.com/invoke-ai/GFPGAN@basicsr-1.4.2#egg=gfpgan
-      - -e git+https://github.com/invoke-ai/PyPatchMatch@0.1.4#egg=pypatchmatch
+      - git+https://github.com/invoke-ai/PyPatchMatch@0.1.5#egg=pypatchmatch
       - -e .
 variables:
   PYTORCH_ENABLE_MPS_FALLBACK: 1

environments-and-requirements/environment-win-cuda.yml

@@ -13,8 +13,6 @@ dependencies:
   - cudatoolkit=11.6
   - pip:
     - albumentations==0.4.3
-    - basicsr==1.4.1
-    - dependency_injector==4.40.0
     - diffusers==0.6.0
     - einops==0.3.0
     - eventlet
@@ -44,5 +42,5 @@ dependencies:
     - git+https://github.com/Birch-san/k-diffusion.git@mps#egg=k_diffusion
     - git+https://github.com/invoke-ai/clipseg.git@relaxed-python-requirement#egg=clipseg
     - git+https://github.com/invoke-ai/GFPGAN@basicsr-1.4.1#egg=gfpgan
-    - -e git+https://github.com/invoke-ai/PyPatchMatch@0.1.4#egg=pypatchmatch
+    - git+https://github.com/invoke-ai/PyPatchMatch@0.1.5#egg=pypatchmatch
     - -e .

environments-and-requirements/requirements-base.txt

@@ -1,22 +1,23 @@
 # pip will resolve the version which matches torch
 albumentations
-dependency_injector==4.40.0
-diffusers
+diffusers==0.10.*
 einops
 eventlet
 facexlib
 flask==2.1.3
 flask_cors==3.0.10
 flask_socketio==5.3.0
-flaskwebgui==0.3.7
+flaskwebgui==1.0.3
 getpass_asterisk
+gfpgan==1.3.8
 huggingface-hub
 imageio
 imageio-ffmpeg
 kornia
-numpy
+numpy==1.23.*
 omegaconf
 opencv-python
+picklescan
 pillow
 pip>=22
 pudb
@@ -31,11 +32,8 @@ taming-transformers-rom1504
 test-tube>=0.7.5
 torch-fidelity
 torchmetrics
-transformers==4.21.*
-picklescan
-git+https://github.com/invoke-ai/GFPGAN@basicsr-1.4.1#egg=gfpgan ; platform_system == 'Windows'
-git+https://github.com/invoke-ai/GFPGAN@basicsr-1.4.2#egg=gfpgan ; platform_system != 'Windows'
-git+https://github.com/openai/CLIP.git@main#egg=clip
-git+https://github.com/Birch-san/k-diffusion.git@mps#egg=k-diffusion
-git+https://github.com/invoke-ai/clipseg.git@relaxed-python-requirement#egg=clipseg
-git+https://github.com/invoke-ai/PyPatchMatch@0.1.4#egg=pypatchmatch
+transformers==4.25.*
+https://github.com/Birch-san/k-diffusion/archive/refs/heads/mps.zip#egg=k-diffusion
+https://github.com/invoke-ai/PyPatchMatch/archive/refs/tags/0.1.5.zip#egg=pypatchmatch
+https://github.com/openai/CLIP/archive/eaa22acb90a5876642d0507623e859909230a52d.zip#egg=clip
+https://github.com/invoke-ai/clipseg/archive/relaxed-python-requirement.zip#egg=clipseg

environments-and-requirements/requirements-lin-cuda.txt

@@ -1,2 +1,5 @@
+--extra-index-url https://download.pytorch.org/whl/cu116 --trusted-host https://download.pytorch.org
 -r environments-and-requirements/requirements-base.txt
+torch
+torchvision
 -e .

environments-and-requirements/requirements-win-colab-cuda.txt

@@ -1,7 +1,6 @@
 -r environments-and-requirements/requirements-base.txt
 # Get hardware-appropriate torch/torchvision
 --extra-index-url https://download.pytorch.org/whl/cu116 --trusted-host https://download.pytorch.org
-basicsr==1.4.1
 torch==1.12.1
 torchvision==0.13.1
 -e .

frontend/.eslintrc.cjs

@@ -1,6 +1,13 @@
 module.exports = {
-  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:react-hooks/recommended'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
   parser: '@typescript-eslint/parser',
   plugins: ['@typescript-eslint', 'eslint-plugin-react-hooks'],
   root: true,
+  rules: {
+    '@typescript-eslint/no-unused-vars': ['warn', { varsIgnorePattern: '_+' }],
+  },
 };

frontend/dist/index.html

@@ -1,18 +1,23 @@
 <!DOCTYPE html>
 <html lang="en">
+  <head>
+    <script type="module" crossorigin src="./assets/polyfills.1ff60148.js"></script>
 
-<head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>InvokeAI - A Stable Diffusion Toolkit</title>
     <link rel="shortcut icon" type="icon" href="./assets/favicon.0d253ced.ico" />
-  <script type="module" crossorigin src="./assets/index.faf4c870.js"></script>
-  <link rel="stylesheet" href="./assets/index.c609c0c8.css">
-</head>
+    <script type="module" crossorigin src="./assets/index.8ab082b4.js"></script>
+    <link rel="stylesheet" href="./assets/index.0dadf5d0.css">
+    <script type="module">try{import.meta.url;import("_").catch(()=>1);}catch(e){}window.__vite_is_modern_browser=true;</script>
+    <script type="module">!function(){if(window.__vite_is_modern_browser)return;console.warn("vite: loading legacy build because dynamic import or import.meta.url is unsupported, syntax error above should be ignored");var e=document.getElementById("vite-legacy-polyfill"),n=document.createElement("script");n.src=e.src,n.onload=function(){System.import(document.getElementById('vite-legacy-entry').getAttribute('data-src'))},document.body.appendChild(n)}();</script>
+  </head>
 
-<body>
+  <body>
     <div id="root"></div>
     
-</body>
-
+    <script nomodule>!function(){var e=document,t=e.createElement("script");if(!("noModule"in t)&&"onbeforeload"in t){var n=!1;e.addEventListener("beforeload",(function(e){if(e.target===t)n=!0;else if(!e.target.hasAttribute("nomodule")||!n)return;e.preventDefault()}),!0),t.type="module",t.src=".",e.head.appendChild(t),t.remove()}}();</script>
+    <script nomodule crossorigin id="vite-legacy-polyfill" src="./assets/polyfills-legacy-dde3a68a.js"></script>
+    <script nomodule crossorigin id="vite-legacy-entry" data-src="./assets/index-legacy-a125eeb7.js">System.import(document.getElementById('vite-legacy-entry').getAttribute('data-src'))</script>
+  </body>
 </html>

frontend/dist/locales/common/de.json

@@ -0,0 +1,54 @@
+{
+  "hotkeysLabel": "Hotkeys",
+  "themeLabel": "Thema",
+  "languagePickerLabel": "Sprachauswahl",
+  "reportBugLabel": "Fehler melden",
+  "githubLabel": "Github",
+  "discordLabel": "Discord",
+  "settingsLabel": "Einstellungen",
+  "darkTheme": "Dunkel",
+  "lightTheme": "Hell",
+  "greenTheme": "Grün",
+  "langEnglish": "Englisch",
+  "langRussian": "Russisch",
+  "langItalian": "Italienisch",
+  "langPortuguese": "Portugiesisch",
+  "langFrench": "Französich",
+  "langGerman": "Deutsch",
+  "text2img": "Text zu Bild",
+  "img2img": "Bild zu Bild",
+  "unifiedCanvas": "Unified Canvas",
+  "nodes": "Knoten",
+  "nodesDesc": "Ein knotenbasiertes System, für die Erzeugung von Bildern, ist derzeit in der Entwicklung. Bleiben Sie gespannt auf Updates zu dieser fantastischen Funktion.",
+  "postProcessing": "Nachbearbeitung",
+  "postProcessDesc1": "InvokeAI bietet eine breite Palette von Nachbearbeitungsfunktionen. Bildhochskalierung und Gesichtsrekonstruktion sind bereits in der WebUI verfügbar. Sie können sie über das Menü Erweiterte Optionen der Reiter Text in Bild und Bild in Bild aufrufen. Sie können Bilder auch direkt bearbeiten, indem Sie die Schaltflächen für Bildaktionen oberhalb der aktuellen Bildanzeige oder im Viewer verwenden.",
+  "postProcessDesc2": "Eine spezielle Benutzeroberfläche wird in Kürze veröffentlicht, um erweiterte Nachbearbeitungs-Workflows zu erleichtern.",
+  "postProcessDesc3": "Die InvokeAI Kommandozeilen-Schnittstelle bietet verschiedene andere Funktionen, darunter Embiggen.",
+  "training": "Training",
+  "trainingDesc1": "Ein spezieller Arbeitsablauf zum Trainieren Ihrer eigenen Embeddings und Checkpoints mit Textual Inversion und Dreambooth über die Weboberfläche.",
+  "trainingDesc2": "InvokeAI unterstützt bereits das Training von benutzerdefinierten Embeddings mit Textual Inversion unter Verwendung des Hauptskripts.",
+  "upload": "Upload",
+  "close": "Schließen",
+  "load": "Laden",
+  "statusConnected": "Verbunden",
+  "statusDisconnected": "Getrennt",
+  "statusError": "Fehler",
+  "statusPreparing": "Vorbereiten",
+  "statusProcessingCanceled": "Verarbeitung abgebrochen",
+  "statusProcessingComplete": "Verarbeitung komplett",
+  "statusGenerating": "Generieren",
+  "statusGeneratingTextToImage": "Erzeugen von Text zu Bild",
+  "statusGeneratingImageToImage": "Erzeugen von Bild zu Bild",
+  "statusGeneratingInpainting": "Erzeuge Inpainting",
+  "statusGeneratingOutpainting": "Erzeuge Outpainting",
+  "statusGenerationComplete": "Generierung abgeschlossen",
+  "statusIterationComplete": "Iteration abgeschlossen",
+  "statusSavingImage": "Speichere Bild",
+  "statusRestoringFaces": "Gesichter restaurieren",
+  "statusRestoringFacesGFPGAN": "Gesichter restaurieren (GFPGAN)",
+  "statusRestoringFacesCodeFormer": "Gesichter restaurieren (CodeFormer)",
+  "statusUpscaling": "Hochskalierung",
+  "statusUpscalingESRGAN": "Hochskalierung (ESRGAN)",
+  "statusLoadingModel": "Laden des Modells",
+  "statusModelChanged": "Modell Geändert"
+}

frontend/dist/locales/common/en-US.json

@@ -0,0 +1,56 @@
+{
+  "hotkeysLabel": "Hotkeys",
+  "themeLabel": "Theme",
+  "languagePickerLabel": "Language Picker",
+  "reportBugLabel": "Report Bug",
+  "githubLabel": "Github",
+  "discordLabel": "Discord",
+  "settingsLabel": "Settings",
+  "darkTheme": "Dark",
+  "lightTheme": "Light",
+  "greenTheme": "Green",
+  "langEnglish": "English",
+  "langRussian": "Russian",
+  "langItalian": "Italian",
+  "langBrPortuguese": "Portuguese (Brazilian)",
+  "langGerman": "German",
+  "langPortuguese": "Portuguese",
+  "langFrench": "French",
+  "langPolish": "Polish",
+  "text2img": "Text To Image",
+  "img2img": "Image To Image",
+  "unifiedCanvas": "Unified Canvas",
+  "nodes": "Nodes",
+  "nodesDesc": "A node based system for the generation of images is under development currently. Stay tuned for updates about this amazing feature.",
+  "postProcessing": "Post Processing",
+  "postProcessDesc1": "Invoke AI offers a wide variety of post processing features. Image Upscaling and Face Restoration are already available in the WebUI. You can access them from the Advanced Options menu of the Text To Image and Image To Image tabs. You can also process images directly, using the image action buttons above the current image display or in the viewer.",
+  "postProcessDesc2": "A dedicated UI will be released soon to facilitate more advanced post processing workflows.",
+  "postProcessDesc3": "The Invoke AI Command Line Interface offers various other features including Embiggen.",
+  "training": "Training",
+  "trainingDesc1": "A dedicated workflow for training your own embeddings and checkpoints using Textual Inversion and Dreambooth from the web interface.",
+  "trainingDesc2": "InvokeAI already supports training custom embeddings using Textual Inversion using the main script.",
+  "upload": "Upload",
+  "close": "Close",
+  "load": "Load",
+  "statusConnected": "Connected",
+  "statusDisconnected": "Disconnected",
+  "statusError": "Error",
+  "statusPreparing": "Preparing",
+  "statusProcessingCanceled": "Processing Canceled",
+  "statusProcessingComplete": "Processing Complete",
+  "statusGenerating": "Generating",
+  "statusGeneratingTextToImage": "Generating Text To Image",
+  "statusGeneratingImageToImage": "Generating Image To Image",
+  "statusGeneratingInpainting": "Generating Inpainting",
+  "statusGeneratingOutpainting": "Generating Outpainting",
+  "statusGenerationComplete": "Generation Complete",
+  "statusIterationComplete": "Iteration Complete",
+  "statusSavingImage": "Saving Image",
+  "statusRestoringFaces": "Restoring Faces",
+  "statusRestoringFacesGFPGAN": "Restoring Faces (GFPGAN)",
+  "statusRestoringFacesCodeFormer": "Restoring Faces (CodeFormer)",
+  "statusUpscaling": "Upscaling",
+  "statusUpscalingESRGAN": "Upscaling (ESRGAN)",
+  "statusLoadingModel": "Loading Model",
+  "statusModelChanged": "Model Changed"
+}

frontend/dist/locales/common/en.json

@@ -0,0 +1,57 @@
+{
+  "hotkeysLabel": "Hotkeys",
+  "themeLabel": "Theme",
+  "languagePickerLabel": "Language Picker",
+  "reportBugLabel": "Report Bug",
+  "githubLabel": "Github",
+  "discordLabel": "Discord",
+  "settingsLabel": "Settings",
+  "darkTheme": "Dark",
+  "lightTheme": "Light",
+  "greenTheme": "Green",
+  "langEnglish": "English",
+  "langRussian": "Russian",
+  "langItalian": "Italian",
+  "langBrPortuguese": "Portuguese (Brazilian)",
+  "langGerman": "German",
+  "langPortuguese": "Portuguese",
+  "langFrench": "French",
+  "langPolish": "Polish",
+  "langSimplifiedChinese": "Simplified Chinese",
+  "text2img": "Text To Image",
+  "img2img": "Image To Image",
+  "unifiedCanvas": "Unified Canvas",
+  "nodes": "Nodes",
+  "nodesDesc": "A node based system for the generation of images is under development currently. Stay tuned for updates about this amazing feature.",
+  "postProcessing": "Post Processing",
+  "postProcessDesc1": "Invoke AI offers a wide variety of post processing features. Image Upscaling and Face Restoration are already available in the WebUI. You can access them from the Advanced Options menu of the Text To Image and Image To Image tabs. You can also process images directly, using the image action buttons above the current image display or in the viewer.",
+  "postProcessDesc2": "A dedicated UI will be released soon to facilitate more advanced post processing workflows.",
+  "postProcessDesc3": "The Invoke AI Command Line Interface offers various other features including Embiggen.",
+  "training": "Training",
+  "trainingDesc1": "A dedicated workflow for training your own embeddings and checkpoints using Textual Inversion and Dreambooth from the web interface.",
+  "trainingDesc2": "InvokeAI already supports training custom embeddings using Textual Inversion using the main script.",
+  "upload": "Upload",
+  "close": "Close",
+  "load": "Load",
+  "statusConnected": "Connected",
+  "statusDisconnected": "Disconnected",
+  "statusError": "Error",
+  "statusPreparing": "Preparing",
+  "statusProcessingCanceled": "Processing Canceled",
+  "statusProcessingComplete": "Processing Complete",
+  "statusGenerating": "Generating",
+  "statusGeneratingTextToImage": "Generating Text To Image",
+  "statusGeneratingImageToImage": "Generating Image To Image",
+  "statusGeneratingInpainting": "Generating Inpainting",
+  "statusGeneratingOutpainting": "Generating Outpainting",
+  "statusGenerationComplete": "Generation Complete",
+  "statusIterationComplete": "Iteration Complete",
+  "statusSavingImage": "Saving Image",
+  "statusRestoringFaces": "Restoring Faces",
+  "statusRestoringFacesGFPGAN": "Restoring Faces (GFPGAN)",
+  "statusRestoringFacesCodeFormer": "Restoring Faces (CodeFormer)",
+  "statusUpscaling": "Upscaling",
+  "statusUpscalingESRGAN": "Upscaling (ESRGAN)",
+  "statusLoadingModel": "Loading Model",
+  "statusModelChanged": "Model Changed"
+}

frontend/dist/locales/common/fr.json

@@ -0,0 +1 @@
+{}

frontend/dist/locales/common/it.json

@@ -0,0 +1,57 @@
+{
+  "hotkeysLabel": "Tasti di scelta rapida",
+  "themeLabel": "Tema",
+  "languagePickerLabel": "Seleziona lingua",
+  "reportBugLabel": "Segnala un errore",
+  "githubLabel": "Github",
+  "discordLabel": "Discord",
+  "settingsLabel": "Impostazioni",
+  "darkTheme": "Scuro",
+  "lightTheme": "Chiaro",
+  "greenTheme": "Verde",
+  "langEnglish": "Inglese",
+  "langRussian": "Russo",
+  "langItalian": "Italiano",
+  "langBrPortuguese": "Portoghese (Brasiliano)",
+  "langGerman": "Tedesco",
+  "langPortuguese": "Portoghese",
+  "langFrench": "Francese",
+  "langPolish": "Polacco",
+  "langSimplifiedChinese": "Cinese semplificato",
+  "text2img": "Testo a Immagine",
+  "img2img": "Immagine a Immagine",
+  "unifiedCanvas": "Tela unificata",
+  "nodes": "Nodi",
+  "nodesDesc": "Attualmente è in fase di sviluppo un sistema basato su nodi per la generazione di immagini. Resta sintonizzato per gli aggiornamenti su questa fantastica funzionalità.",
+  "postProcessing": "Post-elaborazione",
+  "postProcessDesc1": "Invoke AI offre un'ampia varietà di funzionalità di post-elaborazione. Ampiamento Immagine e Restaura i  Volti sono già disponibili nell'interfaccia Web. È possibile accedervi dal menu 'Opzioni avanzate' delle schede 'Testo a Immagine' e 'Immagine a Immagine'. È inoltre possibile elaborare le immagini direttamente, utilizzando i pulsanti di azione dell'immagine sopra la visualizzazione dell'immagine corrente o nel visualizzatore.",
+  "postProcessDesc2": "Presto verrà rilasciata un'interfaccia utente dedicata per facilitare flussi di lavoro di post-elaborazione più avanzati.",
+  "postProcessDesc3": "L'interfaccia da riga di comando di 'Invoke AI' offre varie altre funzionalità tra cui Embiggen.",
+  "training": "Addestramento",
+  "trainingDesc1": "Un flusso di lavoro dedicato per addestrare i tuoi incorporamenti e checkpoint utilizzando Inversione Testuale  e Dreambooth dall'interfaccia web.",
+  "trainingDesc2": "InvokeAI supporta già l'addestramento di incorporamenti personalizzati utilizzando l'inversione testuale utilizzando lo script principale.",
+  "upload": "Caricamento",
+  "close": "Chiudi",
+  "load": "Carica",
+  "statusConnected": "Collegato",
+  "statusDisconnected": "Disconnesso",
+  "statusError": "Errore",
+  "statusPreparing": "Preparazione",
+  "statusProcessingCanceled": "Elaborazione annullata",
+  "statusProcessingComplete": "Elaborazione completata",
+  "statusGenerating": "Generazione in corso",
+  "statusGeneratingTextToImage": "Generazione da Testo a Immagine",
+  "statusGeneratingImageToImage": "Generazione da Immagine a Immagine",
+  "statusGeneratingInpainting": "Generazione Inpainting",
+  "statusGeneratingOutpainting": "Generazione Outpainting",
+  "statusGenerationComplete": "Generazione completata",
+  "statusIterationComplete": "Iterazione completata",
+  "statusSavingImage": "Salvataggio dell'immagine",
+  "statusRestoringFaces": "Restaura i volti",
+  "statusRestoringFacesGFPGAN": "Restaura volti (GFPGAN)",
+  "statusRestoringFacesCodeFormer": "Restaura volti (CodeFormer)",
+  "statusUpscaling": "Ampliamento",
+  "statusUpscalingESRGAN": "Ampliamento (ESRGAN)",
+  "statusLoadingModel": "Caricamento del modello",
+  "statusModelChanged": "Modello cambiato"
+}

frontend/dist/locales/common/pl.json

@@ -0,0 +1,54 @@
+{
+  "hotkeysLabel": "Skróty klawiszowe",
+  "themeLabel": "Motyw",
+  "languagePickerLabel": "Wybór języka",
+  "reportBugLabel": "Zgłoś błąd",
+  "githubLabel": "Github",
+  "discordLabel": "Discord",
+  "settingsLabel": "Ustawienia",
+  "darkTheme": "Ciemny",
+  "lightTheme": "Jasny",
+  "greenTheme": "Zielony",
+  "langEnglish": "Angielski",
+  "langRussian": "Rosyjski",
+  "langItalian": "Włoski",
+  "langPortuguese": "Portugalski",
+  "langFrench": "Francuski",
+  "langPolish": "Polski",
+  "text2img": "Tekst na obraz",
+  "img2img": "Obraz na obraz",
+  "unifiedCanvas": "Tryb uniwersalny",
+  "nodes": "Węzły",
+  "nodesDesc": "W tym miejscu powstanie graficzny system generowania obrazów oparty na węzłach. Jest na co czekać!",
+  "postProcessing": "Przetwarzanie końcowe",
+  "postProcessDesc1": "Invoke AI oferuje wiele opcji przetwarzania końcowego. Z poziomu przeglądarki dostępne jest już zwiększanie rozdzielczości oraz poprawianie twarzy. Znajdziesz je wśród ustawień w trybach \"Tekst na obraz\" oraz \"Obraz na obraz\". Są również obecne w pasku menu wyświetlanym nad podglądem wygenerowanego obrazu.",
+  "postProcessDesc2": "Niedługo zostanie udostępniony specjalny interfejs, który będzie oferował jeszcze więcej możliwości.",
+  "postProcessDesc3": "Z poziomu linii poleceń już teraz dostępne są inne opcje, takie jak skalowanie obrazu metodą Embiggen.",
+  "training": "Trenowanie",
+  "trainingDesc1": "W tym miejscu dostępny będzie system przeznaczony do tworzenia własnych zanurzeń (ang. embeddings) i punktów kontrolnych przy użyciu metod w rodzaju inwersji tekstowej lub Dreambooth.",
+  "trainingDesc2": "Obecnie jest możliwe tworzenie własnych zanurzeń przy użyciu skryptów wywoływanych z linii poleceń.",
+  "upload": "Prześlij",
+  "close": "Zamknij",
+  "load": "Załaduj",
+  "statusConnected": "Połączono z serwerem",
+  "statusDisconnected": "Odłączono od serwera",
+  "statusError": "Błąd",
+  "statusPreparing": "Przygotowywanie",
+  "statusProcessingCanceled": "Anulowano przetwarzanie",
+  "statusProcessingComplete": "Zakończono przetwarzanie",
+  "statusGenerating": "Przetwarzanie",
+  "statusGeneratingTextToImage": "Przetwarzanie tekstu na obraz",
+  "statusGeneratingImageToImage": "Przetwarzanie obrazu na obraz",
+  "statusGeneratingInpainting": "Przemalowywanie",
+  "statusGeneratingOutpainting": "Domalowywanie",
+  "statusGenerationComplete": "Zakończono generowanie",
+  "statusIterationComplete": "Zakończono iterację",
+  "statusSavingImage": "Zapisywanie obrazu",
+  "statusRestoringFaces": "Poprawianie twarzy",
+  "statusRestoringFacesGFPGAN": "Poprawianie twarzy (GFPGAN)",
+  "statusRestoringFacesCodeFormer": "Poprawianie twarzy (CodeFormer)",
+  "statusUpscaling": "Powiększanie obrazu",
+  "statusUpscalingESRGAN": "Powiększanie (ESRGAN)",
+  "statusLoadingModel": "Wczytywanie modelu",
+  "statusModelChanged": "Zmieniono model"
+}

frontend/dist/locales/common/pt.json

@@ -0,0 +1 @@
+{}

frontend/dist/locales/common/pt_br.json

@@ -0,0 +1,54 @@
+{
+  "hotkeysLabel": "Teclas de atalho",
+  "themeLabel": "Tema",
+  "languagePickerLabel": "Seletor de Idioma",
+  "reportBugLabel": "Relatar Bug",
+  "githubLabel": "Github",
+  "discordLabel": "Discord",
+  "settingsLabel": "Configurações",
+  "darkTheme": "Noite",
+  "lightTheme": "Dia",
+  "greenTheme": "Verde",
+  "langEnglish": "English",
+  "langRussian": "Russian",
+  "langItalian": "Italian",
+  "langBrPortuguese": "Português do Brasil",
+  "langPortuguese": "Portuguese",
+  "langFrench": "French",
+  "text2img": "Texto Para Imagem",
+  "img2img": "Imagem Para Imagem",
+  "unifiedCanvas": "Tela Unificada",
+  "nodes": "Nódulos",
+  "nodesDesc": "Um sistema baseado em nódulos para geração de imagens está em contrução. Fique ligado para atualizações sobre essa funcionalidade incrível.",
+  "postProcessing": "Pós-processamento",
+  "postProcessDesc1": "Invoke AI oferece uma variedade e funcionalidades de pós-processamento. Redimensionador de Imagem e Restauração Facial já estão disponíveis na interface. Você pode acessar elas no menu de Opções Avançadas na aba de Texto para Imagem e Imagem para Imagem. Você também pode processar imagens diretamente, usando os botões de ação de imagem acima da atual tela de imagens ou visualizador.",
+  "postProcessDesc2": "Uma interface dedicada será lançada em breve para facilitar fluxos de trabalho com opções mais avançadas de pós-processamento.",
+  "postProcessDesc3": "A interface do comando de linha da Invoke oferece várias funcionalidades incluindo Ampliação.",
+  "training": "Treinando",
+  "trainingDesc1": "Um fluxo de trabalho dedicado para treinar suas próprias incorporações e chockpoints usando Inversão Textual e Dreambooth na interface web.",
+  "trainingDesc2": "InvokeAI já suporta treinar incorporações personalizadas usando Inversão Textual com o script principal.",
+  "upload": "Enviar",
+  "close": "Fechar",
+  "load": "Carregar",
+  "statusConnected": "Conectado",
+  "statusDisconnected": "Disconectado",
+  "statusError": "Erro",
+  "statusPreparing": "Preparando",
+  "statusProcessingCanceled": "Processamento Canceledo",
+  "statusProcessingComplete": "Processamento Completo",
+  "statusGenerating": "Gerando",
+  "statusGeneratingTextToImage": "Gerando Texto Para Imagem",
+  "statusGeneratingImageToImage": "Gerando Imagem Para Imagem",
+  "statusGeneratingInpainting": "Gerando Inpainting",
+  "statusGeneratingOutpainting": "Gerando Outpainting",
+  "statusGenerationComplete": "Geração Completa",
+  "statusIterationComplete": "Iteração Completa",
+  "statusSavingImage": "Salvando Imagem",
+  "statusRestoringFaces": "Restaurando Rostos",
+  "statusRestoringFacesGFPGAN": "Restaurando Rostos (GFPGAN)",
+  "statusRestoringFacesCodeFormer": "Restaurando Rostos (CodeFormer)",
+  "statusUpscaling": "Redimensinando",
+  "statusUpscalingESRGAN": "Redimensinando (ESRGAN)",
+  "statusLoadingModel": "Carregando Modelo",
+  "statusModelChanged": "Modelo Alterado"
+}

frontend/dist/locales/common/ru.json

@@ -0,0 +1,54 @@
+{
+  "hotkeysLabel": "Горячие клавиши",
+  "themeLabel": "Тема",
+  "languagePickerLabel": "Язык",
+  "reportBugLabel": "Сообщить об ошибке",
+  "githubLabel": "Github",
+  "discordLabel": "Discord",
+  "settingsLabel": "Настройка",
+  "darkTheme": "Темная",
+  "lightTheme": "Светлая",
+  "greenTheme": "Зеленая",
+  "langEnglish": "English",
+  "langRussian": "Русский",
+  "langItalian": "Italian",
+  "langPortuguese": "Portuguese",
+  "langFrench": "French",
+  "text2img": "Изображение из текста (text2img)",
+  "img2img": "Изображение в изображение (img2img)",
+  "unifiedCanvas": "Универсальный холст",
+  "nodes": "Ноды",
+  "nodesDesc": "Cистема генерации изображений на основе нодов (узлов) уже разрабатывается. Следите за новостями об этой замечательной функции.",
+  "postProcessing": "Постобработка",
+  "postProcessDesc1": "Invoke AI предлагает широкий спектр функций постобработки. Увеличение изображения (upscale) и восстановление лиц уже доступны в интерфейсе. Получите доступ к ним из меню 'Дополнительные параметры' на вкладках 'Текст в изображение' и 'Изображение в изображение'. Обрабатывайте изображения напрямую, используя кнопки действий с изображениями над текущим изображением или в режиме просмотра.",
+  "postProcessDesc2": "В ближайшее время будет выпущен специальный интерфейс для более продвинутых процессов постобработки.",
+  "postProcessDesc3": "Интерфейс командной строки Invoke AI предлагает различные другие функции, включая увеличение Embiggen",
+  "training": "Обучение",
+  "trainingDesc1": "Специальный интерфейс для обучения собственных моделей с использованием Textual Inversion и Dreambooth",
+  "trainingDesc2": "InvokeAI уже поддерживает обучение моделей с помощью TI, через интерфейс командной строки.",
+  "upload": "Загрузить",
+  "close": "Закрыть",
+  "load": "Загрузить",
+  "statusConnected": "Подключен",
+  "statusDisconnected": "Отключен",
+  "statusError": "Ошибка",
+  "statusPreparing": "Подготовка",
+  "statusProcessingCanceled": "Обработка прервана",
+  "statusProcessingComplete": "Обработка завершена",
+  "statusGenerating": "Генерация",
+  "statusGeneratingTextToImage": "Создаем изображение из текста",
+  "statusGeneratingImageToImage": "Создаем изображение из изображения",
+  "statusGeneratingInpainting": "Дополняем внутри",
+  "statusGeneratingOutpainting": "Дорисовываем снаружи",
+  "statusGenerationComplete": "Генерация завершена",
+  "statusIterationComplete": "Итерация завершена",
+  "statusSavingImage": "Сохранение изображения",
+  "statusRestoringFaces": "Восстановление лиц",
+  "statusRestoringFacesGFPGAN": "Восстановление лиц (GFPGAN)",
+  "statusRestoringFacesCodeFormer": "Восстановление лиц (CodeFormer)",
+  "statusUpscaling": "Увеличение",
+  "statusUpscalingESRGAN": "Увеличение (ESRGAN)",
+  "statusLoadingModel": "Загрузка модели",
+  "statusModelChanged": "Модель изменена"
+}
+

frontend/dist/locales/common/zh_cn.json

@@ -0,0 +1,54 @@
+{
+  "hotkeysLabel": "快捷键",
+  "themeLabel": "主题",
+  "languagePickerLabel": "语言",
+  "reportBugLabel": "提交错误报告",
+  "githubLabel": "GitHub",
+  "discordLabel": "Discord",
+  "settingsLabel": "设置",
+  "darkTheme": "暗色",
+  "lightTheme": "亮色",
+  "greenTheme": "绿色",
+  "langEnglish": "英语",
+  "langRussian": "俄语",
+  "langItalian": "意大利语",
+  "langPortuguese": "葡萄牙语",
+  "langFrench": "法语",
+  "langChineseSimplified": "简体中文",
+  "text2img": "文字到图像",
+  "img2img": "图像到图像",
+  "unifiedCanvas": "统一画布",
+  "nodes": "节点",
+  "nodesDesc": "一个基于节点的图像生成系统目前正在开发中。请持续关注关于这一功能的更新。",
+  "postProcessing": "后期处理",
+  "postProcessDesc1": "Invoke AI 提供各种各样的后期处理功能。图像放大和面部修复在网页界面中已经可用。你可以从文本到图像和图像到图像页面的高级选项菜单中访问它们。你也可以直接使用图像显示上方或查看器中的图像操作按钮处理图像。",
+  "postProcessDesc2": "一个专门的界面将很快发布，新的界面能够处理更复杂的后期处理流程。",
+  "postProcessDesc3": "Invoke AI 命令行界面提供例如Embiggen的各种其他功能。",
+  "training": "训练",
+  "trainingDesc1": "一个专门用于从网络UI使用Textual Inversion和Dreambooth训练自己的嵌入模型和检查点的工作流程。",
+  "trainingDesc2": "InvokeAI已经支持使用主脚本中的Textual Inversion来训练自定义的嵌入模型。",
+  "upload": "上传",
+  "close": "关闭",
+  "load": "加载",
+  "statusConnected": "已连接",
+  "statusDisconnected": "未连接",
+  "statusError": "错误",
+  "statusPreparing": "准备中",
+  "statusProcessingCanceled": "处理取消",
+  "statusProcessingComplete": "处理完成",
+  "statusGenerating": "生成中",
+  "statusGeneratingTextToImage": "文字到图像生成中",
+  "statusGeneratingImageToImage": "图像到图像生成中",
+  "statusGeneratingInpainting": "生成内画中",
+  "statusGeneratingOutpainting": "生成外画中",
+  "statusGenerationComplete": "生成完成",
+  "statusIterationComplete": "迭代完成",
+  "statusSavingImage": "图像保存中",
+  "statusRestoringFaces": "脸部修复中",
+  "statusRestoringFacesGFPGAN": "脸部修复中 (GFPGAN)",
+  "statusRestoringFacesCodeFormer": "脸部修复中 (CodeFormer)",
+  "statusUpscaling": "放大中",
+  "statusUpscalingESRGAN": "放大中 (ESRGAN)",
+  "statusLoadingModel": "模型加载中",
+  "statusModelChanged": "模型已切换"
+}

frontend/dist/locales/gallery/de.json

@@ -0,0 +1,16 @@
+{
+  "generations": "Erzeugungen",
+  "showGenerations": "Zeige Erzeugnisse",
+  "uploads": "Uploads",
+  "showUploads": "Zeige Uploads",
+  "galleryImageSize": "Bildgröße",
+  "galleryImageResetSize": "Größe zurücksetzen",
+  "gallerySettings": "Galerie-Einstellungen",
+  "maintainAspectRatio": "Seitenverhältnis beibehalten",
+  "autoSwitchNewImages": "Automatisch zu neuen Bildern wechseln",
+  "singleColumnLayout": "Einspaltiges Layout",
+  "pinGallery": "Galerie anpinnen",
+  "allImagesLoaded": "Alle Bilder geladen",
+  "loadMore": "Mehr laden",
+  "noImagesInGallery": "Keine Bilder in der Galerie"
+}

frontend/dist/locales/gallery/en-US.json

@@ -0,0 +1,16 @@
+{
+  "generations": "Generations",
+  "showGenerations": "Show Generations",
+  "uploads": "Uploads",
+  "showUploads": "Show Uploads",
+  "galleryImageSize": "Image Size",
+  "galleryImageResetSize": "Reset Size",
+  "gallerySettings": "Gallery Settings",
+  "maintainAspectRatio": "Maintain Aspect Ratio",
+  "autoSwitchNewImages": "Auto-Switch to New Images",
+  "singleColumnLayout": "Single Column Layout",
+  "pinGallery": "Pin Gallery",
+  "allImagesLoaded": "All Images Loaded",
+  "loadMore": "Load More",
+  "noImagesInGallery": "No Images In Gallery"
+}

frontend/dist/locales/gallery/en.json

@@ -0,0 +1,16 @@
+{
+  "generations": "Generations",
+  "showGenerations": "Show Generations",
+  "uploads": "Uploads",
+  "showUploads": "Show Uploads",
+  "galleryImageSize": "Image Size",
+  "galleryImageResetSize": "Reset Size",
+  "gallerySettings": "Gallery Settings",
+  "maintainAspectRatio": "Maintain Aspect Ratio",
+  "autoSwitchNewImages": "Auto-Switch to New Images",
+  "singleColumnLayout": "Single Column Layout",
+  "pinGallery": "Pin Gallery",
+  "allImagesLoaded": "All Images Loaded",
+  "loadMore": "Load More",
+  "noImagesInGallery": "No Images In Gallery"
+}

frontend/dist/locales/gallery/fr.json

@@ -0,0 +1 @@
+{}

frontend/dist/locales/gallery/it.json

@@ -0,0 +1,16 @@
+{
+  "generations": "Generazioni",
+  "showGenerations": "Mostra Generazioni",
+  "uploads": "Caricamenti",
+  "showUploads": "Mostra caricamenti",
+  "galleryImageSize": "Dimensione dell'immagine",
+  "galleryImageResetSize": "Ripristina dimensioni",
+  "gallerySettings": "Impostazioni della galleria",
+  "maintainAspectRatio": "Mantenere le proporzioni",
+  "autoSwitchNewImages": "Passaggio automatico a nuove immagini",
+  "singleColumnLayout": "Layout a colonna singola",
+  "pinGallery": "Blocca la galleria",
+  "allImagesLoaded": "Tutte le immagini caricate",
+  "loadMore": "Carica di più",
+  "noImagesInGallery": "Nessuna immagine nella galleria"
+}

frontend/dist/locales/gallery/pl.json

@@ -0,0 +1,16 @@
+{
+  "generations": "Wygenerowane",
+  "showGenerations": "Pokaż wygenerowane obrazy",
+  "uploads": "Przesłane",
+  "showUploads": "Pokaż przesłane obrazy",
+  "galleryImageSize": "Rozmiar obrazów",
+  "galleryImageResetSize": "Resetuj rozmiar",
+  "gallerySettings": "Ustawienia galerii",
+  "maintainAspectRatio": "Zachowaj proporcje",
+  "autoSwitchNewImages": "Przełączaj na nowe obrazy",
+  "singleColumnLayout": "Układ jednokolumnowy",
+  "pinGallery": "Przypnij galerię",
+  "allImagesLoaded": "Koniec listy",
+  "loadMore": "Wczytaj więcej",
+  "noImagesInGallery": "Brak obrazów w galerii"
+}

frontend/dist/locales/gallery/pt.json

@@ -0,0 +1 @@
+{}

frontend/dist/locales/gallery/pt_br.json

@@ -0,0 +1,16 @@
+{
+  "generations": "Gerações",
+  "showGenerations": "Mostrar Gerações",
+  "uploads": "Enviados",
+  "showUploads": "Mostrar Enviados",
+  "galleryImageSize": "Tamanho da Imagem",
+  "galleryImageResetSize": "Resetar Imagem",
+  "gallerySettings": "Configurações de Galeria",
+  "maintainAspectRatio": "Mater Proporções",
+  "autoSwitchNewImages": "Trocar para Novas Imagens Automaticamente",
+  "singleColumnLayout": "Disposição em Coluna Única",
+  "pinGallery": "Fixar Galeria",
+  "allImagesLoaded": "Todas as Imagens Carregadas",
+  "loadMore": "Carregar Mais",
+  "noImagesInGallery": "Sem Imagens na Galeria"
+}

frontend/dist/locales/gallery/ru.json

@@ -0,0 +1,16 @@
+{
+  "generations": "Генерации",
+  "showGenerations": "Показывать генерации",
+  "uploads": "Загрузки",
+  "showUploads": "Показывать загрузки",
+  "galleryImageSize": "Размер изображений",
+  "galleryImageResetSize": "Размер по умолчанию",
+  "gallerySettings": "Настройка галереи",
+  "maintainAspectRatio": "Сохранять пропорции",
+  "autoSwitchNewImages": "Автоматически выбирать новые",
+  "singleColumnLayout": "Одна колонка",
+  "pinGallery": "Закрепить галерею",
+  "allImagesLoaded": "Все изображения загружены",
+  "loadMore": "Показать больше",
+  "noImagesInGallery": "Изображений нет"
+}

frontend/dist/locales/gallery/zh_cn.json

@@ -0,0 +1,16 @@
+{
+  "generations": "生成的图像",
+  "showGenerations": "显示生成的图像",
+  "uploads": "上传的图像",
+  "showUploads": "显示上传的图像",
+  "galleryImageSize": "预览大小",
+  "galleryImageResetSize": "重置预览大小",
+  "gallerySettings": "预览设置",
+  "maintainAspectRatio": "保持比例",
+  "autoSwitchNewImages": "自动切换到新图像",
+  "singleColumnLayout": "单列布局",
+  "pinGallery": "保持图库常开",
+  "allImagesLoaded": "所有图像加载完成",
+  "loadMore": "加载更多",
+  "noImagesInGallery": "图库中无图像"
+}