lint(api_app): replace import that was only there to test if we could do the other import

# Conflicts:
#	invokeai/app/api_app.py

.dev_scripts/diff_images.py

@@ -20,13 +20,13 @@ def calc_images_mean_L1(image1_path, image2_path):
 
 def parse_args():
     parser = argparse.ArgumentParser()
-    parser.add_argument('image1_path')
-    parser.add_argument('image2_path')
+    parser.add_argument("image1_path")
+    parser.add_argument("image2_path")
     args = parser.parse_args()
     return args
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     args = parse_args()
     mean_L1 = calc_images_mean_L1(args.image1_path, args.image2_path)
     print(mean_L1)

.git-blame-ignore-revs

@@ -1 +1,2 @@
 b3dccfaeb636599c02effc377cdd8a87d658256c
+218b6d0546b990fc449c876fb99f44b50c4daa35

.github/pull_request_template.md

@@ -5,6 +5,7 @@
 - [ ] Bug Fix
 - [ ] Optimization
 - [ ] Documentation Update
+- [ ] Community Node Submission
 
 
 ## Have you discussed this change with the InvokeAI team?
@@ -12,6 +13,11 @@
 - [ ] No, because:
 
       
+## Have you updated all relevant documentation?
+- [ ] Yes
+- [ ] No
+
+
 ## Description
 
 

.github/workflows/close-inactive-issues.yml

@@ -1,11 +1,11 @@
 name: Close inactive issues
 on:
   schedule:
-    - cron: "00 6 * * *"
+    - cron: "00 4 * * *"
 
 env:
-  DAYS_BEFORE_ISSUE_STALE: 14
-  DAYS_BEFORE_ISSUE_CLOSE: 28
+  DAYS_BEFORE_ISSUE_STALE: 30
+  DAYS_BEFORE_ISSUE_CLOSE: 14
 
 jobs:
   close-issues:
@@ -14,7 +14,7 @@ jobs:
       issues: write
       pull-requests: write
     steps:
-      - uses: actions/stale@v5
+      - uses: actions/stale@v8
         with:
           days-before-issue-stale: ${{ env.DAYS_BEFORE_ISSUE_STALE }}
           days-before-issue-close: ${{ env.DAYS_BEFORE_ISSUE_CLOSE }}
@@ -23,5 +23,6 @@ jobs:
           close-issue-message: "Due to inactivity, this issue was automatically closed. If you are still experiencing the issue, please recreate the issue."
           days-before-pr-stale: -1
           days-before-pr-close: -1
+          exempt-issue-labels: "Active Issue"
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           operations-per-run: 500

.github/workflows/lint-frontend.yml

@@ -2,8 +2,6 @@ name: Lint frontend
 
 on:
   pull_request:
-    paths:
-      - 'invokeai/frontend/web/**'
     types:
       - 'ready_for_review'
       - 'opened'
@@ -11,8 +9,6 @@ on:
   push:
     branches:
       - 'main'
-    paths:
-      - 'invokeai/frontend/web/**'
   merge_group:
   workflow_dispatch:
 

.github/workflows/mkdocs-material.yml

@@ -2,7 +2,7 @@ name: mkdocs-material
 on:
   push:
     branches:
-      - 'refs/heads/v2.3'
+      - 'refs/heads/main'
 
 permissions:
     contents: write

.github/workflows/style-checks.yml

@@ -0,0 +1,27 @@
+name: style checks
+# just formatting and flake8 for now
+# TODO: add isort later
+
+on:
+  pull_request:
+  push:
+    branches: main
+
+jobs:
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies with pip
+        run: |
+          pip install black flake8 Flake8-pyproject
+
+      # - run: isort --check-only .
+      - run: black --check .
+      - run: flake8

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

@@ -1,50 +0,0 @@
-name: Test invoke.py pip
-
-# This is a dummy stand-in for the actual tests
-# we don't need to run python tests on non-Python changes
-# But PRs require passing tests to be mergeable
-
-on:
-  pull_request:
-    paths:
-      - '**'
-      - '!pyproject.toml'
-      - '!invokeai/**'
-      - '!tests/**'
-      - 'invokeai/frontend/web/**'
-  merge_group:
-  workflow_dispatch:
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
-  cancel-in-progress: true
-
-jobs:
-  matrix:
-    if: github.event.pull_request.draft == false
-    strategy:
-      matrix:
-        python-version:
-          - '3.10'
-        pytorch:
-          - linux-cuda-11_7
-          - linux-rocm-5_2
-          - linux-cpu
-          - macos-default
-          - windows-cpu
-        include:
-          - pytorch: linux-cuda-11_7
-            os: ubuntu-22.04
-          - pytorch: linux-rocm-5_2
-            os: ubuntu-22.04
-          - pytorch: linux-cpu
-            os: ubuntu-22.04
-          - pytorch: macos-default
-            os: macOS-12
-          - pytorch: windows-cpu
-            os: windows-2022
-    name: ${{ matrix.pytorch }} on ${{ matrix.python-version }}
-    runs-on: ${{ matrix.os }}
-    steps:
-      - name: skip
-        run: echo "no build required"

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

@@ -3,16 +3,7 @@ on:
   push:
     branches:
       - 'main'
-    paths:
-      - 'pyproject.toml'
-      - 'invokeai/**'
-      - '!invokeai/frontend/web/**'
   pull_request:
-    paths:
-      - 'pyproject.toml'
-      - 'invokeai/**'
-      - 'tests/**'
-      - '!invokeai/frontend/web/**'
     types:
       - 'ready_for_review'
       - 'opened'
@@ -65,10 +56,23 @@ jobs:
         id: checkout-sources
         uses: actions/checkout@v3
 
+      - name: Check for changed python files
+        id: changed-files
+        uses: tj-actions/changed-files@v37
+        with:
+          files_yaml: |
+            python:
+              - 'pyproject.toml'
+              - 'invokeai/**'
+              - '!invokeai/frontend/web/**'
+              - 'tests/**'
+
       - name: set test prompt to main branch validation
+        if: steps.changed-files.outputs.python_any_changed == 'true'
         run: echo "TEST_PROMPTS=tests/validate_pr_prompt.txt" >> ${{ matrix.github-env }}
 
       - name: setup python
+        if: steps.changed-files.outputs.python_any_changed == 'true'
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
@@ -76,6 +80,7 @@ jobs:
           cache-dependency-path: pyproject.toml
 
       - name: install invokeai
+        if: steps.changed-files.outputs.python_any_changed == 'true'
         env:
           PIP_EXTRA_INDEX_URL: ${{ matrix.extra-index-url }}
         run: >
@@ -83,6 +88,7 @@ jobs:
           --editable=".[test]"
 
       - name: run pytest
+        if: steps.changed-files.outputs.python_any_changed == 'true'
         id: run-pytest
         run: pytest
 

.gitignore

@@ -1,23 +1,8 @@
-# ignore default image save location and model symbolic link
 .idea/
-embeddings/
-outputs/
-models/ldm/stable-diffusion-v1/model.ckpt
-**/restoration/codeformer/weights
-
-# ignore user models config
-configs/models.user.yaml
-config/models.user.yml
-invokeai.init
-.version
-.last_model
 
 # ignore the Anaconda/Miniconda installer used while building Docker image
 anaconda.sh
 
-# ignore a directory which serves as a place for initial images
-inputs/
-
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -38,7 +23,6 @@ develop-eggs/
 downloads/
 eggs/
 .eggs/
-lib/
 lib64/
 parts/
 sdist/
@@ -190,39 +174,17 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
 
-src
 **/__pycache__/
-outputs
 
-# Logs and associated folders
-# created from generated embeddings.
-logs
-testtube
-checkpoints
 # If it's a Mac
 .DS_Store
 
-invokeai/frontend/yarn.lock
-invokeai/frontend/node_modules
-
 # Let the frontend manage its own gitignore
 !invokeai/frontend/web/*
 
 # Scratch folder
 .scratch/
 .vscode/
-gfpgan/
-models/ldm/stable-diffusion-v1/*.sha256
-
-
-# GFPGAN model files
-gfpgan/
-
-# config file (will be created by installer)
-configs/models.yaml
-
-# ignore initfile
-.invokeai
 
 # ignore environment.yml and requirements.txt
 # these are links to the real files in environments-and-requirements

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+# See https://pre-commit.com/ for usage and config
+repos:
+- repo: local
+  hooks:
+  - id: black
+    name: black
+    stages: [commit]
+    language: system
+    entry: black
+    types: [python]
+
+  - id: flake8
+    name: flake8
+    stages: [commit]
+    language: system
+    entry: flake8
+    types: [python]

LICENSE-SDXL.txt

@@ -0,0 +1,290 @@
+Copyright (c) 2023 Stability AI
+CreativeML Open RAIL++-M License dated July 26, 2023
+
+Section I: PREAMBLE
+
+Multimodal generative models are being widely adopted and used, and
+have the potential to transform the way artists, among other
+individuals, conceive and benefit from AI or ML technologies as a tool
+for content creation.
+
+Notwithstanding the current and potential benefits that these
+artifacts can bring to society at large, there are also concerns about
+potential misuses of them, either due to their technical limitations
+or ethical considerations.
+
+In short, this license strives for both the open and responsible
+downstream use of the accompanying model. When it comes to the open
+character, we took inspiration from open source permissive licenses
+regarding the grant of IP rights. Referring to the downstream
+responsible use, we added use-based restrictions not permitting the
+use of the model in very specific scenarios, in order for the licensor
+to be able to enforce the license in case potential misuses of the
+Model may occur. At the same time, we strive to promote open and
+responsible research on generative models for art and content
+generation.
+
+Even though downstream derivative versions of the model could be
+released under different licensing terms, the latter will always have
+to include - at minimum - the same use-based restrictions as the ones
+in the original license (this license). We believe in the intersection
+between open and responsible AI development; thus, this agreement aims
+to strike a balance between both in order to enable responsible
+open-science in the field of AI.
+
+This CreativeML Open RAIL++-M License governs the use of the model
+(and its derivatives) and is informed by the model card associated
+with the model.
+
+NOW THEREFORE, You and Licensor agree as follows:
+
+Definitions
+
+"License" means the terms and conditions for use, reproduction, and
+Distribution as defined in this document.
+
+"Data" means a collection of information and/or content extracted from
+the dataset used with the Model, including to train, pretrain, or
+otherwise evaluate the Model. The Data is not licensed under this
+License.
+
+"Output" means the results of operating a Model as embodied in
+informational content resulting therefrom.
+
+"Model" means any accompanying machine-learning based assemblies
+(including checkpoints), consisting of learnt weights, parameters
+(including optimizer states), corresponding to the model architecture
+as embodied in the Complementary Material, that have been trained or
+tuned, in whole or in part on the Data, using the Complementary
+Material.
+
+"Derivatives of the Model" means all modifications to the Model, works
+based on the Model, or any other model which is created or initialized
+by transfer of patterns of the weights, parameters, activations or
+output of the Model, to the other model, in order to cause the other
+model to perform similarly to the Model, including - but not limited
+to - distillation methods entailing the use of intermediate data
+representations or methods based on the generation of synthetic data
+by the Model for training the other model.
+
+"Complementary Material" means the accompanying source code and
+scripts used to define, run, load, benchmark or evaluate the Model,
+and used to prepare data for training or evaluation, if any. This
+includes any accompanying documentation, tutorials, examples, etc, if
+any.
+
+"Distribution" means any transmission, reproduction, publication or
+other sharing of the Model or Derivatives of the Model to a third
+party, including providing the Model as a hosted service made
+available by electronic or other remote means - e.g. API-based or web
+access.
+
+"Licensor" means the copyright owner or entity authorized by the
+copyright owner that is granting the License, including the persons or
+entities that may have rights in the Model and/or distributing the
+Model.
+
+"You" (or "Your") means an individual or Legal Entity exercising
+permissions granted by this License and/or making use of the Model for
+whichever purpose and in any field of use, including usage of the
+Model in an end-use application - e.g. chatbot, translator, image
+generator.
+
+"Third Parties" means individuals or legal entities that are not under
+common control with Licensor or You.
+
+"Contribution" means any work of authorship, including the original
+version of the Model and any modifications or additions to that Model
+or Derivatives of the Model thereof, that is intentionally submitted
+to Licensor for inclusion in the Model by the copyright owner or by an
+individual or Legal Entity authorized to submit on behalf of the
+copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent to
+the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control
+systems, and issue tracking systems that are managed by, or on behalf
+of, the Licensor for the purpose of discussing and improving the
+Model, but excluding communication that is conspicuously marked or
+otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" means Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Model.
+
+Section II: INTELLECTUAL PROPERTY RIGHTS
+
+Both copyright and patent grants apply to the Model, Derivatives of
+the Model and Complementary Material. The Model and Derivatives of the
+Model are subject to additional terms as described in
+
+Section III.
+
+Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare, publicly display, publicly
+perform, sublicense, and distribute the Complementary Material, the
+Model, and Derivatives of the Model.
+
+Grant of Patent License. Subject to the terms and conditions of this
+License and where and as applicable, each Contributor hereby grants to
+You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this paragraph) patent license to
+make, have made, use, offer to sell, sell, import, and otherwise
+transfer the Model and the Complementary Material, where such license
+applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by
+combination of their Contribution(s) with the Model to which such
+Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a
+lawsuit) alleging that the Model and/or Complementary Material or a
+Contribution incorporated within the Model and/or Complementary
+Material constitutes direct or contributory patent infringement, then
+any patent licenses granted to You under this License for the Model
+and/or Work shall terminate as of the date such litigation is asserted
+or filed.
+
+Section III: CONDITIONS OF USAGE, DISTRIBUTION AND REDISTRIBUTION
+
+Distribution and Redistribution. You may host for Third Party remote
+access purposes (e.g. software-as-a-service), reproduce and distribute
+copies of the Model or Derivatives of the Model thereof in any medium,
+with or without modifications, provided that You meet the following
+conditions: Use-based restrictions as referenced in paragraph 5 MUST
+be included as an enforceable provision by You in any type of legal
+agreement (e.g. a license) governing the use and/or distribution of
+the Model or Derivatives of the Model, and You shall give notice to
+subsequent users You Distribute to, that the Model or Derivatives of
+the Model are subject to paragraph 5. This provision does not apply to
+the use of Complementary Material. You must give any Third Party
+recipients of the Model or Derivatives of the Model a copy of this
+License; You must cause any modified files to carry prominent notices
+stating that You changed the files; You must retain all copyright,
+patent, trademark, and attribution notices excluding those notices
+that do not pertain to any part of the Model, Derivatives of the
+Model. You may add Your own copyright statement to Your modifications
+and may provide additional or different license terms and conditions -
+respecting paragraph 4.a. - for use, reproduction, or Distribution of
+Your modifications, or for any such Derivatives of the Model as a
+whole, provided Your use, reproduction, and Distribution of the Model
+otherwise complies with the conditions stated in this License.
+
+Use-based restrictions. The restrictions set forth in Attachment A are
+considered Use-based restrictions. Therefore You cannot use the Model
+and the Derivatives of the Model for the specified restricted
+uses. You may use the Model subject to this License, including only
+for lawful purposes and in accordance with the License. Use may
+include creating any content with, finetuning, updating, running,
+training, evaluating and/or reparametrizing the Model. You shall
+require all of Your users who use the Model or a Derivative of the
+Model to comply with the terms of this paragraph (paragraph 5).
+
+The Output You Generate.  Except as set forth herein, Licensor claims
+no rights in the Output You generate using the Model. You are
+accountable for the Output you generate and its subsequent uses. No
+use of the output can contravene any provision as stated in the
+License.
+
+Section IV: OTHER PROVISIONS
+
+Updates and Runtime Restrictions. To the maximum extent permitted by
+law, Licensor reserves the right to restrict (remotely or otherwise)
+usage of the Model in violation of this License.
+
+Trademarks and related. Nothing in this License permits You to make
+use of Licensors’ trademarks, trade names, logos or to otherwise
+suggest endorsement or misrepresent the relationship between the
+parties; and any rights not expressly granted herein are reserved by
+the Licensors.
+
+Disclaimer of Warranty. Unless required by applicable law or agreed to
+in writing, Licensor provides the Model and the Complementary Material
+(and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Model, Derivatives of
+the Model, and the Complementary Material and assume any risks
+associated with Your exercise of permissions under this License.
+
+Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise, unless
+required by applicable law (such as deliberate and grossly negligent
+acts) or agreed to in writing, shall any Contributor be liable to You
+for damages, including any direct, indirect, special, incidental, or
+consequential damages of any character arising as a result of this
+License or out of the use or inability to use the Model and the
+Complementary Material (including but not limited to damages for loss
+of goodwill, work stoppage, computer failure or malfunction, or any
+and all other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+Accepting Warranty or Additional Liability. While redistributing the
+Model, Derivatives of the Model and the Complementary Material
+thereof, You may choose to offer, and charge a fee for, acceptance of
+support, warranty, indemnity, or other liability obligations and/or
+rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if
+You agree to indemnify, defend, and hold each Contributor harmless for
+any liability incurred by, or claims asserted against, such
+Contributor by reason of your accepting any such warranty or
+additional liability.
+
+If any provision of this License is held to be invalid, illegal or
+unenforceable, the remaining provisions shall be unaffected thereby
+and remain valid as if such provision had not been set forth herein.
+
+
+END OF TERMS AND CONDITIONS
+
+Attachment A
+
+Use Restrictions
+
+You agree not to use the Model or Derivatives of the Model:
+
+* In any way that violates any applicable national, federal, state,
+local or international law or regulation;
+
+* For the purpose of exploiting, harming or attempting to exploit or
+harm minors in any way;
+
+* To generate or disseminate verifiably false information and/or
+  content with the purpose of harming others;
+
+* To generate or disseminate personal identifiable information that
+  can be used to harm an individual;
+
+* To defame, disparage or otherwise harass others;
+
+* For fully automated decision making that adversely impacts an
+  individual’s legal rights or otherwise creates or modifies a
+  binding, enforceable obligation;
+
+* For any use intended to or which has the effect of discriminating
+  against or harming individuals or groups based on online or offline
+  social behavior or known or predicted personal or personality
+  characteristics;
+
+* To exploit any of the vulnerabilities of a specific group of persons
+  based on their age, social, physical or mental characteristics, in
+  order to materially distort the behavior of a person pertaining to
+  that group in a manner that causes or is likely to cause that person
+  or another person physical or psychological harm;
+
+* For any use intended to or which has the effect of discriminating
+  against individuals or groups based on legally protected
+  characteristics or categories;
+
+* To provide medical advice and medical results interpretation;
+
+* To generate or disseminate information for the purpose to be used
+  for administration of justice, law enforcement, immigration or
+  asylum processes, such as predicting an individual will commit
+  fraud/crime commitment (e.g. by text profiling, drawing causal
+  relationships between assertions made in documents, indiscriminate
+  and arbitrarily-targeted use).
+

README.md

@@ -36,15 +36,6 @@
 
 </div>
 
-_**Note: This is an alpha release. Bugs are expected and not all
-features are fully implemented. Please use the GitHub [Issues
-pages](https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen)
-to report unexpected problems. Also note that InvokeAI root directory
-which contains models, outputs and configuration files, has changed
-between the 2.x and 3.x release. If you wish to use your v2.3 root
-directory with v3.0, please follow the directions in [Migrating a 2.3
-root directory to 3.0](#migrating-to-3).**_
-
 InvokeAI is a leading creative engine built to empower professionals
 and enthusiasts alike. Generate and create stunning visual media using
 the latest AI-driven technologies. InvokeAI offers an industry leading
@@ -52,7 +43,7 @@ Web Interface, interactive Command Line Interface, and also serves as
 the foundation for multiple commercial products.
 
 **Quick links**: [[How to
-  Install](https://invoke-ai.github.io/InvokeAI/#installation)] [<a
+  Install](https://invoke-ai.github.io/InvokeAI/installation/INSTALLATION/)] [<a
   href="https://discord.gg/ZmtBAhwWhy">Discord Server</a>] [<a
   href="https://invoke-ai.github.io/InvokeAI/">Documentation and
   Tutorials</a>] [<a
@@ -90,7 +81,7 @@ Table of Contents 📝
 ## Quick Start
 
 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/INSTALLATION/)
 
 If upgrading from version 2.3, please read [Migrating a 2.3 root
 directory to 3.0](#migrating-to-3) first.
@@ -132,7 +123,7 @@ and go to http://localhost:9090.
 
 ### Command-Line Installation (for developers and users familiar with Terminals)
 
-You must have Python 3.9 or 3.10 installed on your machine. Earlier or
+You must have Python 3.9 through 3.11 installed on your machine. Earlier or
 later versions are not supported.
 Node.js also needs to be installed along with yarn (can be installed with
 the command `npm install -g yarn` if needed)
@@ -170,7 +161,7 @@ the command `npm install -g yarn` if needed)
     _For Windows/Linux with an NVIDIA GPU:_
 
     ```terminal
-    pip install "InvokeAI[xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117
+    pip install "InvokeAI[xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu118
     ```
 
     _For Linux with an AMD GPU:_
@@ -193,8 +184,9 @@ the command `npm install -g yarn` if needed)
 6. Configure InvokeAI and install a starting set of image generation models (you only need to do this once):
 
     ```terminal
-    invokeai-configure
+    invokeai-configure --root .
     ```
+	Don't miss the dot at the end!
 
 7. Launch the web server (do it every time you run InvokeAI):
 
@@ -202,15 +194,9 @@ the command `npm install -g yarn` if needed)
     invokeai-web
     ```
 
-8. Build Node.js assets
+8. Point your browser to http://localhost:9090 to bring up the web interface.
 
-  ```terminal
-  cd invokeai/frontend/web/
-  yarn vite build
-  ```
-
-9. Point your browser to http://localhost:9090 to bring up the web interface.
-10. Type `banana sushi` in the box on the top left and click `Invoke`.
+9. Type `banana sushi` in the box on the top left and click `Invoke`.
 
 Be sure to activate the virtual environment each time before re-launching InvokeAI,
 using `source .venv/bin/activate` or `.venv\Scripts\activate`.
@@ -264,19 +250,24 @@ old models directory (which contains the models selected at install
 time) will be renamed `models.orig` and can be deleted once you have
 confirmed that the migration was successful.
 
+ If you wish, you can pass the 2.3 root directory to both `--from` and
+`--to` in order to update in place. Warning: this directory will no
+longer be usable with InvokeAI 2.3.
+
 #### Migrating in place
 
 For the adventurous, you may do an in-place upgrade from 2.3 to 3.0
-without touching the command line. The recipe is as follows>
+without touching the command line. ***This recipe does not work on
+Windows platforms due to a bug in the Windows version of the 2.3
+upgrade script.** See the next section for a Windows recipe.
+
+##### For Mac and Linux Users:
 
 1. Launch the InvokeAI launcher script in your current v2.3 root directory.
 
 2. Select option [9] "Update InvokeAI" to bring up the updater dialog.
 
-3a. During the alpha release phase, select option [3] and manually
-enter the tag name `v3.0.0+a2`.
-
-3b. Once 3.0 is released, select option [1] to upgrade to the latest release.
+3. Select option [1] to upgrade to the latest release.
 
 4. Once the upgrade is finished you will be returned to the launcher
 menu. Select option [7] "Re-run the configure script to fix a broken
@@ -295,14 +286,50 @@ worked, you can safely remove these files. Alternatively you can
 restore a working v2.3 directory by removing the new files and
 restoring the ".orig" files' original names.
 
-#### Migration Caveats
+##### For Windows Users:
+
+Windows Users can upgrade with the
+
+1. Enter the 2.3 root directory you wish to upgrade
+2. Launch `invoke.sh` or `invoke.bat`
+3. Select the "Developer's console" option [8]
+4. Type the following commands
+
+```
+pip install "invokeai @ https://github.com/invoke-ai/InvokeAI/archive/refs/tags/v3.0.0" --use-pep517 --upgrade
+invokeai-configure --root .
+```
+(Replace `v3.0.0` with the current release number if this document is out of date).
+
+The first command will install and upgrade new software to run
+InvokeAI. The second will prepare the 2.3 directory for use with 3.0.
+You may now launch the WebUI in the usual way, by selecting option [1]
+from the launcher script
+
+#### Migrating Images
 
 The migration script will migrate your invokeai settings and models,
 including textual inversion models, LoRAs and merges that you may have
 installed previously. However it does **not** migrate the generated
-images stored in your 2.3-format outputs directory. The released
-version of 3.0 is expected to have an interface for importing an
-entire directory of image files as a batch.
+images stored in your 2.3-format outputs directory. To do this, you 
+need to run an additional step:
+
+1. From a working InvokeAI 3.0 root directory, start the launcher and
+enter menu option [8] to open the "developer's console".
+
+2. At the developer's console command line, type the command:
+
+```bash
+invokeai-import-images
+```
+
+3. This will lead you through the process of confirming the desired
+   source and destination for the imported images. The images will
+   appear in the gallery board of your choice, and contain the
+   original prompt, model name, and other parameters used to generate
+   the image.
+   
+(Many kudos to **techjedi** for contributing this script.)
 
 ## Hardware Requirements
 
@@ -314,9 +341,12 @@ AMD card (using the ROCm driver).
 
 You will need one of the following:
 
-- An NVIDIA-based graphics card with 4 GB or more VRAM memory.
+- An NVIDIA-based graphics card with 4 GB or more VRAM memory. 6-8 GB
+  of VRAM is highly recommended for rendering using the Stable
+  Diffusion XL models
 - An Apple computer with an M1 chip.
-- An AMD-based graphics card with 4GB or more VRAM memory. (Linux only)
+- An AMD-based graphics card with 4GB or more VRAM memory (Linux
+  only), 6-8 GB for XL rendering.
 
 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
@@ -349,13 +379,12 @@ Invoke AI provides an organized gallery system for easily storing, accessing, an
 ### Other features
 
 - *Support for both ckpt and diffusers models*
-- *SD 2.0, 2.1 support*
+- *SD 2.0, 2.1, XL support*
 - *Upscaling Tools*
 - *Embedding Manager & Support*
 - *Model Manager & Support*
 - *Node-Based Architecture*
 - *Node-Based Plug-&-Play UI (Beta)*
-- *SDXL Support* (Coming soon)
 
 ### Latest Changes
 

docker/docker-entrypoint.sh

@@ -29,8 +29,8 @@ configure() {
         echo "To reconfigure InvokeAI, delete the above file."
         echo "======================================================================"
     else
-        mkdir -p ${INVOKEAI_ROOT}
-        chown --recursive ${USER} ${INVOKEAI_ROOT}
+        mkdir -p "${INVOKEAI_ROOT}"
+        chown --recursive ${USER} "${INVOKEAI_ROOT}"
         gosu ${USER} invokeai-configure --yes --default_only
     fi
 }
@@ -50,16 +50,16 @@ fi
 if [[ -v "PUBLIC_KEY" ]] && [[ ! -d "${HOME}/.ssh" ]]; then
     apt-get update
     apt-get install -y openssh-server
-    pushd $HOME
+    pushd "$HOME"
     mkdir -p .ssh
-    echo ${PUBLIC_KEY} > .ssh/authorized_keys
+    echo "${PUBLIC_KEY}" > .ssh/authorized_keys
     chmod -R 700 .ssh
     popd
     service ssh start
 fi
 
 
-cd ${INVOKEAI_ROOT}
+cd "${INVOKEAI_ROOT}"
 
 # Run the CMD as the Container User (not root).
 exec gosu ${USER} "$@"

docs/contributing/CONTRIBUTING.md

@@ -1,42 +1,41 @@
+# How to Contribute
+
 ## Welcome to Invoke AI
-
-We're thrilled to have you here and we're excited for you to contribute. 
-
 Invoke AI originated as a project built by the community, and that vision carries forward today as we aim to build the best pro-grade tools available. We work together to incorporate the latest in AI/ML research, making these tools available in over 20 languages to artists and creatives around the world as part of our fully permissive OSS project designed for individual users to self-host and use.
 
-Here are some guidelines to help you get started:
 
-### Technical Prerequisites
+## Contributing to Invoke AI
+Anyone who wishes to contribute to InvokeAI, whether features, bug fixes, code cleanup, testing, code reviews, documentation or translation is very much encouraged to do so.
 
-Front-end: You'll need a working knowledge of React and TypeScript.
+To join, just raise your hand on the InvokeAI Discord server (#dev-chat) or the GitHub discussion board.
 
-Back-end: Depending on the scope of your contribution, you may need to know SQLite, FastAPI, Python, and Socketio. Also, a good majority of the backend logic involved in processing images is built in a modular way using a concept called "Nodes", which are isolated functions that carry out individual, discrete operations. This design allows for easy contributions of novel pipelines and capabilities.
+### Areas of contribution: 
 
-### How to Submit Contributions
+#### Development
+If you’d like to help with development, please see our [development guide](contribution_guides/development.md). If you’re unfamiliar with contributing to open source projects, there is a tutorial contained within the development guide.
 
-To start contributing, please follow these steps:
+#### Nodes
+If you’d like to help with development, please see our [nodes contribution guide](/nodes/contributingNodes). If you’re unfamiliar with contributing to open source projects, there is a tutorial contained within the development guide.
 
-1. Familiarize yourself with our roadmap and open projects to see where your skills and interests align. These documents can serve as a source of inspiration.
-2. Open a Pull Request (PR) with a clear description of the feature you're adding or the problem you're solving. Make sure your contribution aligns with the project's vision.
-3. Adhere to general best practices. This includes assuming interoperability with other nodes, keeping the scope of your functions as small as possible, and organizing your code according to our architecture documents.
+#### Documentation
+If you’d like to help with documentation, please see our [documentation guide](contribution_guides/documentation.md).
 
-### Types of Contributions We're Looking For
+#### Translation
+If you'd like to help with translation, please see our [translation guide](contribution_guides/translation.md).
 
-We welcome all contributions that improve the project. Right now, we're especially looking for:
+#### Tutorials 
+Please reach out to @imic or @hipsterusername on [Discord](https://discord.gg/ZmtBAhwWhy) to help create tutorials for InvokeAI.
 
-1. Quality of life (QOL) enhancements on the front-end.
-2. New backend capabilities added through nodes.
-3. Incorporating additional optimizations from the broader open-source software community.
+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 to become part of our contributor community.
 
-### Communication and Decision-making Process
 
-Project maintainers and code owners review PRs to ensure they align with the project's goals. They may provide design or architectural guidance, suggestions on user experience, or provide more significant feedback on the contribution itself. Expect to receive feedback on your submissions, and don't hesitate to ask questions or propose changes.
+### Contributors
 
-For more robust discussions, or if you're planning to add capabilities not currently listed on our roadmap, please reach out to us on our Discord server. That way, we can ensure your proposed contribution aligns with the project's direction before you start writing code.
+This project is a combined effort of dedicated people from across the world. [Check out the list of all these amazing people](https://invoke-ai.github.io/InvokeAI/other/CONTRIBUTORS/). We thank them for their time, hard work and effort.
 
-### Code of Conduct and Contribution Expectations
+### Code of Conduct
 
-We want everyone in our community to have a positive experience. To facilitate this, we've established a code of conduct and a statement of values that we expect all contributors to adhere to. Please take a moment to review these documents—they're essential to maintaining a respectful and inclusive environment.
+The InvokeAI community is a welcoming place, and we want your help in maintaining that. Please review our [Code of Conduct](https://github.com/invoke-ai/InvokeAI/blob/main/CODE_OF_CONDUCT.md) to learn more - it's essential to maintaining a respectful and inclusive environment.
 
 By making a contribution to this project, you certify that:
 
@@ -49,6 +48,12 @@ This disclaimer is not a license and does not grant any rights or permissions. Y
 
 This disclaimer is provided "as is" without warranty of any kind, whether expressed or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, or non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the contribution or the use or other dealings in the contribution.
 
+### Support
+
+For support, please use this repository's [GitHub Issues](https://github.com/invoke-ai/InvokeAI/issues), or join the [Discord](https://discord.gg/ZmtBAhwWhy).
+
+Original portions of the software are Copyright (c) 2023 by respective contributors.
+
 ---
 
 Remember, your contributions help make this project great. We're excited to see what you'll bring to our community!

docs/contributing/INVOCATIONS.md

@@ -270,9 +270,12 @@ new Invocation ready to be used.
 
 ![resize node editor](../assets/contributing/resize_node_editor.png)
 
-# Advanced
+## Contributing Nodes
+Once you've created a Node, the next step is to share it with the community! The best way to do this is to submit a Pull Request to add the Node to the [Community Nodes](nodes/communityNodes) list. If you're not sure how to do that, take a look a at our [contributing nodes overview](contributingNodes). 
 
-## Custom Input Fields
+## Advanced
+
+### Custom Input Fields
 
 Now that you know how to create your own Invocations, let us dive into slightly
 more advanced topics.
@@ -352,7 +355,7 @@ input field.
 We will discuss the `Config` class in extra detail later in this guide and how
 you can use it to make your Invocations more robust.
 
-## Custom Output Types
+### Custom Output Types
 
 Like with custom inputs, sometimes you might find yourself needing custom
 outputs that InvokeAI does not provide. We can easily set one up.
@@ -396,7 +399,7 @@ All set. We now have an output type that requires what we need to create a
 blank_image. And if you noticed it, we even used the `Config` class to ensure
 the fields are required.
 
-## Custom Configuration
+### Custom Configuration
 
 As you might have noticed when making inputs and outputs, we used a class called
 `Config` from _pydantic_ to further customize them. Because our inputs and
@@ -492,7 +495,7 @@ later time.
 
 # **[TODO]**
 
-## Custom Components For Frontend
+### Custom Components For Frontend
 
 Every backend input type should have a corresponding frontend component so the
 UI knows what to render when you use a particular field type.
@@ -513,7 +516,7 @@ now.
 
 ---
 
-# OLD -- TO BE DELETED OR MOVED LATER
+<!-- # OLD -- TO BE DELETED OR MOVED LATER
 
 ---
 
@@ -787,4 +790,5 @@ With the customization in place, the schema will now show these properties as
 required, obviating the need for extensive null checks in client code.
 
 See this `pydantic` issue for discussion on this solution:
-<https://github.com/pydantic/pydantic/discussions/4577>
+<https://github.com/pydantic/pydantic/discussions/4577> -->
+

docs/contributing/LOCAL_DEVELOPMENT.md

@@ -35,18 +35,17 @@ access.
 
 ## Backend
 
-The backend is contained within the `./invokeai/backend` folder structure. To
-get started however please install the development dependencies.
+The backend is contained within the `./invokeai/backend` and `./invokeai/app` directories.
+To get started please install the development dependencies.
 
 From the root of the repository run the following command. Note the use of `"`.
 
 ```zsh
-pip install ".[test]"
+pip install ".[dev,test]"
 ```
 
-This in an optional group of packages which is defined within the
-`pyproject.toml` and will be required for testing the changes you make the the
-code.
+These are optional groups of packages which are defined within the `pyproject.toml`
+and will be required for testing the changes you make to the code.
 
 ### Running Tests
 
@@ -76,6 +75,20 @@ pytest --cov; open ./coverage/html/index.html
 
     ![html-detail](../assets/contributing/html-detail.png)
 
+### Reloading Changes
+
+Experimenting with changes to the Python source code is a drag if you have to re-start the server —
+and re-load those multi-gigabyte models —
+after every change.
+
+For a faster development workflow, add the `--dev_reload` flag when starting the server.
+The server will watch for changes to all the Python files in the `invokeai` directory and apply those changes to the
+running server on the fly.
+
+This will allow you to avoid restarting the server (and reloading models) in most cases, but there are some caveats; see
+the [jurigged documentation](https://github.com/breuleux/jurigged#caveats) for details.
+
+
 ## Front End
 
 <!--#TODO: get input from blessedcoolant here, for the moment inserted the frontend README via snippets extension.-->

docs/contributing/contribution_guides/development.md

@@ -0,0 +1,91 @@
+# Development
+
+## **What do I need to know to help?**
+
+If you are looking to help to with a code contribution, InvokeAI uses several different technologies under the hood: Python (Pydantic, FastAPI, diffusers) and Typescript (React, Redux Toolkit, ChakraUI, Mantine, Konva). Familiarity with StableDiffusion and image generation concepts is helpful, but not essential. 
+
+For more information, please review our area specific documentation:
+
+* #### [InvokeAI Architecure](../ARCHITECTURE.md)
+* #### [Frontend Documentation](development_guides/contributingToFrontend.md)
+* #### [Node Documentation](../INVOCATIONS.md)
+* #### [Local Development](../LOCAL_DEVELOPMENT.md)
+
+If you don't feel ready to make a code contribution yet, no problem! You can also help out in other ways, such as [documentation](documentation.md) or [translation](translation.md).
+
+There are two paths to making a development contribution: 
+
+1. Choosing an open issue to address. Open issues can be found in the [Issues](https://github.com/invoke-ai/InvokeAI/issues?q=is%3Aissue+is%3Aopen) section of the InvokeAI repository. These are tagged by the issue type (bug, enhancement, etc.) along with the “good first issues” tag denoting if they are suitable for first time contributors.
+    1. Additional items can be found on our [roadmap](https://github.com/orgs/invoke-ai/projects/7). The roadmap is organized in terms of priority, and contains features of varying size and complexity. If there is an inflight item you’d like to help with, reach out to the contributor assigned to the item to see how you can help. 
+2. Opening a new issue or feature to add. **Please make sure you have searched through existing issues before creating new ones.**
+
+*Regardless of what you choose, please post in the  [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord before you start development in order to confirm that the issue or feature is aligned with the current direction of the project. We value our contributors time and effort and want to ensure that no one’s time is being misspent.*
+
+## Best Practices: 
+* Keep your pull requests small. Smaller pull requests are more likely to be accepted and merged
+* Comments! Commenting your code helps reviwers easily understand your contribution
+* Use Python and Typescript’s typing systems, and consider using an editor with [LSP](https://microsoft.github.io/language-server-protocol/) support to streamline development
+* Make all communications public. This ensure knowledge is shared with the whole community
+
+## **How do I make a contribution?**
+
+Never made an open source contribution before? Wondering how contributions work in our project? Here's a quick rundown!
+
+Before starting these steps, ensure you have your local environment [configured for development](../LOCAL_DEVELOPMENT.md).
+
+1.  Find a [good first issue](https://github.com/invoke-ai/InvokeAI/contribute) that you are interested in addressing or a feature that you would like to add. Then, reach out to our team in the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord to ensure you are  setup for success. 
+2. Fork the [InvokeAI](https://github.com/invoke-ai/InvokeAI) repository to your GitHub profile. This means that you will have a copy of the repository under **your-GitHub-username/InvokeAI**.
+3. Clone the repository to your local machine using:
+
+```bash
+git clone https://github.com/your-GitHub-username/InvokeAI.git
+```
+
+If you're unfamiliar with using Git through the commandline, [GitHub Desktop](https://desktop.github.com) is a easy-to-use alternative with a UI. You can do all the same steps listed here, but through the interface. 
+
+4. Create a new branch for your fix using:
+
+```bash
+git checkout -b branch-name-here
+```
+
+5. Make the appropriate changes for the issue you are trying to address or the feature that you want to add.
+6. Add the file contents of the changed files to the "snapshot" git uses to manage the state of the project, also known as the index:
+
+```bash
+git add insert-paths-of-changed-files-here
+```
+
+7. Store the contents of the index with a descriptive message.
+
+```bash
+git commit -m "Insert a short message of the changes made here"
+```
+
+8. Push the changes to the remote repository using
+
+```markdown
+git push origin branch-name-here
+```
+
+9. Submit a pull request to the **main** branch of the InvokeAI repository.
+10. Title the pull request with a short description of the changes made and the issue or bug number associated with your change. For example, you can title an issue like so "Added more log outputting to resolve #1234".
+11. In the description of the pull request, explain the changes that you made, any issues you think exist with the pull request you made, and any questions you have for the maintainer. It's OK if your pull request is not perfect (no pull request is), the reviewer will be able to help you fix any problems and improve it!
+12. Wait for the pull request to be reviewed by other collaborators.
+13. Make changes to the pull request if the reviewer(s) recommend them.
+14. Celebrate your success after your pull request is merged!
+
+If you’d like to learn more about contributing to Open Source projects, here is a [Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github). 
+
+## **Where can I go for help?**
+
+If you need help, you can ask questions in the [#dev-chat](https://discord.com/channels/1020123559063990373/1049495067846524939) channel of the Discord.
+
+For frontend related work, **@pyschedelicious** is the best person to reach out to. 
+
+For backend related work, please reach out to **@blessedcoolant**, **@lstein**, **@StAlKeR7779** or **@pyschedelicious**.
+
+## **What does the Code of Conduct mean for me?**
+
+Our [Code of Conduct](CODE_OF_CONDUCT.md)  means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code.
+

docs/contributing/contribution_guides/development_guides/contributingToFrontend.md

@@ -0,0 +1,75 @@
+# Contributing to the Frontend
+
+# InvokeAI Web UI
+
+- [InvokeAI Web UI](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#invokeai-web-ui)
+    - [Stack](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#stack)
+    - [Contributing](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#contributing)
+        - [Dev Environment](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#dev-environment)
+        - [Production builds](https://github.com/invoke-ai/InvokeAI/tree/main/invokeai/frontend/web/docs#production-builds)
+
+The UI is a fairly straightforward Typescript React app, with the Unified Canvas being more complex.
+
+Code is located in `invokeai/frontend/web/` for review.
+
+## Stack
+
+State management is Redux via [Redux Toolkit](https://github.com/reduxjs/redux-toolkit). We lean heavily on RTK:
+
+- `createAsyncThunk` for HTTP requests
+- `createEntityAdapter` for fetching images and models
+- `createListenerMiddleware` for workflows
+
+The API client and associated types are generated from the OpenAPI schema. See API_CLIENT.md.
+
+Communication with server is a mix of HTTP and [socket.io](https://github.com/socketio/socket.io-client) (with a simple socket.io redux middleware to help).
+
+[Chakra-UI](https://github.com/chakra-ui/chakra-ui) & [Mantine](https://github.com/mantinedev/mantine) for components and styling.
+
+[Konva](https://github.com/konvajs/react-konva) for the canvas, but we are pushing the limits of what is feasible with it (and HTML canvas in general). We plan to rebuild it with [PixiJS](https://github.com/pixijs/pixijs) to take advantage of WebGL's improved raster handling.
+
+[Vite](https://vitejs.dev/) for bundling.
+
+Localisation is via [i18next](https://github.com/i18next/react-i18next), but translation happens on our [Weblate](https://hosted.weblate.org/engage/invokeai/) project. Only the English source strings should be changed on this repo.
+
+## Contributing
+
+Thanks for your interest in contributing to the InvokeAI Web UI!
+
+We encourage you to ping @psychedelicious and @blessedcoolant on [Discord](https://discord.gg/ZmtBAhwWhy) if you want to contribute, just to touch base and ensure your work doesn't conflict with anything else going on. The project is very active.
+
+### Dev Environment
+
+**Setup** 
+
+1. Install [node](https://nodejs.org/en/download/). You can confirm node is installed with:
+```bash
+node --version
+```
+2. Install [yarn classic](https://classic.yarnpkg.com/lang/en/) and confirm it is installed by running this:
+```bash
+npm install --global yarn
+yarn --version
+```
+
+From `invokeai/frontend/web/` run `yarn install` to get everything set up.
+
+Start everything in dev mode:
+1. Ensure your virtual environment is running
+2. Start the dev server: `yarn dev`
+3. Start the InvokeAI Nodes backend: `python scripts/invokeai-web.py # run from the repo root`
+4. Point your browser to the dev server address e.g. [http://localhost:5173/](http://localhost:5173/)
+
+### VSCode Remote Dev
+
+We've noticed an intermittent issue with the VSCode Remote Dev port forwarding. If you use this feature of VSCode, you may intermittently click the Invoke button and then get nothing until the request times out. Suggest disabling the IDE's port forwarding feature and doing it manually via SSH:
+
+`ssh -L 9090:localhost:9090 -L 5173:localhost:5173 user@host`
+
+### Production builds
+
+For a number of technical and logistical reasons, we need to commit UI build artefacts to the repo.
+
+If you submit a PR, there is a good chance we will ask you to include a separate commit with a build of the app.
+
+To build for production, run `yarn build`.

docs/contributing/contribution_guides/documentation.md

@@ -0,0 +1,13 @@
+# Documentation
+
+Documentation is an important part of any open source project. It provides a clear and concise way to communicate how the software works, how to use it, and how to troubleshoot issues. Without proper documentation, it can be difficult for users to understand the purpose and functionality of the project. 
+
+## Contributing
+
+All documentation is maintained in the InvokeAI GitHub repository. If you come across documentation that is out of date or incorrect, please submit a pull request with the necessary changes. 
+
+When updating or creating documentation, please keep in mind InvokeAI is a tool for everyone, not just those who have familiarity with generative art. 
+
+## Help & Questions
+
+Please ping @imic1 or @hipsterusername in the [Discord](https://discord.com/channels/1020123559063990373/1049495067846524939) if you have any questions.

docs/contributing/contribution_guides/translation.md

@@ -0,0 +1,19 @@
+# Translation
+
+InvokeAI uses [Weblate](https://weblate.org/) for translation. Weblate is a FOSS project providing a scalable translation service. Weblate automates the tedious parts of managing translation of a growing project, and the service is generously provided at no cost to FOSS projects like InvokeAI.
+
+## Contributing
+
+If you'd like to contribute by adding or updating a translation, please visit our [Weblate project](https://hosted.weblate.org/engage/invokeai/). You'll need to sign in with your GitHub account (a number of other accounts are supported, including Google).
+
+Once signed in, select a language and then the Web UI component. From here you can Browse and Translate strings from English to your chosen language. Zen mode offers a simpler translation experience.
+
+Your changes will be attributed to you in the automated PR process; you don't need to do anything else.
+
+## Help & Questions
+
+Please check Weblate's [documentation](https://docs.weblate.org/en/latest/index.html) or ping @Harvestor on [Discord](https://discord.com/channels/1020123559063990373/1049495067846524939) if you have any questions.
+
+## Thanks
+
+Thanks to the InvokeAI community for their efforts to translate the project!

docs/contributing/contribution_guides/tutorials.md

@@ -0,0 +1,11 @@
+# Tutorials
+
+Tutorials help new & existing users expand their abilty to use InvokeAI to the full extent of our features and services.  
+
+Currently, we have a set of tutorials available on our [YouTube channel](https://www.youtube.com/@invokeai), but as InvokeAI continues to evolve with new updates, we want to ensure that we are giving our users the resources they need to succeed. 
+
+Tutorials can be in the form of videos or article walkthroughs on a subject of your choice. We recommend focusing tutorials on the key image generation methods, or on a specific component within one of the image generation methods.
+
+## Contributing
+
+Please reach out to @imic or @hipsterusername on [Discord](https://discord.gg/ZmtBAhwWhy) to help create tutorials for InvokeAI.

docs/features/CONCEPTS.md

@@ -1,8 +1,8 @@
 ---
-title: Concepts 
+title: Textual Inversion Embeddings and LoRAs
 ---
 
-# :material-library-shelves: The Hugging Face Concepts Library and Importing Textual Inversion files
+# :material-library-shelves: Textual Inversions and LoRAs
 
 With the advances in research, many new capabilities are available to customize the knowledge and understanding of novel concepts not originally contained in the base model. 
 
@@ -64,21 +64,25 @@ select the embedding you'd like to use. This UI has type-ahead support, so you c
 
 ## Using LoRAs
 
-LoRA files are models that customize the output of Stable Diffusion image generation.
-Larger than embeddings, but much smaller than full models, they augment SD with improved
-understanding of subjects and artistic styles.
+LoRA files are models that customize the output of Stable Diffusion
+image generation.  Larger than embeddings, but much smaller than full
+models, they augment SD with improved understanding of subjects and
+artistic styles.
 
-Unlike TI files, LoRAs do not introduce novel vocabulary into the model's known tokens. Instead,
-LoRAs augment the model's weights that are applied to generate imagery. LoRAs may be supplied
-with a "trigger" word that they have been explicitly trained on, or may simply apply their 
-effect without being triggered.
+Unlike TI files, LoRAs do not introduce novel vocabulary into the
+model's known tokens. Instead, LoRAs augment the model's weights that
+are applied to generate imagery. LoRAs may be supplied with a
+"trigger" word that they have been explicitly trained on, or may
+simply apply their effect without being triggered.
 
-LoRAs are typically stored in .safetensors files, which are the most secure way to store and transmit
-these types of weights. You may install any number of `.safetensors` LoRA files simply by copying them into
-the `lora` directory of the corresponding InvokeAI models directory (usually `invokeai`
-in your home directory). For example, you can simply move a Stable Diffusion 1.5 LoRA file to
-the `sd-1/lora` folder.
+LoRAs are typically stored in .safetensors files, which are the most
+secure way to store and transmit these types of weights. You may
+install any number of `.safetensors` LoRA files simply by copying them
+into the `autoimport/lora` directory of the corresponding InvokeAI models
+directory (usually `invokeai` in your home directory).
 
-To use these when generating, open the LoRA menu item in the options panel, select the LoRAs you want to apply
-and ensure that they have the appropriate weight recommended by the model provider. Typically, most LoRAs perform best at a weight of .75-1. 
+To use these when generating, open the LoRA menu item in the options
+panel, select the LoRAs you want to apply and ensure that they have
+the appropriate weight recommended by the model provider. Typically,
+most LoRAs perform best at a weight of .75-1.
 

docs/features/CONFIGURATION.md

@@ -65,7 +65,6 @@ InvokeAI:
     esrgan: true
     internet_available: true
     log_tokenization: false
-    nsfw_checker: false
     patchmatch: true
     restore: true
 ...
@@ -136,19 +135,16 @@ command-line options by giving the `--help` argument:
 
 ```
 (.venv) > invokeai-web --help
-usage: InvokeAI [-h] [--host HOST] [--port PORT] [--allow_origins [ALLOW_ORIGINS ...]] [--allow_credentials | --no-allow_credentials]
-                [--allow_methods [ALLOW_METHODS ...]] [--allow_headers [ALLOW_HEADERS ...]] [--esrgan | --no-esrgan]
-                [--internet_available | --no-internet_available] [--log_tokenization | --no-log_tokenization]
-                [--nsfw_checker | --no-nsfw_checker] [--patchmatch | --no-patchmatch] [--restore | --no-restore]
-                [--always_use_cpu | --no-always_use_cpu] [--free_gpu_mem | --no-free_gpu_mem] [--max_cache_size MAX_CACHE_SIZE]
-                [--max_vram_cache_size MAX_VRAM_CACHE_SIZE] [--precision {auto,float16,float32,autocast}]
-                [--sequential_guidance | --no-sequential_guidance] [--xformers_enabled | --no-xformers_enabled]
-                [--tiled_decode | --no-tiled_decode] [--root ROOT] [--autoimport_dir AUTOIMPORT_DIR] [--lora_dir LORA_DIR]
-                [--embedding_dir EMBEDDING_DIR] [--controlnet_dir CONTROLNET_DIR] [--conf_path CONF_PATH] [--models_dir MODELS_DIR]
-                [--legacy_conf_dir LEGACY_CONF_DIR] [--db_dir DB_DIR] [--outdir OUTDIR] [--from_file FROM_FILE]
-                [--use_memory_db | --no-use_memory_db] [--model MODEL] [--log_handlers [LOG_HANDLERS ...]]
-                [--log_format {plain,color,syslog,legacy}] [--log_level {debug,info,warning,error,critical}]
-...
+usage: InvokeAI [-h] [--host HOST] [--port PORT] [--allow_origins [ALLOW_ORIGINS ...]] [--allow_credentials | --no-allow_credentials] [--allow_methods [ALLOW_METHODS ...]]
+                [--allow_headers [ALLOW_HEADERS ...]] [--esrgan | --no-esrgan] [--internet_available | --no-internet_available] [--log_tokenization | --no-log_tokenization]
+                [--patchmatch | --no-patchmatch] [--restore | --no-restore]
+                [--always_use_cpu | --no-always_use_cpu] [--free_gpu_mem | --no-free_gpu_mem] [--max_loaded_models MAX_LOADED_MODELS] [--max_cache_size MAX_CACHE_SIZE]
+                [--max_vram_cache_size MAX_VRAM_CACHE_SIZE] [--gpu_mem_reserved GPU_MEM_RESERVED] [--precision {auto,float16,float32,autocast}]
+                [--sequential_guidance | --no-sequential_guidance] [--xformers_enabled | --no-xformers_enabled] [--tiled_decode | --no-tiled_decode] [--root ROOT]
+                [--autoimport_dir AUTOIMPORT_DIR] [--lora_dir LORA_DIR] [--embedding_dir EMBEDDING_DIR] [--controlnet_dir CONTROLNET_DIR] [--conf_path CONF_PATH]
+                [--models_dir MODELS_DIR] [--legacy_conf_dir LEGACY_CONF_DIR] [--db_dir DB_DIR] [--outdir OUTDIR] [--from_file FROM_FILE]
+                [--use_memory_db | --no-use_memory_db] [--model MODEL] [--log_handlers [LOG_HANDLERS ...]] [--log_format {plain,color,syslog,legacy}]
+                [--log_level {debug,info,warning,error,critical}] [--version | --no-version]
 ```
 
 ## The Configuration Settings
@@ -178,24 +174,28 @@ These configuration settings allow you to enable and disable various InvokeAI fe
 | `esrgan`     | `true`      | Activate the ESRGAN upscaling options|
 | `internet_available` | `true`     | When a resource is not available locally, try to fetch it via the internet |
 | `log_tokenization` | `false`      | Before each text2image generation, print a color-coded representation of the prompt to the console; this can help understand why a prompt is not working as expected |
-| `nsfw_checker` | `true`     | Activate the NSFW checker to blur out risque images |
 | `patchmatch` | `true`     | Activate the "patchmatch" algorithm for improved inpainting |
-| `restore`    | `true`     | Activate the facial restoration features (DEPRECATED; restoration features will be removed in 3.0.0) |
 
-### Memory/Performance
+### Generation
 
 These options tune InvokeAI's memory and performance characteristics.
 
-| Setting  | Default Value  |  Description |
-|----------|----------------|--------------|
-| `always_use_cpu`     | `false`      | Use the CPU to generate images, even if a GPU is available |
-| `free_gpu_mem`       | `false`      | Aggressively free up GPU memory after each operation; this will allow you to run in low-VRAM environments with some performance penalties |
-| `max_cache_size`       | `6`      | Amount of CPU RAM (in GB) to reserve for caching models in memory; more cache allows you to keep models in memory and switch among them quickly |
-| `max_vram_cache_size`  | `2.75`   | Amount of GPU VRAM (in GB) to reserve for caching models in VRAM; more cache speeds up generation but reduces the size of the images that can be generated. This can be set to zero to maximize the amount of memory available for generation. |
-| `precision`       | `auto`      | Floating point precision. One of `auto`, `float16` or `float32`. `float16` will consume half the memory of `float32` but produce slightly lower-quality images. The `auto` setting will guess the proper precision based on your video card and operating system |
-| `sequential_guidance`     | `false`      | Calculate guidance in serial rather than in parallel, lowering memory requirements at the cost of some performance loss |
-| `xformers_enabled`        | `true`      | If the x-formers memory-efficient attention module is installed, activate it for better memory usage and generation speed|
-| `tiled_decode`            | `false`     | If true, then during the VAE decoding phase the image will be decoded a section at a time, reducing memory consumption at the cost of a performance hit |
+| Setting               | Default Value | Description                                                                                                                                                                                                                                                      |
+|-----------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `sequential_guidance` | `false`       | Calculate guidance in serial rather than in parallel, lowering memory requirements at the cost of some performance loss                                                                                                                                          |
+| `attention_type`      | `auto`        | Select the type of attention to use. One of `auto`,`normal`,`xformers`,`sliced`, or `torch-sdp`                                                                                                                                                                  |
+| `attention_slice_size` | `auto`       | When "sliced" attention is selected, set the slice size. One of `auto`, `balanced`, `max` or the integers 1-8|
+| `force_tiled_decode`  | `false`       | Force the VAE step to decode in tiles, reducing memory consumption at the cost of performance |
+
+### Device
+
+These options configure the generation execution device.
+
+| Setting               | Default Value | Description                                                                                                                                                                                                                                                      |
+|-----------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `device`           | `auto`        | Preferred execution device. One of `auto`, `cpu`, `cuda`, `cuda:1`, `mps`. `auto` will choose the device depending on the hardware platform and the installed torch capabilities. |
+| `precision`           | `auto`        | Floating point precision. One of `auto`, `float16` or `float32`. `float16` will consume half the memory of `float32` but produce slightly lower-quality images. The `auto` setting will guess the proper precision based on your video card and operating system |
+
 
 ### Paths
 

docs/features/CONTROLNET.md

@@ -8,20 +8,64 @@ title: ControlNet
 
 ControlNet
 
-ControlNet is a powerful set of features developed by the open-source community (notably, Stanford researcher [**@ilyasviel**](https://github.com/lllyasviel)) that allows you to apply a secondary neural network model to your image generation process in Invoke.
+ControlNet is a powerful set of features developed by the open-source
+community (notably, Stanford researcher
+[**@ilyasviel**](https://github.com/lllyasviel)) that allows you to
+apply a secondary neural network model to your image generation
+process in Invoke.
 
-With ControlNet, you can get more control over the output of your image generation, providing you with a way to direct the network towards generating images that better fit your desired style or outcome.
+With ControlNet, you can get more control over the output of your
+image generation, providing you with a way to direct the network
+towards generating images that better fit your desired style or
+outcome.
 
 
 ### How it works
 
-ControlNet works by analyzing an input image, pre-processing that image to identify relevant information that can be interpreted by each specific ControlNet model, and then inserting that control information into the generation process. This can be used to adjust the style, composition, or other aspects of the image to better achieve a specific result.
+ControlNet works by analyzing an input image, pre-processing that
+image to identify relevant information that can be interpreted by each
+specific ControlNet model, and then inserting that control information
+into the generation process. This can be used to adjust the style,
+composition, or other aspects of the image to better achieve a
+specific result.
 
 
 ### Models
 
-As part of the model installation, ControlNet models can be selected including a variety of pre-trained models that have been added to achieve different effects or styles in your generated images. Further ControlNet models may require additional code functionality to also be incorporated into Invoke's Invocations folder. You should expect to follow any installation instructions for ControlNet models loaded  outside the default models provided by Invoke. The default models include:
+InvokeAI provides access to a series of ControlNet models that provide
+different effects or styles in your generated images.  Currently
+InvokeAI only supports "diffuser" style ControlNet models. These are
+folders that contain the files `config.json` and/or
+`diffusion_pytorch_model.safetensors` and
+`diffusion_pytorch_model.fp16.safetensors`. The name of the folder is
+the name of the model.
 
+***InvokeAI does not currently support checkpoint-format
+ControlNets. These come in the form of a single file with the
+extension `.safetensors`.***
+
+Diffuser-style ControlNet models are available at HuggingFace
+(http://huggingface.co) and accessed via their repo IDs (identifiers
+in the format "author/modelname"). The easiest way to install them is
+to use the InvokeAI model installer application. Use the
+`invoke.sh`/`invoke.bat` launcher to select item [5] and then navigate
+to the CONTROLNETS section. Select the models you wish to install and
+press "APPLY CHANGES". You may also enter additional HuggingFace
+repo_ids in the "Additional models" textbox:
+
+![Model Installer -
+Controlnetl](../assets/installing-models/model-installer-controlnet.png){:width="640px"}
+
+Command-line users can launch the model installer using the command
+`invokeai-model-install`.
+
+_Be aware that some ControlNet models require additional code
+functionality in order to work properly, so just installing a
+third-party ControlNet model may not have the desired effect._ Please
+read and follow the documentation for installing a third party model
+not currently included among InvokeAI's default list.
+
+The models currently supported include:
 
 **Canny**:
 

docs/features/NODES.md

@@ -1,206 +0,0 @@
-# Nodes Editor (Experimental)
-
-🚨
-*The node editor is experimental. We've made it accessible because we use it to develop the application, but we have not addressed the many known rough edges. It's very easy to shoot yourself in the foot, and we cannot offer support for it until it sees full release (ETA v3.1). Everything is subject to change without warning.* 
-🚨
-
-The nodes editor is a blank canvas allowing for the use of individual functions and image transformations to control the image generation workflow. The node processing flow is usually done from left (inputs) to right (outputs), though linearity can become abstracted the more complex the node graph becomes. Nodes inputs and outputs are connected by dragging connectors from node to node.
-
-To better understand how nodes are used, think of how an electric power bar works. It takes in one input (electricity from a wall outlet) and passes it to multiple devices through multiple outputs. Similarly, a node could have multiple inputs and outputs functioning at the same (or different) time, but all node outputs pass information onward like a power bar passes electricity. Not all outputs are compatible with all inputs, however - Each node has different constraints on how it is expecting to input/output information. In general, node outputs are colour-coded to match compatible inputs of other nodes.
-
-## Anatomy of a Node
-
-Individual nodes are made up of the following:
-
-- Inputs: Edge points on the left side of the node window where you connect outputs from other nodes.
-- Outputs: Edge points on the right side of the node window where you connect to inputs on other nodes.
-- Options: Various options which are either manually configured, or overridden by connecting an output from another node to the input.
-
-## Diffusion Overview
-
-Taking the time to understand the diffusion process will help you to understand how to set up your nodes in the nodes editor. 
-
-There are two main spaces Stable Diffusion works in: image space and latent space.
-
-Image space represents images in pixel form that you look at. Latent space represents compressed inputs. It’s in latent space that Stable Diffusion processes images. A VAE (Variational Auto Encoder) is responsible for compressing and encoding inputs into latent space, as well as decoding outputs back into image space.
-
-When you generate an image using text-to-image, multiple steps occur in latent space:
-1. Random noise is generated at the chosen height and width. The noise’s characteristics are dictated by the chosen (or not chosen) seed. This noise tensor is passed into latent space. We’ll call this noise A.
-1. Using a model’s U-Net, a noise predictor examines noise A, and the words tokenized by CLIP from your prompt (conditioning). It generates its own noise tensor to predict what the final image might look like in latent space. We’ll call this noise B.
-1. Noise B is subtracted from noise A in an attempt to create a final latent image indicative of the inputs. This step is repeated for the number of sampler steps chosen.
-1. The VAE decodes the final latent image from latent space into image space.
-
-image-to-image is a similar process, with only step 1 being different:
-1. The input image is decoded from image space into latent space by the VAE. Noise is then added to the input latent image. Denoising Strength dictates how much noise is added, 0 being none, and 1 being all-encompassing. We’ll call this noise A. The process is then the same as steps 2-4 in the text-to-image explanation above. 
-
-Furthermore, a model provides the CLIP prompt tokenizer, the VAE, and a U-Net (where noise prediction occurs given a prompt and initial noise tensor).
-
-A noise scheduler (eg. DPM++ 2M Karras) schedules the subtraction of noise from the latent image across the sampler steps chosen (step 3 above). Less noise is usually subtracted at higher sampler steps. 
-
-## Node Types (Base Nodes)
-
-| Node <img width=160 align="right"> | Function                                                                              |
-| ---------------------------------- | --------------------------------------------------------------------------------------|
-| Add                                | Adds two numbers |
-| CannyImageProcessor                | Canny edge detection for ControlNet |
-| ClipSkip                           | Skip layers in clip text_encoder model |
-| Collect                            | Collects values into a collection |
-| Prompt (Compel)                    | Parse prompt using compel package to conditioning |
-| ContentShuffleImageProcessor       | Applies content shuffle processing to image |
-| ControlNet                         | Collects ControlNet info to pass to other nodes |
-| CvInpaint                          | Simple inpaint using opencv |
-| Divide                             | Divides two numbers |
-| DynamicPrompt                      | Parses a prompt using adieyal/dynamic prompt's random or combinatorial generator |
-| FloatLinearRange                   | Creates a range |
-| HedImageProcessor                  | Applies HED edge detection to image |
-| ImageBlur                          | Blurs an image |
-| ImageChannel                       | Gets a channel from an image |
-| ImageCollection                    | Load a collection of images and provide it as output |
-| ImageConvert                       | Converts an image to a different mode |
-| ImageCrop                          | Crops an image to a specified box. The box can be outside of the image. |
-| ImageInverseLerp                   | Inverse linear interpolation of all pixels of an image |
-| ImageLerp                          | Linear interpolation of all pixels of an image |
-| ImageMultiply                      | Multiplies two images together using `PIL.ImageChops.Multiply()` |
-| ImagePaste                         | Pastes an image into another image |
-| ImageProcessor                     | Base class for invocations that reprocess images for ControlNet |
-| ImageResize                        | Resizes an image to specific dimensions |
-| ImageScale                         | Scales an image by a factor |
-| ImageToLatents                     | Scales latents by a given factor |
-| InfillColor                        | Infills transparent areas of an image with a solid color |
-| InfillPatchMatch                   | Infills transparent areas of an image using the PatchMatch algorithm |
-| InfillTile                         | Infills transparent areas of an image with tiles of the image |
-| Inpaint                            | Generates an image using inpaint |
-| Iterate                            | Iterates over a list of items |
-| LatentsToImage                     | Generates an image from latents |
-| LatentsToLatents                   | Generates latents using latents as base image |
-| LeresImageProcessor                | Applies leres processing to image |
-| LineartAnimeImageProcessor         | Applies line art anime processing to image |
-| LineartImageProcessor              | Applies line art processing to image |
-| LoadImage                          | Load an image and provide it as output |
-| Lora Loader                        | Apply selected lora to unet and text_encoder |
-| Model Loader                       | Loads a main model, outputting its submodels |
-| MaskFromAlpha                      | Extracts the alpha channel of an image as a mask |
-| MediapipeFaceProcessor             | Applies mediapipe face processing to image |
-| MidasDepthImageProcessor           | Applies Midas depth processing to image |
-| MlsdImageProcessor                 | Applied MLSD processing to image |
-| Multiply                           | Multiplies two numbers |
-| Noise                              | Generates latent noise |
-| NormalbaeImageProcessor            | Applies NormalBAE processing to image |
-| OpenposeImageProcessor             | Applies Openpose processing to image |
-| ParamFloat                         | A float parameter |
-| ParamInt                           | An integer parameter |
-| PidiImageProcessor                 | Applies PIDI processing to an image |
-| Progress Image                     | Displays the progress image in the Node Editor |
-| RandomInit                         | Outputs a single random integer |
-| RandomRange                        | Creates a collection of random numbers |
-| Range                              | Creates a range of numbers from start to stop with step |
-| RangeOfSize                        | Creates a range from start to start + size with step |
-| ResizeLatents                      | Resizes latents to explicit width/height (in pixels). Provided dimensions are floor-divided by 8. |
-| RestoreFace                        | Restores faces in the image |
-| ScaleLatents                       | Scales latents by a given factor |
-| SegmentAnythingProcessor           | Applies segment anything processing to image |
-| ShowImage                          | Displays a provided image, and passes it forward in the pipeline |
-| StepParamEasing                    | Experimental per-step parameter for easing for denoising steps |
-| Subtract                           | Subtracts two numbers |
-| TextToLatents                      | Generates latents from conditionings |
-| TileResampleProcessor              | Bass class for invocations that preprocess images for ControlNet |
-| Upscale                            | Upscales an image |
-| VAE Loader                         | Loads a VAE model, outputting a VaeLoaderOutput |
-| ZoeDepthImageProcessor             | Applies Zoe depth processing to image |
-
-## Node Grouping Concepts
-
-There are several node grouping concepts that can be examined with a narrow focus. These (and other) groupings can be pieced together to make up functional graph setups, and are important to understanding how groups of nodes work together as part of a whole. Note that the screenshots below aren't examples of complete functioning node graphs (see Examples).
-
-### Noise
-
-As described, an initial noise tensor is necessary for the latent diffusion process. As a result, all non-image *ToLatents nodes require a noise node input.  
-
-<img width="654" alt="groupsnoise" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/2e8d297e-ad55-4d27-bc93-c119dad2a2c5">
-
-### Conditioning
-
-As described, conditioning is necessary for the latent diffusion process, whether empty or not. As a result, all non-image *ToLatents nodes require positive and negative conditioning inputs. Conditioning is reliant on a CLIP tokenizer provided by the Model Loader node.
-
-<img width="1024" alt="groupsconditioning" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/f8f7ad8a-8d9c-418e-b5ad-1437b774b27e">
-
-### Image Space & VAE
-
-The ImageToLatents node doesn't require a noise node input, but requires a VAE input to convert the image from image space into latent space. In reverse, the LatentsToImage node requires a VAE input to convert from latent space back into image space.
-
-<img width="637" alt="groupsimgvae" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/dd99969c-e0a8-4f78-9b17-3ffe179cef9a">
-
-### Defined & Random Seeds
-
-It is common to want to use both the same seed (for continuity) and random seeds (for variance). To define a seed, simply enter it into the 'Seed' field on a noise node. Conversely, the RandomInt node generates a random integer between 'Low' and 'High', and can be used as input to the 'Seed' edge point on a noise node to randomize your seed.
-
-<img width="922" alt="groupsrandseed" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/af55bc20-60f6-438e-aba5-3ec871443710">
-
-### Control
-
-Control means to guide the diffusion process to adhere to a defined input or structure. Control can be provided as input to non-image *ToLatents nodes from ControlNet nodes. ControlNet nodes usually require an image processor which converts an input image for use with ControlNet.
-
-<img width="805" alt="groupscontrol" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/cc9c5de7-23a7-46c8-bbad-1f3609d999a6">
-
-### LoRA
-
-The Lora Loader node lets you load a LoRA (say that ten times fast) and pass it as output to both the Prompt (Compel) and non-image *ToLatents nodes. A model's CLIP tokenizer is passed through the LoRA into Prompt (Compel), where it affects conditioning. A model's U-Net is also passed through the LoRA into a non-image *ToLatents node, where it affects noise prediction.
-
-<img width="993" alt="groupslora" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/630962b0-d914-4505-b3ea-ccae9b0269da">
-
-### Scaling
-
-Use the ImageScale, ScaleLatents, and Upscale nodes to upscale images and/or latent images. The chosen method differs across contexts. However, be aware that latents are already noisy and compressed at their original resolution; scaling an image could produce more detailed results.
-
-<img width="644" alt="groupsallscale" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/99314f05-dd9f-4b6d-b378-31de55346a13">
-
-### Iteration + Multiple Images as Input
-
-Iteration is a common concept in any processing, and means to repeat a process with given input. In nodes, you're able to use the Iterate node to iterate through collections usually gathered by the Collect node. The Iterate node has many potential uses, from processing a collection of images one after another, to varying seeds across multiple image generations and more. This screenshot demonstrates how to collect several images and pass them out one at a time.
-
-<img width="788" alt="groupsiterate" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/4af5ca27-82c9-4018-8c5b-024d3ee0a121">
-
-### Multiple Image Generation + Random Seeds
-
-Multiple image generation in the node editor is done using the RandomRange node. In this case, the 'Size' field represents the number of images to generate. As RandomRange produces a collection of integers, we need to add the Iterate node to iterate through the collection. 
-
-To control seeds across generations takes some care. The first row in the screenshot will generate multiple images with different seeds, but using the same RandomRange parameters across invocations will result in the same group of random seeds being used across the images, producing repeatable results. In the second row, adding the RandomInt node as input to RandomRange's 'Seed' edge point will ensure that seeds are varied across all images across invocations, producing varied results.
-
-<img width="1027" alt="groupsmultigenseeding" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/518d1b2b-fed1-416b-a052-ab06552521b3">
-
-## Examples
-
-With our knowledge of node grouping and the diffusion process, let’s break down some basic graphs in the nodes editor. Note that a node's options can be overridden by inputs from other nodes. These examples aren't strict rules to follow and only demonstrate some basic configurations.
-
-### Basic text-to-image Node Graph
-
-<img width="875" alt="nodest2i" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/17c67720-c376-4db8-94f0-5e00381a61ee">
-
-- Model Loader: A necessity to generating images (as we’ve read above). We choose our model from the dropdown. It outputs a U-Net, CLIP tokenizer, and VAE.
-- Prompt (Compel): Another necessity. Two prompt nodes are created. One will output positive conditioning (what you want, ‘dog’), one will output negative (what you don’t want, ‘cat’). They both input the CLIP tokenizer that the Model Loader node outputs.
-- Noise: Consider this noise A from step one of the text-to-image explanation above. Choose a seed number, width, and height.
-- TextToLatents: This node takes many inputs for converting and processing text & noise from image space into latent space, hence the name TextTo**Latents**. In this setup, it inputs positive and negative conditioning from the prompt nodes for processing (step 2 above). It inputs noise from the noise node for processing (steps 2 & 3 above). Lastly, it inputs a U-Net from the Model Loader node for processing (step 2 above). It outputs latents for use in the next LatentsToImage node. Choose number of sampler steps, CFG scale, and scheduler.
-- LatentsToImage: This node takes in processed latents from the TextToLatents node, and the model’s VAE from the Model Loader node which is responsible for decoding latents back into the image space, hence the name LatentsTo**Image**. This node is the last stop, and once the image is decoded, it is saved to the gallery.
-
-### Basic image-to-image Node Graph
-
-<img width="998" alt="nodesi2i" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/3f2c95d5-cee7-4415-9b79-b46ee60a92fe">
-
-- Model Loader: Choose a model from the dropdown.
-- Prompt (Compel): Two prompt nodes. One positive (dog), one negative (dog). Same CLIP inputs from the Model Loader node as before.
-- ImageToLatents: Upload a source image directly in the node window, via drag'n'drop from the gallery, or passed in as input. The ImageToLatents node inputs the VAE from the Model Loader node to decode the chosen image from image space into latent space, hence the name ImageTo**Latents**. It outputs latents for use in the next LatentsToLatents node. It also outputs the source image's width and height for use in the next Noise node if the final image is to be the same dimensions as the source image.
-- Noise: A noise tensor is created with the width and height of the source image, and connected to the next LatentsToLatents node. Notice the width and height fields are overridden by the input from the ImageToLatents width and height outputs.
-- LatentsToLatents: The inputs and options are nearly identical to TextToLatents, except that LatentsToLatents also takes latents as an input. Considering our source image is already converted to latents in the last ImageToLatents node, and text + noise are no longer the only inputs to process, we use the LatentsToLatents node. 
-- LatentsToImage: Like previously, the LatentsToImage node will use the VAE from the Model Loader as input to decode the latents from LatentsToLatents into image space, and save it to the gallery.
-
-### Basic ControlNet Node Graph
-
-<img width="703" alt="nodescontrol" src="https://github.com/ymgenesis/InvokeAI/assets/25252829/b02ded86-ceb4-44a2-9910-e19ad184d471">
-
-- Model Loader
-- Prompt (Compel)
-- Noise: Width and height of the CannyImageProcessor ControlNet image is passed in to set the dimensions of the noise passed to TextToLatents.
-- CannyImageProcessor: The CannyImageProcessor node is used to process the source image being used as a ControlNet. Each ControlNet processor node applies control in different ways, and has some different options to configure. Width and height are passed to noise, as mentioned. The processed ControlNet image is output to the ControlNet node.
-- ControlNet: Select the type of control model. In this case, canny is chosen as the CannyImageProcessor was used to generate the ControlNet image. Configure the control node options, and pass the control output to TextToLatents.
-- TextToLatents: Similar to the basic text-to-image example, except ControlNet is passed to the control input edge point.
-- LatentsToImage

docs/features/OTHER.md

@@ -16,21 +16,24 @@ Output Example:
 
 ---
 
-## **Seamless Tiling**
+## **Invisible Watermark**
 
-The seamless tiling mode causes generated images to seamlessly tile
-with itself creating repetitive wallpaper-like patterns. To use it,
-activate the Seamless Tiling option in the Web GUI and then select
-whether to tile on the X (horizontal) and/or Y (vertical) axes. Tiling
-will then be active for the next set of generations.
+In keeping with the principles for responsible AI generation, and to
+help AI researchers avoid synthetic images contaminating their
+training sets, InvokeAI adds an invisible watermark to each of the
+final images it generates. The watermark consists of the text
+"InvokeAI" and can be viewed using the
+[invisible-watermarks](https://github.com/ShieldMnt/invisible-watermark)
+tool.
 
-A nice prompt to test seamless tiling with is:
+Watermarking is controlled using the `invisible-watermark` setting in
+`invokeai.yaml`. To turn it off, add the following line under the `Features`
+category.
 
 ```
-pond garden with lotus by claude monet"
+invisible_watermark: false
 ```
 
----
 
 ## **Weighted Prompts**
 
@@ -39,34 +42,10 @@ priority to them, by adding `:<percent>` to the end of the section you wish to u
 example consider this prompt:
 
 ```bash
-tabby cat:0.25 white duck:0.75 hybrid
+(tabby cat):0.25 (white duck):0.75 hybrid
 ```
 
 This will tell the sampler to invest 25% of its effort on the tabby cat aspect of the image and 75%
 on the white duck aspect (surprisingly, this example actually works). The prompt weights can use any
 combination of integers and floating point numbers, and they do not need to add up to 1.
 
-## **Thresholding and Perlin Noise Initialization Options**
-
-Under the Noise section of the Web UI, you will find two options named
-Perlin Noise and Noise Threshold. [Perlin
-noise](https://en.wikipedia.org/wiki/Perlin_noise) is a type of
-structured noise used to simulate terrain and other natural
-textures. The slider controls the percentage of perlin noise that will
-be mixed into the image at the beginning of generation. Adding a little
-perlin noise to a generation will alter the image substantially.
-
-The noise threshold limits the range of the latent values during
-sampling and helps combat the oversharpening seem with higher CFG
-scale values.
-
-For better intuition into what these options do in practice:
-
-![here is a graphic demonstrating them both](../assets/truncation_comparison.jpg)
-
-In generating this graphic, perlin noise at initialization was
-programmatically varied going across on the diagram by values 0.0,
-0.1, 0.2, 0.4, 0.5, 0.6, 0.8, 0.9, 1.0; and the threshold was varied
-going down from 0, 1, 2, 3, 4, 5, 10, 20, 100. The other options are
-fixed using the prompt "a portrait of a beautiful young lady" a CFG of
-20, 100 steps, and a seed of 1950357039.

docs/features/POSTPROCESS.md

@@ -4,35 +4,13 @@ title: Postprocessing
 
 # :material-image-edit: Postprocessing
 
-## Intro
-
-This extension provides the ability to restore faces and upscale images.
+This sections details the ability to improve faces and upscale images.
 
 ## Face Fixing
 
-The default face restoration module is GFPGAN. The default upscale is
-Real-ESRGAN. For an alternative face restoration module, see
-[CodeFormer Support](#codeformer-support) below.
+As of InvokeAI 3.0, the easiest way to improve faces created during image generation is through the Inpainting functionality of the Unified Canvas. Simply add the image containing the faces that you would like to improve to the canvas, mask the face to be improved and run the invocation. For best results, make sure to use an inpainting specific model; these are usually identified by the "-inpainting" term in the model name. 
 
-As of version 1.14, environment.yaml will install the Real-ESRGAN package into
-the standard install location for python packages, and will put GFPGAN into a
-subdirectory of "src" in the InvokeAI directory. Upscaling with Real-ESRGAN
-should "just work" without further intervention. Simply indicate the desired scale on
-the popup in the Web GUI.
-
-**GFPGAN** requires a series of downloadable model files to work. These are
-loaded when you run `invokeai-configure`. If GFPAN is failing with an
-error, please run the following from the InvokeAI directory:
-
-```bash
-invokeai-configure
-```
-
-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.
-
-### Upscaling
+## Upscaling
 
 Open the upscaling dialog by clicking on the "expand" icon located
 above the image display area in the Web UI:
@@ -41,82 +19,23 @@ above the image display area in the Web UI:
 ![upscale1](../assets/features/upscale-dialog.png)
 </figure>
 
-There are three different upscaling parameters that you can
-adjust. The first is the scale itself, either 2x or 4x.
+The default upscaling option is Real-ESRGAN x2 Plus, which will scale your image by a factor of two. This means upscaling a 512x512 image will result in a new 1024x1024 image.
 
-The second is the "Denoising Strength." Higher values will smooth out
-the image and remove digital chatter, but may lose fine detail at
-higher values.
+Other options are the x4 upscalers, which will scale your image by a factor of 4. 
 
-Third, "Upscale Strength" allows you to adjust how the You can set the
-scaling stength between `0` and `1.0` to control the intensity of the
-scaling. AI upscalers generally tend to smooth out texture details. If
-you wish to retain some of those for natural looking results, we
-recommend using values between `0.5 to 0.8`.
-
-[This figure](../assets/features/upscaling-montage.png) illustrates
-the effects of denoising and strength. The original image was 512x512,
-4x scaled to 2048x2048. The "original" version on the upper left was
-scaled using simple pixel averaging. The remainder use the ESRGAN
-upscaling algorithm at different levels of denoising and strength.
-
-<figure markdown>
-![upscaling](../assets/features/upscaling-montage.png){ width=720 }
-</figure>
-
-Both denoising and strength default to 0.75.
-
-### Face Restoration
-
-InvokeAI offers alternative two face restoration algorithms,
-[GFPGAN](https://github.com/TencentARC/GFPGAN) and
-[CodeFormer](https://huggingface.co/spaces/sczhou/CodeFormer). These
-algorithms improve the appearance of faces, particularly eyes and
-mouths. Issues with faces are less common with the latest set of
-Stable Diffusion models than with the original 1.4 release, but the
-restoration algorithms can still make a noticeable improvement in
-certain cases. You can also apply restoration to old photographs you
-upload.
-
-To access face restoration, click the "smiley face" icon in the
-toolbar above the InvokeAI image panel. You will be presented with a
-dialog that offers a choice between the two algorithm and sliders that
-allow you to adjust their parameters. Alternatively, you may open the
-left-hand accordion panel labeled "Face Restoration" and have the
-restoration algorithm of your choice applied to generated images
-automatically.
-
-
-Like upscaling, there are a number of parameters that adjust the face
-restoration output. GFPGAN has a single parameter, `strength`, which
-controls how much the algorithm is allowed to adjust the
-image. CodeFormer has two parameters, `strength`, and `fidelity`,
-which together control the quality of the output image as described in
-the [CodeFormer project
-page](https://shangchenzhou.com/projects/CodeFormer/). Default values
-are 0.75 for both parameters, which achieves a reasonable balance
-between changing the image too much and not enough.
-
-[This figure](../assets/features/restoration-montage.png) illustrates
-the effects of adjusting GFPGAN and CodeFormer parameters.
-
-<figure markdown>
-![upscaling](../assets/features/restoration-montage.png){ width=720 }
-</figure>
 
 !!! note
 
-    GFPGAN and Real-ESRGAN are both memory intensive. In order to avoid crashes and memory overloads
+    Real-ESRGAN is memory intensive. In order to avoid crashes and memory overloads
     during the Stable Diffusion process, these effects are applied after Stable Diffusion has completed
     its work.
 
     In single image generations, you will see the output right away but when you are using multiple
-    iterations, the images will first be generated and then upscaled and face restored after that
+    iterations, the images will first be generated and then upscaled after that
     process is complete. While the image generation is taking place, you will still be able to preview
     the base images.
 
 ## 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
-`--no_esrgan` options, respectively.
+If, for some reason, you do not wish to load the ESRGAN libraries,
+you can disable them on the invoke.py command line with the `--no_esrgan` options.

docs/features/PROMPTS.md

@@ -4,80 +4,6 @@ title: Prompting-Features
 
 # :octicons-command-palette-24: Prompting-Features
 
-## **Negative and Unconditioned Prompts**
-
-Any words between a pair of square brackets will instruct Stable
-Diffusion to attempt to ban the concept from the generated image. The
-same effect is achieved by placing words in the "Negative Prompts"
-textbox in the Web UI.
-
-```text
-this is a test prompt [not really] to make you understand [cool] how this works.
-```
-
-In the above statement, the words 'not really cool` will be ignored by Stable
-Diffusion.
-
-Here's a prompt that depicts what it does.
-
-original prompt:
-
-`#!bash "A fantastical translucent 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"`
-
-`#!bash parameters: steps=20, dimensions=512x768, CFG=7.5, Scheduler=k_euler_a, seed=1654590180`
-
-<figure markdown>
-
-![step1](../assets/negative_prompt_walkthru/step1.png)
-
-</figure>
-
-That image has a woman, so if we want the horse without a rider, we can
-influence the image not to have a woman by putting [woman] in the prompt, like
-this:
-
-`#!bash "A fantastical translucent poney made of water and foam, ethereal, radiant, hyperalism, scottish folklore, digital painting, artstation, concept art, smooth, 8 k frostbite 3 engine, ultra detailed, art by artgerm and greg rutkowski and magali villeneuve [woman]"`
-(same parameters as above)
-
-<figure markdown>
-
-![step2](../assets/negative_prompt_walkthru/step2.png)
-
-</figure>
-
-That's nice - but say we also don't want the image to be quite so blue. We can
-add "blue" to the list of negative prompts, so it's now [woman blue]:
-
-`#!bash "A fantastical translucent poney made of water and foam, ethereal, radiant, hyperalism, scottish folklore, digital painting, artstation, concept art, smooth, 8 k frostbite 3 engine, ultra detailed, art by artgerm and greg rutkowski and magali villeneuve [woman blue]"`
-(same parameters as above)
-
-<figure markdown>
-
-![step3](../assets/negative_prompt_walkthru/step3.png)
-
-</figure>
-
-Getting close - but there's no sense in having a saddle when our horse doesn't
-have a rider, so we'll add one more negative prompt: [woman blue saddle].
-
-`#!bash "A fantastical translucent poney made of water and foam, ethereal, radiant, hyperalism, scottish folklore, digital painting, artstation, concept art, smooth, 8 k frostbite 3 engine, ultra detailed, art by artgerm and greg rutkowski and magali villeneuve [woman blue saddle]"`
-(same parameters as above)
-
-<figure markdown>
-
-![step4](../assets/negative_prompt_walkthru/step4.png)
-
-</figure>
-
-!!! notes "Notes about this feature:"
-
-    * The only requirement for words to be ignored is that they are in between a pair of square brackets.
-    * You can provide multiple words within the same bracket.
-    * You can provide multiple brackets with multiple words in different places of your prompt. That works just fine.
-    * To improve typical anatomy problems, you can add negative prompts like `[bad anatomy, extra legs, extra arms, extra fingers, poorly drawn hands, poorly drawn feet, disfigured, out of frame, tiling, bad art, deformed, mutated]`.
-
----
-
 ## **Prompt Syntax Features**
 
 The InvokeAI prompting language has the following features:
@@ -102,9 +28,6 @@ The following syntax is recognised:
   `a tall thin man (picking (apricots)1.3)1.1`. (`+` is equivalent to 1.1, `++`
   is pow(1.1,2), `+++` is pow(1.1,3), etc; `-` means 0.9, `--` means pow(0.9,2),
   etc.)
-- attention also applies to `[unconditioning]` so
-  `a tall thin man picking apricots [(ladder)0.01]` will _very gently_ nudge SD
-  away from trying to draw the man on a ladder
 
 You can use this to increase or decrease the amount of something. Starting from
 this prompt of `a man picking apricots from a tree`, let's see what happens if
@@ -150,7 +73,7 @@ Or, alternatively, with more man:
 | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- |
 | ![](../assets/prompt_syntax/mountain-man1.png) | ![](../assets/prompt_syntax/mountain-man2.png) | ![](../assets/prompt_syntax/mountain-man3.png) | ![](../assets/prompt_syntax/mountain-man4.png) |
 
-### Blending between prompts
+### Prompt Blending
 
 - `("a tall thin man picking apricots", "a tall thin man picking pears").blend(1,1)`
 - The existing prompt blending using `:<weight>` will continue to be supported -
@@ -168,6 +91,24 @@ Or, alternatively, with more man:
 See the section below on "Prompt Blending" for more information about how this
 works.
 
+### Prompt Conjunction  
+Join multiple clauses together to create a conjoined prompt. Each clause will be passed to CLIP separately. 
+
+For example, the prompt: 
+
+```bash
+"A mystical valley surround by towering granite cliffs, watercolor, warm"
+```
+
+Can be used with .and():
+```bash
+("A mystical valley", "surround by towering granite cliffs", "watercolor", "warm").and()
+```
+
+Each will give you different results - try them out and see what you prefer!
+
+
+
 ### Cross-Attention Control ('prompt2prompt')
 
 Sometimes an image you generate is almost right, and you just want to change one
@@ -190,7 +131,7 @@ For example, consider the prompt `a cat.swap(dog) playing with a ball in the for
 
       - For multiple word swaps, use parentheses: `a (fluffy cat).swap(barking dog) playing with a ball in the forest`.
       - To swap a comma, use quotes: `a ("fluffy, grey cat").swap("big, barking dog") playing with a ball in the forest`.
-- Supports options `t_start` and `t_end` (each 0-1) loosely corresponding to bloc97's `prompt_edit_tokens_start/_end` but with the math swapped to make it easier to
+- Supports options `t_start` and `t_end` (each 0-1) loosely corresponding to (bloc97's)[(https://github.com/bloc97/CrossAttentionControl)] `prompt_edit_tokens_start/_end` but with the math swapped to make it easier to
   intuitively understand. `t_start` and `t_end` are used to control on which steps cross-attention control should run. With the default values `t_start=0` and `t_end=1`, cross-attention control is active on every step of image generation. Other values can be used to turn cross-attention control off for part of the image generation process.
     - For example, if doing a diffusion with 10 steps for the prompt is `a cat.swap(dog, t_start=0.3, t_end=1.0) playing with a ball in the forest`, the first 3 steps will be run as `a cat playing with a ball in the forest`, while the last 7 steps will run as `a dog playing with a ball in the forest`, but the pixels that represent `dog` will be locked to the pixels that would have represented `cat` if the `cat` prompt had been used instead.
     - Conversely, for `a cat.swap(dog, t_start=0, t_end=0.7) playing with a ball in the forest`, the first 7 steps will run as `a dog playing with a ball in the forest` with the pixels that represent `dog` locked to the same pixels that would have represented `cat` if the `cat` prompt was being used instead. The final 3 steps will just run `a cat playing with a ball in the forest`.
@@ -201,7 +142,7 @@ Prompt2prompt `.swap()` is not compatible with xformers, which will be temporari
 The `prompt2prompt` code is based off
 [bloc97's colab](https://github.com/bloc97/CrossAttentionControl).
 
-### Escaping parantheses () and speech marks ""
+### Escaping parentheses () and speech marks ""
 
 If the model you are using has parentheses () or speech marks "" as part of its
 syntax, you will need to "escape" these using a backslash, so that`(my_keyword)`
@@ -212,23 +153,16 @@ the parentheses as part of the prompt syntax and it will get confused.
 
 ## **Prompt Blending**
 
-You may blend together different sections of the prompt to explore the AI's
+You may blend together prompts to explore the AI's
 latent semantic space and generate interesting (and often surprising!)
 variations. The syntax is:
 
 ```bash
-blue sphere:0.25 red cube:0.75 hybrid
+("prompt #1", "prompt #2").blend(0.25, 0.75)
 ```
 
-This will tell the sampler to blend 25% of the concept of a blue sphere with 75%
-of the concept of a red cube. The blend weights can use any combination of
-integers and floating point numbers, and they do not need to add up to 1.
-Everything to the left of the `:XX` up to the previous `:XX` is used for
-merging, so the overall effect is:
-
-```bash
-0.25 * "blue sphere" + 0.75 * "white duck" + hybrid
-```
+This will tell the sampler to blend 25% of the concept of prompt #1 with 75%
+of the concept of prompt #2. It is recommended to keep the sum of the weights to around 1.0, but interesting things might happen if you go outside of this range.
 
 Because you are exploring the "mind" of the AI, the AI's way of mixing two
 concepts may not match yours, leading to surprising effects. To illustrate, here
@@ -236,13 +170,14 @@ are three images generated using various combinations of blend weights. As
 usual, unless you fix the seed, the prompts will give you different results each
 time you run them.
 
-<figure markdown>
+Let's examine how this affects image generation results:
 
-### "blue sphere, red cube, hybrid"
 
-</figure>
+```bash
+"blue sphere, red cube, hybrid"
+```
 
-This example doesn't use melding at all and represents the default way of mixing
+This example doesn't use blending at all and represents the default way of mixing
 concepts.
 
 <figure markdown>
@@ -251,55 +186,47 @@ concepts.
 
 </figure>
 
-It's interesting to see how the AI expressed the concept of "cube" as the four
-quadrants of the enclosing frame. If you look closely, there is depth there, so
-the enclosing frame is actually a cube.
+It's interesting to see how the AI expressed the concept of "cube" within the sphere. 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"
+```bash
+("blue sphere", "red cube").blend(0.25, 0.75)
+```
 
 ![blue-sphere-25-red-cube-75](../assets/prompt-blending/blue-sphere-0.25-red-cube-0.75-hybrid.png)
 
 </figure>
 
-Now that's interesting. We get neither a blue sphere nor a red cube, but a red
-sphere embedded in a brick wall, which represents a melding of concepts within
-the AI's "latent space" of semantic representations. Where is Ludwig
-Wittgenstein when you need him?
+Now that's interesting. We get an image with a resemblance of a red cube, with a hint of blue shadows which represents a melding of concepts within the AI's "latent space" of semantic representations. 
 
 <figure markdown>
 
-### "blue sphere:0.75 red cube:0.25 hybrid"
+```bash
+("blue sphere", "red cube").blend(0.75, 0.25)
+```
 
 ![blue-sphere-75-red-cube-25](../assets/prompt-blending/blue-sphere-0.75-red-cube-0.25-hybrid.png)
 
 </figure>
 
-Definitely more blue-spherey. The cube is gone entirely, but it's really cool
-abstract art.
+Definitely more blue-spherey. 
 
 <figure markdown>
 
-### "blue sphere:0.5 red cube:0.5 hybrid"
+```bash
+("blue sphere", "red cube").blend(0.5, 0.5)
+```
+</figure>
 
+<figure markdown>
 ![blue-sphere-5-red-cube-5-hybrid](../assets/prompt-blending/blue-sphere-0.5-red-cube-0.5-hybrid.png)
-
 </figure>
 
-Whoa...! I see blue and red, but no spheres or cubes. Is the word "hybrid"
-summoning up the concept of some sort of scifi creature? Let's find out.
 
-<figure markdown>
+Whoa...! I see blue and red, and if I squint, spheres and cubes.
 
-### "blue sphere:0.5 red cube:0.5"
 
-![blue-sphere-5-red-cube-5](../assets/prompt-blending/blue-sphere-0.5-red-cube-0.5.png)
-
-</figure>
-
-Indeed, removing the word "hybrid" produces an image that is more like what we'd
-expect.
 
 ## Dynamic Prompts
 

docs/features/WATERMARK+NSFW.md

@@ -1,12 +1,40 @@
 ---
-title: The NSFW Checker
+title: Watermarking, NSFW Image Checking
 ---
 
-# :material-image-off: NSFW Checker
+# :material-image-off: Invisible Watermark and the NSFW Checker
+
+## Watermarking
+
+InvokeAI does not apply watermarking to images by default. However,
+many computer scientists working in the field of generative AI worry
+that a flood of computer-generated imagery will contaminate the image
+data sets needed to train future generations of generative models.
+
+InvokeAI offers an optional watermarking mode that writes a small bit
+of text, **InvokeAI**, into each image that it generates using an
+"invisible" watermarking library that spreads the information
+throughout the image in a way that is not perceptible to the human
+eye. If you are planning to share your generated images on
+internet-accessible services, we encourage you to activate the
+invisible watermark mode in order to help preserve the digital image
+environment.
+
+The downside of watermarking is that it increases the size of the
+image moderately, and has been reported by some individuals to degrade
+image quality. Your mileage may vary.
+
+To read the watermark in an image, activate the InvokeAI virtual
+environment (called the "developer's console" in the launcher) and run
+the command:
+
+```
+invisible-watermark -a decode -t bytes -m dwtDct -l 64 /path/to/image.png
+```
 
 ## The NSFW ("Safety") Checker
 
-The Stable Diffusion image generation models will produce sexual
+Stable Diffusion 1.5-based image generation models will produce sexual
 imagery if deliberately prompted, and will occasionally produce such
 images when this is not intended. Such images are colloquially known
 as "Not Safe for Work" (NSFW). This behavior is due to the nature of
@@ -18,35 +46,17 @@ jurisdictions it may be illegal to publicly distribute such imagery,
 including mounting a publicly-available server that provides
 unfiltered images to the public. Furthermore, the [Stable Diffusion
 weights
-License](https://github.com/invoke-ai/InvokeAI/blob/main/LICENSE-ModelWeights.txt)
-forbids the model from being used to "exploit any of the
+License](https://github.com/invoke-ai/InvokeAI/blob/main/LICENSE-SD1+SD2.txt),
+and the [Stable Diffusion XL
+License][https://github.com/invoke-ai/InvokeAI/blob/main/LICENSE-SDXL.txt]
+both forbid the models from being used to "exploit any of the
 vulnerabilities of a specific group of persons."
 
 For these reasons Stable Diffusion offers a "safety checker," a
 machine learning model trained to recognize potentially disturbing
 imagery. When a potentially NSFW image is detected, the checker will
 blur the image and paste a warning icon on top. The checker can be
-turned on and off on the command line using `--nsfw_checker` and
-`--no-nsfw_checker`.
-
-At installation time, InvokeAI will ask whether the checker should be
-activated by default (neither argument given on the command line). The
-response is stored in the InvokeAI initialization file
-(`invokeai.yaml` in the InvokeAI root directory).  You can change the
-default at any time by opening this file in a text editor and
-changing the line `nsfw_checker:` from true to false or vice-versa:
-
-
-```
-...
-  Features:
-    esrgan: true
-    internet_available: true
-    log_tokenization: false
-    nsfw_checker: true
-    patchmatch: true
-    restore: true
-```
+turned on and off in the Web interface under Settings.
 
 ## Caveats
 
@@ -84,10 +94,3 @@ are encouraged to turn **off** intermediate image rendering when you
 are using the checker. Future versions of InvokeAI will apply
 additional blurring to intermediate images when the checker is active.
 
-### Watermarking
-
-InvokeAI does not apply any sort of watermark to images it
-generates. However, it does write metadata into the PNG data area,
-including the prompt used to generate the image and relevant parameter
-settings. These fields can be examined using the `sd-metadata.py`
-script that comes with the InvokeAI package.

docs/features/WEB.md

@@ -4,15 +4,19 @@ title: InvokeAI Web Server
 
 # :material-web: InvokeAI Web Server
 
-As of version 2.0.0, this distribution comes with a full-featured web server
-(see screenshot).
+## Quick guided walkthrough of the WebUI's features
 
-To use it, launch the `invoke.sh`/`invoke.bat` script and select
-option (2). Alternatively, with the InvokeAI environment active, run
-the `invokeai` script by adding the `--web` option:
+While most of the WebUI's features are intuitive, here is a guided walkthrough
+through its various components.
+
+### Launching the WebUI
+
+To run the InvokeAI web server, start the `invoke.sh`/`invoke.bat`
+script and select option (1). Alternatively, with the InvokeAI
+environment active, run `invokeai-web`:
 
 ```bash
-invokeai --web
+invokeai-web
 ```
 
 You can then connect to the server by pointing your web browser at
@@ -28,33 +32,32 @@ invoke.sh --host 0.0.0.0
 or
 
 ```bash
-invokeai --web --host 0.0.0.0
+invokeai-web --host 0.0.0.0
 ```
 
-## Quick guided walkthrough of the WebUI's features
-
-While most of the WebUI's features are intuitive, here is a guided walkthrough
-through its various components.
+### The InvokeAI Web Interface
 
 ![Invoke Web Server - Major Components](../assets/invoke-web-server-1.png){:width="640px"}
 
 The screenshot above shows the Text to Image tab of the WebUI. There are three
 main sections:
 
-1. A **control panel** on the left, which contains various settings for text to
-   image generation. The most important part is the text field (currently
-   showing `strawberry sushi`) for entering the text prompt, and the camera icon
-   directly underneath that will render the image. We'll call this the _Invoke_
-   button from now on.
+1. A **control panel** on the left, which contains various settings
+   for text to image generation. The most important part is the text
+   field (currently showing `fantasy painting, horned demon`) for
+   entering the positive text prompt, another text field right below it for an
+   optional negative text prompt (concepts to exclude), and a _Invoke_ button 
+   to begin the image rendering process.
 
-2. The **current image** section in the middle, which shows a large format
-   version of the image you are currently working on. A series of buttons at the
-   top ("image to image", "Use All", "Use Seed", etc) lets you modify the image
-   in various ways.
+2. The **current image** section in the middle, which shows a large
+   format version of the image you are currently working on. A series
+   of buttons at the top lets you modify and manipulate the image in
+   various ways.
 
-3. A \*_gallery_ section on the left that contains a history of the images you
+3. A **gallery** section on the left that contains a history of the images you
    have generated. These images are read and written to the directory specified
-   at launch time in `--outdir`.
+   in the `INVOKEAIROOT/invokeai.yaml` initialization file, usually a directory
+   named `outputs` in `INVOKEAIROOT`.
 
 In addition to these three elements, there are a series of icons for changing
 global settings, reporting bugs, and changing the theme on the upper right.
@@ -76,15 +79,11 @@ From top to bottom, these are:
    with outpainting,and modify interior portions of the image with
    inpainting, erase portions of a starting image and have the AI fill in
    the erased region from a text prompt.
-4. Node Editor - this panel allows you to create
+4. Node Editor - (experimental) this panel allows you to create
    pipelines of common operations and combine them into workflows.
 5. Model Manager - this panel allows you to import and configure new
    models using URLs, local paths, or HuggingFace diffusers repo_ids.
 
-The inpainting, outpainting and postprocessing tabs are currently in
-development. However, limited versions of their features can already be accessed
-through the Text to Image and Image to Image tabs.
-
 ## Walkthrough
 
 The following walkthrough will exercise most (but not all) of the WebUI's
@@ -92,43 +91,54 @@ feature set.
 
 ### Text to Image
 
-1. Launch the WebUI using `python scripts/invoke.py --web` and connect to it
-   with your browser by accessing `http://localhost:9090`. If the browser and
-   server are running on different machines on your LAN, add the option
-   `--host 0.0.0.0` to the launch command line and connect to the machine
-   hosting the web server using its IP address or domain name.
+1. Launch the WebUI using launcher option [1] and connect to it with
+   your browser by accessing `http://localhost:9090`. If the browser
+   and server are running on different machines on your LAN, add the
+   option `--host 0.0.0.0` to the `invoke.sh` launch command line and connect to
+   the machine hosting the web server using its IP address or domain
+   name.
 
-2. If all goes well, the WebUI should come up and you'll see a green
-   `connected` message on the upper right.
+2. If all goes well, the WebUI should come up and you'll see a green dot
+   meaning `connected`  on the upper right.
+
+![Invoke Web Server - Control Panel](../assets/invoke-control-panel-1.png){ align=right width=300px }
 
 #### Basics
 
-1.  Generate an image by typing _strawberry sushi_ into the large prompt field
-    on the upper left and then clicking on the Invoke button (the one with the
-    Camera icon). After a short wait, you'll see a large image of sushi in the
+1.  Generate an image by typing _bluebird_ into the large prompt field
+    on the upper left and then clicking on the Invoke button or pressing
+	the return button.
+	After a short wait, you'll see a large image of a bluebird in the
     image panel, and a new thumbnail in the gallery on the right.
 
-    If you need more room on the screen, you can turn the gallery off by
-    clicking on the **x** to the right of "Your Invocations". You can turn it
-    back on later by clicking the image icon that appears in the gallery's
-    place.
+    If you need more room on the screen, you can turn the gallery off
+    by typing the **g** hotkey. You can turn it back on later by clicking the
+    image icon that appears in the gallery's place. The list of hotkeys can
+	be found by clicking on the keyboard icon above the image gallery.
 
-    The images are written into the directory indicated by the `--outdir` option
-    provided at script launch time. By default, this is `outputs/img-samples`
-    under the InvokeAI directory.
-
-2.  Generate a bunch of strawberry sushi images by increasing the number of
-    requested images by adjusting the Images counter just below the Camera
+2.  Generate a bunch of bluebird images by increasing the number of
+    requested images by adjusting the Images counter just below the Invoke
     button. As each is generated, it will be added to the gallery. You can
     switch the active image by clicking on the gallery thumbnails.
+	
+	If you'd like to watch the image generation progress, click the hourglass
+	icon above the main image area. As generation progresses, you'll see
+	increasingly detailed versions of the ultimate image.
 
-3.  Try playing with different settings, including image width and height, the
-    Sampler, the Steps and the CFG scale.
+3.  Try playing with different settings, including changing the main
+    model, the image width and height, the Scheduler, the Steps and
+    the CFG scale.
+	
+	The _Model_ changes the main model. Thousands of custom models are
+	now available, which generate a variety of image styles and
+	subjects. While InvokeAI comes with a few starter models, it is
+	easy to import new models into the application. See [Installing
+	Models](../installation/050_INSTALLING_MODELS.md) for more details.
 
     Image _Width_ and _Height_ do what you'd expect. However, be aware that
     larger images consume more VRAM memory and take longer to generate.
 
-    The _Sampler_ controls how the AI selects the image to display. Some
+    The _Scheduler_ controls how the AI selects the image to display. Some
     samplers are more "creative" than others and will produce a wider range of
     variations (see next section). Some samplers run faster than others.
 
@@ -142,17 +152,27 @@ feature set.
     to the input prompt. You can go as high or low as you like, but generally
     values greater than 20 won't improve things much, and values lower than 5
     will produce unexpected images. There are complex interactions between
-    _Steps_, _CFG Scale_ and the _Sampler_, so experiment to find out what works
+    _Steps_, _CFG Scale_ and the _Scheduler_, so experiment to find out what works
     for you.
+	
+	The _Seed_ controls the series of values returned by InvokeAI's
+    random number generator. Each unique seed value will generate a different
+	image. To regenerate a previous image, simply use the original image's
+	seed value. A slider to the right of the _Seed_ field will change the
+	seed each time an image is generated.
 
-4.  To regenerate a previously-generated image, select the image you want and
-    click _Use All_. This loads the text prompt and other original settings into
-    the control panel. If you then press _Invoke_ it will regenerate the image
-    exactly. You can also selectively modify the prompt or other settings to
-    tweak the image.
+![Invoke Web Server - Control Panel 2](../assets/control-panel-2.png){ align=right width=400px }
 
-    Alternatively, you may click on _Use Seed_ to load just the image's seed,
-    and leave other settings unchanged.
+4.  To regenerate a previously-generated image, select the image you
+    want and click the asterisk ("*") button at the top of the
+    image. This loads the text prompt and other original settings into
+    the control panel. If you then press _Invoke_ it will regenerate
+    the image exactly. You can also selectively modify the prompt or
+    other settings to tweak the image.
+
+    Alternatively, you may click on the "sprouting plant icon" to load
+    just the image's seed, and leave other settings unchanged or the
+    quote icon to load just the positive and negative prompts.
 
 5.  To regenerate a Stable Diffusion image that was generated by another SD
     package, you need to know its text prompt and its _Seed_. Copy-paste the
@@ -161,62 +181,22 @@ feature set.
     you Invoke, you will get something similar to the original image. It will
     not be exact unless you also set the correct values for the original
     sampler, CFG, steps and dimensions, but it will (usually) be close.
+	
+6.  To save an image, right click on it to bring up a menu that will
+	let you download the image, save it to a named image gallery, and
+	copy it to the clipboard, among other things.
 
-#### Variations on a theme
+#### Upscaling
 
-1.  Let's try generating some variations. Select your favorite sushi image from
-    the gallery to load it. Then select "Use All" from the list of buttons
-    above. This will load up all the settings used to generate this image,
-    including its unique seed.
+![Invoke Web Server - Upscaling](../assets/upscaling.png){ align=right width=400px }
 
-    Go down to the Variations section of the Control Panel and set the button to
-    On. Set Variation Amount to 0.2 to generate a modest number of variations on
-    the image, and also set the Image counter to `4`. Press the `invoke` button.
-    This will generate a series of related images. To obtain smaller variations,
-    just lower the Variation Amount. You may also experiment with changing the
-    Sampler. Some samplers generate more variability than others. _k_euler_a_ is
-    particularly creative, while _ddim_ is pretty conservative.
-
-2.  For even more variations, experiment with increasing the setting for
-    _Perlin_. This adds a bit of noise to the image generation process. Note
-    that values of Perlin noise greater than 0.15 produce poor images for
-    several of the samplers.
-
-#### Facial reconstruction and upscaling
-
-Stable Diffusion frequently produces mangled faces, particularly when there are
-multiple figures in the same scene. Stable Diffusion has particular issues with
-generating reallistic eyes. InvokeAI provides the ability to reconstruct faces
-using either the GFPGAN or CodeFormer libraries. For more information see
-[POSTPROCESS](POSTPROCESS.md).
-
-1.  Invoke a prompt that generates a mangled face. A prompt that often gives
-    this is "portrait of a lawyer, 3/4 shot" (this is not intended as a slur
-    against lawyers!) Once you have an image that needs some touching up, load
-    it into the Image panel, and press the button with the face icon
-    (highlighted in the first screenshot below). A dialog box will appear. Leave
-    _Strength_ at 0.8 and press \*Restore Faces". If all goes well, the eyes and
-    other aspects of the face will be improved (see the second screenshot)
-
-    ![Invoke Web Server - Original Image](../assets/invoke-web-server-3.png)
-
-    ![Invoke Web Server - Retouched Image](../assets/invoke-web-server-4.png)
-
-    The facial reconstruction _Strength_ field adjusts how aggressively the face
-    library will try to alter the face. It can be as high as 1.0, but be aware
-    that this often softens the face airbrush style, losing some details. The
-    default 0.8 is usually sufficient.
-
-2.  "Upscaling" is the process of increasing the size of an image while
-    retaining the sharpness. InvokeAI uses an external library called "ESRGAN"
-    to do this. To invoke upscaling, simply select an image and press the _HD_
-    button above it. You can select between 2X and 4X upscaling, and adjust the
-    upscaling strength, which has much the same meaning as in facial
-    reconstruction. Try running this on one of your previously-generated images.
-
-3.  Finally, you can run facial reconstruction and/or upscaling automatically
-    after each Invocation. Go to the Advanced Options section of the Control
-    Panel and turn on _Restore Face_ and/or _Upscale_.
+"Upscaling" is the process of increasing the size of an image while
+    retaining the sharpness. InvokeAI uses an external library called
+    "ESRGAN" to do this. To invoke upscaling, simply select an image
+    and press the "expanding arrows" button above it. You can select
+    between 2X and 4X upscaling, and adjust the upscaling strength,
+    which has much the same meaning as in facial reconstruction. Try
+    running this on one of your previously-generated images.
 
 ### Image to Image
 
@@ -224,24 +204,14 @@ InvokeAI lets you take an existing image and use it as the basis for a new
 creation. You can use any sort of image, including a photograph, a scanned
 sketch, or a digital drawing, as long as it is in PNG or JPEG format.
 
-For this tutorial, we'll use files named
-[Lincoln-and-Parrot-512.png](../assets/Lincoln-and-Parrot-512.png), and
-[Lincoln-and-Parrot-512-transparent.png](../assets/Lincoln-and-Parrot-512-transparent.png).
-Download these images to your local machine now to continue with the
-walkthrough.
+For this tutorial, we'll use the file named
+[Lincoln-and-Parrot-512.png](../assets/Lincoln-and-Parrot-512.png).
 
-1.  Click on the _Image to Image_ tab icon, which is the second icon from the
-    top on the left-hand side of the screen:
+1.  Click on the _Image to Image_ tab icon, which is the second icon
+    from the top on the left-hand side of the screen. This will bring
+    you to a screen similar to the one shown here:
 
-    <figure markdown>
-    ![Invoke Web Server - Image to Image Icon](../assets/invoke-web-server-5.png)
-    </figure>
-
-    This will bring you to a screen similar to the one shown here:
-
-    <figure markdown>
-    ![Invoke Web Server - Image to Image Tab](../assets/invoke-web-server-6.png){:width="640px"}
-    </figure>
+    ![Invoke Web Server - Image to Image Tab](../assets/invoke-web-server-6.png){ width="640px" }
 
 2.  Drag-and-drop the Lincoln-and-Parrot image into the Image panel, or click
     the blank area to get an upload dialog. The image will load into an area
@@ -255,120 +225,99 @@ walkthrough.
     ![Invoke Web Server - Image to Image example](../assets/invoke-web-server-7.png){:width="640px"}
 
 4.  Experiment with the different settings. The most influential one in Image to
-    Image is _Image to Image Strength_ located about midway down the control
+    Image is _Denoising Strength_ located about midway down the control
     panel. By default it is set to 0.75, but can range from 0.0 to 0.99. The
     higher the value, the more of the original image the AI will replace. A
     value of 0 will leave the initial image completely unchanged, while 0.99
-    will replace it completely. However, the Sampler and CFG Scale also
+    will replace it completely. However, the _Scheduler_ and _CFG Scale_ also
     influence the final result. You can also generate variations in the same way
     as described in Text to Image.
 
-5.  What if we only want to change certain part(s) of the image and leave the
-    rest intact? This is called Inpainting, and a future version of the InvokeAI
-    web server will provide an interactive painting canvas on which you can
-    directly draw the areas you wish to Inpaint into. For now, you can achieve
-    this effect by using an external photoeditor tool to make one or more
-    regions of the image transparent as described in [INPAINTING.md] and
-    uploading that.
-
-    The file
-    [Lincoln-and-Parrot-512-transparent.png](../assets/Lincoln-and-Parrot-512-transparent.png)
-    is a version of the earlier image in which the area around the parrot has
-    been replaced with transparency. Click on the "x" in the upper right of the
-    Initial Image and upload the transparent version. Using the same prompt "old
-    sea captain with raven on shoulder" try Invoking an image. This time, only
-    the parrot will be replaced, leaving the rest of the original image intact:
-
-    <figure markdown>
-    ![Invoke Web Server - Inpainting](../assets/invoke-web-server-8.png){:width="640px"}
-    </figure>
+5.  What if we only want to change certain part(s) of the image and
+    leave the rest intact? This is called Inpainting, and you can do
+    it in the [Unified Canvas](UNIFIED_CANVAS.md). The Unified Canvas
+    also allows you to extend borders of the image and fill in the
+    blank areas, a process called outpainting.
 
 6.  Would you like to modify a previously-generated image using the Image to
-    Image facility? Easy! While in the Image to Image panel, hover over any of
-    the gallery images to see a little menu of icons pop up. Click the picture
-    icon to instantly send the selected image to Image to Image as the initial
-    image.
+    Image facility? Easy! While in the Image to Image panel, drag and drop any
+	image in the gallery into the Initial Image area, and it will be ready for
+	use. You can do the same thing with the main image display. Click on the
+	_Send to_ icon to get a menu of
+	commands and choose "Send to Image to Image".
+	
+	![Send To Icon](../assets/send-to-icon.png) 
 
-You can do the same from the Text to Image tab by clicking on the picture icon
-above the central image panel. The screenshot below shows where the "use as
-initial image" icons are located.
+### Textual Inversion, LoRA and ControlNet
 
-![Invoke Web Server - Use as Image Links](../assets/invoke-web-server-9.png){:width="640px"}
+InvokeAI supports several different types of model files that
+extending the capabilities of the main model by adding artistic
+styles, special effects, or subjects. By mixing and matching textual
+inversion, LoRA and ControlNet models, you can achieve many
+interesting and beautiful effects.
 
-### Unified Canvas
+We will give an example using a LoRA model named "Ink Scenery". This
+LoRA, which can be downloaded from Civitai (civitai.com), is
+specialized to paint landscapes that look like they were made with
+dripping india ink. To install this LoRA, we first download it and 
+put it into the `autoimport/lora` folder located inside the
+`invokeai` root directory. After restarting the web server, the
+LoRA will now become available for use.
 
-See the [Unified Canvas Guide](UNIFIED_CANVAS.md)
+To see this LoRA at work, we'll first generate an image without it
+using the standard `stable-diffusion-v1-5` model. Choose this
+model and enter the prompt "mountains, ink". Here is a typical
+generated image, a mountain range rendered in ink and watercolor
+wash:
 
-## Reference
+![Ink Scenery without LoRA](../assets/lora-example-0.png){ width=512px }
 
-### Additional Options
+Now let's install and activate the Ink Scenery LoRA. Go to
+https://civitai.com/models/78605/ink-scenery-or and download the LoRA
+model file to `invokeai/autoimport/lora` and restart the web
+server. (Alternatively, you can use [InvokeAI's Web Model
+Manager](../installation/050_INSTALLING_MODELS.md) to download and
+install the LoRA directly by typing its URL into the _Import
+Models_->_Location_ field).
 
-| parameter <img width=160 align="right"> | effect                                                                                                                                     |
-| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| `--web_develop`                         | Starts the web server in development mode.                                                                                                 |
-| `--web_verbose`                         | Enables verbose logging                                                                                                                    |
-| `--cors [CORS ...]`                     | Additional allowed origins, comma-separated                                                                                                |
-| `--host HOST`                           | Web server: Host or IP to listen on. Set to 0.0.0.0 to accept traffic from other devices on your network.                                  |
-| `--port PORT`                           | Web server: Port to listen on                                                                                                              |
-| `--certfile CERTFILE`                   | Web server: Path to certificate file to use for SSL. Use together with --keyfile                                                           |
-| `--keyfile KEYFILE`                     | Web server: Path to private key file to use for SSL. Use together with --certfile'                                                         |
-| `--gui`                                 | Start InvokeAI GUI - This is the "desktop mode" version of the web app. It uses Flask to create a desktop app experience of the webserver. |
+Scroll down the control panel until you get to the LoRA accordion
+section, and open it:
 
-### Web Specific Features
+![LoRA Section](../assets/lora-example-1.png){ width=512px }
 
-The web experience offers an incredibly easy-to-use experience for interacting
-with the InvokeAI toolkit. For detailed guidance on individual features, see the
-Feature-specific help documents available in this directory. Note that the
-latest functionality available in the CLI may not always be available in the Web
-interface.
+Click the popup menu and select "Ink scenery". (If it isn't there, then
+the model wasn't installed to the right place, or perhaps you forgot
+to restart the web server.) The LoRA section will change to look like this:
 
-#### Dark Mode & Light Mode
+![LoRA Section Loaded](../assets/lora-example-2.png){ width=512px }
 
-The InvokeAI interface is available in a nano-carbon black & purple Dark Mode,
-and a "burn your eyes out Nosferatu" Light Mode. These can be toggled by
-clicking the Sun/Moon icons at the top right of the interface.
+Note that there is now a slider control for _Ink scenery_. The slider
+controls how much influence the LoRA model will have on the generated
+image.
 
-![InvokeAI Web Server - Dark Mode](../assets/invoke_web_dark.png)
+Run the "mountains, ink" prompt again and observe the change in style:
 
-![InvokeAI Web Server - Light Mode](../assets/invoke_web_light.png)
+![Ink Scenery](../assets/lora-example-3.png){ width=512px }
 
-#### Invocation Toolbar
+Try adjusting the weight slider for larger and smaller weights and
+generate the image after each adjustment. The higher the weight, the
+more influence the LoRA will have.
 
-The left side of the InvokeAI interface is available for customizing the prompt
-and the settings used for invoking your new image. Typing your prompt into the
-open text field and clicking the Invoke button will produce the image based on
-the settings configured in the toolbar.
+To remove the LoRA completely, just click on its trash can icon.
 
-See below for additional documentation related to each feature:
+Multiple LoRAs can be added simultaneously and combined with textual
+inversions and ControlNet models. Please see [Textual Inversions and
+LoRAs](CONCEPTS.md) and [Using ControlNet](CONTROLNET.md) for details.
 
-- [Variations](./VARIATIONS.md)
-- [Upscaling](./POSTPROCESS.md#upscaling)
-- [Image to Image](./IMG2IMG.md)
-- [Other](./OTHER.md)
+## Summary
 
-#### Invocation Gallery
-
-The currently selected --outdir (or the default outputs folder) will display all
-previously generated files on load. As new invocations are generated, these will
-be dynamically added to the gallery, and can be previewed by selecting them.
-Each image also has a simple set of actions (e.g., Delete, Use Seed, Use All
-Parameters, etc.) that can be accessed by hovering over the image.
-
-#### Image Workspace
-
-When an image from the Invocation Gallery is selected, or is generated, the
-image will be displayed within the center of the interface. A quickbar of common
-image interactions are displayed along the top of the image, including:
-
-- Use image in the `Image to Image` workflow
-- Initialize Face Restoration on the selected file
-- Initialize Upscaling on the selected file
-- View File metadata and details
-- Delete the file
+This walkthrough just skims the surface of the many things InvokeAI
+can do. Please see [Features](index.md) for more detailed reference
+guides.
 
 ## Acknowledgements
 
-A huge shout-out to the core team working to make this vision a reality,
+A huge shout-out to the core team working to make the Web GUI a reality,
 including [psychedelicious](https://github.com/psychedelicious),
 [Kyle0654](https://github.com/Kyle0654) and
 [blessedcoolant](https://github.com/blessedcoolant).

docs/features/index.md

@@ -4,6 +4,9 @@ title: Overview
 
 Here you can find the documentation for InvokeAI's various features.
 
+## The [Getting Started Guide](../help/gettingStartedWithAI) 
+A getting started guide for those new to AI image generation. 
+
 ## The Basics
 ### * The [Web User Interface](WEB.md)
 Guide to the Web interface. Also see the [WebUI Hotkeys Reference Guide](WEBUIHOTKEYS.md)
@@ -17,38 +20,40 @@ a single convenient digital artist-optimized user interface.
 ### * [Prompt Engineering](PROMPTS.md)
 Get the images you want with the InvokeAI  prompt engineering language.
 
-## * The [Concepts Library](CONCEPTS.md)
-Add custom subjects and styles using HuggingFace's repository of embeddings.
+### * The [LoRA, LyCORIS and Textual Inversion Models](CONCEPTS.md)
+Add custom subjects and styles using a variety of fine-tuned models.
+
+### * [ControlNet](CONTROLNET.md)
+Learn how to install and use ControlNet models for fine control over
+image output.
 
 ### * [Image-to-Image Guide](IMG2IMG.md)
 Use a seed image to build new creations in the CLI.
 
-### * [Generating Variations](VARIATIONS.md)
-Have an image you like and want to generate many more like it? Variations
-are the ticket.
-
 ## Model Management
 
-## * [Model Installation](../installation/050_INSTALLING_MODELS.md)
+### * [Model Installation](../installation/050_INSTALLING_MODELS.md)
 Learn how to import third-party models and switch among them. This
 guide also covers optimizing models to load quickly.
 
-## * [Merging Models](MODEL_MERGING.md)
+### * [Merging Models](MODEL_MERGING.md)
 Teach an old model new tricks. Merge 2-3 models together to create a
 new model that combines characteristics of the originals.
 
-## * [Textual Inversion](TRAINING.md)
+### * [Textual Inversion](TRAINING.md)
 Personalize models by adding your own style or subjects.
 
-# Other Features
+## Other Features
 
-## * [The NSFW Checker](NSFW.md)
+### * [The NSFW Checker](WATERMARK+NSFW.md)
 Prevent InvokeAI from displaying unwanted racy images.
 
-## * [Controlling Logging](LOGGING.md)
+### * [Controlling Logging](LOGGING.md)
 Control how InvokeAI logs status messages.
 
-## * [Miscellaneous](OTHER.md)
+<!-- OUT OF DATE
+### * [Miscellaneous](OTHER.md)
 Run InvokeAI on Google Colab, generate images with repeating patterns,
 batch process a file of prompts, increase the "creativity" of image
 generation by adding initial noise, and more!
+-->

docs/help/diffusion.md

@@ -0,0 +1,27 @@
+Taking the time to understand the diffusion process will help you to understand how to more effectively use InvokeAI.
+
+There are two main ways Stable Diffusion works - with images, and latents.
+
+Image space represents images in pixel form that you look at. Latent space represents compressed inputs. It’s in latent space that Stable Diffusion processes images. A VAE (Variational Auto Encoder) is responsible for compressing and encoding inputs into latent space, as well as decoding outputs back into image space.
+
+To fully understand the diffusion process, we need to understand a few more terms: UNet, CLIP, and conditioning.
+
+A U-Net is a model trained on a large number of latent images with with known amounts of random noise added.  This means that the U-Net can be given a slightly noisy image and it will predict the pattern of noise needed to subtract from the image in order to recover the original. 
+
+CLIP is a model that tokenizes and encodes text into conditioning. This conditioning guides the model during the denoising steps to produce a new image. 
+
+The U-Net and CLIP work together during the image generation process at each denoising step, with the U-Net removing noise in such a way that the result is similar to images in the U-Net’s training set, while CLIP guides the U-Net towards creating images that are most similar to the prompt.
+
+
+When you generate an image using text-to-image, multiple steps occur in latent space:
+1. Random noise is generated at the chosen height and width. The noise’s characteristics are dictated by  seed. This noise tensor is passed into latent space. We’ll call this noise A.
+2. Using a model’s U-Net, a noise predictor examines noise A, and the words tokenized by CLIP from your prompt (conditioning). It generates its own noise tensor to predict what the final image might look like in latent space. We’ll call this noise B.
+3. Noise B is subtracted from noise A in an attempt to create a latent image consistent with the prompt. This step is repeated for the number of sampler steps chosen.
+4. The VAE decodes the final latent image from latent space into image space.
+
+Image-to-image is a similar process, with only step 1 being different:
+1. The input image is encoded from image space into latent space by the VAE. Noise is then added to the input latent image. Denoising Strength dictates how may noise steps are added, and the amount of noise added at each step. A Denoising Strength of 0 means there are 0 steps and no noise added, resulting in an unchanged image, while a Denoising Strength of 1 results in the image being completely replaced with noise and a full set of denoising steps are performance. The process is then the same as steps 2-4 in the text-to-image process. 
+
+Furthermore, a model provides the CLIP prompt tokenizer, the VAE, and a U-Net (where noise prediction occurs given a prompt and initial noise tensor).
+
+A noise scheduler (eg. DPM++ 2M Karras) schedules the subtraction of noise from the latent image across the sampler steps chosen (step 3 above). Less noise is usually subtracted at higher sampler steps. 

docs/help/gettingStartedWithAI.md

@@ -0,0 +1,95 @@
+# Getting Started with AI Image Generation
+
+New to image generation with AI? You’re in the right place! 
+
+This is a high level walkthrough of some of the concepts and terms you’ll see as you start using InvokeAI. Please note, this is not an exhaustive guide and may be out of date due to the rapidly changing nature of the space. 
+
+## Using InvokeAI
+
+### **Prompt Crafting**
+
+- Prompts are the basis of using InvokeAI, providing the models directions on what to generate. As a general rule of thumb, the more detailed your prompt is, the better your result will be.
+
+ *To get started, here’s an easy template to use for structuring your prompts:*
+
+- Subject, Style, Quality, Aesthetic
+    - **Subject:** What your image will be about. E.g. “a futuristic city with trains”,  “penguins floating on icebergs”, “friends sharing beers”
+    - **Style:** The style or medium in which your image will be in. E.g. “photograph”, “pencil sketch”, “oil paints”, or “pop art”, “cubism”, “abstract”
+    - **Quality:** A particular aspect or trait that you would like to see emphasized in your image. E.g. "award-winning", "featured in {relevant set of high quality works}", "professionally acclaimed". Many people often use "masterpiece".
+    - **Aesthetics:** The visual impact and design of the artwork. This can be colors, mood, lighting, setting, etc.
+- There are two prompt boxes: *Positive Prompt* & *Negative Prompt*.
+    - A **Positive** Prompt includes words you want the model to reference when creating an image.
+    - Negative Prompt is for anything you want the model to eliminate when creating an image. It doesn’t always interpret things exactly the way you would, but helps control the generation process. Always try to include a few terms - you can typically use lower quality image terms like “blurry” or “distorted” with good success.
+- Some examples prompts you can try on your own:
+    - A detailed oil painting of a tranquil forest at sunset with vibrant+ colors and soft, golden light filtering through the trees
+    - friends sharing beers in a busy city, realistic colored pencil sketch, twilight, masterpiece, bright, lively
+
+### Generation Workflows
+
+- Invoke offers a number of different workflows for interacting with models to produce images. Each is extremely powerful on its own, but together provide you an unparalleled way of producing high quality creative outputs that align with your vision.
+    - **Text to Image:** The text to image tab focuses on the key workflow of using a prompt to generate a new image. It includes other features that help control the generation process as well.
+    - **Image to Image:** With image to image, you provide an image as a reference (called the “initial image”), which provides more guidance around color and structure to the AI as it generates a new image. This is provided alongside the same features as Text to Image.
+    - **Unified Canvas:** The Unified Canvas is an advanced AI-first image editing tool that is easy to use, but hard to master. Drag an image onto the canvas from your gallery in order to regenerate certain elements, edit content or colors (known as inpainting), or extend the image with an exceptional degree of consistency and clarity (called outpainting).
+
+### Improving Image Quality
+
+- Fine tuning your prompt - the more specific you are, the closer the image will turn out to what is in your head!  Adding more details in the Positive Prompt or Negative Prompt can help add / remove pieces of your image to improve it - You can also use advanced techniques like upweighting and downweighting to control the influence of certain words. [Learn more here](https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#prompt-syntax-features).
+    - **Tip: If you’re seeing poor results, try adding the things you don’t like about the image to your negative prompt may help. E.g. distorted, low quality, unrealistic, etc.**
+- Explore different models - Other models can produce different results due to the data they’ve been trained on. Each model has specific language and settings it works best with; a model’s documentation is your friend here.  Play around with some and see what works best for you!
+- Increasing Steps - The number of steps used controls how much time the model is given to produce an image, and depends on the “Scheduler” used. The schedule controls how each step is processed by the model. More steps tends to mean better results, but will take longer - We recommend at least 30 steps for most
+- Tweak and Iterate - Remember, it’s best to change one thing at a time so you know what is working and what isn't. Sometimes you just need to try a new image, and other times using a new prompt might be the ticket. For testing, consider turning off the “random” Seed - Using the same seed with the same settings will produce the same image, which makes it the perfect way to learn exactly what your changes are doing.
+- Explore Advanced Settings - InvokeAI has a full suite of tools available to allow you complete control over your image creation process - Check out our [docs if you want to learn more](https://invoke-ai.github.io/InvokeAI/features/).
+
+
+## Terms & Concepts
+
+If you're interested in learning more, check out [this presentation](https://docs.google.com/presentation/d/1IO78i8oEXFTZ5peuHHYkVF-Y3e2M6iM5tCnc-YBfcCM/edit?usp=sharing) from one of our maintainers (@lstein). 
+
+### Stable Diffusion
+
+Stable Diffusion is deep learning, text-to-image model that is the foundation of the capabilities found in InvokeAI. Since the release of Stable Diffusion, there have been many subsequent models created based on Stable Diffusion that are designed to generate specific types of images. 
+
+### Prompts
+
+Prompts provide the models directions on what to generate. As a general rule of thumb, the more detailed your prompt is, the better your result will be.
+
+### Models
+
+Models are the magic that power InvokeAI. These files represent the output of training a machine on understanding massive amounts of images - providing them with the capability to generate new images using just a text description of what you’d like to see. (Like Stable Diffusion!)
+
+Invoke offers a simple way to download several different models upon installation, but many more can be discovered online, including at ****. Each model can produce a unique style of output, based on the images it was trained on - Try out different models to see which best fits your creative vision!
+
+- *Models that contain “inpainting” in the name are designed for use with the inpainting feature of the Unified Canvas*
+
+### Scheduler
+
+Schedulers guide the process of removing noise (de-noising) from data. They determine:
+
+1. The number of steps to take to remove the noise.
+2. Whether the steps are random (stochastic) or predictable (deterministic).
+3. The specific method (algorithm) used for de-noising.
+
+Experimenting with different schedulers is recommended as each will produce different outputs!
+
+### Steps
+
+The number of de-noising steps each generation through. 
+
+Schedulers can be intricate and there's often a balance to strike between how quickly they can de-noise data and how well they can do it. It's typically advised to experiment with different schedulers to see which one gives the best results. There has been a lot written on the internet about different schedulers, as well as exploring what the right level of "steps" are for each. You can save generation time by reducing the number of steps used, but you'll want to make sure that you are satisfied with the quality of images produced!
+
+### Low-Rank Adaptations / LoRAs
+
+Low-Rank Adaptations (LoRAs) are like a smaller, more focused version of models, intended to focus on training a better understanding of how a specific character, style, or concept looks.
+
+### Textual Inversion Embeddings
+
+Textual Inversion Embeddings, like LoRAs, assist with more easily prompting for certain characters, styles, or concepts. However, embeddings are trained to update the relationship between a specific word (known as the “trigger”) and the intended output. 
+
+### ControlNet
+
+ControlNets are neural network models that are able to extract key features from an existing image and use these features to guide the output of the image generation model. 
+
+### VAE
+
+Variational auto-encoder (VAE) is a encode/decode model that translates the "latents" image produced during the image generation procees to the large pixel images that we see. 
+

docs/index.md

@@ -11,6 +11,33 @@ title: Home
   ```
 -->
 
+<!-- CSS styling -->
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.2.1/css/fontawesome.min.css">
+<style>
+    .button {
+      width: 300px;
+      height: 50px;
+      background-color: #448AFF;
+      color: #fff;
+      font-size: 16px;
+      border: none;
+      cursor: pointer;
+      border-radius: 0.2rem;
+    }
+
+    .button-container {
+      display: grid;
+      grid-template-columns: repeat(3, 300px);
+      gap: 20px;
+    }
+
+    .button:hover {
+      background-color: #526CFE;
+    }
+</style>
+
+
+
 <div align="center" markdown>
 
 
@@ -22,9 +49,9 @@ title: Home
 [![github stars badge]][github stars link]
 [![github forks badge]][github forks link]
 
-[![CI checks on main badge]][ci checks on main link]
+<!-- [![CI checks on main badge]][ci checks on main link]
 [![CI checks on dev badge]][ci checks on dev link]
-[![latest commit to dev badge]][latest commit to dev link]
+[![latest commit to dev badge]][latest commit to dev link] -->
 
 [![github open issues badge]][github open issues link]
 [![github open prs badge]][github open prs link]
@@ -54,10 +81,10 @@ title: Home
 [github stars badge]:
   https://flat.badgen.net/github/stars/invoke-ai/InvokeAI?icon=github
 [github stars link]: https://github.com/invoke-ai/InvokeAI/stargazers
-[latest commit to dev badge]:
+<!-- [latest commit to dev badge]:
   https://flat.badgen.net/github/last-commit/invoke-ai/InvokeAI/development?icon=github&color=yellow&label=last%20dev%20commit&cache=900
 [latest commit to dev link]:
-  https://github.com/invoke-ai/InvokeAI/commits/development
+  https://github.com/invoke-ai/InvokeAI/commits/main -->
 [latest release badge]:
   https://flat.badgen.net/github/release/invoke-ai/InvokeAI/development?icon=github
 [latest release link]: https://github.com/invoke-ai/InvokeAI/releases
@@ -70,61 +97,24 @@ 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 of 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>]
-
 <div align="center"><img src="assets/invoke-web-server-1.png" width=640></div>
 
-!!! note
+!!! Note
 
-    This fork is rapidly evolving. Please use the [Issues tab](https://github.com/invoke-ai/InvokeAI/issues) to report bugs and make feature requests. Be sure to use the provided templates. They will help aid diagnose issues faster.
+    This project is rapidly evolving. Please use the [Issues tab](https://github.com/invoke-ai/InvokeAI/issues) to report bugs and make feature requests. Be sure to use the provided templates as it will help aid response time.
 
-## :fontawesome-solid-computer: Hardware Requirements
+## :octicons-link-24: Quick Links
 
-### :octicons-cpu-24: System
+<div class="button-container">
+    <a href="installation/INSTALLATION"> <button class="button">Installation</button> </a>
+    <a href="features/"> <button class="button">Features</button> </a>
+    <a href="help/gettingStartedWithAI/"> <button class="button">Getting Started</button> </a>
+    <a href="contributing/CONTRIBUTING/"> <button class="button">Contributing</button> </a>
+    <a href="https://github.com/invoke-ai/InvokeAI/"> <button class="button">Code and Downloads</button> </a>
+    <a href="https://github.com/invoke-ai/InvokeAI/issues"> <button class="button">Bug Reports </button> </a>
+    <a href="https://discord.gg/ZmtBAhwWhy"> <button class="button"> Join the Discord Server!</button> </a>
+</div>
 
-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)
-- :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 and Disk
-
-- At least 12 GB Main Memory RAM.
-- At least 18 GB of free disk space for the machine learning model, Python, and
-  all its dependencies.
-
-## :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).
-
-### [Installation Getting Started Guide](installation)
-#### [Automated Installer](installation/010_INSTALL_AUTOMATED.md)
-This method is recommended for 1st time users
-#### [Manual Installation](installation/020_INSTALL_MANUAL.md)
-This method is recommended for experienced users and developers
-#### [Docker Installation](installation/040_INSTALL_DOCKER.md)
-This method is recommended for those familiar with running Docker containers
-### Other Installation Guides
-  - [PyPatchMatch](installation/060_INSTALL_PATCHMATCH.md)
-  - [XFormers](installation/070_INSTALL_XFORMERS.md)
-  - [CUDA and ROCm Drivers](installation/030_INSTALL_CUDA_AND_ROCM.md)
-  - [Installing New Models](installation/050_INSTALLING_MODELS.md)
 
 ## :octicons-gift-24: InvokeAI Features
 
@@ -145,8 +135,9 @@ This method is recommended for those familiar with running Docker containers
 ### Model Management
 - [Installing](installation/050_INSTALLING_MODELS.md)
 - [Model Merging](features/MODEL_MERGING.md)
+- [ControlNet Models](features/CONTROLNET.md)
 - [Style/Subject Concepts and Embeddings](features/CONCEPTS.md)
-- [Not Safe for Work (NSFW) Checker](features/NSFW.md)
+- [Watermarking and the Not Safe for Work (NSFW) Checker](features/WATERMARK+NSFW.md)
 <!-- seperator -->
 ### Prompt Engineering
 - [Prompt Syntax](features/PROMPTS.md)
@@ -221,18 +212,14 @@ get solutions for common installation problems and other issues.
 
 Anyone who wishes to contribute to this project, whether documentation,
 features, bug fixes, code cleanup, testing, or code reviews, is very much
-encouraged to do so. If you are unfamiliar with how to contribute to GitHub
-projects, here is a
-[Getting Started Guide](https://opensource.com/article/19/7/create-pull-request-github).
+encouraged to do so. 
 
-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.
+[Please take a look at our Contribution documentation to learn more about contributing to InvokeAI. 
+](contributing/CONTRIBUTING.md)
 
 ## :octicons-person-24: Contributors
 
-This fork is a combined effort of various people from across the world.
+This software is a combined effort of various people from across the world.
 [Check out the list of all these amazing people](other/CONTRIBUTORS.md). We
 thank them for their time, hard work and effort.
 

docs/installation/010_INSTALL_AUTOMATED.md

@@ -40,10 +40,8 @@ experimental versions later.
     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.*` or `3.10.*`, you meet
-    requirements. We do not recommend using Python 3.11 or higher,
-    as not all the libraries that InvokeAI depends on work properly
-    with this version.
+    number. If it is version `3.9.*`, `3.10.*` or `3.11.*` you meet
+    requirements.
 
     !!! warning "What to do if you have an unsupported version"
 
@@ -124,9 +122,9 @@ experimental versions later.
     [latest release](https://github.com/invoke-ai/InvokeAI/releases/latest),
     and look for a file named:
 
-    - InvokeAI-installer-v2.X.X.zip
+    - InvokeAI-installer-v3.X.X.zip
 
-    where "2.X.X" is the latest released version. The file is located
+    where "3.X.X" is the latest released version. The file is located
     at the very bottom of the release page, under **Assets**.
 
 4.  **Unpack the installer**: Unpack the zip file into a convenient directory. This will create a new
@@ -215,17 +213,6 @@ experimental versions later.
     Generally the defaults are fine, and you can come back to this screen at
     any time to tweak your system. Here are the options you can adjust:
 
-    - ***Output directory for images***
-      This is the path to a directory in which InvokeAI will store all its
-      generated images.
-
-    - ***NSFW checker***
-      If checked, InvokeAI will test images for potential sexual content
-      and blur them out if found. Note that the NSFW checker consumes
-      an additional 0.6 GB of VRAM on top of the 2-3 GB of VRAM used
-      by most image models. If you have a low VRAM GPU (4-6 GB), you
-      can reduce out of memory errors by disabling the checker.
-
     - ***HuggingFace Access Token***
       InvokeAI has the ability to download embedded styles and subjects
       from the HuggingFace Concept Library on-demand. However, some of
@@ -257,20 +244,30 @@ experimental versions later.
 	and graphics cards. The "autocast" option is deprecated and
 	shouldn't be used unless you are asked to by a member of the team.
 
-    - ***Number of models to cache in CPU memory***
+    - **Size of the RAM cache used for fast model switching***
         This allows you to keep models in memory and switch rapidly among
 	them rather than having them load from disk each time. This slider
-	controls how many models to keep loaded at once. Each
-	model will use 2-4 GB of RAM, so use this cautiously
+	controls how many models to keep loaded at once. A typical SD-1 or SD-2 model
+	uses 2-3 GB of memory. A typical SDXL model uses 6-7 GB. Providing more
+	RAM will allow more models to be co-resident.
 
-    - ***Directory containing embedding/textual inversion files***
-        This is the directory in which you can place custom embedding
-	files (.pt or .bin). During startup, this directory will be
-	scanned and InvokeAI will print out the text terms that
-	are available to trigger the embeddings.
+    - ***Output directory for images***
+      This is the path to a directory in which InvokeAI will store all its
+      generated images.
+
+    - ***Autoimport Folder***
+      This is the directory in which you can place models you have
+	  downloaded and wish to load into InvokeAI. You can place a variety
+	  of models in this directory, including diffusers folders, .ckpt files,
+	  .safetensors files, as well as LoRAs, ControlNet and Textual Inversion
+	  files (both folder and file versions). To help organize this folder,
+	  you can create several levels of subfolders and drop your models into
+      whichever ones you want.
+	
+    - ***LICENSE***     
 
     At the bottom of the screen you will see a checkbox for accepting
-    the CreativeML Responsible AI License. You need to accept the license
+    the CreativeML Responsible AI Licenses. You need to accept the license
     in order to download Stable Diffusion models from the next screen.
 
     _You can come back to the startup options form_ as many times as you like.
@@ -375,8 +372,71 @@ experimental versions later.
         Once InvokeAI is installed, do not move or remove this directory."
 
 
+<a name="troubleshooting"></a>
 ## Troubleshooting
 
+### _OSErrors on Windows while installing dependencies_
+
+During a zip file installation or an online update, installation stops
+with an error like this:
+
+![broken-dependency-screenshot](../assets/troubleshooting/broken-dependency.png){:width="800px"}
+
+This seems to happen particularly often with the `pydantic` and
+`numpy` packages. The most reliable solution requires several manual
+steps to complete installation.
+
+Open up a Powershell window and navigate to the `invokeai` directory
+created by the installer. Then give the following series of commands:
+
+```cmd
+rm .\.venv -r -force
+python -mvenv .venv
+.\.venv\Scripts\activate
+pip install invokeai
+invokeai-configure --yes --root .
+```
+
+If you see anything marked as an error during this process please stop
+and seek help on the Discord [installation support
+channel](https://discord.com/channels/1020123559063990373/1041391462190956654). A
+few warning messages are OK.
+
+If you are updating from a previous version, this should restore your
+system to a working state. If you are installing from scratch, there
+is one additional command to give:
+
+```cmd
+wget -O invoke.bat https://raw.githubusercontent.com/invoke-ai/InvokeAI/main/installer/templates/invoke.bat.in
+```
+
+This will create the `invoke.bat` script needed to launch InvokeAI and
+its related programs.
+
+
+### _Stable Diffusion XL Generation Fails after Trying to Load unet_
+
+InvokeAI is working in other respects, but when trying to generate
+images with Stable Diffusion XL you get a "Server Error". The text log
+in the launch window contains this log line above several more lines of
+error messages:
+
+```INFO --> Loading model:D:\LONG\PATH\TO\MODEL, type sdxl:main:unet```
+
+This failure mode occurs when there is a network glitch during
+downloading the very large SDXL model.
+
+To address this, first go to the Web Model Manager and delete the
+Stable-Diffusion-XL-base-1.X model. Then navigate to HuggingFace and
+manually download the .safetensors version of the model. The 1.0
+version is located at
+https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0/tree/main
+and the file is named `sd_xl_base_1.0.safetensors`.
+
+Save this file to disk and then reenter the Model Manager. Navigate to
+Import Models->Add Model, then type (or drag-and-drop) the path to the
+.safetensors file. Press "Add Model".
+
 ### _Package dependency conflicts_
 
 If you have previously installed InvokeAI or another Stable Diffusion
@@ -411,7 +471,7 @@ Then type the following commands:
 
 === "NVIDIA System"
     ```bash
-    pip install torch torchvision --force-reinstall --extra-index-url https://download.pytorch.org/whl/cu117
+    pip install torch torchvision --force-reinstall --extra-index-url https://download.pytorch.org/whl/cu118
     pip install xformers
     ```
 

docs/installation/020_INSTALL_MANUAL.md

@@ -8,9 +8,9 @@ title: Installing Manually
 
 </figure>
 
-!!! warning "This is for advanced Users"
+!!! warning "This is for Advanced Users"
 
-    **python experience is mandatory**
+    **Python experience is mandatory**
 
 ## Introduction
 
@@ -32,7 +32,7 @@ gaming):
 
 * **Python**
 
-    version 3.9 or 3.10 (3.11 is not recommended).
+    version 3.9 through 3.11
 
 * **CUDA Tools**
 
@@ -65,7 +65,7 @@ gaming):
 To install InvokeAI with virtual environments and the PIP package
 manager, please follow these steps:
 
-1.  Please make sure you are using Python 3.9 or 3.10. The rest of the install
+1.  Please make sure you are using Python 3.9 through 3.11. The rest of the install
     procedure depends on this and will not work with other versions:
 
     ```bash
@@ -148,7 +148,7 @@ manager, please follow these steps:
     === "CUDA (NVidia)"
 
         ```bash
-        pip install "InvokeAI[xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117
+        pip install "InvokeAI[xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu118
         ```
 
     === "ROCm (AMD)"
@@ -192,8 +192,10 @@ manager, please follow these steps:
     your outputs.
 
     ```terminal
-    invokeai-configure
+    invokeai-configure --root .
     ```
+	
+	Don't miss the dot at the end of the command!
 
     The script `invokeai-configure` will interactively guide you through the
     process of downloading and installing the weights files needed for InvokeAI.
@@ -225,12 +227,6 @@ manager, please follow these steps:
 
         !!! warning "Make sure that the virtual environment is activated, which should create `(.venv)` in front of your prompt!"
 
-        === "CLI"
-
-            ```bash
-            invokeai
-            ```
-
         === "local Webserver"
 
             ```bash
@@ -243,6 +239,12 @@ manager, please follow these steps:
             invokeai --web --host 0.0.0.0
             ```
 
+        === "CLI"
+
+            ```bash
+            invokeai
+            ```
+
         If you choose the run the web interface, point your browser at
         http://localhost:9090 in order to load the GUI.
 
@@ -310,7 +312,7 @@ installation protocol (important!)
 
     === "CUDA (NVidia)"
         ```bash
-        pip install -e .[xformers] --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117
+        pip install -e .[xformers] --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu118
         ```
 
     === "ROCm (AMD)"
@@ -354,7 +356,7 @@ you can do so using this unsupported recipe:
 mkdir ~/invokeai
 conda create -n invokeai python=3.10
 conda activate invokeai
-pip install InvokeAI[xformers] --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117
+pip install InvokeAI[xformers] --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu118
 invokeai-configure --root ~/invokeai
 invokeai --root ~/invokeai --web
 ```

docs/installation/030_INSTALL_CUDA_AND_ROCM.md

@@ -34,11 +34,11 @@ directly from NVIDIA. **Do not try to install Ubuntu's
 nvidia-cuda-toolkit package. It is out of date and will cause
 conflicts among the NVIDIA driver and binaries.**
 
-Go to [CUDA Toolkit 11.7
-Downloads](https://developer.nvidia.com/cuda-11-7-0-download-archive),
-and use the target selection wizard to choose your operating system,
-hardware platform, and preferred installation method (e.g. "local"
-versus "network").
+Go to [CUDA Toolkit
+Downloads](https://developer.nvidia.com/cuda-downloads), and use the
+target selection wizard to choose your operating system, hardware
+platform, and preferred installation method (e.g. "local" versus
+"network").
 
 This will provide you with a downloadable install file or, depending
 on your choices, a recipe for downloading and running a install shell
@@ -61,7 +61,7 @@ Runtime Site](https://developer.nvidia.com/nvidia-container-runtime)
 
 When installing torch and torchvision manually with `pip`, remember to provide
 the argument `--extra-index-url
-https://download.pytorch.org/whl/cu117` as described in the [Manual
+https://download.pytorch.org/whl/cu118` as described in the [Manual
 Installation Guide](020_INSTALL_MANUAL.md).
 
 ## :simple-amd: ROCm

docs/installation/040_INSTALL_DOCKER.md

@@ -4,9 +4,9 @@ title: Installing with Docker
 
 # :fontawesome-brands-docker: Docker
 
-!!! warning "For end users"
+!!! warning "For most users"
 
-    We highly recommend to Install InvokeAI locally using [these instructions](index.md)
+    We highly recommend to Install InvokeAI locally using [these instructions](INSTALLATION.md)
 
 !!! tip "For developers"
 

docs/installation/050_INSTALLING_MODELS.md

@@ -124,7 +124,7 @@ installation. Examples:
 invokeai-model-install --list controlnet
 
 # (install the model at the indicated URL)
-invokeai-model-install --add http://civitai.com/2860
+invokeai-model-install --add https://civitai.com/api/download/models/128713
 
 # (delete the named model)
 invokeai-model-install --delete sd-1/main/analog-diffusion
@@ -170,4 +170,4 @@ elsewhere on disk and they will be autoimported. You can also create
 subfolders and organize them as you wish.
 
 The location of the autoimport directories are controlled by settings
-in `invokeai.yaml`. See [Configuration](../features/CONFIGURATION.md).
+in `invokeai.yaml`. See [Configuration](../features/CONFIGURATION.md).

docs/installation/070_INSTALL_XFORMERS.md

@@ -28,18 +28,21 @@ command line, then just be sure to activate it's virtual environment.
 Then run the following three commands:
 
 ```sh
-pip install xformers==0.0.16rc425
-pip install triton
+pip install xformers~=0.0.19
+pip install triton    # WON'T WORK ON WINDOWS
 python -m xformers.info output
 ```
 
 The first command installs `xformers`, the second installs the
 `triton` training accelerator, and the third prints out the `xformers`
-installation status. If all goes well, you'll see a report like the
+installation status. On Windows, please omit the `triton` package,
+which is not available on that platform.
+
+If all goes well, you'll see a report like the
 following:
 
 ```sh
-xFormers 0.0.16rc425
+xFormers 0.0.20
 memory_efficient_attention.cutlassF:               available
 memory_efficient_attention.cutlassB:               available
 memory_efficient_attention.flshattF:               available
@@ -48,22 +51,28 @@ memory_efficient_attention.smallkF:                available
 memory_efficient_attention.smallkB:                available
 memory_efficient_attention.tritonflashattF:        available
 memory_efficient_attention.tritonflashattB:        available
+indexing.scaled_index_addF:                        available
+indexing.scaled_index_addB:                        available
+indexing.index_select:                             available
+swiglu.dual_gemm_silu:                             available
+swiglu.gemm_fused_operand_sum:                     available
 swiglu.fused.p.cpp:                                available
 is_triton_available:                               True
 is_functorch_available:                            False
-pytorch.version:                                   1.13.1+cu117
+pytorch.version:                                   2.0.1+cu118
 pytorch.cuda:                                      available
-gpu.compute_capability:                            8.6
-gpu.name:                                          NVIDIA RTX A2000 12GB
+gpu.compute_capability:                            8.9
+gpu.name:                                          NVIDIA GeForce RTX 4070
 build.info:                                        available
-build.cuda_version:                                1107
-build.python_version:                              3.10.9
-build.torch_version:                               1.13.1+cu117
+build.cuda_version:                                1108
+build.python_version:                              3.10.11
+build.torch_version:                               2.0.1+cu118
 build.env.TORCH_CUDA_ARCH_LIST:                    5.0+PTX 6.0 6.1 7.0 7.5 8.0 8.6
 build.env.XFORMERS_BUILD_TYPE:                     Release
 build.env.XFORMERS_ENABLE_DEBUG_ASSERTIONS:        None
 build.env.NVCC_FLAGS:                              None
-build.env.XFORMERS_PACKAGE_FROM:                   wheel-v0.0.16rc425
+build.env.XFORMERS_PACKAGE_FROM:                   wheel-v0.0.20
+build.nvcc_version:                                11.8.89
 source.privacy:                                    open source
 ```
 
@@ -83,14 +92,14 @@ installed from source. These instructions were written for a system
 running Ubuntu 22.04, but other Linux distributions should be able to
 adapt this recipe.
 
-#### 1. Install CUDA Toolkit 11.7
+#### 1. Install CUDA Toolkit 11.8
 
 You will need the CUDA developer's toolkit in order to compile and
 install xFormers. **Do not try to install Ubuntu's nvidia-cuda-toolkit
 package.** It is out of date and will cause conflicts among the NVIDIA
 driver and binaries. Instead install the CUDA Toolkit package provided
-by NVIDIA itself. Go to [CUDA Toolkit 11.7
-Downloads](https://developer.nvidia.com/cuda-11-7-0-download-archive)
+by NVIDIA itself. Go to [CUDA Toolkit 11.8
+Downloads](https://developer.nvidia.com/cuda-11-8-0-download-archive)
 and use the target selection wizard to choose your platform and Linux
 distribution. Select an installer type of "runfile (local)" at the
 last step.
@@ -101,17 +110,17 @@ example, the install script recipe for Ubuntu 22.04 running on a
 x86_64 system is:
 
 ```
-wget https://developer.download.nvidia.com/compute/cuda/11.7.0/local_installers/cuda_11.7.0_515.43.04_linux.run
-sudo sh cuda_11.7.0_515.43.04_linux.run
+wget https://developer.download.nvidia.com/compute/cuda/11.8.0/local_installers/cuda_11.8.0_520.61.05_linux.run
+sudo sh cuda_11.8.0_520.61.05_linux.run
 ```
 
 Rather than cut-and-paste this example, We recommend that you walk
 through the toolkit wizard in order to get the most up to date
 installer for your system.
 
-#### 2. Confirm/Install pyTorch 1.13 with CUDA 11.7 support
+#### 2. Confirm/Install pyTorch 2.01 with CUDA 11.8 support
 
-If you are using InvokeAI 2.3 or higher, these will already be
+If you are using InvokeAI 3.0.2 or higher, these will already be
 installed. If not, you can check whether you have the needed libraries
 using a quick command. Activate the invokeai virtual environment,
 either by entering the "developer's console", or manually with a
@@ -124,7 +133,7 @@ Then run the command:
 python -c 'exec("import torch\nprint(torch.__version__)")'
 ```
 
-If it prints __1.13.1+cu117__ you're good. If not, you can install the
+If it prints __1.13.1+cu118__ you're good. If not, you can install the
 most up to date libraries with this command:
 
 ```sh

docs/installation/INSTALLATION.md

@@ -1,6 +1,4 @@
----
-title: Overview
----
+# Overview
 
 We offer several ways to install InvokeAI, each one suited to your
 experience and preferences. We suggest that everyone start by
@@ -15,7 +13,57 @@ See the [troubleshooting
 section](010_INSTALL_AUTOMATED.md#troubleshooting) of the automated
 install guide for frequently-encountered installation issues.
 
-## Main Application
+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).
+
+### [Installation Getting Started Guide](installation)
+#### **[Automated Installer](010_INSTALL_AUTOMATED.md)**
+✅ This is the recommended installation method for first-time users. 
+#### [Manual Installation](020_INSTALL_MANUAL.md)
+This method is recommended for experienced users and developers
+#### [Docker Installation](040_INSTALL_DOCKER.md)
+This method is recommended for those familiar with running Docker containers
+### Other Installation Guides
+  - [PyPatchMatch](060_INSTALL_PATCHMATCH.md)
+  - [XFormers](070_INSTALL_XFORMERS.md)
+  - [CUDA and ROCm Drivers](030_INSTALL_CUDA_AND_ROCM.md)
+  - [Installing New Models](050_INSTALLING_MODELS.md)
+
+## :fontawesome-solid-computer: Hardware Requirements
+
+### :octicons-cpu-24: System
+
+You wil need one of the following:
+
+- :simple-nvidia: An NVIDIA-based graphics card with 4 GB or more VRAM memory.
+- :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.
+
+** SDXL 1.0 Requirements*
+To use SDXL, user must have one of the following: 
+- :simple-nvidia: An NVIDIA-based graphics card with 8 GB or more VRAM memory.
+- :simple-amd: An AMD-based graphics card with 16 GB or more VRAM memory (Linux
+  only)
+- :fontawesome-brands-apple: An Apple computer with an M1 chip.
+
+
+### :fontawesome-solid-memory: Memory and Disk
+
+- At least 12 GB Main Memory RAM.
+- At least 18 GB of free disk space for the machine learning model, Python, and
+  all its dependencies.
+
+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
+
+## Installation options
 
 1. [Automated Installer](010_INSTALL_AUTOMATED.md)
 
@@ -24,6 +72,9 @@ install guide for frequently-encountered installation issues.
     "developer console" which will help us debug problems with you and
     give you to access experimental features.
 
+
+    ✅ This is the recommended option for first time users. 
+
 2. [Manual Installation](020_INSTALL_MANUAL.md)
 
     In this method you will manually run the commands needed to install

docs/javascripts/tablesort.js

@@ -0,0 +1,7 @@
+document$.subscribe(function() {
+    var tables = document.querySelectorAll("article table:not([class])")
+    tables.forEach(function(table) {
+      new Tablesort(table)
+    })
+  })
+  

docs/nodes/NODES.md

@@ -0,0 +1,68 @@
+# Using the Node Editor
+
+The nodes editor is a blank canvas allowing for the use of individual functions and image transformations to control the image generation workflow. Nodes take in inputs on the left side of the node, and return an output on the right side of the node. A node graph is composed of multiple nodes that are connected together to create a workflow. Nodes' inputs and outputs are connected by dragging connectors from node to node. Inputs and outputs are color coded for ease of use.
+
+To better understand how nodes are used, think of how an electric power bar works. It takes in one input (electricity from a wall outlet) and passes it to multiple devices through multiple outputs. Similarly, a node could have multiple inputs and outputs functioning at the same (or different) time, but all node outputs pass information onward like a power bar passes electricity. Not all outputs are compatible with all inputs, however - Each node has different constraints on how it is expecting to input/output information. In general, node outputs are colour-coded to match compatible inputs of other nodes.
+
+
+If you're not familiar with Diffusion, take a look at our [Diffusion Overview.](../help/diffusion.md) Understanding how diffusion works will enable you to more easily use the Nodes Editor and build workflows to suit your needs.
+
+## Important Concepts
+
+There are several node grouping concepts that can be examined with a narrow focus. These (and other) groupings can be pieced together to make up functional graph setups, and are important to understanding how groups of nodes work together as part of a whole. Note that the screenshots below aren't examples of complete functioning node graphs (see Examples).
+
+### Noise
+
+An initial noise tensor is necessary for the latent diffusion process. As a result, the Denoising node requires a noise node input.  
+
+![groupsnoise](../assets/nodes/groupsnoise.png)
+
+### Text Prompt Conditioning
+
+Conditioning is necessary for the latent diffusion process, whether empty or not. As a result, the Denoising node requires positive and negative conditioning inputs. Conditioning is reliant on a CLIP text encoder provided by the Model Loader node.
+
+![groupsconditioning](../assets/nodes/groupsconditioning.png)
+
+### Image to Latents & VAE
+
+The ImageToLatents node takes in a pixel image and a VAE and outputs a latents. The LatentsToImage node does the opposite, taking in a latents and a VAE and outpus a pixel image. 
+
+![groupsimgvae](../assets/nodes/groupsimgvae.png)
+
+### Defined & Random Seeds
+
+It is common to want to use both the same seed (for continuity) and random seeds (for variety). To define a seed, simply enter it into the 'Seed' field on a noise node. Conversely, the RandomInt node generates a random integer between 'Low' and 'High', and can be used as input to the 'Seed' edge point on a noise node to randomize your seed.
+
+![groupsrandseed](../assets/nodes/groupsrandseed.png)
+
+### ControlNet
+
+The ControlNet node outputs a Control, which can be provided as input to non-image *ToLatents nodes. Depending on the type of ControlNet desired, ControlNet nodes usually require an image processor node, such as a Canny Processor or Depth Processor, which prepares an input image for use with ControlNet.
+
+![groupscontrol](../assets/nodes/groupscontrol.png)
+
+### LoRA
+
+The Lora Loader node lets you load a LoRA and pass it as output.A LoRA provides fine-tunes to the UNet and text encoder weights that augment the base model’s image and text vocabularies.
+
+![groupslora](../assets/nodes/groupslora.png)
+
+### Scaling
+
+Use the ImageScale, ScaleLatents, and Upscale nodes to upscale images and/or latent images. Upscaling is the process of enlarging an image and adding more detail. The chosen method differs across contexts. However, be aware that latents are already noisy and compressed at their original resolution; scaling an image could produce more detailed results.
+
+![groupsallscale](../assets/nodes/groupsallscale.png)
+
+### Iteration + Multiple Images as Input
+
+Iteration is a common concept in any processing, and means to repeat a process with given input. In nodes, you're able to use the Iterate node to iterate through collections usually gathered by the Collect node. The Iterate node has many potential uses, from processing a collection of images one after another, to varying seeds across multiple image generations and more. This screenshot demonstrates how to collect several images and use them in an image generation workflow.
+
+![groupsiterate](../assets/nodes/groupsiterate.png)
+
+### Multiple Image Generation + Random Seeds
+
+Multiple image generation in the node editor is done using the RandomRange node. In this case, the 'Size' field represents the number of images to generate. As RandomRange produces a collection of integers, we need to add the Iterate node to iterate through the collection. 
+
+To control seeds across generations takes some care. The first row in the screenshot will generate multiple images with different seeds, but using the same RandomRange parameters across invocations will result in the same group of random seeds being used across the images, producing repeatable results. In the second row, adding the RandomInt node as input to RandomRange's 'Seed' edge point will ensure that seeds are varied across all images across invocations, producing varied results.
+
+![groupsmultigenseeding](../assets/nodes/groupsmultigenseeding.png)

docs/nodes/comfyToInvoke.md

@@ -0,0 +1,80 @@
+# ComfyUI to InvokeAI
+
+If you're coming to InvokeAI from ComfyUI, welcome! You'll find things are similar but different - the good news is that you already know how things should work, and it's just a matter of wiring them up! 
+
+Some things to note: 
+
+- InvokeAI's nodes tend to be more granular than default nodes in Comfy. This means each node in Invoke will do a specific task and you might need to use multiple nodes to achieve the same result. The added granularity improves the control you have have over your workflows. 
+- InvokeAI's backend and ComfyUI's backend are very different which means Comfy workflows are not able to be imported into InvokeAI. However, we have created a [list of popular workflows](exampleWorkflows.md) for you to get started with Nodes in InvokeAI!
+
+## Node Equivalents:
+
+| Comfy UI Category | ComfyUI Node | Invoke Equivalent      |
+|:---------------------------------- |:---------------------------------- | :----------------------------------|
+| Sampling |KSampler |Denoise Latents|
+| Sampling |Ksampler Advanced|Denoise Latents |
+| Loaders |Load Checkpoint | Main Model Loader _or_ SDXL Main Model Loader|
+| Loaders |Load VAE | VAE Loader |
+| Loaders |Load Lora | LoRA Loader _or_ SDXL Lora Loader|
+| Loaders |Load ControlNet Model | ControlNet|
+| Loaders |Load ControlNet Model (diff) | ControlNet|
+| Loaders |Load Style Model | Reference Only ControlNet will be coming in a future version of InvokeAI|
+| Loaders |unCLIPCheckpointLoader | N/A |
+| Loaders |GLIGENLoader | N/A |
+| Loaders |Hypernetwork Loader | N/A |
+| Loaders |Load Upscale Model | Occurs within "Upscale (RealESRGAN)"|
+|Conditioning |CLIP Text Encode (Prompt) | Compel (Prompt) or SDXL Compel (Prompt) |
+|Conditioning |CLIP Set Last Layer | CLIP Skip|
+|Conditioning |Conditioning (Average) | Use the .blend() feature of prompts |
+|Conditioning |Conditioning (Combine) | N/A |
+|Conditioning |Conditioning (Concat) | See the Prompt Tools Community Node|
+|Conditioning |Conditioning (Set Area) | N/A |
+|Conditioning |Conditioning (Set Mask) | Mask Edge |
+|Conditioning |CLIP Vision Encode | N/A |
+|Conditioning |unCLIPConditioning | N/A |
+|Conditioning |Apply ControlNet | ControlNet |
+|Conditioning |Apply ControlNet (Advanced) | ControlNet |
+|Latent |VAE Decode | Latents to Image|
+|Latent |VAE Encode | Image to Latents |
+|Latent |Empty Latent Image | Noise |
+|Latent |Upscale Latent |Resize Latents |
+|Latent |Upscale Latent By |Scale Latents |
+|Latent |Latent Composite | Blend Latents |
+|Latent |LatentCompositeMasked | N/A |
+|Image |Save Image | Image |
+|Image |Preview Image |Current |
+|Image |Load Image | Image|
+|Image |Empty Image| Blank Image |
+|Image |Invert Image | Invert Lerp Image |
+|Image |Batch Images | Link "Image" nodes into an "Image Collection" node |
+|Image |Pad Image for Outpainting | Outpainting is easily accomplished in the Unified Canvas |
+|Image |ImageCompositeMasked | Paste Image |
+|Image | Upscale Image | Resize Image |
+|Image | Upscale Image By | Upscale Image |
+|Image | Upscale Image (using Model) | Upscale Image |
+|Image | ImageBlur | Blur Image |
+|Image | ImageQuantize | N/A |
+|Image | ImageSharpen | N/A |
+|Image | Canny | Canny Processor |
+|Mask |Load Image (as Mask) | Image |
+|Mask |Convert Mask to Image | Image|
+|Mask |Convert Image to Mask | Image |
+|Mask |SolidMask | N/A |
+|Mask |InvertMask |Invert Lerp Image |
+|Mask |CropMask | Crop Image |
+|Mask |MaskComposite | Combine Mask |
+|Mask |FeatherMask | Blur Image |
+|Advanced | Load CLIP | Main Model Loader _or_ SDXL Main Model Loader|
+|Advanced | UNETLoader | Main Model Loader _or_ SDXL Main Model Loader|
+|Advanced | DualCLIPLoader | Main Model Loader _or_ SDXL Main Model Loader|
+|Advanced | Load Checkpoint | Main Model Loader _or_ SDXL Main Model Loader |
+|Advanced | ConditioningZeroOut | N/A |
+|Advanced | ConditioningSetTimestepRange | N/A |
+|Advanced | CLIPTextEncodeSDXLRefiner | Compel (Prompt) or SDXL Compel (Prompt) |
+|Advanced | CLIPTextEncodeSDXL |Compel (Prompt) or SDXL Compel (Prompt) |
+|Advanced | ModelMergeSimple | Model Merging is available in the Model Manager |
+|Advanced | ModelMergeBlocks | Model Merging is available in the Model Manager|
+|Advanced | CheckpointSave | Model saving is available in the Model Manager|
+|Advanced | CLIPMergeSimple | N/A |
+
+

docs/nodes/communityNodes.md

@@ -0,0 +1,81 @@
+# Community Nodes
+
+These are nodes that have been developed by the community, for the community. If you're not sure what a node is, you can learn more about nodes [here](overview.md).
+
+If you'd like to submit a node for the community, please refer to the [node creation overview](contributingNodes.md).
+
+To download a node, simply download the `.py` node file from the link and add it to the `invokeai/app/invocations` folder in your Invoke AI install location. Along with the node, an example node graph should be provided to help you get started with the node. 
+
+To use a community node graph, download the the `.json` node graph file and load it into Invoke AI via the **Load Nodes** button on the Node Editor. 
+
+## Community Nodes
+
+### FaceTools
+
+**Description:** FaceTools is a collection of nodes created to manipulate faces as you would in Unified Canvas. It includes FaceMask, FaceOff, and FacePlace. FaceMask autodetects a face in the image using MediaPipe and creates a mask from it. FaceOff similarly detects a face, then takes the face off of the image by adding a square bounding box around it and cropping/scaling it. FacePlace puts the bounded face image from FaceOff back onto the original image. Using these nodes with other inpainting node(s), you can put new faces on existing things, put new things around existing faces, and work closer with a face as a bounded image. Additionally, you can supply X and Y offset values to scale/change the shape of the mask for finer control on FaceMask and FaceOff. See GitHub repository below for usage examples.
+
+**Node Link:** https://github.com/ymgenesis/FaceTools/
+
+**FaceMask Output Examples** 
+
+![5cc8abce-53b0-487a-b891-3bf94dcc8960](https://github.com/invoke-ai/InvokeAI/assets/25252829/43f36d24-1429-4ab1-bd06-a4bedfe0955e)
+![b920b710-1882-49a0-8d02-82dff2cca907](https://github.com/invoke-ai/InvokeAI/assets/25252829/7660c1ed-bf7d-4d0a-947f-1fc1679557ba)
+![71a91805-fda5-481c-b380-264665703133](https://github.com/invoke-ai/InvokeAI/assets/25252829/f8f6a2ee-2b68-4482-87da-b90221d5c3e2)
+
+<hr>
+
+### Ideal Size
+
+**Description:** This node calculates an ideal image size for a first pass of a multi-pass upscaling. The aim is to avoid duplication that results from choosing a size larger than the model is capable of.
+
+**Node Link:** https://github.com/JPPhoto/ideal-size-node
+
+<hr>
+
+### Retroize
+
+**Description:** Retroize is a collection of nodes for InvokeAI to "Retroize" images. Any image can be given a fresh coat of retro paint with these nodes, either from your gallery or from within the graph itself. It includes nodes to pixelize, quantize, palettize, and ditherize images; as well as to retrieve palettes from existing images.
+
+**Node Link:** https://github.com/Ar7ific1al/invokeai-retroizeinode/
+
+**Retroize Output Examples**
+
+![image](https://github.com/Ar7ific1al/InvokeAI_nodes_retroize/assets/2306586/de8b4fa6-324c-4c2d-b36c-297600c73974)
+
+--------------------------------
+### GPT2RandomPromptMaker
+
+**Description:** A node for InvokeAI utilizes the GPT-2 language model to generate random prompts based on a provided seed and context.
+
+**Node Link:** https://github.com/mickr777/GPT2RandomPromptMaker
+
+**Output Examples** 
+
+Generated Prompt: An enchanted weapon will be usable by any character regardless of their alignment.
+
+![9acf5aef-7254-40dd-95b3-8eac431dfab0 (1)](https://github.com/mickr777/InvokeAI/assets/115216705/8496ba09-bcdd-4ff7-8076-ff213b6a1e4c)
+
+
+
+--------------------------------
+### Example Node Template
+
+**Description:** This node allows you to do super cool things with InvokeAI.
+
+**Node Link:** https://github.com/invoke-ai/InvokeAI/fake_node.py
+
+**Example Node Graph:**  https://github.com/invoke-ai/InvokeAI/fake_node_graph.json
+
+**Output Examples** 
+
+![Example Image](https://invoke-ai.github.io/InvokeAI/assets/invoke_ai_banner.png){: style="height:115px;width:240px"}
+
+
+## Disclaimer
+
+The nodes linked have been developed and contributed by members of the Invoke AI community. While we strive to ensure the quality and safety of these contributions, we do not guarantee the reliability or security of the nodes. If you have issues or concerns with any of the nodes below, please raise it on GitHub or in the Discord.
+
+
+## Help
+If you run into any issues with a node, please post in the [InvokeAI Discord](https://discord.gg/ZmtBAhwWhy). 
+

docs/nodes/contributingNodes.md

@@ -0,0 +1,27 @@
+# Contributing Nodes
+
+To learn about the specifics of creating a new node, please visit our [Node creation documentation](../contributing/INVOCATIONS.md). 
+
+Once you’ve created a node and confirmed that it behaves as expected locally, follow these steps: 
+
+- Make sure the node is contained in a new Python (.py) file 
+- Submit a pull request with a link to your node in GitHub against the `nodes` branch to add the node to the [Community Nodes](Community Nodes) list
+    - Make sure you are following the template below and have provided all relevant details about the node and what it does.
+- A maintainer will review the pull request and node. If the node is aligned with the direction of the project, you might be asked for permission to include it in the core project.
+
+### Community Node Template
+
+```markdown
+--------------------------------
+### Super Cool Node Template
+
+**Description:** This node allows you to do super cool things with InvokeAI.
+
+**Node Link:** https://github.com/invoke-ai/InvokeAI/fake_node.py
+
+**Example Node Graph:**  https://github.com/invoke-ai/InvokeAI/fake_node_graph.json
+
+**Output Examples** 
+
+![InvokeAI](https://invoke-ai.github.io/InvokeAI/assets/invoke_ai_banner.png)
+```

docs/nodes/defaultNodes.md

@@ -0,0 +1,97 @@
+# List of Default Nodes
+
+The table below contains a list of the default nodes shipped with InvokeAI and their descriptions. 
+
+| Node <img width=160 align="right"> | Function                                                                              |
+|: ---------------------------------- | :--------------------------------------------------------------------------------------|
+|Add Integers 			| Adds two numbers|
+|Boolean Primitive Collection 			| A collection of boolean primitive values|
+|Boolean Primitive 			| A boolean primitive value|
+|Canny Processor 			| Canny edge detection for ControlNet|
+|CLIP Skip 			| Skip layers in clip text_encoder model.|
+|Collect 			| Collects values into a collection|
+|Color Correct 			| Shifts the colors of a target image to match the reference image, optionally using a mask to only color-correct certain regions of the target image.|
+|Color Primitive 			| A color primitive value|
+|Compel Prompt 			| Parse prompt using compel package to conditioning.|
+|Conditioning Primitive Collection 			| A collection of conditioning tensor primitive values|
+|Conditioning Primitive 			| A conditioning tensor primitive value|
+|Content Shuffle Processor 			| Applies content shuffle processing to image|
+|ControlNet 			| Collects ControlNet info to pass to other nodes|
+|OpenCV Inpaint 			| Simple inpaint using opencv.|
+|Denoise Latents 			| Denoises noisy latents to decodable images|
+|Divide Integers 			| Divides two numbers|
+|Dynamic Prompt 			| Parses a prompt using adieyal/dynamicprompts' random or combinatorial generator|
+|Upscale (RealESRGAN) 			| Upscales an image using RealESRGAN.|
+|Float Primitive Collection 			| A collection of float primitive values|
+|Float Primitive 			| A float primitive value|
+|Float Range 			| Creates a range|
+|HED (softedge) Processor 			| Applies HED edge detection to image|
+|Blur Image 			| Blurs an image|
+|Extract Image Channel 			| Gets a channel from an image.|
+|Image Primitive Collection 			| A collection of image primitive values|
+|Convert Image Mode 			| Converts an image to a different mode.|
+|Crop Image 			| Crops an image to a specified box. The box can be outside of the image.|
+|Image Hue Adjustment 			| Adjusts the Hue of an image.|
+|Inverse Lerp Image 			| Inverse linear interpolation of all pixels of an image|
+|Image Primitive 			| An image primitive value|
+|Lerp Image 			| Linear interpolation of all pixels of an image|
+|Image Luminosity Adjustment 			| Adjusts the Luminosity (Value) of an image.|
+|Multiply Images 			| Multiplies two images together using `PIL.ImageChops.multiply()`.|
+|Blur NSFW Image 			| Add blur to NSFW-flagged images|
+|Paste Image 			| Pastes an image into another image.|
+|ImageProcessor 			| Base class for invocations that preprocess images for ControlNet|
+|Resize Image 			| Resizes an image to specific dimensions|
+|Image Saturation Adjustment 			| Adjusts the Saturation of an image.|
+|Scale Image 			| Scales an image by a factor|
+|Image to Latents 			| Encodes an image into latents.|
+|Add Invisible Watermark 			| Add an invisible watermark to an image|
+|Solid Color Infill 			| Infills transparent areas of an image with a solid color|
+|PatchMatch Infill 			| Infills transparent areas of an image using the PatchMatch algorithm|
+|Tile Infill 			| Infills transparent areas of an image with tiles of the image|
+|Integer Primitive Collection 			| A collection of integer primitive values|
+|Integer Primitive 			| An integer primitive value|
+|Iterate 			| Iterates over a list of items|
+|Latents Primitive Collection 			| A collection of latents tensor primitive values|
+|Latents Primitive 			| A latents tensor primitive value|
+|Latents to Image 			| Generates an image from latents.|
+|Leres (Depth) Processor 			| Applies leres processing to image|
+|Lineart Anime Processor 			| Applies line art anime processing to image|
+|Lineart Processor 			| Applies line art processing to image|
+|LoRA Loader 			| Apply selected lora to unet and text_encoder.|
+|Main Model Loader 			| Loads a main model, outputting its submodels.|
+|Combine Mask 			| Combine two masks together by multiplying them using `PIL.ImageChops.multiply()`.|
+|Mask Edge 			| Applies an edge mask to an image|
+|Mask from Alpha 			| Extracts the alpha channel of an image as a mask.|
+|Mediapipe Face Processor 			| Applies mediapipe face processing to image|
+|Midas (Depth) Processor 			| Applies Midas depth processing to image|
+|MLSD Processor 			| Applies MLSD processing to image|
+|Multiply Integers 			| Multiplies two numbers|
+|Noise 			| Generates latent noise.|
+|Normal BAE Processor 			| Applies NormalBae processing to image|
+|ONNX Latents to Image 			| Generates an image from latents.|
+|ONNX Prompt (Raw) 			| A node to process inputs and produce outputs. May use dependency injection in __init__ to receive providers.|
+|ONNX Text to Latents 			| Generates latents from conditionings.|
+|ONNX Model Loader 			| Loads a main model, outputting its submodels.|
+|Openpose Processor 			| Applies Openpose processing to image|
+|PIDI Processor 			| Applies PIDI processing to image|
+|Prompts from File 			| Loads prompts from a text file|
+|Random Integer 			| Outputs a single random integer.|
+|Random Range 			| Creates a collection of random numbers|
+|Integer Range 			| Creates a range of numbers from start to stop with step|
+|Integer Range of Size 			| Creates a range from start to start + size with step|
+|Resize Latents 			| Resizes latents to explicit width/height (in pixels). Provided dimensions are floor-divided by 8.|
+|SDXL Compel Prompt 			| Parse prompt using compel package to conditioning.|
+|SDXL LoRA Loader 			| Apply selected lora to unet and text_encoder.|
+|SDXL Main Model Loader 			| Loads an sdxl base model, outputting its submodels.|
+|SDXL Refiner Compel Prompt 			| Parse prompt using compel package to conditioning.|
+|SDXL Refiner Model Loader 			| Loads an sdxl refiner model, outputting its submodels.|
+|Scale Latents 			| Scales latents by a given factor.|
+|Segment Anything Processor 			| Applies segment anything processing to image|
+|Show Image 			| Displays a provided image, and passes it forward in the pipeline.|
+|Step Param Easing 			| Experimental per-step parameter easing for denoising steps|
+|String Primitive Collection 			| A collection of string primitive values|
+|String Primitive 			| A string primitive value|
+|Subtract Integers 			| Subtracts two numbers|
+|Tile Resample Processor 			| Tile resampler processor|
+|VAE Loader 			| Loads a VAE model, outputting a VaeLoaderOutput|
+|Zoe (Depth) Processor 			| Applies Zoe depth processing to image|

docs/nodes/exampleWorkflows.md

@@ -0,0 +1,15 @@
+# Example Workflows
+
+TODO: Will update once uploading workflows is available.
+
+## Text2Image
+
+## Image2Image
+
+## ControlNet
+
+## Upscaling
+
+## Inpainting / Outpainting
+
+## LoRAs

docs/nodes/overview.md

@@ -0,0 +1,26 @@
+# Nodes
+
+## What are Nodes?
+An Node is simply a single operation that takes in inputs and returns
+out outputs. Multiple nodes can be linked together to create more
+complex functionality. All InvokeAI features are added through nodes.
+
+### Anatomy of a Node
+
+Individual nodes are made up of the following:
+
+- Inputs: Edge points on the left side of the node window where you connect outputs from other nodes.
+- Outputs: Edge points on the right side of the node window where you connect to inputs on other nodes.
+- Options: Various options which are either manually configured, or overridden by connecting an output from another node to the input.
+
+
+With nodes, you can can easily extend the image generation capabilities of InvokeAI, and allow you build workflows that suit your needs. 
+
+You can read more about nodes and the node editor [here](../nodes/NODES.md). 
+
+To get started with nodes, take a look at some of our examples for [common workflows](../nodes/exampleWorkflows.md)
+
+## Downloading New Nodes
+To download a new node, visit our list of [Community Nodes](../nodes/communityNodes.md). These are nodes that have been created by the community, for the community. 
+
+

docs/other/CONTRIBUTORS.md

@@ -17,67 +17,267 @@ We thank them for all of their time and hard work.
 
 * @lstein (Lincoln Stein) - Co-maintainer
 * @blessedcoolant - Co-maintainer
-* @hipsterusername (Kent Keirsey) - Product Manager
-* @psychedelicious - Web Team Leader
+* @hipsterusername (Kent Keirsey) - Co-maintainer, CEO, Positive Vibes
+* @psychedelicious (Spencer Mabrito) - 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
+* @damian0815 - Attention Systems and Compel Maintainer
 * @ebr (Eugene Brodsky) - Cloud/DevOps/Sofware engineer; your friendly neighbourhood cluster-autoscaler
-* @jpphoto (Jonathan Pollack) - Inference and rendering engine optimization
-* @genomancer (Gregg Helt) - Model training and merging
+* @genomancer (Gregg Helt) - Controlnet support
+* @StAlKeR7779 (Sergey Borisov) - Torch stack, ONNX, model management, optimization
+* @cheerio (Mary Rogers) - Lead Engineer & Web App Development
+* @brandon (Brandon Rising) - Platform, Infrastructure, Backend Systems
+* @ryanjdick (Ryan Dick) - Machine Learning & Training
+* @millu (Millun Atluri) - Community Manager, Documentation, Node-wrangler
+* @chainchompa (Jennifer Player) - Web Development & Chain-Chomping
+* @keturn (Kevin Turner) - Diffusers
+* @gogurt enjoyer - Discord moderator and end user support
+* @whosawhatsis - Discord moderator and end user support
+* @dwinrger - Discord moderator and end user support
+* @526christian - Discord moderator and end user support
 
-## **Contributions by**
+## **Full List of Contributors by Commit Name**
 
-- [Sean McLellan](https://github.com/Oceanswave)
-- [Kevin Gibbons](https://github.com/bakkot)
-- [Tesseract Cat](https://github.com/TesseractCat)
-- [blessedcoolant](https://github.com/blessedcoolant)
-- [David Ford](https://github.com/david-ford)
-- [yunsaki](https://github.com/yunsaki)
-- [James Reynolds](https://github.com/magnusviri)
-- [David Wager](https://github.com/maddavid123)
-- [Jason Toffaletti](https://github.com/toffaletti)
-- [tildebyte](https://github.com/tildebyte)
-- [Cragin Godley](https://github.com/cgodley)
-- [BlueAmulet](https://github.com/BlueAmulet)
-- [Benjamin Warner](https://github.com/warner-benjamin)
-- [Cora Johnson-Roberson](https://github.com/corajr)
-- [veprogames](https://github.com/veprogames)
-- [JigenD](https://github.com/JigenD)
-- [Niek van der Maas](https://github.com/Niek)
-- [Henry van Megen](https://github.com/hvanmegen)
-- [Håvard Gulldahl](https://github.com/havardgulldahl)
-- [greentext2](https://github.com/greentext2)
-- [Simon Vans-Colina](https://github.com/simonvc)
-- [Gabriel Rotbart](https://github.com/gabrielrotbart)
-- [Eric Khun](https://github.com/erickhun)
-- [Brent Ozar](https://github.com/BrentOzar)
-- [nderscore](https://github.com/nderscore)
-- [Mikhail Tishin](https://github.com/tishin)
-- [Tom Elovi Spruce](https://github.com/ilovecomputers)
-- [spezialspezial](https://github.com/spezialspezial)
-- [Yosuke Shinya](https://github.com/shinya7y)
-- [Andy Pilate](https://github.com/Cubox)
-- [Muhammad Usama](https://github.com/SMUsamaShah)
-- [Arturo Mendivil](https://github.com/artmen1516)
-- [Paul Sajna](https://github.com/sajattack)
-- [Samuel Husso](https://github.com/shusso)
-- [nicolai256](https://github.com/nicolai256)
-- [Mihai](https://github.com/mh-dm)
-- [Any Winter](https://github.com/any-winter-4079)
-- [Doggettx](https://github.com/doggettx)
-- [Matthias Wild](https://github.com/mauwii)
-- [Kyle Schouviller](https://github.com/kyle0654)
-- [rabidcopy](https://github.com/rabidcopy)
-- [Dominic Letz](https://github.com/dominicletz)
-- [Dmitry T.](https://github.com/ArDiouscuros)
-- [Kent Keirsey](https://github.com/hipsterusername)
-- [psychedelicious](https://github.com/psychedelicious)
-- [damian0815](https://github.com/damian0815)
-- [Eugene Brodsky](https://github.com/ebr)
+- AbdBarho
+- ablattmann
+- AdamOStark
+- Adam Rice
+- Airton Silva
+- Alexander Eichhorn
+- Alexandre D. Roberge
+- Andreas Rozek
+- Andre LaBranche
+- Andy Bearman
+- Andy Luhrs
+- Andy Pilate
+- Any-Winter-4079
+- apolinario
+- ArDiouscuros
+- Armando C. Santisbon
+- Arthur Holstvoogd
+- artmen1516
+- Artur
+- Arturo Mendivil
+- Ben Alkov
+- Benjamin Warner
+- Bernard Maltais
+- blessedcoolant
+- blhook
+- BlueAmulet
+- Bouncyknighter
+- Brandon Rising
+- Brent Ozar
+- Brian Racer
+- bsilvereagle
+- c67e708d
+- CapableWeb
+- Carson Katri
+- Chloe
+- Chris Dawson
+- Chris Hayes
+- Chris Jones
+- chromaticist
+- Claus F. Strasburger
+- cmdr2
+- cody
+- Conor Reid
+- Cora Johnson-Roberson
+- coreco
+- cosmii02
+- cpacker
+- Cragin Godley
+- creachec
+- Damian Stewart
+- Daniel Manzke
+- Danny Beer
+- Dan Sully
+- David Burnett
+- David Ford
+- David Regla
+- David Wager
+- Daya Adianto
+- db3000
+- Denis Olshin
+- Dennis
+- Dominic Letz
+- DrGunnarMallon
+- Edward Johan
+- elliotsayes
+- Elrik
+- ElrikUnderlake
+- Eric Khun
+- Eric Wolf
+- Eugene Brodsky
+- ExperimentalCyborg
+- Fabian Bahl
+- Fabio 'MrWHO' Torchetti
+- fattire
+- Felipe Nogueira
+- Félix Sanz
+- figgefigge
+- Gabriel Mackievicz Telles
+- gabrielrotbart
+- gallegonovato
+- Gérald LONLAS
+- GitHub Actions Bot
+- gogurtenjoyer
+- greentext2
+- Gregg Helt
+- H4rk
+- Håvard Gulldahl
+- henry
+- Henry van Megen
+- hipsterusername
+- hj
+- Hosted Weblate
+- Iman Karim
+- ismail ihsan bülbül
+- Ivan Efimov
+- jakehl
+- Jakub Kolčář
+- JamDon2
+- James Reynolds
+- Jan Skurovec
+- Jari Vetoniemi
+- Jason Toffaletti
+- Jaulustus
+- Jeff Mahoney
+- jeremy
+- Jeremy Clark
+- JigenD
+- Jim Hays
+- Johan Roxendal
+- Johnathon Selstad
+- Jonathan
+- Joseph Dries III
+- JPPhoto
+- jspraul
+- Justin Wong
+- Juuso V
+- Kaspar Emanuel
+- Katsuyuki-Karasawa
+- Kent Keirsey
+- Kevin Coakley
+- Kevin Gibbons
+- Kevin Schaul
+- Kevin Turner
+- krummrey
+- Kyle Lacy
+- Kyle Schouviller
+- Lawrence Norton
+- LemonDouble
+- Leo Pasanen
+- Lincoln Stein
+- LoganPederson
+- Lynne Whitehorn
+- majick
+- Marco Labarile
+- Martin Kristiansen
+- Mary Hipp Rogers
+- mastercaster9000
+- Matthias Wild
+- michaelk71
+- mickr777
+- Mihai
+- Mihail Dumitrescu
+- Mikhail Tishin
+- Millun Atluri
+- Minjune Song
+- mitien
+- mofuzz
+- Muhammad Usama
+- Name
+- _nderscore
+- Netzer R
+- Nicholas Koh
+- Nicholas Körfer
+- nicolai256
+- Niek van der Maas
+- noodlebox
+- Nuno Coração
+- ofirkris
+- Olivier Louvignes
+- owenvincent
+- Patrick Esser
+- Patrick Tien
+- Patrick von Platen
+- Paul Sajna
+- pejotr
+- Peter Baylies
+- Peter Lin
+- plucked
+- prixt
+- psychedelicious
+- Rainer Bernhardt
+- Riccardo Giovanetti
+- Rich Jones
+- rmagur1203
+- Rob Baines
+- Robert Bolender
+- Robin Rombach
+- Rohan Barar
+- rpagliuca
+- rromb
+- Rupesh Sreeraman
+- Ryan Cao
+- Saifeddine
+- Saifeddine ALOUI
+- SammCheese
+- Sammy
+- sammyf
+- Samuel Husso
+- Scott Lahteine
+- Sean McLellan
+- Sebastian Aigner
+- Sergey Borisov
+- Sergey Krashevich
+- Shapor Naghibzadeh
+- Shawn Zhong
+- Simon Vans-Colina
+- skunkworxdark
+- slashtechno
+- spezialspezial
+- ssantos
+- StAlKeR7779
+- Stephan Koglin-Fischer
+- SteveCaruso
+- Steve Martinelli
+- Steven Frank
+- System X - Files
+- Taylor Kems
+- techicode
+- techybrain-dev
+- tesseractcat
+- thealanle
+- Thomas
+- tildebyte
+- Tim Cabbage
+- Tom
+- Tom Elovi Spruce
+- Tom Gouville
+- tomosuto
+- Travco
+- Travis Palmer
+- tyler
+- unknown
+- user1
+- Vedant Madane
+- veprogames
+- wa.code
+- wfng92
+- whosawhatsis
+- Will
+- William Becher
+- William Chong
+- xra
+- Yeung Yiu Hung
+- ymgenesis
+- Yorzaren
+- Yosuke Shinya
+- yun saki
+- Zadagu
+- zeptofine
+- 冯不游
+- 唐澤 克幸
 
 ## **Original CompVis Authors**
 

flake.lock

@@ -0,0 +1,25 @@
+{
+  "nodes": {
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1690630721,
+        "narHash": "sha256-Y04onHyBQT4Erfr2fc82dbJTfXGYrf4V0ysLUYnPOP8=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "d2b52322f35597c62abf56de91b0236746b2a03d",
+        "type": "github"
+      },
+      "original": {
+        "id": "nixpkgs",
+        "type": "indirect"
+      }
+    },
+    "root": {
+      "inputs": {
+        "nixpkgs": "nixpkgs"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

flake.nix

@@ -0,0 +1,91 @@
+# Important note: this flake does not attempt to create a fully isolated, 'pure'
+# Python environment for InvokeAI. Instead, it depends on local invocations of
+# virtualenv/pip to install the required (binary) packages, most importantly the
+# prebuilt binary pytorch packages with CUDA support.
+# ML Python packages with CUDA support, like pytorch, are notoriously expensive
+# to compile so it's purposefuly not what this flake does.
+
+{
+  description = "An (impure) flake to develop on InvokeAI.";
+
+  outputs = { self, nixpkgs }:
+    let
+      system = "x86_64-linux";
+      pkgs = import nixpkgs {
+        inherit system;
+        config.allowUnfree = true;
+      };
+
+      python = pkgs.python310;
+
+      mkShell = { dir, install }:
+        let
+          setupScript = pkgs.writeScript "setup-invokai" ''
+            # This must be sourced using 'source', not executed.
+            ${python}/bin/python -m venv ${dir}
+            ${dir}/bin/python -m pip install ${install}
+            # ${dir}/bin/python -c 'import torch; assert(torch.cuda.is_available())'
+            source ${dir}/bin/activate
+          '';
+        in
+        pkgs.mkShell rec {
+          buildInputs = with pkgs; [
+            # Backend: graphics, CUDA.
+            cudaPackages.cudnn
+            cudaPackages.cuda_nvrtc
+            cudatoolkit
+            pkgconfig
+            libconfig
+            cmake
+            blas
+            freeglut
+            glib
+            gperf
+            procps
+            libGL
+            libGLU
+            linuxPackages.nvidia_x11
+            python
+            (opencv4.override {
+              enableGtk3 = true;
+              enableFfmpeg = true;
+              enableCuda = true;
+              enableUnfree = true;
+            })
+            stdenv.cc
+            stdenv.cc.cc.lib
+            xorg.libX11
+            xorg.libXext
+            xorg.libXi
+            xorg.libXmu
+            xorg.libXrandr
+            xorg.libXv
+            zlib
+
+            # Pre-commit hooks.
+            black
+
+            # Frontend.
+            yarn
+            nodejs
+          ];
+          LD_LIBRARY_PATH = pkgs.lib.makeLibraryPath buildInputs;
+          CUDA_PATH = pkgs.cudatoolkit;
+          EXTRA_LDFLAGS = "-L${pkgs.linuxPackages.nvidia_x11}/lib";
+          shellHook = ''
+            if [[ -f "${dir}/bin/activate" ]]; then
+              source "${dir}/bin/activate"
+              echo "Using Python: $(which python)"
+            else
+              echo "Use 'source ${setupScript}' to set up the environment."
+            fi
+          '';
+        };
+    in
+    {
+      devShells.${system} = rec {
+        develop = mkShell { dir = "venv"; install = "-e '.[xformers]' --extra-index-url https://download.pytorch.org/whl/cu118"; };
+        default = develop;
+      };
+    };
+}

installer/install.sh.in

@@ -9,16 +9,20 @@ cd $scriptdir
 function version { echo "$@" | awk -F. '{ printf("%d%03d%03d%03d\n", $1,$2,$3,$4); }'; }
 
 MINIMUM_PYTHON_VERSION=3.9.0
-MAXIMUM_PYTHON_VERSION=3.11.0
+MAXIMUM_PYTHON_VERSION=3.11.100
 PYTHON=""
-for candidate in python3.10 python3.9 python3 python ; do
+for candidate in python3.11 python3.10 python3.9 python3 python ; do
     if ppath=`which $candidate`; then
+        # when using `pyenv`, the executable for an inactive Python version will exist but will not be operational
+        # we check that this found executable can actually run
+        if [ $($candidate --version &>/dev/null; echo ${PIPESTATUS}) -gt 0 ]; then continue; fi
+
         python_version=$($ppath -V | awk '{ print $2 }')
         if [ $(version $python_version) -ge $(version "$MINIMUM_PYTHON_VERSION") ]; then
-	    if [ $(version $python_version) -lt $(version "$MAXIMUM_PYTHON_VERSION") ]; then
-		PYTHON=$ppath
-		break
-	    fi
+            if [ $(version $python_version) -le $(version "$MAXIMUM_PYTHON_VERSION") ]; then
+                PYTHON=$ppath
+                break
+            fi
         fi
     fi
 done

installer/lib/installer.py

@@ -13,7 +13,7 @@ from pathlib import Path
 from tempfile import TemporaryDirectory
 from typing import Union
 
-SUPPORTED_PYTHON = ">=3.9.0,<3.11"
+SUPPORTED_PYTHON = ">=3.9.0,<=3.11.100"
 INSTALLER_REQS = ["rich", "semver", "requests", "plumbum", "prompt-toolkit"]
 BOOTSTRAP_VENV_PREFIX = "invokeai-installer-tmp"
 
@@ -141,15 +141,16 @@ class Installer:
 
         # upgrade pip in Python 3.9 environments
         if int(platform.python_version_tuple()[1]) == 9:
-
             from plumbum import FG, local
 
             pip = local[get_pip_from_venv(venv_dir)]
-            pip[ "install", "--upgrade", "pip"] & FG
+            pip["install", "--upgrade", "pip"] & FG
 
         return venv_dir
 
-    def install(self, root: str = "~/invokeai-3", version: str = "latest", yes_to_all=False, find_links: Path = None) -> None:
+    def install(
+        self, root: str = "~/invokeai", version: str = "latest", yes_to_all=False, find_links: Path = None
+    ) -> None:
         """
         Install the InvokeAI application into the given runtime path
 
@@ -167,7 +168,8 @@ class Installer:
 
         messages.welcome()
 
-        self.dest = Path(root).expanduser().resolve() if yes_to_all else messages.dest_path(root)
+        default_path = os.environ.get("INVOKEAI_ROOT") or Path(root).expanduser().resolve()
+        self.dest = default_path if yes_to_all else messages.dest_path(root)
 
         # create the venv for the app
         self.venv = self.app_venv()
@@ -175,7 +177,7 @@ class Installer:
         self.instance = InvokeAiInstance(runtime=self.dest, venv=self.venv, version=version)
 
         # install dependencies and the InvokeAI application
-        (extra_index_url,optional_modules) = get_torch_source() if not yes_to_all else (None,None)
+        (extra_index_url, optional_modules) = get_torch_source() if not yes_to_all else (None, None)
         self.instance.install(
             extra_index_url,
             optional_modules,
@@ -188,6 +190,7 @@ class Installer:
         # run through the configuration flow
         self.instance.configure()
 
+
 class InvokeAiInstance:
     """
     Manages an installed instance of InvokeAI, comprising a virtual environment and a runtime directory.
@@ -196,7 +199,6 @@ class InvokeAiInstance:
     """
 
     def __init__(self, runtime: Path, venv: Path, version: str) -> None:
-
         self.runtime = runtime
         self.venv = venv
         self.pip = get_pip_from_venv(venv)
@@ -247,6 +249,9 @@ class InvokeAiInstance:
             pip[
                 "install",
                 "--require-virtualenv",
+                "numpy~=1.24.0",  # choose versions that won't be uninstalled during phase 2
+                "urllib3~=1.26.0",
+                "requests~=2.28.0",
                 "torch~=2.0.0",
                 "torchmetrics==0.11.4",
                 "torchvision>=0.14.1",
@@ -312,7 +317,7 @@ class InvokeAiInstance:
                 "install",
                 "--require-virtualenv",
                 "--use-pep517",
-                str(src)+(optional_modules if optional_modules else ''),
+                str(src) + (optional_modules if optional_modules else ""),
                 "--find-links" if find_links is not None else None,
                 find_links,
                 "--extra-index-url" if extra_index_url is not None else None,
@@ -329,21 +334,21 @@ class InvokeAiInstance:
 
         # set sys.argv to a consistent state
         new_argv = [sys.argv[0]]
-        for i in range(1,len(sys.argv)):
+        for i in range(1, len(sys.argv)):
             el = sys.argv[i]
-            if el in ['-r','--root']:
+            if el in ["-r", "--root"]:
                 new_argv.append(el)
-                new_argv.append(sys.argv[i+1])
-            elif el in ['-y','--yes','--yes-to-all']:
+                new_argv.append(sys.argv[i + 1])
+            elif el in ["-y", "--yes", "--yes-to-all"]:
                 new_argv.append(el)
         sys.argv = new_argv
-        
+
         import requests  # to catch download exceptions
         from messages import introduction
 
         introduction()
 
-        from invokeai.frontend.install import invokeai_configure
+        from invokeai.frontend.install.invokeai_configure import invokeai_configure
 
         # NOTE: currently the config script does its own arg parsing! this means the command-line switches
         # from the installer will also automatically propagate down to the config script.
@@ -353,16 +358,16 @@ class InvokeAiInstance:
             invokeai_configure()
             succeeded = True
         except requests.exceptions.ConnectionError as e:
-            print(f'\nA network error was encountered during configuration and download: {str(e)}')
+            print(f"\nA network error was encountered during configuration and download: {str(e)}")
         except OSError as e:
-            print(f'\nAn OS error was encountered during configuration and download: {str(e)}')
+            print(f"\nAn OS error was encountered during configuration and download: {str(e)}")
         except Exception as e:
-            print(f'\nA problem was encountered during the configuration and download steps: {str(e)}')
+            print(f"\nA problem was encountered during the configuration and download steps: {str(e)}")
         finally:
             if not succeeded:
                 print('To try again, find the "invokeai" directory, run the script "invoke.sh" or "invoke.bat"')
-                print('and choose option 7 to fix a broken install, optionally followed by option 5 to install models.')
-                print('Alternatively you can relaunch the installer.')
+                print("and choose option 7 to fix a broken install, optionally followed by option 5 to install models.")
+                print("Alternatively you can relaunch the installer.")
 
     def install_user_scripts(self):
         """
@@ -371,11 +376,11 @@ class InvokeAiInstance:
 
         ext = "bat" if OS == "Windows" else "sh"
 
-        #scripts = ['invoke', 'update']
-        scripts = ['invoke']
-        
+        # scripts = ['invoke', 'update']
+        scripts = ["invoke"]
+
         for script in scripts:
-            src = Path(__file__).parent / '..' / "templates" / f"{script}.{ext}.in"
+            src = Path(__file__).parent / ".." / "templates" / f"{script}.{ext}.in"
             dest = self.runtime / f"{script}.{ext}"
             shutil.copy(src, dest)
             os.chmod(dest, 0o0755)
@@ -402,7 +407,7 @@ def get_pip_from_venv(venv_path: Path) -> str:
     :rtype: str
     """
 
-    pip = "Scripts\pip.exe" if OS == "Windows" else "bin/pip"
+    pip = "Scripts\\pip.exe" if OS == "Windows" else "bin/pip"
     return str(venv_path.expanduser().resolve() / pip)
 
 
@@ -420,11 +425,7 @@ def set_sys_path(venv_path: Path) -> None:
     # filter out any paths in sys.path that may be system- or user-wide
     # but leave the temporary bootstrap virtualenv as it contains packages we
     # temporarily need at install time
-    sys.path = list(filter(
-        lambda p: not p.endswith("-packages")
-        or p.find(BOOTSTRAP_VENV_PREFIX) != -1,
-        sys.path
-    ))
+    sys.path = list(filter(lambda p: not p.endswith("-packages") or p.find(BOOTSTRAP_VENV_PREFIX) != -1, sys.path))
 
     # determine site-packages/lib directory location for the venv
     lib = "Lib" if OS == "Windows" else f"lib/python{sys.version_info.major}.{sys.version_info.minor}"
@@ -433,7 +434,7 @@ def set_sys_path(venv_path: Path) -> None:
     sys.path.append(str(Path(venv_path, lib, "site-packages").expanduser().resolve()))
 
 
-def get_torch_source() -> (Union[str, None],str):
+def get_torch_source() -> (Union[str, None], str):
     """
     Determine the extra index URL for pip to use for torch installation.
     This depends on the OS and the graphics accelerator in use.
@@ -454,16 +455,19 @@ def get_torch_source() -> (Union[str, None],str):
     device = graphical_accelerator()
 
     url = None
-    optional_modules = None
+    optional_modules = "[onnx]"
     if OS == "Linux":
         if device == "rocm":
             url = "https://download.pytorch.org/whl/rocm5.4.2"
         elif device == "cpu":
             url = "https://download.pytorch.org/whl/cpu"
 
-    if device == 'cuda':
-        url = 'https://download.pytorch.org/whl/cu117'
-        optional_modules = '[xformers]'
+    if device == "cuda":
+        url = "https://download.pytorch.org/whl/cu118"
+        optional_modules = "[xformers,onnx-cuda]"
+    if device == "cuda_and_dml":
+        url = "https://download.pytorch.org/whl/cu118"
+        optional_modules = "[xformers,onnx-directml]"
 
     # in all other cases, Torch wheels should be coming from PyPi as of Torch 1.13
 

installer/lib/main.py

@@ -3,6 +3,7 @@ InvokeAI Installer
 """
 
 import argparse
+import os
 from pathlib import Path
 from installer import Installer
 
@@ -15,7 +16,7 @@ if __name__ == "__main__":
         dest="root",
         type=str,
         help="Destination path for installation",
-        default="~/invokeai",
+        default=os.environ.get("INVOKEAI_ROOT") or "~/invokeai",
     )
     parser.add_argument(
         "-y",
@@ -41,14 +42,14 @@ if __name__ == "__main__":
         type=Path,
         default=None,
     )
-    
+
     args = parser.parse_args()
 
     inst = Installer()
 
     try:
         inst.install(**args.__dict__)
-    except KeyboardInterrupt as exc:
+    except KeyboardInterrupt:
         print("\n")
         print("Ctrl-C pressed. Aborting.")
         print("Come back soon!")

installer/lib/messages.py

@@ -36,13 +36,15 @@ else:
 
 
 def welcome():
-
     @group()
     def text():
         if (platform_specific := _platform_specific_help()) != "":
             yield platform_specific
             yield ""
-        yield Text.from_markup("Some of the installation steps take a long time to run. Please be patient. If the script appears to hang for more than 10 minutes, please interrupt with [i]Control-C[/] and retry.", justify="center")
+        yield Text.from_markup(
+            "Some of the installation steps take a long time to run. Please be patient. If the script appears to hang for more than 10 minutes, please interrupt with [i]Control-C[/] and retry.",
+            justify="center",
+        )
 
     console.rule()
     print(
@@ -58,6 +60,7 @@ def welcome():
     )
     console.line()
 
+
 def confirm_install(dest: Path) -> bool:
     if dest.exists():
         print(f":exclamation: Directory {dest} already exists :exclamation:")
@@ -67,7 +70,7 @@ def confirm_install(dest: Path) -> bool:
         )
     else:
         print(f"InvokeAI will be installed in {dest}")
-        dest_confirmed = not Confirm.ask(f"Would you like to pick a different location?", default=False)
+        dest_confirmed = not Confirm.ask("Would you like to pick a different location?", default=False)
     console.line()
 
     return dest_confirmed
@@ -87,12 +90,11 @@ def dest_path(dest=None) -> Path:
         dest = Path(dest).expanduser().resolve()
     else:
         dest = Path.cwd().expanduser().resolve()
-    prev_dest = dest.expanduser().resolve()
+    prev_dest = init_path = dest
 
     dest_confirmed = confirm_install(dest)
 
     while not dest_confirmed:
-
         # if the given destination already exists, the starting point for browsing is its parent directory.
         # the user may have made a typo, or otherwise wants to place the root dir next to an existing one.
         # if the destination dir does NOT exist, then the user must have changed their mind about the selection.
@@ -107,9 +109,9 @@ def dest_path(dest=None) -> Path:
         )
 
         console.line()
-        print(f"[orange3]Please select the destination directory for the installation:[/] \[{browse_start}]: ")
+        console.print(f"[orange3]Please select the destination directory for the installation:[/] \\[{browse_start}]: ")
         selected = prompt(
-            f">>> ",
+            ">>> ",
             complete_in_thread=True,
             completer=path_completer,
             default=str(browse_start) + os.sep,
@@ -132,14 +134,14 @@ def dest_path(dest=None) -> Path:
     try:
         dest.mkdir(exist_ok=True, parents=True)
         return dest
-    except PermissionError as exc:
-        print(
+    except PermissionError:
+        console.print(
             f"Failed to create directory {dest} due to insufficient permissions",
             style=Style(color="red"),
             highlight=True,
         )
-    except OSError as exc:
-        console.print_exception(exc)
+    except OSError:
+        console.print_exception()
 
     if Confirm.ask("Would you like to try again?"):
         dest_path(init_path)
@@ -165,6 +167,10 @@ def graphical_accelerator():
         "an [gold1 b]NVIDIA[/] GPU (using CUDA™)",
         "cuda",
     )
+    nvidia_with_dml = (
+        "an [gold1 b]NVIDIA[/] GPU (using CUDA™, and DirectML™ for ONNX) -- ALPHA",
+        "cuda_and_dml",
+    )
     amd = (
         "an [gold1 b]AMD[/] GPU (using ROCm™)",
         "rocm",
@@ -179,7 +185,7 @@ def graphical_accelerator():
     )
 
     if OS == "Windows":
-        options = [nvidia, cpu]
+        options = [nvidia, nvidia_with_dml, cpu]
     if OS == "Linux":
         options = [nvidia, amd, cpu]
     elif OS == "Darwin":
@@ -300,15 +306,20 @@ def introduction() -> None:
     )
     console.line(2)
 
-def _platform_specific_help()->str:
+
+def _platform_specific_help() -> str:
     if OS == "Darwin":
-        text = Text.from_markup("""[b wheat1]macOS Users![/]\n\nPlease be sure you have the [b wheat1]Xcode command-line tools[/] installed before continuing.\nIf not, cancel with [i]Control-C[/] and follow the Xcode install instructions at [deep_sky_blue1]https://www.freecodecamp.org/news/install-xcode-command-line-tools/[/].""")
+        text = Text.from_markup(
+            """[b wheat1]macOS Users![/]\n\nPlease be sure you have the [b wheat1]Xcode command-line tools[/] installed before continuing.\nIf not, cancel with [i]Control-C[/] and follow the Xcode install instructions at [deep_sky_blue1]https://www.freecodecamp.org/news/install-xcode-command-line-tools/[/]."""
+        )
     elif OS == "Windows":
-        text = Text.from_markup("""[b wheat1]Windows Users![/]\n\nBefore you start, please do the following:
+        text = Text.from_markup(
+            """[b wheat1]Windows Users![/]\n\nBefore you start, please do the following:
   1. Double-click on the file [b wheat1]WinLongPathsEnabled.reg[/] in order to
      enable long path support on your system.
   2. Make sure you have the [b wheat1]Visual C++ core libraries[/] installed. If not, install from
-     [deep_sky_blue1]https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170[/]""")
+     [deep_sky_blue1]https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170[/]"""
+        )
     else:
         text = ""
     return text

installer/readme.txt

@@ -8,16 +8,13 @@ Preparations:
   to work. Instructions are given here:
   https://invoke-ai.github.io/InvokeAI/installation/INSTALL_AUTOMATED/
 
-  NOTE: At this time we do not recommend Python 3.11. We recommend 
-  Version 3.10.9, which has been extensively tested with InvokeAI.
-  
   Before you start the installer, please open up your system's command
   line window (Terminal or Command) and type the commands:
 
      python --version
 
   If all is well, it will print "Python 3.X.X", where the version number
-  is at least 3.9.1, and less than 3.11.
+  is at least 3.9.*, and not higher than 3.11.*.
 
   If this works, check the version of the Python package manager, pip:
 

installer/templates/invoke.bat.in

@@ -41,7 +41,7 @@ IF /I "%choice%" == "1" (
     python .venv\Scripts\invokeai-configure.exe --skip-sd-weight --skip-support-models
 ) ELSE IF /I "%choice%" == "7" (
     echo Running invokeai-configure...
-    python .venv\Scripts\invokeai-configure.exe --yes --default_only
+    python .venv\Scripts\invokeai-configure.exe --yes --skip-sd-weight
 ) ELSE IF /I "%choice%" == "8" (
     echo Developer Console
     echo Python command is:

installer/templates/invoke.sh.in

@@ -82,7 +82,7 @@ do_choice() {
     7)
         clear
         printf "Re-run the configure script to fix a broken install or to complete a major upgrade\n"
-        invokeai-configure --root ${INVOKEAI_ROOT} --yes --default_only
+        invokeai-configure --root ${INVOKEAI_ROOT} --yes --default_only --skip-sd-weights
         ;;
     8)
         clear

invokeai/app/api/dependencies.py

@@ -1,7 +1,6 @@
 # Copyright (c) 2022 Kyle Schouviller (https://github.com/kyle0654)
 
 from logging import Logger
-import os
 from invokeai.app.services.board_image_record_storage import (
     SqliteBoardImageRecordStorage,
 )
@@ -29,6 +28,7 @@ from ..services.invoker import Invoker
 from ..services.processor import DefaultInvocationProcessor
 from ..services.sqlite import SqliteItemStorage
 from ..services.model_manager_service import ModelManagerService
+from ..services.invocation_stats import InvocationStatsService
 from .events import FastAPIEventService
 
 
@@ -44,7 +44,7 @@ def check_internet() -> bool:
     try:
         urllib.request.urlopen(host, timeout=1)
         return True
-    except:
+    except Exception:
         return False
 
 
@@ -54,11 +54,12 @@ logger = InvokeAILogger.getLogger()
 class ApiDependencies:
     """Contains and initializes all dependencies for the API"""
 
-    invoker: Invoker = None
+    invoker: Invoker
 
     @staticmethod
     def initialize(config: InvokeAIAppConfig, event_handler_id: int, logger: Logger = logger):
-        logger.debug(f"InvokeAI version {__version__}")
+        logger.info(f"InvokeAI version {__version__}")
+        logger.info(f"Root directory = {str(config.root_path)}")
         logger.debug(f"Internet connectivity is {config.internet_available}")
 
         events = FastAPIEventService(event_handler_id)
@@ -66,8 +67,9 @@ class ApiDependencies:
         output_folder = config.output_path
 
         # TODO: build a file/path manager?
-        db_location = config.db_path
-        db_location.parent.mkdir(parents=True, exist_ok=True)
+        db_path = config.db_path
+        db_path.parent.mkdir(parents=True, exist_ok=True)
+        db_location = str(db_path)
 
         graph_execution_manager = SqliteItemStorage[GraphExecutionState](
             filename=db_location, table_name="graph_executions"
@@ -77,9 +79,7 @@ class ApiDependencies:
         image_record_storage = SqliteImageRecordStorage(db_location)
         image_file_storage = DiskImageFileStorage(f"{output_folder}/images")
         names = SimpleNameService()
-        latents = ForwardCacheLatentsStorage(
-            DiskLatentsStorage(f"{output_folder}/latents")
-        )
+        latents = ForwardCacheLatentsStorage(DiskLatentsStorage(f"{output_folder}/latents"))
 
         board_record_storage = SqliteBoardRecordStorage(db_location)
         board_image_record_storage = SqliteBoardImageRecordStorage(db_location)
@@ -124,12 +124,11 @@ class ApiDependencies:
             boards=boards,
             board_images=board_images,
             queue=MemoryInvocationQueue(),
-            graph_library=SqliteItemStorage[LibraryGraph](
-                filename=db_location, table_name="graphs"
-            ),
+            graph_library=SqliteItemStorage[LibraryGraph](filename=db_location, table_name="graphs"),
             graph_execution_manager=graph_execution_manager,
             processor=DefaultInvocationProcessor(),
             configuration=config,
+            performance_statistics=InvocationStatsService(graph_execution_manager),
             logger=logger,
         )
 

invokeai/app/api/routers/app_info.py

@@ -1,9 +1,35 @@
+import typing
+from enum import Enum
+from fastapi import Body
 from fastapi.routing import APIRouter
+from pathlib import Path
 from pydantic import BaseModel, Field
 
 from invokeai.backend.image_util.patchmatch import PatchMatch
+from invokeai.backend.image_util.safety_checker import SafetyChecker
+from invokeai.backend.image_util.invisible_watermark import InvisibleWatermark
+from invokeai.app.invocations.upscale import ESRGAN_MODELS
+
 from invokeai.version import __version__
 
+from ..dependencies import ApiDependencies
+from invokeai.backend.util.logging import logging
+
+
+class LogLevel(int, Enum):
+    NotSet = logging.NOTSET
+    Debug = logging.DEBUG
+    Info = logging.INFO
+    Warning = logging.WARNING
+    Error = logging.ERROR
+    Critical = logging.CRITICAL
+
+
+class Upscaler(BaseModel):
+    upscaling_method: str = Field(description="Name of upscaling method")
+    upscaling_models: list[str] = Field(description="List of upscaling models for this method")
+
+
 app_router = APIRouter(prefix="/v1/app", tags=["app"])
 
 
@@ -17,20 +43,63 @@ class AppConfig(BaseModel):
     """App Config Response"""
 
     infill_methods: list[str] = Field(description="List of available infill methods")
+    upscaling_methods: list[Upscaler] = Field(description="List of upscaling methods")
+    nsfw_methods: list[str] = Field(description="List of NSFW checking methods")
+    watermarking_methods: list[str] = Field(description="List of invisible watermark methods")
 
 
-@app_router.get(
-    "/version", operation_id="app_version", status_code=200, response_model=AppVersion
-)
+@app_router.get("/version", operation_id="app_version", status_code=200, response_model=AppVersion)
 async def get_version() -> AppVersion:
     return AppVersion(version=__version__)
 
 
-@app_router.get(
-    "/config", operation_id="get_config", status_code=200, response_model=AppConfig
-)
+@app_router.get("/config", operation_id="get_config", status_code=200, response_model=AppConfig)
 async def get_config() -> AppConfig:
-    infill_methods = ['tile']
+    infill_methods = ["tile", "lama"]
     if PatchMatch.patchmatch_available():
-        infill_methods.append('patchmatch')
-    return AppConfig(infill_methods=infill_methods)
+        infill_methods.append("patchmatch")
+
+    upscaling_models = []
+    for model in typing.get_args(ESRGAN_MODELS):
+        upscaling_models.append(str(Path(model).stem))
+    upscaler = Upscaler(upscaling_method="esrgan", upscaling_models=upscaling_models)
+
+    nsfw_methods = []
+    if SafetyChecker.safety_checker_available():
+        nsfw_methods.append("nsfw_checker")
+
+    watermarking_methods = []
+    if InvisibleWatermark.invisible_watermark_available():
+        watermarking_methods.append("invisible_watermark")
+
+    return AppConfig(
+        infill_methods=infill_methods,
+        upscaling_methods=[upscaler],
+        nsfw_methods=nsfw_methods,
+        watermarking_methods=watermarking_methods,
+    )
+
+
+@app_router.get(
+    "/logging",
+    operation_id="get_log_level",
+    responses={200: {"description": "The operation was successful"}},
+    response_model=LogLevel,
+)
+async def get_log_level() -> LogLevel:
+    """Returns the log level"""
+    return LogLevel(ApiDependencies.invoker.services.logger.level)
+
+
+@app_router.post(
+    "/logging",
+    operation_id="set_log_level",
+    responses={200: {"description": "The operation was successful"}},
+    response_model=LogLevel,
+)
+async def set_log_level(
+    level: LogLevel = Body(description="New log verbosity level"),
+) -> LogLevel:
+    """Sets the log verbosity level"""
+    ApiDependencies.invoker.services.logger.setLevel(level)
+    return LogLevel(ApiDependencies.invoker.services.logger.level)

invokeai/app/api/routers/board_images.py

@@ -1,69 +1,112 @@
-from fastapi import Body, HTTPException, Path, Query
+from fastapi import Body, HTTPException
 from fastapi.routing import APIRouter
-from invokeai.app.services.board_record_storage import BoardRecord, BoardChanges
-from invokeai.app.services.image_record_storage import OffsetPaginatedResults
-from invokeai.app.services.models.board_record import BoardDTO
-from invokeai.app.services.models.image_record import ImageDTO
+from pydantic import BaseModel, Field
 
 from ..dependencies import ApiDependencies
 
 board_images_router = APIRouter(prefix="/v1/board_images", tags=["boards"])
 
 
+class AddImagesToBoardResult(BaseModel):
+    board_id: str = Field(description="The id of the board the images were added to")
+    added_image_names: list[str] = Field(description="The image names that were added to the board")
+
+
+class RemoveImagesFromBoardResult(BaseModel):
+    removed_image_names: list[str] = Field(description="The image names that were removed from their board")
+
+
 @board_images_router.post(
     "/",
-    operation_id="create_board_image",
+    operation_id="add_image_to_board",
     responses={
         201: {"description": "The image was added to a board successfully"},
     },
     status_code=201,
 )
-async def create_board_image(
+async def add_image_to_board(
     board_id: str = Body(description="The id of the board to add to"),
     image_name: str = Body(description="The name of the image to add"),
 ):
     """Creates a board_image"""
     try:
-        result = ApiDependencies.invoker.services.board_images.add_image_to_board(board_id=board_id, image_name=image_name)
+        result = ApiDependencies.invoker.services.board_images.add_image_to_board(
+            board_id=board_id, image_name=image_name
+        )
         return result
-    except Exception as e:
-        raise HTTPException(status_code=500, detail="Failed to add to board")
-    
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to add image to board")
+
+
 @board_images_router.delete(
     "/",
-    operation_id="remove_board_image",
+    operation_id="remove_image_from_board",
     responses={
         201: {"description": "The image was removed from the board successfully"},
     },
     status_code=201,
 )
-async def remove_board_image(
-    board_id: str = Body(description="The id of the board"),
-    image_name: str = Body(description="The name of the image to remove"),
+async def remove_image_from_board(
+    image_name: str = Body(description="The name of the image to remove", embed=True),
 ):
-    """Deletes a board_image"""
+    """Removes an image from its board, if it had one"""
     try:
-        result = ApiDependencies.invoker.services.board_images.remove_image_from_board(board_id=board_id, image_name=image_name)
+        result = ApiDependencies.invoker.services.board_images.remove_image_from_board(image_name=image_name)
         return result
-    except Exception as e:
-        raise HTTPException(status_code=500, detail="Failed to update board")
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to remove image from board")
 
 
-
-@board_images_router.get(
-    "/{board_id}",
-    operation_id="list_board_images",
-    response_model=OffsetPaginatedResults[ImageDTO],
+@board_images_router.post(
+    "/batch",
+    operation_id="add_images_to_board",
+    responses={
+        201: {"description": "Images were added to board successfully"},
+    },
+    status_code=201,
+    response_model=AddImagesToBoardResult,
 )
-async def list_board_images(
-    board_id: str = Path(description="The id of the board"),
-    offset: int = Query(default=0, description="The page offset"),
-    limit: int = Query(default=10, description="The number of boards per page"),
-) -> OffsetPaginatedResults[ImageDTO]:
-    """Gets a list of images for a board"""
+async def add_images_to_board(
+    board_id: str = Body(description="The id of the board to add to"),
+    image_names: list[str] = Body(description="The names of the images to add", embed=True),
+) -> AddImagesToBoardResult:
+    """Adds a list of images to a board"""
+    try:
+        added_image_names: list[str] = []
+        for image_name in image_names:
+            try:
+                ApiDependencies.invoker.services.board_images.add_image_to_board(
+                    board_id=board_id, image_name=image_name
+                )
+                added_image_names.append(image_name)
+            except Exception:
+                pass
+        return AddImagesToBoardResult(board_id=board_id, added_image_names=added_image_names)
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to add images to board")
 
-    results = ApiDependencies.invoker.services.board_images.get_images_for_board(
-        board_id,
-    )
-    return results
 
+@board_images_router.post(
+    "/batch/delete",
+    operation_id="remove_images_from_board",
+    responses={
+        201: {"description": "Images were removed from board successfully"},
+    },
+    status_code=201,
+    response_model=RemoveImagesFromBoardResult,
+)
+async def remove_images_from_board(
+    image_names: list[str] = Body(description="The names of the images to remove", embed=True),
+) -> RemoveImagesFromBoardResult:
+    """Removes a list of images from their board, if they had one"""
+    try:
+        removed_image_names: list[str] = []
+        for image_name in image_names:
+            try:
+                ApiDependencies.invoker.services.board_images.remove_image_from_board(image_name=image_name)
+                removed_image_names.append(image_name)
+            except Exception:
+                pass
+        return RemoveImagesFromBoardResult(removed_image_names=removed_image_names)
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to remove images from board")

invokeai/app/api/routers/boards.py

@@ -1,16 +1,26 @@
 from typing import Optional, Union
+
 from fastapi import Body, HTTPException, Path, Query
 from fastapi.routing import APIRouter
+from pydantic import BaseModel, Field
+
 from invokeai.app.services.board_record_storage import BoardChanges
 from invokeai.app.services.image_record_storage import OffsetPaginatedResults
 from invokeai.app.services.models.board_record import BoardDTO
 
-
 from ..dependencies import ApiDependencies
 
 boards_router = APIRouter(prefix="/v1/boards", tags=["boards"])
 
 
+class DeleteBoardResult(BaseModel):
+    board_id: str = Field(description="The id of the board that was deleted.")
+    deleted_board_images: list[str] = Field(
+        description="The image names of the board-images relationships that were deleted."
+    )
+    deleted_images: list[str] = Field(description="The names of the images that were deleted.")
+
+
 @boards_router.post(
     "/",
     operation_id="create_board",
@@ -27,7 +37,7 @@ async def create_board(
     try:
         result = ApiDependencies.invoker.services.boards.create(board_name=board_name)
         return result
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=500, detail="Failed to create board")
 
 
@@ -40,7 +50,7 @@ async def get_board(
     try:
         result = ApiDependencies.invoker.services.boards.get_dto(board_id=board_id)
         return result
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=404, detail="Board not found")
 
 
@@ -61,33 +71,42 @@ async def update_board(
 ) -> BoardDTO:
     """Updates a board"""
     try:
-        result = ApiDependencies.invoker.services.boards.update(
-            board_id=board_id, changes=changes
-        )
+        result = ApiDependencies.invoker.services.boards.update(board_id=board_id, changes=changes)
         return result
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=500, detail="Failed to update board")
 
 
-@boards_router.delete("/{board_id}", operation_id="delete_board")
+@boards_router.delete("/{board_id}", operation_id="delete_board", response_model=DeleteBoardResult)
 async def delete_board(
     board_id: str = Path(description="The id of board to delete"),
-    include_images: Optional[bool] = Query(
-        description="Permanently delete all images on the board", default=False
-    ),
-) -> None:
+    include_images: Optional[bool] = Query(description="Permanently delete all images on the board", default=False),
+) -> DeleteBoardResult:
     """Deletes a board"""
     try:
         if include_images is True:
-            ApiDependencies.invoker.services.images.delete_images_on_board(
+            deleted_images = ApiDependencies.invoker.services.board_images.get_all_board_image_names_for_board(
+                board_id=board_id
+            )
+            ApiDependencies.invoker.services.images.delete_images_on_board(board_id=board_id)
+            ApiDependencies.invoker.services.boards.delete(board_id=board_id)
+            return DeleteBoardResult(
+                board_id=board_id,
+                deleted_board_images=[],
+                deleted_images=deleted_images,
+            )
+        else:
+            deleted_board_images = ApiDependencies.invoker.services.board_images.get_all_board_image_names_for_board(
                 board_id=board_id
             )
             ApiDependencies.invoker.services.boards.delete(board_id=board_id)
-        else:
-            ApiDependencies.invoker.services.boards.delete(board_id=board_id)
-    except Exception as e:
-        # TODO: Does this need any exception handling at all?
-        pass
+            return DeleteBoardResult(
+                board_id=board_id,
+                deleted_board_images=deleted_board_images,
+                deleted_images=[],
+            )
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to delete board")
 
 
 @boards_router.get(
@@ -98,9 +117,7 @@ async def delete_board(
 async def list_boards(
     all: Optional[bool] = Query(default=None, description="Whether to list all boards"),
     offset: Optional[int] = Query(default=None, description="The page offset"),
-    limit: Optional[int] = Query(
-        default=None, description="The number of boards per page"
-    ),
+    limit: Optional[int] = Query(default=None, description="The number of boards per page"),
 ) -> Union[OffsetPaginatedResults[BoardDTO], list[BoardDTO]]:
     """Gets a list of boards"""
     if all:
@@ -115,3 +132,19 @@ async def list_boards(
             status_code=400,
             detail="Invalid request: Must provide either 'all' or both 'offset' and 'limit'",
         )
+
+
+@boards_router.get(
+    "/{board_id}/image_names",
+    operation_id="list_all_board_image_names",
+    response_model=list[str],
+)
+async def list_all_board_image_names(
+    board_id: str = Path(description="The id of the board"),
+) -> list[str]:
+    """Gets a list of images for a board"""
+
+    image_names = ApiDependencies.invoker.services.board_images.get_all_board_image_names_for_board(
+        board_id,
+    )
+    return image_names

invokeai/app/api/routers/images.py

@@ -1,30 +1,31 @@
 import io
 from typing import Optional
 
-from fastapi import (Body, HTTPException, Path, Query, Request, Response,
-                     UploadFile)
+from PIL import Image
+from fastapi import Body, HTTPException, Path, Query, Request, Response, UploadFile
 from fastapi.responses import FileResponse
 from fastapi.routing import APIRouter
-from PIL import Image
+from pydantic import BaseModel, Field
 
 from invokeai.app.invocations.metadata import ImageMetadata
 from invokeai.app.models.image import ImageCategory, ResourceOrigin
 from invokeai.app.services.image_record_storage import OffsetPaginatedResults
-from invokeai.app.services.item_storage import PaginatedResults
-from invokeai.app.services.models.image_record import (ImageDTO,
-                                                       ImageRecordChanges,
-                                                       ImageUrlsDTO)
-
+from invokeai.app.services.models.image_record import (
+    ImageDTO,
+    ImageRecordChanges,
+    ImageUrlsDTO,
+)
 from ..dependencies import ApiDependencies
 
 images_router = APIRouter(prefix="/v1/images", tags=["images"])
 
+
 # images are immutable; set a high max-age
 IMAGE_MAX_AGE = 31536000
 
 
 @images_router.post(
-    "/",
+    "/upload",
     operation_id="upload_image",
     responses={
         201: {"description": "The image was uploaded successfully"},
@@ -39,9 +40,9 @@ async def upload_image(
     response: Response,
     image_category: ImageCategory = Query(description="The category of the image"),
     is_intermediate: bool = Query(description="Whether this is an intermediate image"),
-    session_id: Optional[str] = Query(
-        default=None, description="The session ID associated with this upload, if any"
-    ),
+    board_id: Optional[str] = Query(default=None, description="The board to add this image to, if any"),
+    session_id: Optional[str] = Query(default=None, description="The session ID associated with this upload, if any"),
+    crop_visible: Optional[bool] = Query(default=False, description="Whether to crop the image"),
 ) -> ImageDTO:
     """Uploads an image"""
     if not file.content_type.startswith("image"):
@@ -51,7 +52,10 @@ async def upload_image(
 
     try:
         pil_image = Image.open(io.BytesIO(contents))
-    except:
+        if crop_visible:
+            bbox = pil_image.getbbox()
+            pil_image = pil_image.crop(bbox)
+    except Exception:
         # Error opening the image
         raise HTTPException(status_code=415, detail="Failed to read image")
 
@@ -61,6 +65,7 @@ async def upload_image(
             image_origin=ResourceOrigin.EXTERNAL,
             image_category=image_category,
             session_id=session_id,
+            board_id=board_id,
             is_intermediate=is_intermediate,
         )
 
@@ -68,11 +73,11 @@ async def upload_image(
         response.headers["Location"] = image_dto.image_url
 
         return image_dto
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=500, detail="Failed to create image")
 
 
-@images_router.delete("/{image_name}", operation_id="delete_image")
+@images_router.delete("/i/{image_name}", operation_id="delete_image")
 async def delete_image(
     image_name: str = Path(description="The name of the image to delete"),
 ) -> None:
@@ -80,32 +85,42 @@ async def delete_image(
 
     try:
         ApiDependencies.invoker.services.images.delete(image_name)
-    except Exception as e:
+    except Exception:
         # TODO: Does this need any exception handling at all?
         pass
 
 
+@images_router.post("/clear-intermediates", operation_id="clear_intermediates")
+async def clear_intermediates() -> int:
+    """Clears all intermediates"""
+
+    try:
+        count_deleted = ApiDependencies.invoker.services.images.delete_intermediates()
+        return count_deleted
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to clear intermediates")
+        pass
+
+
 @images_router.patch(
-    "/{image_name}",
+    "/i/{image_name}",
     operation_id="update_image",
     response_model=ImageDTO,
 )
 async def update_image(
     image_name: str = Path(description="The name of the image to update"),
-    image_changes: ImageRecordChanges = Body(
-        description="The changes to apply to the image"
-    ),
+    image_changes: ImageRecordChanges = Body(description="The changes to apply to the image"),
 ) -> ImageDTO:
     """Updates an image"""
 
     try:
         return ApiDependencies.invoker.services.images.update(image_name, image_changes)
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=400, detail="Failed to update image")
 
 
 @images_router.get(
-    "/{image_name}",
+    "/i/{image_name}",
     operation_id="get_image_dto",
     response_model=ImageDTO,
 )
@@ -116,11 +131,12 @@ async def get_image_dto(
 
     try:
         return ApiDependencies.invoker.services.images.get_dto(image_name)
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=404)
 
+
 @images_router.get(
-    "/{image_name}/metadata",
+    "/i/{image_name}/metadata",
     operation_id="get_image_metadata",
     response_model=ImageMetadata,
 )
@@ -131,12 +147,13 @@ async def get_image_metadata(
 
     try:
         return ApiDependencies.invoker.services.images.get_metadata(image_name)
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=404)
 
 
-@images_router.get(
-    "/{image_name}/full",
+@images_router.api_route(
+    "/i/{image_name}/full",
+    methods=["GET", "HEAD"],
     operation_id="get_image_full",
     response_class=Response,
     responses={
@@ -166,12 +183,12 @@ async def get_image_full(
         )
         response.headers["Cache-Control"] = f"max-age={IMAGE_MAX_AGE}"
         return response
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=404)
 
 
 @images_router.get(
-    "/{image_name}/thumbnail",
+    "/i/{image_name}/thumbnail",
     operation_id="get_image_thumbnail",
     response_class=Response,
     responses={
@@ -188,23 +205,19 @@ async def get_image_thumbnail(
     """Gets a thumbnail image file"""
 
     try:
-        path = ApiDependencies.invoker.services.images.get_path(
-            image_name, thumbnail=True
-        )
+        path = ApiDependencies.invoker.services.images.get_path(image_name, thumbnail=True)
         if not ApiDependencies.invoker.services.images.validate_path(path):
             raise HTTPException(status_code=404)
 
-        response = FileResponse(
-            path, media_type="image/webp", content_disposition_type="inline"
-        )
+        response = FileResponse(path, media_type="image/webp", content_disposition_type="inline")
         response.headers["Cache-Control"] = f"max-age={IMAGE_MAX_AGE}"
         return response
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=404)
 
 
 @images_router.get(
-    "/{image_name}/urls",
+    "/i/{image_name}/urls",
     operation_id="get_image_urls",
     response_model=ImageUrlsDTO,
 )
@@ -215,15 +228,13 @@ async def get_image_urls(
 
     try:
         image_url = ApiDependencies.invoker.services.images.get_url(image_name)
-        thumbnail_url = ApiDependencies.invoker.services.images.get_url(
-            image_name, thumbnail=True
-        )
+        thumbnail_url = ApiDependencies.invoker.services.images.get_url(image_name, thumbnail=True)
         return ImageUrlsDTO(
             image_name=image_name,
             image_url=image_url,
             thumbnail_url=thumbnail_url,
         )
-    except Exception as e:
+    except Exception:
         raise HTTPException(status_code=404)
 
 
@@ -233,17 +244,12 @@ async def get_image_urls(
     response_model=OffsetPaginatedResults[ImageDTO],
 )
 async def list_image_dtos(
-    image_origin: Optional[ResourceOrigin] = Query(
-        default=None, description="The origin of images to list"
-    ),
-    categories: Optional[list[ImageCategory]] = Query(
-        default=None, description="The categories of image to include"
-    ),
-    is_intermediate: Optional[bool] = Query(
-        default=None, description="Whether to list intermediate images"
-    ),
+    image_origin: Optional[ResourceOrigin] = Query(default=None, description="The origin of images to list."),
+    categories: Optional[list[ImageCategory]] = Query(default=None, description="The categories of image to include."),
+    is_intermediate: Optional[bool] = Query(default=None, description="Whether to list intermediate images."),
     board_id: Optional[str] = Query(
-        default=None, description="The board id to filter by"
+        default=None,
+        description="The board id to filter by. Use 'none' to find images without a board.",
     ),
     offset: int = Query(default=0, description="The page offset"),
     limit: int = Query(default=10, description="The number of images per page"),
@@ -260,3 +266,62 @@ async def list_image_dtos(
     )
 
     return image_dtos
+
+
+class DeleteImagesFromListResult(BaseModel):
+    deleted_images: list[str]
+
+
+@images_router.post("/delete", operation_id="delete_images_from_list", response_model=DeleteImagesFromListResult)
+async def delete_images_from_list(
+    image_names: list[str] = Body(description="The list of names of images to delete", embed=True),
+) -> DeleteImagesFromListResult:
+    try:
+        deleted_images: list[str] = []
+        for image_name in image_names:
+            try:
+                ApiDependencies.invoker.services.images.delete(image_name)
+                deleted_images.append(image_name)
+            except Exception:
+                pass
+        return DeleteImagesFromListResult(deleted_images=deleted_images)
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to delete images")
+
+
+class ImagesUpdatedFromListResult(BaseModel):
+    updated_image_names: list[str] = Field(description="The image names that were updated")
+
+
+@images_router.post("/star", operation_id="star_images_in_list", response_model=ImagesUpdatedFromListResult)
+async def star_images_in_list(
+    image_names: list[str] = Body(description="The list of names of images to star", embed=True),
+) -> ImagesUpdatedFromListResult:
+    try:
+        updated_image_names: list[str] = []
+        for image_name in image_names:
+            try:
+                ApiDependencies.invoker.services.images.update(image_name, changes=ImageRecordChanges(starred=True))
+                updated_image_names.append(image_name)
+            except Exception:
+                pass
+        return ImagesUpdatedFromListResult(updated_image_names=updated_image_names)
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to star images")
+
+
+@images_router.post("/unstar", operation_id="unstar_images_in_list", response_model=ImagesUpdatedFromListResult)
+async def unstar_images_in_list(
+    image_names: list[str] = Body(description="The list of names of images to unstar", embed=True),
+) -> ImagesUpdatedFromListResult:
+    try:
+        updated_image_names: list[str] = []
+        for image_name in image_names:
+            try:
+                ApiDependencies.invoker.services.images.update(image_name, changes=ImageRecordChanges(starred=False))
+                updated_image_names.append(image_name)
+            except Exception:
+                pass
+        return ImagesUpdatedFromListResult(updated_image_names=updated_image_names)
+    except Exception:
+        raise HTTPException(status_code=500, detail="Failed to unstar images")

invokeai/app/api/routers/models.py

@@ -28,49 +28,52 @@ ConvertModelResponse = Union[tuple(OPENAPI_MODEL_CONFIGS)]
 MergeModelResponse = Union[tuple(OPENAPI_MODEL_CONFIGS)]
 ImportModelAttributes = Union[tuple(OPENAPI_MODEL_CONFIGS)]
 
+
 class ModelsList(BaseModel):
     models: list[Union[tuple(OPENAPI_MODEL_CONFIGS)]]
 
+
 @models_router.get(
     "/",
     operation_id="list_models",
-    responses={200: {"model": ModelsList }},
+    responses={200: {"model": ModelsList}},
 )
 async def list_models(
     base_models: Optional[List[BaseModelType]] = Query(default=None, description="Base models to include"),
     model_type: Optional[ModelType] = Query(default=None, description="The type of model to get"),
 ) -> ModelsList:
     """Gets a list of models"""
-    if base_models and len(base_models)>0:
+    if base_models and len(base_models) > 0:
         models_raw = list()
         for base_model in base_models:
             models_raw.extend(ApiDependencies.invoker.services.model_manager.list_models(base_model, model_type))
     else:
         models_raw = ApiDependencies.invoker.services.model_manager.list_models(None, model_type)
-    models = parse_obj_as(ModelsList, { "models": models_raw })
+    models = parse_obj_as(ModelsList, {"models": models_raw})
     return models
 
+
 @models_router.patch(
     "/{base_model}/{model_type}/{model_name}",
     operation_id="update_model",
-    responses={200: {"description" : "The model was updated successfully"},
-               400: {"description" : "Bad request"},
-               404: {"description" : "The model could not be found"},
-               409: {"description" : "There is already a model corresponding to the new name"},
-               },
-    status_code = 200,
-    response_model = UpdateModelResponse,
+    responses={
+        200: {"description": "The model was updated successfully"},
+        400: {"description": "Bad request"},
+        404: {"description": "The model could not be found"},
+        409: {"description": "There is already a model corresponding to the new name"},
+    },
+    status_code=200,
+    response_model=UpdateModelResponse,
 )
 async def update_model(
-        base_model: BaseModelType = Path(description="Base model"),
-        model_type: ModelType = Path(description="The type of model"),
-        model_name: str = Path(description="model name"),
-        info: Union[tuple(OPENAPI_MODEL_CONFIGS)] = Body(description="Model configuration"),
+    base_model: BaseModelType = Path(description="Base model"),
+    model_type: ModelType = Path(description="The type of model"),
+    model_name: str = Path(description="model name"),
+    info: Union[tuple(OPENAPI_MODEL_CONFIGS)] = Body(description="Model configuration"),
 ) -> UpdateModelResponse:
-    """ Update model contents with a new config. If the model name or base fields are changed, then the model is renamed. """
+    """Update model contents with a new config. If the model name or base fields are changed, then the model is renamed."""
     logger = ApiDependencies.invoker.services.logger
 
-    
     try:
         previous_info = ApiDependencies.invoker.services.model_manager.list_model(
             model_name=model_name,
@@ -81,13 +84,13 @@ async def update_model(
         # rename operation requested
         if info.model_name != model_name or info.base_model != base_model:
             ApiDependencies.invoker.services.model_manager.rename_model(
-                base_model = base_model,
-                model_type = model_type,
-                model_name = model_name,
-                new_name = info.model_name,
-                new_base = info.base_model,
+                base_model=base_model,
+                model_type=model_type,
+                model_name=model_name,
+                new_name=info.model_name,
+                new_base=info.base_model,
             )
-            logger.info(f'Successfully renamed {base_model}/{model_name}=>{info.base_model}/{info.model_name}')
+            logger.info(f"Successfully renamed {base_model.value}/{model_name}=>{info.base_model}/{info.model_name}")
             # update information to support an update of attributes
             model_name = info.model_name
             base_model = info.base_model
@@ -96,16 +99,19 @@ async def update_model(
                 base_model=base_model,
                 model_type=model_type,
             )
-            if new_info.get('path') != previous_info.get('path'):  # model manager moved model path during rename - don't overwrite it
-                info.path = new_info.get('path')
-            
+            if new_info.get("path") != previous_info.get(
+                "path"
+            ):  # model manager moved model path during rename - don't overwrite it
+                info.path = new_info.get("path")
+
+        # replace empty string values with None/null to avoid phenomenon of vae: ''
+        info_dict = info.dict()
+        info_dict = {x: info_dict[x] if info_dict[x] else None for x in info_dict.keys()}
+
         ApiDependencies.invoker.services.model_manager.update_model(
-            model_name=model_name,
-            base_model=base_model,
-            model_type=model_type,
-            model_attributes=info.dict()
+            model_name=model_name, base_model=base_model, model_type=model_type, model_attributes=info_dict
         )
-            
+
         model_raw = ApiDependencies.invoker.services.model_manager.list_model(
             model_name=model_name,
             base_model=base_model,
@@ -123,49 +129,48 @@ async def update_model(
 
     return model_response
 
+
 @models_router.post(
     "/import",
     operation_id="import_model",
-    responses= {
-        201: {"description" : "The model imported successfully"},
-        404: {"description" : "The model could not be found"},
-        415: {"description" : "Unrecognized file/folder format"},
-        424: {"description" : "The model appeared to import successfully, but could not be found in the model manager"},
-        409: {"description" : "There is already a model corresponding to this path or repo_id"},
+    responses={
+        201: {"description": "The model imported successfully"},
+        404: {"description": "The model could not be found"},
+        415: {"description": "Unrecognized file/folder format"},
+        424: {"description": "The model appeared to import successfully, but could not be found in the model manager"},
+        409: {"description": "There is already a model corresponding to this path or repo_id"},
     },
     status_code=201,
-    response_model=ImportModelResponse
+    response_model=ImportModelResponse,
 )
 async def import_model(
-        location: str = Body(description="A model path, repo_id or URL to import"),
-        prediction_type: Optional[Literal['v_prediction','epsilon','sample']] = \
-                Body(description='Prediction type for SDv2 checkpoint files', default="v_prediction"),
+    location: str = Body(description="A model path, repo_id or URL to import"),
+    prediction_type: Optional[Literal["v_prediction", "epsilon", "sample"]] = Body(
+        description="Prediction type for SDv2 checkpoint files", default="v_prediction"
+    ),
 ) -> ImportModelResponse:
-    """ Add a model using its local path, repo_id, or remote URL. Model characteristics will be probed and configured automatically """
-    
+    """Add a model using its local path, repo_id, or remote URL. Model characteristics will be probed and configured automatically"""
+
     items_to_import = {location}
-    prediction_types = { x.value: x for x in SchedulerPredictionType }
+    prediction_types = {x.value: x for x in SchedulerPredictionType}
     logger = ApiDependencies.invoker.services.logger
 
     try:
         installed_models = ApiDependencies.invoker.services.model_manager.heuristic_import(
-            items_to_import = items_to_import,
-            prediction_type_helper = lambda x: prediction_types.get(prediction_type)
+            items_to_import=items_to_import, prediction_type_helper=lambda x: prediction_types.get(prediction_type)
         )
         info = installed_models.get(location)
 
         if not info:
             logger.error("Import failed")
             raise HTTPException(status_code=415)
-        
-        logger.info(f'Successfully imported {location}, got {info}')
+
+        logger.info(f"Successfully imported {location}, got {info}")
         model_raw = ApiDependencies.invoker.services.model_manager.list_model(
-            model_name=info.name,
-            base_model=info.base_model,
-            model_type=info.model_type
+            model_name=info.name, base_model=info.base_model, model_type=info.model_type
         )
         return parse_obj_as(ImportModelResponse, model_raw)
-    
+
     except ModelNotFoundException as e:
         logger.error(str(e))
         raise HTTPException(status_code=404, detail=str(e))
@@ -175,38 +180,34 @@ async def import_model(
     except ValueError as e:
         logger.error(str(e))
         raise HTTPException(status_code=409, detail=str(e))
-        
+
+
 @models_router.post(
     "/add",
     operation_id="add_model",
-    responses= {
-        201: {"description" : "The model added successfully"},
-        404: {"description" : "The model could not be found"},
-        424: {"description" : "The model appeared to add successfully, but could not be found in the model manager"},
-        409: {"description" : "There is already a model corresponding to this path or repo_id"},
+    responses={
+        201: {"description": "The model added successfully"},
+        404: {"description": "The model could not be found"},
+        424: {"description": "The model appeared to add successfully, but could not be found in the model manager"},
+        409: {"description": "There is already a model corresponding to this path or repo_id"},
     },
     status_code=201,
-    response_model=ImportModelResponse
+    response_model=ImportModelResponse,
 )
 async def add_model(
-        info: Union[tuple(OPENAPI_MODEL_CONFIGS)] = Body(description="Model configuration"),
+    info: Union[tuple(OPENAPI_MODEL_CONFIGS)] = Body(description="Model configuration"),
 ) -> ImportModelResponse:
-    """ Add a model using the configuration information appropriate for its type. Only local models can be added by path"""
-    
+    """Add a model using the configuration information appropriate for its type. Only local models can be added by path"""
+
     logger = ApiDependencies.invoker.services.logger
 
     try:
         ApiDependencies.invoker.services.model_manager.add_model(
-            info.model_name,
-            info.base_model,
-            info.model_type,
-            model_attributes = info.dict()
+            info.model_name, info.base_model, info.model_type, model_attributes=info.dict()
         )
-        logger.info(f'Successfully added {info.model_name}')
+        logger.info(f"Successfully added {info.model_name}")
         model_raw = ApiDependencies.invoker.services.model_manager.list_model(
-            model_name=info.model_name,
-            base_model=info.base_model,
-            model_type=info.model_type
+            model_name=info.model_name, base_model=info.base_model, model_type=info.model_type
         )
         return parse_obj_as(ImportModelResponse, model_raw)
     except ModelNotFoundException as e:
@@ -216,66 +217,66 @@ async def add_model(
         logger.error(str(e))
         raise HTTPException(status_code=409, detail=str(e))
 
-    
+
 @models_router.delete(
     "/{base_model}/{model_type}/{model_name}",
     operation_id="del_model",
-    responses={
-        204: { "description": "Model deleted successfully" }, 
-        404: { "description": "Model not found" }
-    },
-    status_code = 204,
-    response_model = None,
+    responses={204: {"description": "Model deleted successfully"}, 404: {"description": "Model not found"}},
+    status_code=204,
+    response_model=None,
 )
 async def delete_model(
-        base_model: BaseModelType = Path(description="Base model"),
-        model_type: ModelType = Path(description="The type of model"),
-        model_name: str = Path(description="model name"),
+    base_model: BaseModelType = Path(description="Base model"),
+    model_type: ModelType = Path(description="The type of model"),
+    model_name: str = Path(description="model name"),
 ) -> Response:
     """Delete Model"""
     logger = ApiDependencies.invoker.services.logger
-    
+
     try:
-        ApiDependencies.invoker.services.model_manager.del_model(model_name,
-                                                                 base_model = base_model,
-                                                                 model_type = model_type
-                                                                 )
+        ApiDependencies.invoker.services.model_manager.del_model(
+            model_name, base_model=base_model, model_type=model_type
+        )
         logger.info(f"Deleted model: {model_name}")
         return Response(status_code=204)
     except ModelNotFoundException as e:
         logger.error(str(e))
         raise HTTPException(status_code=404, detail=str(e))
 
+
 @models_router.put(
     "/convert/{base_model}/{model_type}/{model_name}",
     operation_id="convert_model",
     responses={
-        200: { "description": "Model converted successfully" },
-        400: {"description" : "Bad request"  },
-        404: { "description": "Model not found"  },
+        200: {"description": "Model converted successfully"},
+        400: {"description": "Bad request"},
+        404: {"description": "Model not found"},
     },
-    status_code = 200,
-    response_model = ConvertModelResponse,
+    status_code=200,
+    response_model=ConvertModelResponse,
 )
 async def convert_model(
-        base_model: BaseModelType = Path(description="Base model"),
-        model_type: ModelType = Path(description="The type of model"),
-        model_name: str = Path(description="model name"),
-        convert_dest_directory: Optional[str] = Query(default=None, description="Save the converted model to the designated directory"),
+    base_model: BaseModelType = Path(description="Base model"),
+    model_type: ModelType = Path(description="The type of model"),
+    model_name: str = Path(description="model name"),
+    convert_dest_directory: Optional[str] = Query(
+        default=None, description="Save the converted model to the designated directory"
+    ),
 ) -> ConvertModelResponse:
     """Convert a checkpoint model into a diffusers model, optionally saving to the indicated destination directory, or `models` if none."""
     logger = ApiDependencies.invoker.services.logger
     try:
         logger.info(f"Converting model: {model_name}")
         dest = pathlib.Path(convert_dest_directory) if convert_dest_directory else None
-        ApiDependencies.invoker.services.model_manager.convert_model(model_name,
-                                                                     base_model = base_model,
-                                                                     model_type = model_type,
-                                                                     convert_dest_directory = dest,
-                                                                     )
-        model_raw = ApiDependencies.invoker.services.model_manager.list_model(model_name,
-                                                                              base_model = base_model,
-                                                                              model_type = model_type)
+        ApiDependencies.invoker.services.model_manager.convert_model(
+            model_name,
+            base_model=base_model,
+            model_type=model_type,
+            convert_dest_directory=dest,
+        )
+        model_raw = ApiDependencies.invoker.services.model_manager.list_model(
+            model_name, base_model=base_model, model_type=model_type
+        )
         response = parse_obj_as(ConvertModelResponse, model_raw)
     except ModelNotFoundException as e:
         raise HTTPException(status_code=404, detail=f"Model '{model_name}' not found: {str(e)}")
@@ -283,140 +284,104 @@ async def convert_model(
         raise HTTPException(status_code=400, detail=str(e))
     return response
 
+
 @models_router.get(
     "/search",
     operation_id="search_for_models",
     responses={
-        200: { "description": "Directory searched successfully" },
-        404: { "description": "Invalid directory path"  },
+        200: {"description": "Directory searched successfully"},
+        404: {"description": "Invalid directory path"},
     },
-    status_code = 200,
-    response_model = List[pathlib.Path]
+    status_code=200,
+    response_model=List[pathlib.Path],
 )
 async def search_for_models(
-        search_path: pathlib.Path = Query(description="Directory path to search for models")
-)->List[pathlib.Path]:
+    search_path: pathlib.Path = Query(description="Directory path to search for models"),
+) -> List[pathlib.Path]:
     if not search_path.is_dir():
-        raise HTTPException(status_code=404, detail=f"The search path '{search_path}' does not exist or is not directory")
-    return ApiDependencies.invoker.services.model_manager.search_for_models([search_path])
+        raise HTTPException(
+            status_code=404, detail=f"The search path '{search_path}' does not exist or is not directory"
+        )
+    return ApiDependencies.invoker.services.model_manager.search_for_models(search_path)
+
 
 @models_router.get(
     "/ckpt_confs",
     operation_id="list_ckpt_configs",
     responses={
-        200: { "description" : "paths retrieved successfully" },
+        200: {"description": "paths retrieved successfully"},
     },
-    status_code = 200,
-    response_model = List[pathlib.Path]
+    status_code=200,
+    response_model=List[pathlib.Path],
 )
-async def list_ckpt_configs(
-)->List[pathlib.Path]:
+async def list_ckpt_configs() -> List[pathlib.Path]:
     """Return a list of the legacy checkpoint configuration files stored in `ROOT/configs/stable-diffusion`, relative to ROOT."""
     return ApiDependencies.invoker.services.model_manager.list_checkpoint_configs()
-    
-        
-@models_router.get(
+
+
+@models_router.post(
     "/sync",
     operation_id="sync_to_config",
     responses={
-        201: { "description": "synchronization successful" },
+        201: {"description": "synchronization successful"},
     },
-    status_code = 201,
-    response_model = None
+    status_code=201,
+    response_model=bool,
 )
-async def sync_to_config(
-)->None:
+async def sync_to_config() -> bool:
     """Call after making changes to models.yaml, autoimport directories or models directory to synchronize
     in-memory data structures with disk data structures."""
-    return ApiDependencies.invoker.services.model_manager.sync_to_config()
-        
+    ApiDependencies.invoker.services.model_manager.sync_to_config()
+    return True
+
+
 @models_router.put(
     "/merge/{base_model}",
     operation_id="merge_models",
     responses={
-        200: { "description": "Model converted successfully" },
-        400: { "description": "Incompatible models"  },
-        404: { "description": "One or more models not found"  },
+        200: {"description": "Model converted successfully"},
+        400: {"description": "Incompatible models"},
+        404: {"description": "One or more models not found"},
     },
-    status_code = 200,
-    response_model = MergeModelResponse,
+    status_code=200,
+    response_model=MergeModelResponse,
 )
 async def merge_models(
-        base_model: BaseModelType                  = Path(description="Base model"),
-        model_names: List[str]                     = Body(description="model name", min_items=2, max_items=3),
-        merged_model_name: Optional[str]           = Body(description="Name of destination model"),
-        alpha: Optional[float]                     = Body(description="Alpha weighting strength to apply to 2d and 3d models", default=0.5),
-        interp: Optional[MergeInterpolationMethod] = Body(description="Interpolation method"),
-        force: Optional[bool]                      = Body(description="Force merging of models created with different versions of diffusers", default=False),
-        merge_dest_directory: Optional[str]       = Body(description="Save the merged model to the designated directory (with 'merged_model_name' appended)", default=None)
+    base_model: BaseModelType = Path(description="Base model"),
+    model_names: List[str] = Body(description="model name", min_items=2, max_items=3),
+    merged_model_name: Optional[str] = Body(description="Name of destination model"),
+    alpha: Optional[float] = Body(description="Alpha weighting strength to apply to 2d and 3d models", default=0.5),
+    interp: Optional[MergeInterpolationMethod] = Body(description="Interpolation method"),
+    force: Optional[bool] = Body(
+        description="Force merging of models created with different versions of diffusers", default=False
+    ),
+    merge_dest_directory: Optional[str] = Body(
+        description="Save the merged model to the designated directory (with 'merged_model_name' appended)",
+        default=None,
+    ),
 ) -> MergeModelResponse:
     """Convert a checkpoint model into a diffusers model"""
     logger = ApiDependencies.invoker.services.logger
     try:
         logger.info(f"Merging models: {model_names} into {merge_dest_directory or '<MODELS>'}/{merged_model_name}")
         dest = pathlib.Path(merge_dest_directory) if merge_dest_directory else None
-        result = ApiDependencies.invoker.services.model_manager.merge_models(model_names,
-                                                                             base_model,
-                                                                             merged_model_name=merged_model_name or "+".join(model_names),
-                                                                             alpha=alpha,
-                                                                             interp=interp,
-                                                                             force=force,
-                                                                             merge_dest_directory = dest
-                                                                             )
-        model_raw = ApiDependencies.invoker.services.model_manager.list_model(result.name,
-                                                                              base_model = base_model,
-                                                                              model_type = ModelType.Main,
-                                                                              )
+        result = ApiDependencies.invoker.services.model_manager.merge_models(
+            model_names,
+            base_model,
+            merged_model_name=merged_model_name or "+".join(model_names),
+            alpha=alpha,
+            interp=interp,
+            force=force,
+            merge_dest_directory=dest,
+        )
+        model_raw = ApiDependencies.invoker.services.model_manager.list_model(
+            result.name,
+            base_model=base_model,
+            model_type=ModelType.Main,
+        )
         response = parse_obj_as(ConvertModelResponse, model_raw)
     except ModelNotFoundException:
         raise HTTPException(status_code=404, detail=f"One or more of the models '{model_names}' not found")
     except ValueError as e:
         raise HTTPException(status_code=400, detail=str(e))
     return response
-
-# The rename operation is now supported by update_model and no longer needs to be
-# a standalone route.
-# @models_router.post(
-#     "/rename/{base_model}/{model_type}/{model_name}",
-#     operation_id="rename_model",
-#     responses= {
-#         201: {"description" : "The model was renamed successfully"},
-#         404: {"description" : "The model could not be found"},
-#         409: {"description" : "There is already a model corresponding to the new name"},
-#     },
-#     status_code=201,
-#     response_model=ImportModelResponse
-# )
-# async def rename_model(
-#         base_model: BaseModelType = Path(description="Base model"),
-#         model_type: ModelType = Path(description="The type of model"),
-#         model_name: str = Path(description="current model name"),
-#         new_name: Optional[str] = Query(description="new model name", default=None),
-#         new_base: Optional[BaseModelType] = Query(description="new model base", default=None),
-# ) -> ImportModelResponse:
-#     """ Rename a model"""
-    
-#     logger = ApiDependencies.invoker.services.logger
-
-#     try:
-#         result = ApiDependencies.invoker.services.model_manager.rename_model(
-#             base_model = base_model,
-#             model_type = model_type,
-#             model_name = model_name,
-#             new_name = new_name,
-#             new_base = new_base,
-#         )
-#         logger.debug(result)
-#         logger.info(f'Successfully renamed {model_name}=>{new_name}')
-#         model_raw = ApiDependencies.invoker.services.model_manager.list_model(
-#             model_name=new_name or model_name,
-#             base_model=new_base or base_model,
-#             model_type=model_type
-#         )
-#         return parse_obj_as(ImportModelResponse, model_raw)
-#     except ModelNotFoundException as e:
-#         logger.error(str(e))
-#         raise HTTPException(status_code=404, detail=str(e))
-#     except ValueError as e:
-#         logger.error(str(e))
-#         raise HTTPException(status_code=409, detail=str(e))