fix: model install broken due to duplicate key

.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,2 +1 @@
 b3dccfaeb636599c02effc377cdd8a87d658256c
-218b6d0546b990fc449c876fb99f44b50c4daa35

.github/CODEOWNERS

@@ -2,7 +2,7 @@
 /.github/workflows/  @lstein @blessedcoolant
 
 # documentation
-/docs/ @lstein @blessedcoolant @hipsterusername @Millu
+/docs/ @lstein @blessedcoolant @hipsterusername
 /mkdocs.yml @lstein  @blessedcoolant
 
 # nodes
@@ -22,7 +22,7 @@
 /invokeai/backend @blessedcoolant @psychedelicious @lstein @maryhipp
 
 # generation, model management, postprocessing
-/invokeai/backend  @damian0815 @lstein @blessedcoolant @gregghelt2 @StAlKeR7779 @brandonrising @ryanjdick
+/invokeai/backend  @damian0815 @lstein @blessedcoolant @gregghelt2 @StAlKeR7779 @brandonrising
 
 # front ends
 /invokeai/frontend/CLI @lstein

.github/workflows/lint-frontend.yml

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

.github/workflows/style-checks.yml

@@ -1,27 +0,0 @@
-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

@@ -0,0 +1,50 @@
+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,7 +3,16 @@ 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'
@@ -56,23 +65,10 @@ 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 }}
@@ -80,7 +76,6 @@ 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: >
@@ -88,7 +83,6 @@ jobs:
           --editable=".[test]"
 
       - name: run pytest
-        if: steps.changed-files.outputs.python_any_changed == 'true'
         id: run-pytest
         run: pytest
 

.gitignore

@@ -1,8 +1,23 @@
+# 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]
@@ -23,6 +38,7 @@ develop-eggs/
 downloads/
 eggs/
 .eggs/
+lib/
 lib64/
 parts/
 sdist/
@@ -174,17 +190,39 @@ 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

@@ -1,17 +0,0 @@
-# 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]

README.md

@@ -43,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/INSTALLATION/)] [<a
+  Install](https://invoke-ai.github.io/InvokeAI/#installation)] [<a
   href="https://discord.gg/ZmtBAhwWhy">Discord Server</a>] [<a
   href="https://invoke-ai.github.io/InvokeAI/">Documentation and
   Tutorials</a>] [<a
@@ -81,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/INSTALLATION/)
+[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/)
 
 If upgrading from version 2.3, please read [Migrating a 2.3 root
 directory to 3.0](#migrating-to-3) first.
@@ -123,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 through 3.11 installed on your machine. Earlier or
+You must have Python 3.9 or 3.10 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)
@@ -161,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/cu118
+    pip install "InvokeAI[xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117
     ```
 
     _For Linux with an AMD GPU:_
@@ -184,9 +184,8 @@ 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 --root .
+    invokeai-configure
     ```
-	Don't miss the dot at the end!
 
 7. Launch the web server (do it every time you run InvokeAI):
 
@@ -194,9 +193,15 @@ the command `npm install -g yarn` if needed)
     invokeai-web
     ```
 
-8. Point your browser to http://localhost:9090 to bring up the web interface.
+8. Build Node.js assets
 
-9. Type `banana sushi` in the box on the top left and click `Invoke`.
+  ```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`.
 
 Be sure to activate the virtual environment each time before re-launching InvokeAI,
 using `source .venv/bin/activate` or `.venv\Scripts\activate`.
@@ -306,30 +311,13 @@ 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
+#### Migration Caveats
 
 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. 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.)
+images stored in your 2.3-format outputs directory. You will need to
+manually import selected images into the 3.0 gallery via drag-and-drop.
 
 ## Hardware Requirements
 

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

@@ -14,14 +14,11 @@ To join, just raise your hand on the InvokeAI Discord server (#dev-chat) or the
 #### 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.
 
-#### 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.
-
 #### Documentation
-If you’d like to help with documentation, please see our [documentation guide](contribution_guides/documentation.md).
+If you’d like to help with documentation, please see our [documentation guide](contribution_guides/documenation.md).
 
 #### Translation
-If you'd like to help with translation, please see our [translation guide](contribution_guides/translation.md).
+If you'd like to help with translation, please see our [translation guide](docs/contributing/.contribution_guides/translation.md).
 
 #### Tutorials 
 Please reach out to @imic or @hipsterusername on [Discord](https://discord.gg/ZmtBAhwWhy) to help create tutorials for InvokeAI.

docs/contributing/INVOCATIONS.md

@@ -29,13 +29,12 @@ The first set of things we need to do when creating a new Invocation are -
 
 - Create a new class that derives from a predefined parent class called
   `BaseInvocation`.
+- The name of every Invocation must end with the word `Invocation` in order for
+  it to be recognized as an Invocation.
 - Every Invocation must have a `docstring` that describes what this Invocation
   does.
-- While not strictly required, we suggest every invocation class name ends in
-  "Invocation", eg "CropImageInvocation".
-- Every Invocation must use the `@invocation` decorator to provide its unique
-  invocation type. You may also provide its title, tags and category using the
-  decorator.
+- Every Invocation must have a unique `type` field defined which becomes its
+  indentifier.
 - Invocations are strictly typed. We make use of the native
   [typing](https://docs.python.org/3/library/typing.html) library and the
   installed [pydantic](https://pydantic-docs.helpmanual.io/) library for
@@ -44,11 +43,12 @@ The first set of things we need to do when creating a new Invocation are -
 So let us do that.
 
 ```python
-from .baseinvocation import BaseInvocation, invocation
+from typing import Literal
+from .baseinvocation import BaseInvocation
 
-@invocation('resize')
 class ResizeInvocation(BaseInvocation):
     '''Resizes an image'''
+    type: Literal['resize'] = 'resize'
 ```
 
 That's great.
@@ -62,10 +62,8 @@ our Invocation takes.
 
 ### **Inputs**
 
-Every Invocation input must be defined using the `InputField` function. This is
-a wrapper around the pydantic `Field` function, which handles a few extra things
-and provides type hints. Like everything else, this should be strictly typed and
-defined.
+Every Invocation input is a pydantic `Field` and like everything else should be
+strictly typed and defined.
 
 So let us create these inputs for our Invocation. First up, the `image` input we
 need. Generally, we can use standard variable types in Python but InvokeAI
@@ -78,51 +76,55 @@ create your own custom field types later in this guide. For now, let's go ahead
 and use it.
 
 ```python
-from .baseinvocation import BaseInvocation, InputField, invocation
-from .primitives import ImageField
+from typing import Literal, Union
+from pydantic import Field
+
+from .baseinvocation import BaseInvocation
+from ..models.image import ImageField
 
-@invocation('resize')
 class ResizeInvocation(BaseInvocation):
+    '''Resizes an image'''
+    type: Literal['resize'] = 'resize'
 
     # Inputs
-    image: ImageField = InputField(description="The input image")
+    image: Union[ImageField, None] = Field(description="The input image", default=None)
 ```
 
 Let us break down our input code.
 
 ```python
-image: ImageField = InputField(description="The input image")
+image: Union[ImageField, None] = Field(description="The input image", default=None)
 ```
 
-| Part      | Value                                       | Description                                                                     |
-| --------- | ------------------------------------------- | ------------------------------------------------------------------------------- |
-| Name      | `image`                                     | The variable that will hold our image                                           |
-| Type Hint | `ImageField`                                | The types for our field. Indicates that the image must be an `ImageField` type. |
-| Field     | `InputField(description="The input image")` | The image variable is an `InputField` which needs a description.                |
+| Part      | Value                                                | Description                                                                                        |
+| --------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| Name      | `image`                                              | The variable that will hold our image                                                              |
+| Type Hint | `Union[ImageField, None]`                            | The types for our field. Indicates that the image can either be an `ImageField` type or `None`     |
+| Field     | `Field(description="The input image", default=None)` | The image variable is a field which needs a description and a default value that we set to `None`. |
 
 Great. Now let us create our other inputs for `width` and `height`
 
 ```python
-from .baseinvocation import BaseInvocation, InputField, invocation
-from .primitives import ImageField
+from typing import Literal, Union
+from pydantic import Field
+
+from .baseinvocation import BaseInvocation
+from ..models.image import ImageField
 
-@invocation('resize')
 class ResizeInvocation(BaseInvocation):
     '''Resizes an image'''
+    type: Literal['resize'] = 'resize'
 
     # Inputs
-    image: ImageField = InputField(description="The input image")
-    width: int = InputField(default=512, ge=64, le=2048, description="Width of the new image")
-    height: int = InputField(default=512, ge=64, le=2048, description="Height of the new image")
+    image: Union[ImageField, None] = Field(description="The input image", default=None)
+    width: int = Field(default=512, ge=64, le=2048, description="Width of the new image")
+    height: int = Field(default=512, ge=64, le=2048, description="Height of the new image")
 ```
 
-As you might have noticed, we added two new arguments to the `InputField`
-definition for `width` and `height`, called `gt` and `le`. They stand for
-_greater than or equal to_ and _less than or equal to_.
-
-These impose contraints on those fields, and will raise an exception if the
-values do not meet the constraints. Field constraints are provided by
-**pydantic**, so anything you see in the **pydantic docs** will work.
+As you might have noticed, we added two new parameters to the field type for
+`width` and `height` called `gt` and `le`. These basically stand for _greater
+than or equal to_ and _less than or equal to_. There are various other param
+types for field that you can find on the **pydantic** documentation.
 
 **Note:** _Any time it is possible to define constraints for our field, we
 should do it so the frontend has more information on how to parse this field._
@@ -139,17 +141,20 @@ that are provided by it by InvokeAI.
 Let us create this function first.
 
 ```python
-from .baseinvocation import BaseInvocation, InputField, invocation
-from .primitives import ImageField
+from typing import Literal, Union
+from pydantic import Field
+
+from .baseinvocation import BaseInvocation, InvocationContext
+from ..models.image import ImageField
 
-@invocation('resize')
 class ResizeInvocation(BaseInvocation):
     '''Resizes an image'''
+    type: Literal['resize'] = 'resize'
 
     # Inputs
-    image: ImageField = InputField(description="The input image")
-    width: int = InputField(default=512, ge=64, le=2048, description="Width of the new image")
-    height: int = InputField(default=512, ge=64, le=2048, description="Height of the new image")
+    image: Union[ImageField, None] = Field(description="The input image", default=None)
+    width: int = Field(default=512, ge=64, le=2048, description="Width of the new image")
+    height: int = Field(default=512, ge=64, le=2048, description="Height of the new image")
 
     def invoke(self, context: InvocationContext):
         pass
@@ -168,18 +173,21 @@ all the necessary info related to image outputs. So let us use that.
 We will cover how to create your own output types later in this guide.
 
 ```python
-from .baseinvocation import BaseInvocation, InputField, invocation
-from .primitives import ImageField
+from typing import Literal, Union
+from pydantic import Field
+
+from .baseinvocation import BaseInvocation, InvocationContext
+from ..models.image import ImageField
 from .image import ImageOutput
 
-@invocation('resize')
 class ResizeInvocation(BaseInvocation):
     '''Resizes an image'''
+    type: Literal['resize'] = 'resize'
 
     # Inputs
-    image: ImageField = InputField(description="The input image")
-    width: int = InputField(default=512, ge=64, le=2048, description="Width of the new image")
-    height: int = InputField(default=512, ge=64, le=2048, description="Height of the new image")
+    image: Union[ImageField, None] = Field(description="The input image", default=None)
+    width: int = Field(default=512, ge=64, le=2048, description="Width of the new image")
+    height: int = Field(default=512, ge=64, le=2048, description="Height of the new image")
 
     def invoke(self, context: InvocationContext) -> ImageOutput:
         pass
@@ -187,34 +195,39 @@ class ResizeInvocation(BaseInvocation):
 
 Perfect. Now that we have our Invocation setup, let us do what we want to do.
 
-- We will first load the image using one of the services provided by InvokeAI to
-  load the image.
+- We will first load the image. Generally we do this using the `PIL` library but
+  we can use one of the services provided by InvokeAI to load the image.
 - We will resize the image using `PIL` to our input data.
 - We will output this image in the format we set above.
 
 So let's do that.
 
 ```python
-from .baseinvocation import BaseInvocation, InputField, invocation
-from .primitives import ImageField
+from typing import Literal, Union
+from pydantic import Field
+
+from .baseinvocation import BaseInvocation, InvocationContext
+from ..models.image import ImageField, ResourceOrigin, ImageCategory
 from .image import ImageOutput
 
-@invocation("resize")
 class ResizeInvocation(BaseInvocation):
-    """Resizes an image"""
+    '''Resizes an image'''
+    type: Literal['resize'] = 'resize'
 
-    image: ImageField = InputField(description="The input image")
-    width: int = InputField(default=512, ge=64, le=2048, description="Width of the new image")
-    height: int = InputField(default=512, ge=64, le=2048, description="Height of the new image")
+    # Inputs
+    image: Union[ImageField, None] = Field(description="The input image", default=None)
+    width: int = Field(default=512, ge=64, le=2048, description="Width of the new image")
+    height: int = Field(default=512, ge=64, le=2048, description="Height of the new image")
 
     def invoke(self, context: InvocationContext) -> ImageOutput:
-        # Load the image using InvokeAI's predefined Image Service. Returns the PIL image.
-        image = context.services.images.get_pil_image(self.image.image_name)
+        # Load the image using InvokeAI's predefined Image Service.
+        image = context.services.images.get_pil_image(self.image.image_origin, self.image.image_name)
 
         # Resizing the image
+        # Because we used the above service, we already have a PIL image. So we can simply resize.
         resized_image = image.resize((self.width, self.height))
 
-        # Save the image using InvokeAI's predefined Image Service. Returns the prepared PIL image.
+        # Preparing the image for output using InvokeAI's predefined Image Service.
         output_image = context.services.images.create(
             image=resized_image,
             image_origin=ResourceOrigin.INTERNAL,
@@ -228,6 +241,7 @@ class ResizeInvocation(BaseInvocation):
         return ImageOutput(
             image=ImageField(
                 image_name=output_image.image_name,
+                image_origin=output_image.image_origin,
             ),
             width=output_image.width,
             height=output_image.height,
@@ -239,20 +253,6 @@ certain way that the images need to be dispatched in order to be stored and read
 correctly. In 99% of the cases when dealing with an image output, you can simply
 copy-paste the template above.
 
-### Customization
-
-We can use the `@invocation` decorator to provide some additional info to the
-UI, like a custom title, tags and category.
-
-```python
-@invocation("resize", title="My Resizer", tags=["resize", "image"], category="My Invocations")
-class ResizeInvocation(BaseInvocation):
-    """Resizes an image"""
-
-    image: ImageField = InputField(description="The input image")
-    ...
-```
-
 That's it. You made your own **Resize Invocation**.
 
 ## Result
@@ -270,59 +270,9 @@ new Invocation ready to be used.
 
 ![resize node editor](../assets/contributing/resize_node_editor.png)
 
-## Contributing Nodes
+# Advanced
 
-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).
-
-## Advanced
-
--->
-
-### 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.
-
-Now that you are familiar with Invocations and Inputs, let us use that knowledge
-to create an output that has an `image` field, a `color` field and a `string`
-field.
-
-- An invocation output is a class that derives from the parent class of
-  `BaseInvocationOutput`.
-- All invocation outputs must use the `@invocation_output` decorator to provide
-  their unique output type.
-- Output fields must use the provided `OutputField` function. This is very
-  similar to the `InputField` function described earlier - it's a wrapper around
-  `pydantic`'s `Field()`.
-- It is not mandatory but we recommend using names ending with `Output` for
-  output types.
-- It is not mandatory but we highly recommend adding a `docstring` to describe
-  what your output type is for.
-
-Now that we know the basic rules for creating a new output type, let us go ahead
-and make it.
-
-```python
-from .baseinvocation import BaseInvocationOutput, OutputField, invocation_output
-from .primitives import ImageField, ColorField
-
-@invocation_output('image_color_string_output')
-class ImageColorStringOutput(BaseInvocationOutput):
-    '''Base class for nodes that output a single image'''
-
-    image: ImageField = OutputField(description="The image")
-    color: ColorField = OutputField(description="The color")
-    text: str = OutputField(description="The string")
-```
-
-That's all there is to it.
-
-<!-- TODO: DANGER - we probably do not want people to create their own field types, because this requires a lot of work on the frontend to accomodate.
-
-### Custom Input Fields
+## Custom Input Fields
 
 Now that you know how to create your own Invocations, let us dive into slightly
 more advanced topics.
@@ -376,7 +326,173 @@ like this.
 color: ColorField = Field(default=ColorField(r=0, g=0, b=0, a=0), description='Background color of an image')
 ```
 
-### Custom Components For Frontend
+**Extra Config**
+
+All input fields also take an additional `Config` class that you can use to do
+various advanced things like setting required parameters and etc.
+
+Let us do that for our _ColorField_ and enforce all the values because we did
+not define any defaults for our fields.
+
+```python
+class ColorField(BaseModel):
+    '''A field that holds the rgba values of a color'''
+    r: int = Field(ge=0, le=255, description="The red channel")
+    g: int = Field(ge=0, le=255, description="The green channel")
+    b: int = Field(ge=0, le=255, description="The blue channel")
+    a: int = Field(ge=0, le=255, description="The alpha channel")
+
+    class Config:
+        schema_extra = {"required": ["r", "g", "b", "a"]}
+```
+
+Now it becomes mandatory for the user to supply all the values required by our
+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
+
+Like with custom inputs, sometimes you might find yourself needing custom
+outputs that InvokeAI does not provide. We can easily set one up.
+
+Now that you are familiar with Invocations and Inputs, let us use that knowledge
+to put together a custom output type for an Invocation that returns _width_,
+_height_ and _background_color_ that we need to create a blank image.
+
+- A custom output type is a class that derives from the parent class of
+  `BaseInvocationOutput`.
+- It is not mandatory but we recommend using names ending with `Output` for
+  output types. So we'll call our class `BlankImageOutput`
+- It is not mandatory but we highly recommend adding a `docstring` to describe
+  what your output type is for.
+- Like Invocations, each output type should have a `type` variable that is
+  **unique**
+
+Now that we know the basic rules for creating a new output type, let us go ahead
+and make it.
+
+```python
+from typing import Literal
+from pydantic import Field
+
+from .baseinvocation import BaseInvocationOutput
+
+class BlankImageOutput(BaseInvocationOutput):
+    '''Base output type for creating a blank image'''
+    type: Literal['blank_image_output'] = 'blank_image_output'
+
+    # Inputs
+    width: int = Field(description='Width of blank image')
+    height: int = Field(description='Height of blank image')
+    bg_color: ColorField = Field(description='Background color of blank image')
+
+    class Config:
+        schema_extra = {"required": ["type", "width", "height", "bg_color"]}
+```
+
+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
+
+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
+outputs essentially inherit from _pydantic_'s `BaseModel` class, all
+[configuration options](https://docs.pydantic.dev/latest/usage/schema/#schema-customization)
+that are valid for _pydantic_ classes are also valid for our inputs and outputs.
+You can do the same for your Invocations too but InvokeAI makes our life a
+little bit easier on that end.
+
+InvokeAI provides a custom configuration class called `InvocationConfig`
+particularly for configuring Invocations. This is exactly the same as the raw
+`Config` class from _pydantic_ with some extra stuff on top to help faciliate
+parsing of the scheme in the frontend UI.
+
+At the current moment, tihs `InvocationConfig` class is further improved with
+the following features related the `ui`.
+
+| Config Option | Field Type                                                                                                    | Example                                                                                                               |
+| ------------- | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| type_hints    | `Dict[str, Literal["integer", "float", "boolean", "string", "enum", "image", "latents", "model", "control"]]` | `type_hint: "model"` provides type hints related to the model like displaying a list of available models              |
+| tags          | `List[str]`                                                                                                   | `tags: ['resize', 'image']` will classify your invocation under the tags of resize and image.                         |
+| title         | `str`                                                                                                         | `title: 'Resize Image` will rename your to this custom title rather than infer from the name of the Invocation class. |
+
+So let us update your `ResizeInvocation` with some extra configuration and see
+how that works.
+
+```python
+from typing import Literal, Union
+from pydantic import Field
+
+from .baseinvocation import BaseInvocation, InvocationContext, InvocationConfig
+from ..models.image import ImageField, ResourceOrigin, ImageCategory
+from .image import ImageOutput
+
+class ResizeInvocation(BaseInvocation):
+    '''Resizes an image'''
+    type: Literal['resize'] = 'resize'
+
+    # Inputs
+    image: Union[ImageField, None] = Field(description="The input image", default=None)
+    width: int = Field(default=512, ge=64, le=2048, description="Width of the new image")
+    height: int = Field(default=512, ge=64, le=2048, description="Height of the new image")
+
+    class Config(InvocationConfig):
+        schema_extra: {
+            ui: {
+                tags: ['resize', 'image'],
+                title: ['My Custom Resize']
+            }
+        }
+
+    def invoke(self, context: InvocationContext) -> ImageOutput:
+        # Load the image using InvokeAI's predefined Image Service.
+        image = context.services.images.get_pil_image(self.image.image_origin, self.image.image_name)
+
+        # Resizing the image
+        # Because we used the above service, we already have a PIL image. So we can simply resize.
+        resized_image = image.resize((self.width, self.height))
+
+        # Preparing the image for output using InvokeAI's predefined Image Service.
+        output_image = context.services.images.create(
+            image=resized_image,
+            image_origin=ResourceOrigin.INTERNAL,
+            image_category=ImageCategory.GENERAL,
+            node_id=self.id,
+            session_id=context.graph_execution_state_id,
+            is_intermediate=self.is_intermediate,
+        )
+
+        # Returning the Image
+        return ImageOutput(
+            image=ImageField(
+                image_name=output_image.image_name,
+                image_origin=output_image.image_origin,
+            ),
+            width=output_image.width,
+            height=output_image.height,
+        )
+```
+
+We now customized our code to let the frontend know that our Invocation falls
+under `resize` and `image` categories. So when the user searches for these
+particular words, our Invocation will show up too.
+
+We also set a custom title for our Invocation. So instead of being called
+`Resize`, it will be called `My Custom Resize`.
+
+As simple as that.
+
+As time goes by, InvokeAI will further improve and add more customizability for
+Invocation configuration. We will have more documentation regarding this at a
+later time.
+
+# **[TODO]**
+
+## 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.
@@ -394,4 +510,281 @@ Let us create a new component for our custom color field we created above. When
 we use a color field, let us say we want the UI to display a color picker for
 the user to pick from rather than entering values. That is what we will build
 now.
--->
+
+---
+
+# OLD -- TO BE DELETED OR MOVED LATER
+
+---
+
+## Creating a new invocation
+
+To create a new invocation, either find the appropriate module file in
+`/ldm/invoke/app/invocations` to add your invocation to, or create a new one in
+that folder. All invocations in that folder will be discovered and made
+available to the CLI and API automatically. Invocations make use of
+[typing](https://docs.python.org/3/library/typing.html) and
+[pydantic](https://pydantic-docs.helpmanual.io/) for validation and integration
+into the CLI and API.
+
+An invocation looks like this:
+
+```py
+class UpscaleInvocation(BaseInvocation):
+    """Upscales an image."""
+
+    # fmt: off
+    type: Literal["upscale"] = "upscale"
+
+    # Inputs
+    image: Union[ImageField, None] = Field(description="The input image", default=None)
+    strength: float                = Field(default=0.75, gt=0, le=1, description="The strength")
+    level: Literal[2, 4]           = Field(default=2, description="The upscale level")
+    # fmt: on
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "tags": ["upscaling", "image"],
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> ImageOutput:
+        image = context.services.images.get_pil_image(
+            self.image.image_origin, self.image.image_name
+        )
+        results = context.services.restoration.upscale_and_reconstruct(
+            image_list=[[image, 0]],
+            upscale=(self.level, self.strength),
+            strength=0.0,  # GFPGAN strength
+            save_original=False,
+            image_callback=None,
+        )
+
+        # Results are image and seed, unwrap for now
+        # TODO: can this return multiple results?
+        image_dto = context.services.images.create(
+            image=results[0][0],
+            image_origin=ResourceOrigin.INTERNAL,
+            image_category=ImageCategory.GENERAL,
+            node_id=self.id,
+            session_id=context.graph_execution_state_id,
+            is_intermediate=self.is_intermediate,
+        )
+
+        return ImageOutput(
+            image=ImageField(
+                image_name=image_dto.image_name,
+                image_origin=image_dto.image_origin,
+            ),
+            width=image_dto.width,
+            height=image_dto.height,
+        )
+
+```
+
+Each portion is important to implement correctly.
+
+### Class definition and type
+
+```py
+class UpscaleInvocation(BaseInvocation):
+    """Upscales an image."""
+    type: Literal['upscale'] = 'upscale'
+```
+
+All invocations must derive from `BaseInvocation`. They should have a docstring
+that declares what they do in a single, short line. They should also have a
+`type` with a type hint that's `Literal["command_name"]`, where `command_name`
+is what the user will type on the CLI or use in the API to create this
+invocation. The `command_name` must be unique. The `type` must be assigned to
+the value of the literal in the type hint.
+
+### Inputs
+
+```py
+    # Inputs
+    image: Union[ImageField,None] = Field(description="The input image")
+    strength: float               = Field(default=0.75, gt=0, le=1, description="The strength")
+    level: Literal[2,4]           = Field(default=2, description="The upscale level")
+```
+
+Inputs consist of three parts: a name, a type hint, and a `Field` with default,
+description, and validation information. For example:
+
+| Part      | Value                                                         | Description                                                                                                               |
+| --------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
+| Name      | `strength`                                                    | This field is referred to as `strength`                                                                                   |
+| Type Hint | `float`                                                       | This field must be of type `float`                                                                                        |
+| Field     | `Field(default=0.75, gt=0, le=1, description="The strength")` | The default value is `0.75`, the value must be in the range (0,1], and help text will show "The strength" for this field. |
+
+Notice that `image` has type `Union[ImageField,None]`. The `Union` allows this
+field to be parsed with `None` as a value, which enables linking to previous
+invocations. All fields should either provide a default value or allow `None` as
+a value, so that they can be overwritten with a linked output from another
+invocation.
+
+The special type `ImageField` is also used here. All images are passed as
+`ImageField`, which protects them from pydantic validation errors (since images
+only ever come from links).
+
+Finally, note that for all linking, the `type` of the linked fields must match.
+If the `name` also matches, then the field can be **automatically linked** to a
+previous invocation by name and matching.
+
+### Config
+
+```py
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "tags": ["upscaling", "image"],
+            },
+        }
+```
+
+This is an optional configuration for the invocation. It inherits from
+pydantic's model `Config` class, and it used primarily to customize the
+autogenerated OpenAPI schema.
+
+The UI relies on the OpenAPI schema in two ways:
+
+- An API client & Typescript types are generated from it. This happens at build
+  time.
+- The node editor parses the schema into a template used by the UI to create the
+  node editor UI. This parsing happens at runtime.
+
+In this example, a `ui` key has been added to the `schema_extra` dict to provide
+some tags for the UI, to facilitate filtering nodes.
+
+See the Schema Generation section below for more information.
+
+### Invoke Function
+
+```py
+    def invoke(self, context: InvocationContext) -> ImageOutput:
+        image = context.services.images.get_pil_image(
+            self.image.image_origin, self.image.image_name
+        )
+        results = context.services.restoration.upscale_and_reconstruct(
+            image_list=[[image, 0]],
+            upscale=(self.level, self.strength),
+            strength=0.0,  # GFPGAN strength
+            save_original=False,
+            image_callback=None,
+        )
+
+        # Results are image and seed, unwrap for now
+        # TODO: can this return multiple results?
+        image_dto = context.services.images.create(
+            image=results[0][0],
+            image_origin=ResourceOrigin.INTERNAL,
+            image_category=ImageCategory.GENERAL,
+            node_id=self.id,
+            session_id=context.graph_execution_state_id,
+            is_intermediate=self.is_intermediate,
+        )
+
+        return ImageOutput(
+            image=ImageField(
+                image_name=image_dto.image_name,
+                image_origin=image_dto.image_origin,
+            ),
+            width=image_dto.width,
+            height=image_dto.height,
+        )
+```
+
+The `invoke` function is the last portion of an invocation. It is provided an
+`InvocationContext` which contains services to perform work as well as a
+`session_id` for use as needed. It should return a class with output values that
+derives from `BaseInvocationOutput`.
+
+Before being called, the invocation will have all of its fields set from
+defaults, inputs, and finally links (overriding in that order).
+
+Assume that this invocation may be running simultaneously with other
+invocations, may be running on another machine, or in other interesting
+scenarios. If you need functionality, please provide it as a service in the
+`InvocationServices` class, and make sure it can be overridden.
+
+### Outputs
+
+```py
+class ImageOutput(BaseInvocationOutput):
+    """Base class for invocations that output an image"""
+
+    # fmt: off
+    type: Literal["image_output"] = "image_output"
+    image:      ImageField = Field(default=None, description="The output image")
+    width:             int = Field(description="The width of the image in pixels")
+    height:            int = Field(description="The height of the image in pixels")
+    # fmt: on
+
+    class Config:
+        schema_extra = {"required": ["type", "image", "width", "height"]}
+```
+
+Output classes look like an invocation class without the invoke method. Prefer
+to use an existing output class if available, and prefer to name inputs the same
+as outputs when possible, to promote automatic invocation linking.
+
+## Schema Generation
+
+Invocation, output and related classes are used to generate an OpenAPI schema.
+
+### Required Properties
+
+The schema generation treat all properties with default values as optional. This
+makes sense internally, but when when using these classes via the generated
+schema, we end up with e.g. the `ImageOutput` class having its `image` property
+marked as optional.
+
+We know that this property will always be present, so the additional logic
+needed to always check if the property exists adds a lot of extraneous cruft.
+
+To fix this, we can leverage `pydantic`'s
+[schema customisation](https://docs.pydantic.dev/usage/schema/#schema-customization)
+to mark properties that we know will always be present as required.
+
+Here's that `ImageOutput` class, without the needed schema customisation:
+
+```python
+class ImageOutput(BaseInvocationOutput):
+    """Base class for invocations that output an image"""
+
+    # fmt: off
+    type: Literal["image_output"] = "image_output"
+    image:      ImageField = Field(default=None, description="The output image")
+    width:             int = Field(description="The width of the image in pixels")
+    height:            int = Field(description="The height of the image in pixels")
+    # fmt: on
+```
+
+The OpenAPI schema that results from this `ImageOutput` will have the `type`,
+`image`, `width` and `height` properties marked as optional, even though we know
+they will always have a value.
+
+```python
+class ImageOutput(BaseInvocationOutput):
+    """Base class for invocations that output an image"""
+
+    # fmt: off
+    type: Literal["image_output"] = "image_output"
+    image:      ImageField = Field(default=None, description="The output image")
+    width:             int = Field(description="The width of the image in pixels")
+    height:            int = Field(description="The height of the image in pixels")
+    # fmt: on
+
+    # Add schema customization
+    class Config:
+        schema_extra = {"required": ["type", "image", "width", "height"]}
+```
+
+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>

docs/contributing/LOCAL_DEVELOPMENT.md

@@ -35,17 +35,18 @@ access.
 
 ## Backend
 
-The backend is contained within the `./invokeai/backend` and `./invokeai/app` directories.
-To get started please install the development dependencies.
+The backend is contained within the `./invokeai/backend` folder structure. To
+get started however please install the development dependencies.
 
 From the root of the repository run the following command. Note the use of `"`.
 
 ```zsh
-pip install ".[dev,test]"
+pip install ".[test]"
 ```
 
-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.
+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.
 
 ### Running Tests
 
@@ -75,20 +76,6 @@ 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

@@ -16,7 +16,7 @@ If you don't feel ready to make a code contribution yet, no problem! You can als
 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. 
+    1. Additional items can be found on our roadmap <******************************link to roadmap>******************************. 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.*

docs/features/CONFIGURATION.md

@@ -175,27 +175,22 @@ These configuration settings allow you to enable and disable various InvokeAI fe
 | `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 |
 | `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) |
 
-### Generation
+### Memory/Performance
 
 These options tune InvokeAI's memory and performance characteristics.
 
-| 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 |
-
+| 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 |
 
 ### Paths
 

docs/features/NODES.md

@@ -0,0 +1,208 @@
+# 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()` |
+| ImageNSFWBlurInvocation            | Detects and blurs images that may contain sexually explicit content |
+| 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 |
+| ImageWatermarkInvocation           | Adds an invisible watermark to images |
+| 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.  
+
+![groupsnoise](../assets/nodes/groupsnoise.png)
+
+### 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.
+
+![groupsconditioning](../assets/nodes/groupsconditioning.png)
+
+### 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.
+
+![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 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.
+
+![groupsrandseed](../assets/nodes/groupsrandseed.png)
+
+### 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.
+
+![groupscontrol](../assets/nodes/groupscontrol.png)
+
+### 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.
+
+![groupslora](../assets/nodes/groupslora.png)
+
+### 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.
+
+![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 pass them out one at a time.
+
+![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)
+
+## 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
+
+![nodest2i](../assets/nodes/nodest2i.png)
+
+- 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
+
+![nodesi2i](../assets/nodes/nodesi2i.png)
+
+- 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
+
+![nodescontrol](../assets/nodes/nodescontrol.png)
+
+- 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/POSTPROCESS.md

@@ -4,13 +4,35 @@ title: Postprocessing
 
 # :material-image-edit: Postprocessing
 
-This sections details the ability to improve faces and upscale images.
+## Intro
+
+This extension provides the ability to restore faces and upscale images.
 
 ## Face Fixing
 
-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. 
+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.
 
-## Upscaling
+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
 
 Open the upscaling dialog by clicking on the "expand" icon located
 above the image display area in the Web UI:
@@ -19,23 +41,82 @@ above the image display area in the Web UI:
 ![upscale1](../assets/features/upscale-dialog.png)
 </figure>
 
-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.
+There are three different upscaling parameters that you can
+adjust. The first is the scale itself, either 2x or 4x.
 
-Other options are the x4 upscalers, which will scale your image by a factor of 4. 
+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.
 
+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
 
-    Real-ESRGAN is memory intensive. In order to avoid crashes and memory overloads
+    GFPGAN and Real-ESRGAN are both memory intensive. In order to avoid crashes and memory overloads
     during the Stable Diffusion process, these effects are applied after Stable Diffusion has completed
     its work.
 
     In single image generations, you will see the output right away but when you are using multiple
-    iterations, the images will first be generated and then upscaled after that
+    iterations, the images will first be generated and then upscaled and face restored after that
     process is complete. While the image generation is taking place, you will still be able to preview
     the base images.
 
 ## How to disable
 
-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.
+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.

docs/features/PROMPTS.md

@@ -4,6 +4,80 @@ 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:
@@ -28,6 +102,9 @@ 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
@@ -73,7 +150,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) |
 
-### Prompt Blending
+### Blending between prompts
 
 - `("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 -
@@ -91,24 +168,6 @@ 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
@@ -131,7 +190,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)[(https://github.com/bloc97/CrossAttentionControl)] `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 `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`.
@@ -142,7 +201,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 parentheses () and speech marks ""
+### Escaping parantheses () 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)`
@@ -153,16 +212,23 @@ the parentheses as part of the prompt syntax and it will get confused.
 
 ## **Prompt Blending**
 
-You may blend together prompts to explore the AI's
+You may blend together different sections of the prompt to explore the AI's
 latent semantic space and generate interesting (and often surprising!)
 variations. The syntax is:
 
 ```bash
-("prompt #1", "prompt #2").blend(0.25, 0.75)
+blue sphere:0.25 red cube:0.75 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.
+This will tell the sampler to blend 25% of the concept of a blue sphere with 75%
+of the concept of a red cube. The blend weights can use any combination of
+integers and floating point numbers, and they do not need to add up to 1.
+Everything to the left of the `:XX` up to the previous `:XX` is used for
+merging, so the overall effect is:
+
+```bash
+0.25 * "blue sphere" + 0.75 * "white duck" + hybrid
+```
 
 Because you are exploring the "mind" of the AI, the AI's way of mixing two
 concepts may not match yours, leading to surprising effects. To illustrate, here
@@ -170,14 +236,13 @@ 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.
 
-Let's examine how this affects image generation results:
+<figure markdown>
 
+### "blue sphere, red cube, hybrid"
 
-```bash
-"blue sphere, red cube, hybrid"
-```
+</figure>
 
-This example doesn't use blending at all and represents the default way of mixing
+This example doesn't use melding at all and represents the default way of mixing
 concepts.
 
 <figure markdown>
@@ -186,47 +251,55 @@ concepts.
 
 </figure>
 
-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.
+It's interesting to see how the AI expressed the concept of "cube" as the four
+quadrants of the enclosing frame. If you look closely, there is depth there, so
+the enclosing frame is actually a cube.
 
 <figure markdown>
 
-```bash
-("blue sphere", "red cube").blend(0.25, 0.75)
-```
+### "blue sphere:0.25 red cube:0.75 hybrid"
 
 ![blue-sphere-25-red-cube-75](../assets/prompt-blending/blue-sphere-0.25-red-cube-0.75-hybrid.png)
 
 </figure>
 
-Now that's interesting. We get 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. 
+Now that's interesting. We get neither a blue sphere nor a red cube, but a red
+sphere embedded in a brick wall, which represents a melding of concepts within
+the AI's "latent space" of semantic representations. Where is Ludwig
+Wittgenstein when you need him?
 
 <figure markdown>
 
-```bash
-("blue sphere", "red cube").blend(0.75, 0.25)
-```
+### "blue sphere:0.75 red cube:0.25 hybrid"
 
 ![blue-sphere-75-red-cube-25](../assets/prompt-blending/blue-sphere-0.75-red-cube-0.25-hybrid.png)
 
 </figure>
 
-Definitely more blue-spherey. 
+Definitely more blue-spherey. The cube is gone entirely, but it's really cool
+abstract art.
 
 <figure markdown>
 
-```bash
-("blue sphere", "red cube").blend(0.5, 0.5)
-```
-</figure>
+### "blue sphere:0.5 red cube:0.5 hybrid"
 
-<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.
 
-Whoa...! I see blue and red, and if I squint, spheres and cubes.
+<figure markdown>
 
+### "blue sphere:0.5 red cube:0.5"
 
+![blue-sphere-5-red-cube-5](../assets/prompt-blending/blue-sphere-0.5-red-cube-0.5.png)
+
+</figure>
+
+Indeed, removing the word "hybrid" produces an image that is more like what we'd
+expect.
 
 ## Dynamic Prompts
 

docs/features/index.md

@@ -4,9 +4,6 @@ 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)
@@ -30,6 +27,10 @@ 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)
@@ -45,7 +46,7 @@ Personalize models by adding your own style or subjects.
 
 ## Other Features
 
-### * [The NSFW Checker](WATERMARK+NSFW.md)
+### * [The NSFW Checker](NSFW.md)
 Prevent InvokeAI from displaying unwanted racy images.
 
 ### * [Controlling Logging](LOGGING.md)

docs/help/diffusion.md

@@ -1,27 +0,0 @@
-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

@@ -1,95 +0,0 @@
-# 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,33 +11,6 @@ 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>
 
 
@@ -49,9 +22,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]
@@ -97,23 +70,61 @@ 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 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.
+    This fork is rapidly evolving. Please use the [Issues tab](https://github.com/invoke-ai/InvokeAI/issues) to report bugs and make feature requests. Be sure to use the provided templates. They will help aid diagnose issues faster.
 
-## :octicons-link-24: Quick Links
+## :octicons-package-dependencies-24: Installation
 
-<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>
+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 is the recommended installation method for first-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)
+
+## :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.
+
+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-gift-24: InvokeAI Features
@@ -219,7 +230,7 @@ encouraged to do so.
 
 ## :octicons-person-24: Contributors
 
-This software is a combined effort of various people from across the world.
+This fork is a combined effort of various people from across the world.
 [Check out the list of all these amazing people](other/CONTRIBUTORS.md). We
 thank them for their time, hard work and effort.
 

docs/installation/010_INSTALL_AUTOMATED.md

@@ -40,8 +40,10 @@ 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.*`, `3.10.*` or `3.11.*` you meet
-    requirements.
+    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.
 
     !!! warning "What to do if you have an unsupported version"
 
@@ -264,7 +266,7 @@ experimental versions later.
 	  you can create several levels of subfolders and drop your models into
       whichever ones you want.
 	
-    - ***LICENSE***     
+    - ***Autoimport FolderLICENSE***     
 
     At the bottom of the screen you will see a checkbox for accepting
     the CreativeML Responsible AI Licenses. You need to accept the license
@@ -372,71 +374,8 @@ 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
@@ -471,7 +410,7 @@ Then type the following commands:
 
 === "NVIDIA System"
     ```bash
-    pip install torch torchvision --force-reinstall --extra-index-url https://download.pytorch.org/whl/cu118
+    pip install torch torchvision --force-reinstall --extra-index-url https://download.pytorch.org/whl/cu117
     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 through 3.11
+    version 3.9 or 3.10 (3.11 is not recommended).
 
 * **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 through 3.11. The rest of the install
+1.  Please make sure you are using Python 3.9 or 3.10. 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/cu118
+        pip install "InvokeAI[xformers]" --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117
         ```
 
     === "ROCm (AMD)"
@@ -192,10 +192,8 @@ manager, please follow these steps:
     your outputs.
 
     ```terminal
-    invokeai-configure --root .
+    invokeai-configure
     ```
-	
-	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.
@@ -227,6 +225,12 @@ 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
@@ -239,12 +243,6 @@ 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.
 
@@ -312,7 +310,7 @@ installation protocol (important!)
 
     === "CUDA (NVidia)"
         ```bash
-        pip install -e .[xformers] --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu118
+        pip install -e .[xformers] --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117
         ```
 
     === "ROCm (AMD)"
@@ -356,7 +354,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/cu118
+pip install InvokeAI[xformers] --use-pep517 --extra-index-url https://download.pytorch.org/whl/cu117
 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
-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").
+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").
 
 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/cu118` as described in the [Manual
+https://download.pytorch.org/whl/cu117` 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 most users"
+!!! warning "For end users"
 
-    We highly recommend to Install InvokeAI locally using [these instructions](INSTALLATION.md)
+    We highly recommend to Install InvokeAI locally using [these instructions](index.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 https://civitai.com/api/download/models/128713
+invokeai-model-install --add http://civitai.com/2860
 
 # (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,21 +28,18 @@ command line, then just be sure to activate it's virtual environment.
 Then run the following three commands:
 
 ```sh
-pip install xformers~=0.0.19
-pip install triton    # WON'T WORK ON WINDOWS
+pip install xformers==0.0.16rc425
+pip install triton
 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. 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
+installation status. If all goes well, you'll see a report like the
 following:
 
 ```sh
-xFormers 0.0.20
+xFormers 0.0.16rc425
 memory_efficient_attention.cutlassF:               available
 memory_efficient_attention.cutlassB:               available
 memory_efficient_attention.flshattF:               available
@@ -51,28 +48,22 @@ 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:                                   2.0.1+cu118
+pytorch.version:                                   1.13.1+cu117
 pytorch.cuda:                                      available
-gpu.compute_capability:                            8.9
-gpu.name:                                          NVIDIA GeForce RTX 4070
+gpu.compute_capability:                            8.6
+gpu.name:                                          NVIDIA RTX A2000 12GB
 build.info:                                        available
-build.cuda_version:                                1108
-build.python_version:                              3.10.11
-build.torch_version:                               2.0.1+cu118
+build.cuda_version:                                1107
+build.python_version:                              3.10.9
+build.torch_version:                               1.13.1+cu117
 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.20
-build.nvcc_version:                                11.8.89
+build.env.XFORMERS_PACKAGE_FROM:                   wheel-v0.0.16rc425
 source.privacy:                                    open source
 ```
 
@@ -92,14 +83,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.8
+#### 1. Install CUDA Toolkit 11.7
 
 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.8
-Downloads](https://developer.nvidia.com/cuda-11-8-0-download-archive)
+by NVIDIA itself. 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 platform and Linux
 distribution. Select an installer type of "runfile (local)" at the
 last step.
@@ -110,17 +101,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.8.0/local_installers/cuda_11.8.0_520.61.05_linux.run
-sudo sh cuda_11.8.0_520.61.05_linux.run
+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
 ```
 
 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 2.01 with CUDA 11.8 support
+#### 2. Confirm/Install pyTorch 1.13 with CUDA 11.7 support
 
-If you are using InvokeAI 3.0.2 or higher, these will already be
+If you are using InvokeAI 2.3 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
@@ -133,7 +124,7 @@ Then run the command:
 python -c 'exec("import torch\nprint(torch.__version__)")'
 ```
 
-If it prints __1.13.1+cu118__ you're good. If not, you can install the
+If it prints __1.13.1+cu117__ you're good. If not, you can install the
 most up to date libraries with this command:
 
 ```sh

docs/installation/index.md

@@ -1,4 +1,6 @@
-# Overview
+---
+title: Overview
+---
 
 We offer several ways to install InvokeAI, each one suited to your
 experience and preferences. We suggest that everyone start by
@@ -13,56 +15,6 @@ See the [troubleshooting
 section](010_INSTALL_AUTOMATED.md#troubleshooting) of the automated
 install guide for frequently-encountered installation issues.
 
-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)

docs/javascripts/tablesort.js

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

docs/nodes/NODES.md

@@ -1,68 +0,0 @@
-# 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

@@ -1,80 +0,0 @@
-# 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

@@ -2,102 +2,35 @@
 
 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).
+If you'd like to submit a node for the community, please refer to the [node creation overview](./overview.md#contributing-nodes).
 
-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 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
+## Disclaimer
 
-### FaceTools
+The nodes linked below 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.
 
-**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.
+## List of Nodes
 
-**Node Link:** https://github.com/ymgenesis/FaceTools/
+### Face Mask
 
-**FaceMask Output Examples** 
+**Description:** This node autodetects a face in the image using MediaPipe and masks it by making it transparent. Via outpainting you can swap faces with other faces, or invert the mask and swap things around the face with other things. Additionally, you can supply X and Y offset values to scale/change the shape of the mask for finer control. The node also outputs an all-white mask in the same dimensions as the input image. This is needed by the inpaint node (and unified canvas) for outpainting.
 
-![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)
+**Node Link:** https://github.com/ymgenesis/InvokeAI/blob/facemaskmediapipe/invokeai/app/invocations/facemask.py
 
-### 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
-
-
---------------------------------
-### 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
+**Example Node Graph:** https://www.mediafire.com/file/gohn5sb1bfp8use/21-July_2023-FaceMask.json/file
 
 **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)
+![2e3168cb-af6a-475d-bfac-c7b7fd67b4c2](https://github.com/ymgenesis/InvokeAI/assets/25252829/a5ad7d44-2ada-4b3c-a56e-a21f8244a1ac)
+![2_annotated](https://github.com/ymgenesis/InvokeAI/assets/25252829/53416c8a-a23b-4d76-bb6d-3cfd776e0096)
+![2fe2150c-fd08-4e26-8c36-f0610bf441bb](https://github.com/ymgenesis/InvokeAI/assets/25252829/b0f7ecfe-f093-4147-a904-b9f131b41dc9)
+![831b6b98-4f0f-4360-93c8-69a9c1338cbe](https://github.com/ymgenesis/InvokeAI/assets/25252829/fc7b0622-e361-4155-8a76-082894d084f0)
 
 --------------------------------
-### Load Video Frame
-
-**Description:** This is a video frame image provider + indexer/video creation nodes for hooking up to iterators and ranges and ControlNets and such for invokeAI node experimentation. Think animation + ControlNet outputs.
-
-**Node Link:** https://github.com/helix4u/load_video_frame
-
-**Example Node Graph:**  https://github.com/helix4u/load_video_frame/blob/main/Example_Workflow.json
-
-**Output Example:** 
-=======
-![Example animation](https://github.com/helix4u/load_video_frame/blob/main/testmp4_embed_converted.gif)
-[Full mp4 of Example Output test.mp4](https://github.com/helix4u/load_video_frame/blob/main/test.mp4)
-
---------------------------------
-
-### Oobabooga
-
-**Description:** asks a local LLM running in Oobabooga's Text-Generation-Webui to write a prompt based on the user input.
-
-**Link:** https://github.com/sammyf/oobabooga-node
-
-
-**Example:**
-
-"describe a new mystical  creature in its natural environment"
-
-*can return*
-
-"The mystical creature I am describing to you is called the "Glimmerwing". It is a majestic, iridescent being that inhabits the depths of the most enchanted forests and glimmering lakes. Its body is covered in shimmering scales that reflect every color of the rainbow, and it has delicate, translucent wings that sparkle like diamonds in the sunlight. The Glimmerwing's home is a crystal-clear lake, surrounded by towering trees with leaves that shimmer like jewels. In this serene environment, the Glimmerwing spends its days swimming gracefully through the water, chasing schools of glittering fish and playing with the gentle ripples of the lake's surface.
-As the sun sets, the Glimmerwing perches on a branch of one of the trees, spreading its wings to catch the last rays of light. The creature's scales glow softly, casting a rainbow of colors across the forest floor. The Glimmerwing sings a haunting melody, its voice echoing through the stillness of the night air. Its song is said to have the power to heal the sick and bring peace to troubled souls. Those who are lucky enough to hear the Glimmerwing's song are forever changed by its beauty and grace."
-
-![glimmerwing_small](https://github.com/sammyf/oobabooga-node/assets/42468608/cecdd820-93dd-4c35-abbf-607e001fb2ed)
-
-**Requirement**
-
-a Text-Generation-Webui instance (might work remotely too, but I never tried it) and obviously InvokeAI 3.x
-
-**Note**
-
-This node works best with SDXL models, especially as the style can be described independantly of the LLM's output.
-
---------------------------------
-
-### Example Node Template
+### Super Cool Node Template
 
 **Description:** This node allows you to do super cool things with InvokeAI.
 
@@ -107,14 +40,13 @@ This node works best with SDXL models, especially as the style can be described
 
 **Output Examples** 
 
-![Example Image](https://invoke-ai.github.io/InvokeAI/assets/invoke_ai_banner.png){: style="height:115px;width:240px"}
+![Invoke AI](https://invoke-ai.github.io/InvokeAI/assets/invoke_ai_banner.png)
 
+### Ideal Size
 
-## 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.
+**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
 
 ## Help
 If you run into any issues with a node, please post in the [InvokeAI Discord](https://discord.gg/ZmtBAhwWhy). 
-

docs/nodes/contributingNodes.md

@@ -1,27 +0,0 @@
-# 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

@@ -1,97 +0,0 @@
-# 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

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

docs/nodes/overview.md

@@ -1,26 +1,42 @@
 # 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
+An Node is simply a single operation that takes in some inputs and gives
+out some outputs. We can then chain multiple nodes together to create more
 complex functionality. All InvokeAI features are added through nodes.
 
-### Anatomy of a Node
+This means nodes can be used to easily extend the image generation capabilities of InvokeAI, and allow you build workflows to suit your needs. 
 
-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.
+You can read more about nodes and the node editor [here](../features/NODES.md). 
 
 
-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. 
+## Downloading Nodes
+To download a new node, visit our list of [Community Nodes](communityNodes.md). These are nodes that have been created by the community, for the community. 
 
 
+## Contributing Nodes
+
+To learn about creating a new node, please visit our [Node creation documenation](../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)
+```

flake.lock

@@ -1,25 +0,0 @@
-{
-  "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

@@ -1,91 +0,0 @@
-# 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/create_installer.sh

@@ -46,7 +46,6 @@ if [[ $(python -c 'from importlib.util import find_spec; print(find_spec("build"
     pip install --user build
 fi
 
-rm -r ../build
 python -m build --wheel --outdir dist/ ../.
 
 # ----------------------

installer/install.sh.in

@@ -9,20 +9,16 @@ 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.100
+MAXIMUM_PYTHON_VERSION=3.11.0
 PYTHON=""
-for candidate in python3.11 python3.10 python3.9 python3 python ; do
+for candidate in 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) -le $(version "$MAXIMUM_PYTHON_VERSION") ]; then
-                PYTHON=$ppath
-                break
-            fi
+	    if [ $(version $python_version) -lt $(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.100"
+SUPPORTED_PYTHON = ">=3.9.0,<3.11"
 INSTALLER_REQS = ["rich", "semver", "requests", "plumbum", "prompt-toolkit"]
 BOOTSTRAP_VENV_PREFIX = "invokeai-installer-tmp"
 
@@ -141,16 +141,15 @@ 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", version: str = "latest", yes_to_all=False, find_links: Path = None
-    ) -> None:
+    def install(self, root: str = "~/invokeai-3", version: str = "latest", yes_to_all=False, find_links: Path = None) -> None:
         """
         Install the InvokeAI application into the given runtime path
 
@@ -168,8 +167,7 @@ class Installer:
 
         messages.welcome()
 
-        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)
+        self.dest = Path(root).expanduser().resolve() if yes_to_all else messages.dest_path(root)
 
         # create the venv for the app
         self.venv = self.app_venv()
@@ -177,7 +175,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,
@@ -190,7 +188,6 @@ 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.
@@ -199,6 +196,7 @@ 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)
@@ -249,9 +247,6 @@ 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",
@@ -317,7 +312,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,
@@ -334,21 +329,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.invokeai_configure import invokeai_configure
+        from invokeai.frontend.install 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.
@@ -358,16 +353,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):
         """
@@ -376,11 +371,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)
@@ -407,7 +402,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)
 
 
@@ -425,7 +420,11 @@ 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}"
@@ -434,7 +433,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.
@@ -455,19 +454,16 @@ def get_torch_source() -> (Union[str, None], str):
     device = graphical_accelerator()
 
     url = None
-    optional_modules = "[onnx]"
+    optional_modules = None
     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/cu118"
-        optional_modules = "[xformers,onnx-cuda]"
-    if device == "cuda_and_dml":
-        url = "https://download.pytorch.org/whl/cu118"
-        optional_modules = "[xformers,onnx-directml]"
+    if device == 'cuda':
+        url = 'https://download.pytorch.org/whl/cu117'
+        optional_modules = '[xformers]'
 
     # in all other cases, Torch wheels should be coming from PyPi as of Torch 1.13
 

installer/lib/main.py

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

installer/lib/messages.py

@@ -36,15 +36,13 @@ 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(
@@ -60,7 +58,6 @@ def welcome():
     )
     console.line()
 
-
 def confirm_install(dest: Path) -> bool:
     if dest.exists():
         print(f":exclamation: Directory {dest} already exists :exclamation:")
@@ -70,7 +67,7 @@ def confirm_install(dest: Path) -> bool:
         )
     else:
         print(f"InvokeAI will be installed in {dest}")
-        dest_confirmed = not Confirm.ask("Would you like to pick a different location?", default=False)
+        dest_confirmed = not Confirm.ask(f"Would you like to pick a different location?", default=False)
     console.line()
 
     return dest_confirmed
@@ -90,11 +87,12 @@ def dest_path(dest=None) -> Path:
         dest = Path(dest).expanduser().resolve()
     else:
         dest = Path.cwd().expanduser().resolve()
-    prev_dest = init_path = dest
+    prev_dest = dest.expanduser().resolve()
 
     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.
@@ -109,9 +107,9 @@ def dest_path(dest=None) -> Path:
         )
 
         console.line()
-        console.print(f"[orange3]Please select the destination directory for the installation:[/] \\[{browse_start}]: ")
+        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,
@@ -134,14 +132,14 @@ def dest_path(dest=None) -> Path:
     try:
         dest.mkdir(exist_ok=True, parents=True)
         return dest
-    except PermissionError:
-        console.print(
+    except PermissionError as exc:
+        print(
             f"Failed to create directory {dest} due to insufficient permissions",
             style=Style(color="red"),
             highlight=True,
         )
-    except OSError:
-        console.print_exception()
+    except OSError as exc:
+        console.print_exception(exc)
 
     if Confirm.ask("Would you like to try again?"):
         dest_path(init_path)
@@ -167,10 +165,6 @@ 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",
@@ -185,7 +179,7 @@ def graphical_accelerator():
     )
 
     if OS == "Windows":
-        options = [nvidia, nvidia_with_dml, cpu]
+        options = [nvidia, cpu]
     if OS == "Linux":
         options = [nvidia, amd, cpu]
     elif OS == "Darwin":
@@ -306,20 +300,15 @@ 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,13 +8,16 @@ 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.*, and not higher than 3.11.*.
+  is at least 3.9.1, and less 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 --skip-sd-weight
+    python .venv\Scripts\invokeai-configure.exe --yes --default_only
 ) 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 --skip-sd-weights
+        invokeai-configure --root ${INVOKEAI_ROOT} --yes --default_only
         ;;
     8)
         clear

invokeai/app/api/dependencies.py

@@ -1,6 +1,7 @@
 # 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,
 )
@@ -28,7 +29,6 @@ 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 Exception:
+    except:
         return False
 
 
@@ -54,7 +54,7 @@ logger = InvokeAILogger.getLogger()
 class ApiDependencies:
     """Contains and initializes all dependencies for the API"""
 
-    invoker: Invoker
+    invoker: Invoker = None
 
     @staticmethod
     def initialize(config: InvokeAIAppConfig, event_handler_id: int, logger: Logger = logger):
@@ -67,9 +67,8 @@ class ApiDependencies:
         output_folder = config.output_path
 
         # TODO: build a file/path manager?
-        db_path = config.db_path
-        db_path.parent.mkdir(parents=True, exist_ok=True)
-        db_location = str(db_path)
+        db_location = config.db_path
+        db_location.parent.mkdir(parents=True, exist_ok=True)
 
         graph_execution_manager = SqliteItemStorage[GraphExecutionState](
             filename=db_location, table_name="graph_executions"
@@ -79,7 +78,9 @@ 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,11 +125,12 @@ 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

@@ -15,7 +15,6 @@ 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
@@ -24,12 +23,10 @@ class LogLevel(int, Enum):
     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"])
 
 
@@ -48,30 +45,38 @@ class AppConfig(BaseModel):
     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", "lama"]
+    infill_methods = ['tile']
     if PatchMatch.patchmatch_available():
-        infill_methods.append("patchmatch")
+        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)
-
+    upscaler = Upscaler(
+        upscaling_method = 'esrgan',
+        upscaling_models = upscaling_models
+    )
+    
     nsfw_methods = []
     if SafetyChecker.safety_checker_available():
-        nsfw_methods.append("nsfw_checker")
+        nsfw_methods.append('nsfw_checker')
 
     watermarking_methods = []
     if InvisibleWatermark.invisible_watermark_available():
-        watermarking_methods.append("invisible_watermark")
-
+        watermarking_methods.append('invisible_watermark')
+        
     return AppConfig(
         infill_methods=infill_methods,
         upscaling_methods=[upscaler],
@@ -79,26 +84,25 @@ async def get_config() -> AppConfig:
         watermarking_methods=watermarking_methods,
     )
 
-
 @app_router.get(
     "/logging",
     operation_id="get_log_level",
-    responses={200: {"description": "The operation was successful"}},
-    response_model=LogLevel,
+    responses={200: {"description" : "The operation was successful"}},
+    response_model = LogLevel,
 )
-async def get_log_level() -> 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,
+    responses={200: {"description" : "The operation was successful"}},
+    response_model = LogLevel,
 )
 async def set_log_level(
-    level: LogLevel = Body(description="New log verbosity level"),
+        level: LogLevel = Body(description="New log verbosity level"),
 ) -> LogLevel:
     """Sets the log verbosity level"""
     ApiDependencies.invoker.services.logger.setLevel(level)

invokeai/app/api/routers/board_images.py

@@ -1,30 +1,24 @@
-from fastapi import Body, HTTPException
+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 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 ..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="add_image_to_board",
+    operation_id="create_board_image",
     responses={
         201: {"description": "The image was added to a board successfully"},
     },
     status_code=201,
 )
-async def add_image_to_board(
+async def create_board_image(
     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"),
 ):
@@ -34,79 +28,28 @@ async def add_image_to_board(
             board_id=board_id, image_name=image_name
         )
         return result
-    except Exception:
-        raise HTTPException(status_code=500, detail="Failed to add image to board")
+    except Exception as e:
+        raise HTTPException(status_code=500, detail="Failed to add to board")
 
 
 @board_images_router.delete(
     "/",
-    operation_id="remove_image_from_board",
+    operation_id="remove_board_image",
     responses={
         201: {"description": "The image was removed from the board successfully"},
     },
     status_code=201,
 )
-async def remove_image_from_board(
-    image_name: str = Body(description="The name of the image to remove", embed=True),
+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"),
 ):
-    """Removes an image from its board, if it had one"""
+    """Deletes a board_image"""
     try:
-        result = ApiDependencies.invoker.services.board_images.remove_image_from_board(image_name=image_name)
+        result = ApiDependencies.invoker.services.board_images.remove_image_from_board(
+            board_id=board_id, image_name=image_name
+        )
         return result
-    except Exception:
-        raise HTTPException(status_code=500, detail="Failed to remove image from board")
+    except Exception as e:
+        raise HTTPException(status_code=500, detail="Failed to update board")
 
-
-@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 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")
-
-
-@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

@@ -18,7 +18,9 @@ class DeleteBoardResult(BaseModel):
     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.")
+    deleted_images: list[str] = Field(
+        description="The names of the images that were deleted."
+    )
 
 
 @boards_router.post(
@@ -37,7 +39,7 @@ async def create_board(
     try:
         result = ApiDependencies.invoker.services.boards.create(board_name=board_name)
         return result
-    except Exception:
+    except Exception as e:
         raise HTTPException(status_code=500, detail="Failed to create board")
 
 
@@ -50,7 +52,7 @@ async def get_board(
     try:
         result = ApiDependencies.invoker.services.boards.get_dto(board_id=board_id)
         return result
-    except Exception:
+    except Exception as e:
         raise HTTPException(status_code=404, detail="Board not found")
 
 
@@ -71,16 +73,22 @@ 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:
+    except Exception as e:
         raise HTTPException(status_code=500, detail="Failed to update board")
 
 
-@boards_router.delete("/{board_id}", operation_id="delete_board", response_model=DeleteBoardResult)
+@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),
+    include_images: Optional[bool] = Query(
+        description="Permanently delete all images on the board", default=False
+    ),
 ) -> DeleteBoardResult:
     """Deletes a board"""
     try:
@@ -88,7 +96,9 @@ async def delete_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.images.delete_images_on_board(
+                board_id=board_id
+            )
             ApiDependencies.invoker.services.boards.delete(board_id=board_id)
             return DeleteBoardResult(
                 board_id=board_id,
@@ -105,7 +115,7 @@ async def delete_board(
                 deleted_board_images=deleted_board_images,
                 deleted_images=[],
             )
-    except Exception:
+    except Exception as e:
         raise HTTPException(status_code=500, detail="Failed to delete board")
 
 
@@ -117,7 +127,9 @@ 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:

invokeai/app/api/routers/images.py

@@ -1,31 +1,31 @@
 import io
 from typing import Optional
 
-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 pydantic import BaseModel, Field
+from PIL import Image
 
 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 ..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"},
@@ -40,9 +40,15 @@ 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"),
-    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"),
+    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"):
@@ -55,7 +61,7 @@ async def upload_image(
         if crop_visible:
             bbox = pil_image.getbbox()
             pil_image = pil_image.crop(bbox)
-    except Exception:
+    except:
         # Error opening the image
         raise HTTPException(status_code=415, detail="Failed to read image")
 
@@ -73,11 +79,11 @@ async def upload_image(
         response.headers["Location"] = image_dto.image_url
 
         return image_dto
-    except Exception:
+    except Exception as e:
         raise HTTPException(status_code=500, detail="Failed to create image")
 
 
-@images_router.delete("/i/{image_name}", operation_id="delete_image")
+@images_router.delete("/{image_name}", operation_id="delete_image")
 async def delete_image(
     image_name: str = Path(description="The name of the image to delete"),
 ) -> None:
@@ -85,7 +91,7 @@ async def delete_image(
 
     try:
         ApiDependencies.invoker.services.images.delete(image_name)
-    except Exception:
+    except Exception as e:
         # TODO: Does this need any exception handling at all?
         pass
 
@@ -97,30 +103,32 @@ async def clear_intermediates() -> int:
     try:
         count_deleted = ApiDependencies.invoker.services.images.delete_intermediates()
         return count_deleted
-    except Exception:
+    except Exception as e:
         raise HTTPException(status_code=500, detail="Failed to clear intermediates")
         pass
 
 
 @images_router.patch(
-    "/i/{image_name}",
+    "/{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:
+    except Exception as e:
         raise HTTPException(status_code=400, detail="Failed to update image")
 
 
 @images_router.get(
-    "/i/{image_name}",
+    "/{image_name}",
     operation_id="get_image_dto",
     response_model=ImageDTO,
 )
@@ -131,12 +139,12 @@ async def get_image_dto(
 
     try:
         return ApiDependencies.invoker.services.images.get_dto(image_name)
-    except Exception:
+    except Exception as e:
         raise HTTPException(status_code=404)
 
 
 @images_router.get(
-    "/i/{image_name}/metadata",
+    "/{image_name}/metadata",
     operation_id="get_image_metadata",
     response_model=ImageMetadata,
 )
@@ -147,13 +155,12 @@ async def get_image_metadata(
 
     try:
         return ApiDependencies.invoker.services.images.get_metadata(image_name)
-    except Exception:
+    except Exception as e:
         raise HTTPException(status_code=404)
 
 
-@images_router.api_route(
-    "/i/{image_name}/full",
-    methods=["GET", "HEAD"],
+@images_router.get(
+    "/{image_name}/full",
     operation_id="get_image_full",
     response_class=Response,
     responses={
@@ -183,12 +190,12 @@ async def get_image_full(
         )
         response.headers["Cache-Control"] = f"max-age={IMAGE_MAX_AGE}"
         return response
-    except Exception:
+    except Exception as e:
         raise HTTPException(status_code=404)
 
 
 @images_router.get(
-    "/i/{image_name}/thumbnail",
+    "/{image_name}/thumbnail",
     operation_id="get_image_thumbnail",
     response_class=Response,
     responses={
@@ -205,19 +212,23 @@ 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:
+    except Exception as e:
         raise HTTPException(status_code=404)
 
 
 @images_router.get(
-    "/i/{image_name}/urls",
+    "/{image_name}/urls",
     operation_id="get_image_urls",
     response_model=ImageUrlsDTO,
 )
@@ -228,13 +239,15 @@ 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:
+    except Exception as e:
         raise HTTPException(status_code=404)
 
 
@@ -244,9 +257,15 @@ 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. Use 'none' to find images without a board.",
@@ -266,62 +285,3 @@ 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,52 +28,49 @@ 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,
@@ -84,13 +81,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.value}/{model_name}=>{info.base_model}/{info.model_name}")
+            logger.info(f'Successfully renamed {base_model}/{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
@@ -99,19 +96,16 @@ 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")
-
-        # 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()}
-
+            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')
+            
         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,
@@ -129,48 +123,49 @@ 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))
@@ -180,34 +175,38 @@ 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:
@@ -217,66 +216,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)}")
@@ -284,101 +283,91 @@ 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"
-        )
+        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.post(
     "/sync",
     operation_id="sync_to_config",
     responses={
-        201: {"description": "synchronization successful"},
+        201: { "description": "synchronization successful" },
     },
-    status_code=201,
-    response_model=bool,
+    status_code = 201,
+    response_model = bool
 )
-async def sync_to_config() -> bool:
+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."""
     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")

invokeai/app/api/routers/sessions.py

@@ -1,13 +1,12 @@
 # Copyright (c) 2022 Kyle Schouviller (https://github.com/kyle0654)
 
-from typing import Annotated, Optional, Union
+from typing import Annotated, List, Optional, Union
 
 from fastapi import Body, HTTPException, Path, Query, Response
 from fastapi.routing import APIRouter
 from pydantic.fields import Field
 
-# Importing * is bad karma but needed here for node detection
-from ...invocations import *  # noqa: F401 F403
+from ...invocations import *
 from ...invocations.baseinvocation import BaseInvocation
 from ...services.graph import (
     Edge,
@@ -31,7 +30,9 @@ session_router = APIRouter(prefix="/v1/sessions", tags=["sessions"])
     },
 )
 async def create_session(
-    graph: Optional[Graph] = Body(default=None, description="The graph to initialize the session with")
+    graph: Optional[Graph] = Body(
+        default=None, description="The graph to initialize the session with"
+    )
 ) -> GraphExecutionState:
     """Creates a new session, optionally initializing it with an invocation graph"""
     session = ApiDependencies.invoker.create_execution_state(graph)
@@ -50,9 +51,13 @@ async def list_sessions(
 ) -> PaginatedResults[GraphExecutionState]:
     """Gets a list of sessions, optionally searching"""
     if query == "":
-        result = ApiDependencies.invoker.services.graph_execution_manager.list(page, per_page)
+        result = ApiDependencies.invoker.services.graph_execution_manager.list(
+            page, per_page
+        )
     else:
-        result = ApiDependencies.invoker.services.graph_execution_manager.search(query, page, per_page)
+        result = ApiDependencies.invoker.services.graph_execution_manager.search(
+            query, page, per_page
+        )
     return result
 
 
@@ -86,9 +91,9 @@ async def get_session(
 )
 async def add_node(
     session_id: str = Path(description="The id of the session"),
-    node: Annotated[Union[BaseInvocation.get_invocations()], Field(discriminator="type")] = Body(  # type: ignore
-        description="The node to add"
-    ),
+    node: Annotated[
+        Union[BaseInvocation.get_invocations()], Field(discriminator="type") # type: ignore
+    ] = Body(description="The node to add"),
 ) -> str:
     """Adds a node to the graph"""
     session = ApiDependencies.invoker.services.graph_execution_manager.get(session_id)
@@ -119,9 +124,9 @@ async def add_node(
 async def update_node(
     session_id: str = Path(description="The id of the session"),
     node_path: str = Path(description="The path to the node in the graph"),
-    node: Annotated[Union[BaseInvocation.get_invocations()], Field(discriminator="type")] = Body(  # type: ignore
-        description="The new node"
-    ),
+    node: Annotated[
+        Union[BaseInvocation.get_invocations()], Field(discriminator="type") # type: ignore
+    ] = Body(description="The new node"),
 ) -> GraphExecutionState:
     """Updates a node in the graph and removes all linked edges"""
     session = ApiDependencies.invoker.services.graph_execution_manager.get(session_id)
@@ -225,7 +230,7 @@ async def delete_edge(
     try:
         edge = Edge(
             source=EdgeConnection(node_id=from_node_id, field=from_field),
-            destination=EdgeConnection(node_id=to_node_id, field=to_field),
+            destination=EdgeConnection(node_id=to_node_id, field=to_field)
         )
         session.delete_edge(edge)
         ApiDependencies.invoker.services.graph_execution_manager.set(
@@ -250,7 +255,9 @@ async def delete_edge(
 )
 async def invoke_session(
     session_id: str = Path(description="The id of the session to invoke"),
-    all: bool = Query(default=False, description="Whether or not to invoke all remaining invocations"),
+    all: bool = Query(
+        default=False, description="Whether or not to invoke all remaining invocations"
+    ),
 ) -> Response:
     """Invokes a session"""
     session = ApiDependencies.invoker.services.graph_execution_manager.get(session_id)
@@ -267,7 +274,9 @@ async def invoke_session(
 @session_router.delete(
     "/{session_id}/invoke",
     operation_id="cancel_session_invoke",
-    responses={202: {"description": "The invocation is canceled"}},
+    responses={
+        202: {"description": "The invocation is canceled"}
+    },
 )
 async def cancel_session_invoke(
     session_id: str = Path(description="The id of the session to cancel"),

invokeai/app/api/sockets.py

@@ -16,7 +16,9 @@ class SocketIO:
         self.__sio.on("subscribe", handler=self._handle_sub)
         self.__sio.on("unsubscribe", handler=self._handle_unsub)
 
-        local_handler.register(event_name=EventServiceBase.session_event, _func=self._handle_session_event)
+        local_handler.register(
+            event_name=EventServiceBase.session_event, _func=self._handle_session_event
+        )
 
     async def _handle_session_event(self, event: Event):
         await self.__sio.emit(

invokeai/app/api_app.py

@@ -1,11 +1,11 @@
 # Copyright (c) 2022-2023 Kyle Schouviller (https://github.com/kyle0654) and the InvokeAI Team
 import asyncio
-import logging
-import socket
+import sys
 from inspect import signature
-from pathlib import Path
 
 import uvicorn
+import socket
+
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.openapi.docs import get_redoc_html, get_swagger_ui_html
@@ -13,39 +13,41 @@ from fastapi.openapi.utils import get_openapi
 from fastapi.staticfiles import StaticFiles
 from fastapi_events.handlers.local import local_handler
 from fastapi_events.middleware import EventHandlerASGIMiddleware
+from pathlib import Path
 from pydantic.schema import schema
 
+#This should come early so that modules can log their initialization properly
 from .services.config import InvokeAIAppConfig
 from ..backend.util.logging import InvokeAILogger
-
+app_config = InvokeAIAppConfig.get_config()
+app_config.parse_args()
+logger = InvokeAILogger.getLogger(config=app_config)
 from invokeai.version.invokeai_version import __version__
 
+# we call this early so that the message appears before
+# other invokeai initialization messages
+if app_config.version:
+    print(f'InvokeAI version {__version__}')
+    sys.exit(0)
+
 import invokeai.frontend.web as web_dir
 import mimetypes
 
 from .api.dependencies import ApiDependencies
 from .api.routers import sessions, models, images, boards, board_images, app_info
 from .api.sockets import SocketIO
-from .invocations.baseinvocation import BaseInvocation, _InputField, _OutputField, UIConfigBase
+from .invocations.baseinvocation import BaseInvocation
+    
 
 import torch
-
-# noinspection PyUnresolvedReferences
-import invokeai.backend.util.hotfixes  # noqa: F401 (monkeypatching on import)
-
+import invokeai.backend.util.hotfixes
 if torch.backends.mps.is_available():
-    # noinspection PyUnresolvedReferences
-    import invokeai.backend.util.mps_fixes  # noqa: F401 (monkeypatching on import)
-
-
-app_config = InvokeAIAppConfig.get_config()
-app_config.parse_args()
-logger = InvokeAILogger.getLogger(config=app_config)
+    import invokeai.backend.util.mps_fixes
 
 # fix for windows mimetypes registry entries being borked
 # see https://github.com/invoke-ai/InvokeAI/discussions/3684#discussioncomment-6391352
-mimetypes.add_type("application/javascript", ".js")
-mimetypes.add_type("text/css", ".css")
+mimetypes.add_type('application/javascript', '.js')
+mimetypes.add_type('text/css', '.css')
 
 # Create the app
 # TODO: create this all in a method so configuration/etc. can be passed in?
@@ -55,13 +57,14 @@ app = FastAPI(title="Invoke AI", docs_url=None, redoc_url=None)
 event_handler_id: int = id(app)
 app.add_middleware(
     EventHandlerASGIMiddleware,
-    handlers=[local_handler],  # TODO: consider doing this in services to support different configurations
+    handlers=[
+        local_handler
+    ],  # TODO: consider doing this in services to support different configurations
     middleware_id=event_handler_id,
 )
 
 socket_io = SocketIO(app)
 
-
 # Add startup event to load dependencies
 @app.on_event("startup")
 async def startup_event():
@@ -73,7 +76,9 @@ async def startup_event():
         allow_headers=app_config.allow_headers,
     )
 
-    ApiDependencies.initialize(config=app_config, event_handler_id=event_handler_id, logger=logger)
+    ApiDependencies.initialize(
+        config=app_config, event_handler_id=event_handler_id, logger=logger
+    )
 
 
 # Shut down threads
@@ -98,8 +103,7 @@ app.include_router(boards.boards_router, prefix="/api")
 
 app.include_router(board_images.board_images_router, prefix="/api")
 
-app.include_router(app_info.app_router, prefix="/api")
-
+app.include_router(app_info.app_router, prefix='/api')
 
 # Build a custom OpenAPI to include all outputs
 # TODO: can outputs be included on metadata of invocation schemas somehow?
@@ -123,18 +127,12 @@ def custom_openapi():
 
     output_schemas = schema(output_types, ref_prefix="#/components/schemas/")
     for schema_key, output_schema in output_schemas["definitions"].items():
-        output_schema["class"] = "output"
         openapi_schema["components"]["schemas"][schema_key] = output_schema
 
         # TODO: note that we assume the schema_key here is the TYPE.__name__
         # This could break in some cases, figure out a better way to do it
         output_type_titles[schema_key] = output_schema["title"]
 
-    # Add Node Editor UI helper schemas
-    ui_config_schemas = schema([UIConfigBase, _InputField, _OutputField], ref_prefix="#/components/schemas/")
-    for schema_key, ui_config_schema in ui_config_schemas["definitions"].items():
-        openapi_schema["components"]["schemas"][schema_key] = ui_config_schema
-
     # Add a reference to the output type to additionalProperties of the invoker schema
     for invoker in all_invocations:
         invoker_name = invoker.__name__
@@ -142,11 +140,10 @@ def custom_openapi():
         output_type_title = output_type_titles[output_type.__name__]
         invoker_schema = openapi_schema["components"]["schemas"][invoker_name]
         outputs_ref = {"$ref": f"#/components/schemas/{output_type_title}"}
+
         invoker_schema["output"] = outputs_ref
-        invoker_schema["class"] = "invocation"
 
     from invokeai.backend.model_management.models import get_model_config_enums
-
     for model_config_format_enum in set(get_model_config_enums()):
         name = model_config_format_enum.__qualname__
 
@@ -169,8 +166,7 @@ def custom_openapi():
 app.openapi = custom_openapi
 
 # Override API doc favicons
-app.mount("/static", StaticFiles(directory=Path(web_dir.__path__[0], "static/dream_web")), name="static")
-
+app.mount("/static", StaticFiles(directory=Path(web_dir.__path__[0], 'static/dream_web')), name="static")
 
 @app.get("/docs", include_in_schema=False)
 def overridden_swagger():
@@ -191,8 +187,11 @@ def overridden_redoc():
 
 
 # Must mount *after* the other routes else it borks em
-app.mount("/", StaticFiles(directory=Path(web_dir.__path__[0], "dist"), html=True), name="ui")
-
+app.mount("/", 
+          StaticFiles(directory=Path(web_dir.__path__[0],"dist"), 
+                      html=True
+                     ), name="ui"
+         )
 
 def invoke_api():
     def find_port(port: int):
@@ -204,49 +203,19 @@ def invoke_api():
                 return find_port(port=port + 1)
             else:
                 return port
-
+            
     from invokeai.backend.install.check_root import check_invokeai_root
-
     check_invokeai_root(app_config)  # note, may exit with an exception if root not set up
-
-    if app_config.dev_reload:
-        try:
-            import jurigged
-        except ImportError as e:
-            logger.error(
-                'Can\'t start `--dev_reload` because jurigged is not found; `pip install -e ".[dev]"` to include development dependencies.',
-                exc_info=e,
-            )
-        else:
-            jurigged.watch(logger=InvokeAILogger.getLogger(name="jurigged").info)
-
+    
     port = find_port(app_config.port)
     if port != app_config.port:
         logger.warn(f"Port {app_config.port} in use, using port {port}")
-
     # Start our own event loop for eventing usage
     loop = asyncio.new_event_loop()
-    config = uvicorn.Config(
-        app=app,
-        host=app_config.host,
-        port=port,
-        loop=loop,
-        log_level=app_config.log_level,
-    )
+    config = uvicorn.Config(app=app, host=app_config.host, port=port, loop=loop)
+    # Use access_log to turn off logging
     server = uvicorn.Server(config)
-
-    # replace uvicorn's loggers with InvokeAI's for consistent appearance
-    for logname in ["uvicorn.access", "uvicorn"]:
-        log = logging.getLogger(logname)
-        log.handlers.clear()
-        for ch in logger.handlers:
-            log.addHandler(ch)
-
     loop.run_until_complete(server.serve())
 
-
 if __name__ == "__main__":
-    if app_config.version:
-        print(f"InvokeAI version {__version__}")
-    else:
-        invoke_api()
+    invoke_api()

invokeai/app/cli/commands.py

@@ -14,14 +14,8 @@ from ..services.graph import GraphExecutionState, LibraryGraph, Edge
 from ..services.invoker import Invoker
 
 
-def add_field_argument(command_parser, name: str, field, default_override=None):
-    default = (
-        default_override
-        if default_override is not None
-        else field.default
-        if field.default_factory is None
-        else field.default_factory()
-    )
+def add_field_argument(command_parser, name: str, field, default_override = None):
+    default = default_override if default_override is not None else field.default if field.default_factory is None else field.default_factory()
     if get_origin(field.type_) == Literal:
         allowed_values = get_args(field.type_)
         allowed_types = set()
@@ -53,8 +47,8 @@ def add_parsers(
     commands: list[type],
     command_field: str = "type",
     exclude_fields: list[str] = ["id", "type"],
-    add_arguments: Union[Callable[[argparse.ArgumentParser], None], None] = None,
-):
+    add_arguments: Union[Callable[[argparse.ArgumentParser], None],None] = None
+    ):
     """Adds parsers for each command to the subparsers"""
 
     # Create subparsers for each command
@@ -67,7 +61,7 @@ def add_parsers(
             add_arguments(command_parser)
 
         # Convert all fields to arguments
-        fields = command.__fields__  # type: ignore
+        fields = command.__fields__ # type: ignore
         for name, field in fields.items():
             if name in exclude_fields:
                 continue
@@ -76,11 +70,13 @@ def add_parsers(
 
 
 def add_graph_parsers(
-    subparsers, graphs: list[LibraryGraph], add_arguments: Union[Callable[[argparse.ArgumentParser], None], None] = None
+    subparsers,
+    graphs: list[LibraryGraph],
+    add_arguments: Union[Callable[[argparse.ArgumentParser], None], None] = None
 ):
     for graph in graphs:
         command_parser = subparsers.add_parser(graph.name, help=graph.description)
-
+        
         if add_arguments is not None:
             add_arguments(command_parser)
 
@@ -132,7 +128,6 @@ class CliContext:
 
 class ExitCli(Exception):
     """Exception to exit the CLI"""
-
     pass
 
 
@@ -160,7 +155,7 @@ class BaseCommand(ABC, BaseModel):
     @classmethod
     def get_commands_map(cls):
         # Get the type strings out of the literals and into a dictionary
-        return dict(map(lambda t: (get_args(get_type_hints(t)["type"])[0], t), BaseCommand.get_all_subclasses()))
+        return dict(map(lambda t: (get_args(get_type_hints(t)['type'])[0], t),BaseCommand.get_all_subclasses()))
 
     @abstractmethod
     def run(self, context: CliContext) -> None:
@@ -170,8 +165,7 @@ class BaseCommand(ABC, BaseModel):
 
 class ExitCommand(BaseCommand):
     """Exits the CLI"""
-
-    type: Literal["exit"] = "exit"
+    type: Literal['exit'] = 'exit'
 
     def run(self, context: CliContext) -> None:
         raise ExitCli()
@@ -179,8 +173,7 @@ class ExitCommand(BaseCommand):
 
 class HelpCommand(BaseCommand):
     """Shows help"""
-
-    type: Literal["help"] = "help"
+    type: Literal['help'] = 'help'
 
     def run(self, context: CliContext) -> None:
         context.parser.print_help()
@@ -190,7 +183,11 @@ def get_graph_execution_history(
     graph_execution_state: GraphExecutionState,
 ) -> Iterable[str]:
     """Gets the history of fully-executed invocations for a graph execution"""
-    return (n for n in reversed(graph_execution_state.executed_history) if n in graph_execution_state.graph.nodes)
+    return (
+        n
+        for n in reversed(graph_execution_state.executed_history)
+        if n in graph_execution_state.graph.nodes
+    )
 
 
 def get_invocation_command(invocation) -> str:
@@ -221,8 +218,7 @@ def get_invocation_command(invocation) -> str:
 
 class HistoryCommand(BaseCommand):
     """Shows the invocation history"""
-
-    type: Literal["history"] = "history"
+    type: Literal['history'] = 'history'
 
     # Inputs
     # fmt: off
@@ -239,8 +235,7 @@ class HistoryCommand(BaseCommand):
 
 class SetDefaultCommand(BaseCommand):
     """Sets a default value for a field"""
-
-    type: Literal["default"] = "default"
+    type: Literal['default'] = 'default'
 
     # Inputs
     # fmt: off
@@ -258,8 +253,7 @@ class SetDefaultCommand(BaseCommand):
 
 class DrawGraphCommand(BaseCommand):
     """Debugs a graph"""
-
-    type: Literal["draw_graph"] = "draw_graph"
+    type: Literal['draw_graph'] = 'draw_graph'
 
     def run(self, context: CliContext) -> None:
         session: GraphExecutionState = context.invoker.services.graph_execution_manager.get(context.session.id)
@@ -277,8 +271,7 @@ class DrawGraphCommand(BaseCommand):
 
 class DrawExecutionGraphCommand(BaseCommand):
     """Debugs an execution graph"""
-
-    type: Literal["draw_xgraph"] = "draw_xgraph"
+    type: Literal['draw_xgraph'] = 'draw_xgraph'
 
     def run(self, context: CliContext) -> None:
         session: GraphExecutionState = context.invoker.services.graph_execution_manager.get(context.session.id)
@@ -293,7 +286,6 @@ class DrawExecutionGraphCommand(BaseCommand):
         plt.axis("off")
         plt.show()
 
-
 class SortedHelpFormatter(argparse.HelpFormatter):
     def _iter_indented_subactions(self, action):
         try:

invokeai/app/cli/completer.py

@@ -19,8 +19,8 @@ from ..services.invocation_services import InvocationServices
 # singleton object, class variable
 completer = None
 
-
 class Completer(object):
+    
     def __init__(self, model_manager: ModelManager):
         self.commands = self.get_commands()
         self.matches = None
@@ -43,7 +43,7 @@ class Completer(object):
             except IndexError:
                 pass
             options = options or list(self.parse_commands().keys())
-
+            
             if not text:  # first time
                 self.matches = options
             else:
@@ -56,17 +56,17 @@ class Completer(object):
         return match
 
     @classmethod
-    def get_commands(self) -> List[object]:
+    def get_commands(self)->List[object]:
         """
         Return a list of all the client commands and invocations.
         """
         return BaseCommand.get_commands() + BaseInvocation.get_invocations()
 
-    def get_current_command(self, buffer: str) -> tuple[str, str]:
+    def get_current_command(self, buffer: str)->tuple[str, str]:
         """
         Parse the readline buffer to find the most recent command and its switch.
         """
-        if len(buffer) == 0:
+        if len(buffer)==0:
             return None, None
         tokens = shlex.split(buffer)
         command = None
@@ -78,11 +78,11 @@ class Completer(object):
             else:
                 switch = t
         # don't try to autocomplete switches that are already complete
-        if switch and buffer.endswith(" "):
-            switch = None
-        return command or "", switch or ""
+        if switch and buffer.endswith(' '):
+            switch=None
+        return command or '', switch or ''
 
-    def parse_commands(self) -> Dict[str, List[str]]:
+    def parse_commands(self)->Dict[str, List[str]]:
         """
         Return a dict in which the keys are the command name
         and the values are the parameters the command takes.
@@ -90,11 +90,11 @@ class Completer(object):
         result = dict()
         for command in self.commands:
             hints = get_type_hints(command)
-            name = get_args(hints["type"])[0]
-            result.update({name: hints})
+            name = get_args(hints['type'])[0]
+            result.update({name:hints})
         return result
 
-    def get_command_options(self, command: str, switch: str) -> List[str]:
+    def get_command_options(self, command: str, switch: str)->List[str]:
         """
         Return all the parameters that can be passed to the command as
         command-line switches. Returns None if the command is unrecognized.
@@ -102,53 +102,49 @@ class Completer(object):
         parsed_commands = self.parse_commands()
         if command not in parsed_commands:
             return None
-
+        
         # handle switches in the format "-foo=bar"
         argument = None
-        if switch and "=" in switch:
-            switch, argument = switch.split("=")
-
-        parameter = switch.strip("-")
+        if switch and '=' in switch:
+            switch, argument = switch.split('=')
+            
+        parameter = switch.strip('-')
         if parameter in parsed_commands[command]:
             if argument is None:
                 return self.get_parameter_options(parameter, parsed_commands[command][parameter])
             else:
-                return [
-                    f"--{parameter}={x}"
-                    for x in self.get_parameter_options(parameter, parsed_commands[command][parameter])
-                ]
+                return [f"--{parameter}={x}" for x in self.get_parameter_options(parameter, parsed_commands[command][parameter])]
         else:
             return [f"--{x}" for x in parsed_commands[command].keys()]
 
-    def get_parameter_options(self, parameter: str, typehint) -> List[str]:
+    def get_parameter_options(self, parameter: str, typehint)->List[str]:
         """
         Given a parameter type (such as Literal), offers autocompletions.
         """
         if get_origin(typehint) == Literal:
             return get_args(typehint)
-        if parameter == "model":
+        if parameter == 'model':
             return self.manager.model_names()
-
+        
     def _pre_input_hook(self):
         if self.linebuffer:
             readline.insert_text(self.linebuffer)
             readline.redisplay()
             self.linebuffer = None
-
-
+    
 def set_autocompleter(services: InvocationServices) -> Completer:
     global completer
-
+    
     if completer:
         return completer
-
+    
     completer = Completer(services.model_manager)
 
     readline.set_completer(completer.complete)
+    # pyreadline3 does not have a set_auto_history() method
     try:
         readline.set_auto_history(True)
-    except AttributeError:
-        # pyreadline3 does not have a set_auto_history() method
+    except:
         pass
     readline.set_pre_input_hook(completer._pre_input_hook)
     readline.set_completer_delims(" ")
@@ -166,6 +162,8 @@ def set_autocompleter(services: InvocationServices) -> Completer:
         pass
     except OSError:  # file likely corrupted
         newname = f"{histfile}.old"
-        logger.error(f"Your history file {histfile} couldn't be loaded and may be corrupted. Renaming it to {newname}")
+        logger.error(
+            f"Your history file {histfile} couldn't be loaded and may be corrupted. Renaming it to {newname}"
+        )
         histfile.replace(Path(newname))
     atexit.register(readline.write_history_file, histfile)

invokeai/app/cli_app.py

@@ -13,8 +13,15 @@ from pydantic.fields import Field
 # This should come early so that the logger can pick up its configuration options
 from .services.config import InvokeAIAppConfig
 from invokeai.backend.util.logging import InvokeAILogger
+config = InvokeAIAppConfig.get_config()
+config.parse_args()
+logger = InvokeAILogger().getLogger(config=config)
 from invokeai.version.invokeai_version import __version__
 
+# we call this early so that the message appears before other invokeai initialization messages
+if config.version:
+    print(f'InvokeAI version {__version__}')
+    sys.exit(0)
 
 from invokeai.app.services.board_image_record_storage import (
     SqliteBoardImageRecordStorage,
@@ -29,22 +36,18 @@ from invokeai.app.services.image_record_storage import SqliteImageRecordStorage
 from invokeai.app.services.images import ImageService, ImageServiceDependencies
 from invokeai.app.services.resource_name import SimpleNameService
 from invokeai.app.services.urls import LocalUrlService
-from invokeai.app.services.invocation_stats import InvocationStatsService
-from .services.default_graphs import default_text_to_image_graph_id, create_system_graphs
+from .services.default_graphs import (default_text_to_image_graph_id,
+                                      create_system_graphs)
 from .services.latent_storage import DiskLatentsStorage, ForwardCacheLatentsStorage
 
-from .cli.commands import BaseCommand, CliContext, ExitCli, SortedHelpFormatter, add_graph_parsers, add_parsers
+from .cli.commands import (BaseCommand, CliContext, ExitCli,
+                           SortedHelpFormatter, add_graph_parsers, add_parsers)
 from .cli.completer import set_autocompleter
 from .invocations.baseinvocation import BaseInvocation
 from .services.events import EventServiceBase
-from .services.graph import (
-    Edge,
-    EdgeConnection,
-    GraphExecutionState,
-    GraphInvocation,
-    LibraryGraph,
-    are_connection_types_compatible,
-)
+from .services.graph import (Edge, EdgeConnection, GraphExecutionState,
+                             GraphInvocation, LibraryGraph,
+                             are_connection_types_compatible)
 from .services.image_file_storage import DiskImageFileStorage
 from .services.invocation_queue import MemoryInvocationQueue
 from .services.invocation_services import InvocationServices
@@ -54,15 +57,9 @@ from .services.processor import DefaultInvocationProcessor
 from .services.sqlite import SqliteItemStorage
 
 import torch
-import invokeai.backend.util.hotfixes  # noqa: F401 (monkeypatching on import)
-
+import invokeai.backend.util.hotfixes
 if torch.backends.mps.is_available():
-    import invokeai.backend.util.mps_fixes  # noqa: F401 (monkeypatching on import)
-
-
-config = InvokeAIAppConfig.get_config()
-config.parse_args()
-logger = InvokeAILogger().getLogger(config=config)
+    import invokeai.backend.util.mps_fixes
 
 
 class CliCommand(BaseModel):
@@ -72,7 +69,6 @@ class CliCommand(BaseModel):
 class InvalidArgs(Exception):
     pass
 
-
 def add_invocation_args(command_parser):
     # Add linking capability
     command_parser.add_argument(
@@ -117,7 +113,7 @@ def get_command_parser(services: InvocationServices) -> argparse.ArgumentParser:
     return parser
 
 
-class NodeField:
+class NodeField():
     alias: str
     node_path: str
     field: str
@@ -130,20 +126,15 @@ class NodeField:
         self.field_type = field_type
 
 
-def fields_from_type_hints(hints: dict[str, type], node_path: str) -> dict[str, NodeField]:
-    return {k: NodeField(alias=k, node_path=node_path, field=k, field_type=v) for k, v in hints.items()}
+def fields_from_type_hints(hints: dict[str, type], node_path: str) -> dict[str,NodeField]:
+    return {k:NodeField(alias=k, node_path=node_path, field=k, field_type=v) for k, v in hints.items()}
 
 
 def get_node_input_field(graph: LibraryGraph, field_alias: str, node_id: str) -> NodeField:
     """Gets the node field for the specified field alias"""
     exposed_input = next(e for e in graph.exposed_inputs if e.alias == field_alias)
     node_type = type(graph.graph.get_node(exposed_input.node_path))
-    return NodeField(
-        alias=exposed_input.alias,
-        node_path=f"{node_id}.{exposed_input.node_path}",
-        field=exposed_input.field,
-        field_type=get_type_hints(node_type)[exposed_input.field],
-    )
+    return NodeField(alias=exposed_input.alias, node_path=f'{node_id}.{exposed_input.node_path}', field=exposed_input.field, field_type=get_type_hints(node_type)[exposed_input.field])
 
 
 def get_node_output_field(graph: LibraryGraph, field_alias: str, node_id: str) -> NodeField:
@@ -151,12 +142,7 @@ def get_node_output_field(graph: LibraryGraph, field_alias: str, node_id: str) -
     exposed_output = next(e for e in graph.exposed_outputs if e.alias == field_alias)
     node_type = type(graph.graph.get_node(exposed_output.node_path))
     node_output_type = node_type.get_output_type()
-    return NodeField(
-        alias=exposed_output.alias,
-        node_path=f"{node_id}.{exposed_output.node_path}",
-        field=exposed_output.field,
-        field_type=get_type_hints(node_output_type)[exposed_output.field],
-    )
+    return NodeField(alias=exposed_output.alias, node_path=f'{node_id}.{exposed_output.node_path}', field=exposed_output.field, field_type=get_type_hints(node_output_type)[exposed_output.field])
 
 
 def get_node_inputs(invocation: BaseInvocation, context: CliContext) -> dict[str, NodeField]:
@@ -179,7 +165,9 @@ def get_node_outputs(invocation: BaseInvocation, context: CliContext) -> dict[st
         return {e.alias: get_node_output_field(graph, e.alias, invocation.id) for e in graph.exposed_outputs}
 
 
-def generate_matching_edges(a: BaseInvocation, b: BaseInvocation, context: CliContext) -> list[Edge]:
+def generate_matching_edges(
+    a: BaseInvocation, b: BaseInvocation, context: CliContext
+) -> list[Edge]:
     """Generates all possible edges between two invocations"""
     afields = get_node_outputs(a, context)
     bfields = get_node_inputs(b, context)
@@ -191,14 +179,12 @@ def generate_matching_edges(a: BaseInvocation, b: BaseInvocation, context: CliCo
     matching_fields = matching_fields.difference(invalid_fields)
 
     # Validate types
-    matching_fields = [
-        f for f in matching_fields if are_connection_types_compatible(afields[f].field_type, bfields[f].field_type)
-    ]
+    matching_fields = [f for f in matching_fields if are_connection_types_compatible(afields[f].field_type, bfields[f].field_type)]
 
     edges = [
         Edge(
             source=EdgeConnection(node_id=afields[alias].node_path, field=afields[alias].field),
-            destination=EdgeConnection(node_id=bfields[alias].node_path, field=bfields[alias].field),
+            destination=EdgeConnection(node_id=bfields[alias].node_path, field=bfields[alias].field)
         )
         for alias in matching_fields
     ]
@@ -207,7 +193,6 @@ def generate_matching_edges(a: BaseInvocation, b: BaseInvocation, context: CliCo
 
 class SessionError(Exception):
     """Raised when a session error has occurred"""
-
     pass
 
 
@@ -224,23 +209,22 @@ def invoke_all(context: CliContext):
             context.invoker.services.logger.error(
                 f"Error in node {n} (source node {context.session.prepared_source_mapping[n]}): {context.session.errors[n]}"
             )
-
+        
         raise SessionError()
 
-
 def invoke_cli():
-    logger.info(f"InvokeAI version {__version__}")
+    logger.info(f'InvokeAI version {__version__}')
     # get the optional list of invocations to execute on the command line
     parser = config.get_parser()
-    parser.add_argument("commands", nargs="*")
+    parser.add_argument('commands',nargs='*')
     invocation_commands = parser.parse_args().commands
 
     # get the optional file to read commands from.
     # Simplest is to use it for STDIN
     if infile := config.from_file:
-        sys.stdin = open(infile, "r")
-
-    model_manager = ModelManagerService(config, logger)
+        sys.stdin = open(infile,"r")
+    
+    model_manager = ModelManagerService(config,logger)
 
     events = EventServiceBase()
     output_folder = config.output_path
@@ -250,13 +234,13 @@ def invoke_cli():
         db_location = ":memory:"
     else:
         db_location = config.db_path
-        db_location.parent.mkdir(parents=True, exist_ok=True)
+        db_location.parent.mkdir(parents=True,exist_ok=True)
 
     logger.info(f'InvokeAI database location is "{db_location}"')
 
     graph_execution_manager = SqliteItemStorage[GraphExecutionState](
-        filename=db_location, table_name="graph_executions"
-    )
+            filename=db_location, table_name="graph_executions"
+        )
 
     urls = LocalUrlService()
     image_record_storage = SqliteImageRecordStorage(db_location)
@@ -297,22 +281,24 @@ def invoke_cli():
             graph_execution_manager=graph_execution_manager,
         )
     )
-
+        
     services = InvocationServices(
         model_manager=model_manager,
         events=events,
-        latents=ForwardCacheLatentsStorage(DiskLatentsStorage(f"{output_folder}/latents")),
+        latents = ForwardCacheLatentsStorage(DiskLatentsStorage(f'{output_folder}/latents')),
         images=images,
         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(),
-        performance_statistics=InvocationStatsService(graph_execution_manager),
         logger=logger,
         configuration=config,
     )
+    
 
     system_graphs = create_system_graphs(services.graph_library)
     system_graph_names = set([g.name for g in system_graphs])
@@ -322,7 +308,7 @@ def invoke_cli():
     session: GraphExecutionState = invoker.create_execution_state()
     parser = get_command_parser(services)
 
-    re_negid = re.compile("^-[0-9]+$")
+    re_negid = re.compile('^-[0-9]+$')
 
     # Uncomment to print out previous sessions at startup
     # print(services.session_manager.list())
@@ -332,7 +318,7 @@ def invoke_cli():
 
     command_line_args_exist = len(invocation_commands) > 0
     done = False
-
+    
     while not done:
         try:
             if command_line_args_exist:
@@ -346,7 +332,7 @@ def invoke_cli():
 
         try:
             # Refresh the state of the session
-            # history = list(get_graph_execution_history(context.session))
+            #history = list(get_graph_execution_history(context.session))
             history = list(reversed(context.nodes_added))
 
             # Split the command for piping
@@ -367,17 +353,17 @@ def invoke_cli():
                         args[field_name] = field_default
 
                 # Parse invocation
-                command: CliCommand = None  # type:ignore
+                command: CliCommand = None # type:ignore
                 system_graph: Optional[LibraryGraph] = None
-                if args["type"] in system_graph_names:
-                    system_graph = next(filter(lambda g: g.name == args["type"], system_graphs))
+                if args['type'] in system_graph_names:
+                    system_graph = next(filter(lambda g: g.name == args['type'], system_graphs))
                     invocation = GraphInvocation(graph=system_graph.graph, id=str(current_id))
                     for exposed_input in system_graph.exposed_inputs:
                         if exposed_input.alias in args:
                             node = invocation.graph.get_node(exposed_input.node_path)
                             field = exposed_input.field
                             setattr(node, field, args[exposed_input.alias])
-                    command = CliCommand(command=invocation)
+                    command = CliCommand(command = invocation)
                     context.graph_nodes[invocation.id] = system_graph.id
                 else:
                     args["id"] = current_id
@@ -399,13 +385,17 @@ def invoke_cli():
                 # Pipe previous command output (if there was a previous command)
                 edges: list[Edge] = list()
                 if len(history) > 0 or current_id != start_id:
-                    from_id = history[0] if current_id == start_id else str(current_id - 1)
+                    from_id = (
+                        history[0] if current_id == start_id else str(current_id - 1)
+                    )
                     from_node = (
                         next(filter(lambda n: n[0].id == from_id, new_invocations))[0]
                         if current_id != start_id
                         else context.session.graph.get_node(from_id)
                     )
-                    matching_edges = generate_matching_edges(from_node, command.command, context)
+                    matching_edges = generate_matching_edges(
+                        from_node, command.command, context
+                    )
                     edges.extend(matching_edges)
 
                 # Parse provided links
@@ -416,18 +406,16 @@ def invoke_cli():
                             node_id = str(current_id + int(node_id))
 
                         link_node = context.session.graph.get_node(node_id)
-                        matching_edges = generate_matching_edges(link_node, command.command, context)
+                        matching_edges = generate_matching_edges(
+                            link_node, command.command, context
+                        )
                         matching_destinations = [e.destination for e in matching_edges]
                         edges = [e for e in edges if e.destination not in matching_destinations]
                         edges.extend(matching_edges)
 
                 if "link" in args and args["link"]:
                     for link in args["link"]:
-                        edges = [
-                            e
-                            for e in edges
-                            if e.destination.node_id != command.command.id or e.destination.field != link[2]
-                        ]
+                        edges = [e for e in edges if e.destination.node_id != command.command.id or e.destination.field != link[2]]
 
                         node_id = link[0]
                         if re_negid.match(node_id):
@@ -440,7 +428,7 @@ def invoke_cli():
                         edges.append(
                             Edge(
                                 source=EdgeConnection(node_id=node_output.node_path, field=node_output.field),
-                                destination=EdgeConnection(node_id=node_input.node_path, field=node_input.field),
+                                destination=EdgeConnection(node_id=node_input.node_path, field=node_input.field)
                             )
                         )
 
@@ -479,7 +467,4 @@ def invoke_cli():
 
 
 if __name__ == "__main__":
-    if config.version:
-        print(f"InvokeAI version {__version__}")
-    else:
-        invoke_cli()
+    invoke_cli()

invokeai/app/invocations/__init__.py

@@ -4,5 +4,9 @@ __all__ = []
 
 dirname = os.path.dirname(os.path.abspath(__file__))
 for f in os.listdir(dirname):
-    if f != "__init__.py" and os.path.isfile("%s/%s" % (dirname, f)) and f[-3:] == ".py":
+    if (
+        f != "__init__.py"
+        and os.path.isfile("%s/%s" % (dirname, f))
+        and f[-3:] == ".py"
+    ):
         __all__.append(f[:-3])

invokeai/app/invocations/baseinvocation.py

@@ -2,382 +2,17 @@
 
 from __future__ import annotations
 
-import json
 from abc import ABC, abstractmethod
-from enum import Enum
 from inspect import signature
-import re
-from typing import (
-    TYPE_CHECKING,
-    AbstractSet,
-    Any,
-    Callable,
-    ClassVar,
-    Literal,
-    Mapping,
-    Optional,
-    Type,
-    TypeVar,
-    Union,
-    get_args,
-    get_type_hints,
-)
+from typing import (TYPE_CHECKING, Dict, List, Literal, TypedDict, get_args,
+                    get_type_hints)
 
-from pydantic import BaseModel, Field, validator
-from pydantic.fields import Undefined, ModelField
-from pydantic.typing import NoArgAnyCallable
+from pydantic import BaseConfig, BaseModel, Field
 
 if TYPE_CHECKING:
     from ..services.invocation_services import InvocationServices
 
 
-class FieldDescriptions:
-    denoising_start = "When to start denoising, expressed a percentage of total steps"
-    denoising_end = "When to stop denoising, expressed a percentage of total steps"
-    cfg_scale = "Classifier-Free Guidance scale"
-    scheduler = "Scheduler to use during inference"
-    positive_cond = "Positive conditioning tensor"
-    negative_cond = "Negative conditioning tensor"
-    noise = "Noise tensor"
-    clip = "CLIP (tokenizer, text encoder, LoRAs) and skipped layer count"
-    unet = "UNet (scheduler, LoRAs)"
-    vae = "VAE"
-    cond = "Conditioning tensor"
-    controlnet_model = "ControlNet model to load"
-    vae_model = "VAE model to load"
-    lora_model = "LoRA model to load"
-    main_model = "Main model (UNet, VAE, CLIP) to load"
-    sdxl_main_model = "SDXL Main model (UNet, VAE, CLIP1, CLIP2) to load"
-    sdxl_refiner_model = "SDXL Refiner Main Modde (UNet, VAE, CLIP2) to load"
-    onnx_main_model = "ONNX Main model (UNet, VAE, CLIP) to load"
-    lora_weight = "The weight at which the LoRA is applied to each model"
-    compel_prompt = "Prompt to be parsed by Compel to create a conditioning tensor"
-    raw_prompt = "Raw prompt text (no parsing)"
-    sdxl_aesthetic = "The aesthetic score to apply to the conditioning tensor"
-    skipped_layers = "Number of layers to skip in text encoder"
-    seed = "Seed for random number generation"
-    steps = "Number of steps to run"
-    width = "Width of output (px)"
-    height = "Height of output (px)"
-    control = "ControlNet(s) to apply"
-    denoised_latents = "Denoised latents tensor"
-    latents = "Latents tensor"
-    strength = "Strength of denoising (proportional to steps)"
-    core_metadata = "Optional core metadata to be written to image"
-    interp_mode = "Interpolation mode"
-    torch_antialias = "Whether or not to apply antialiasing (bilinear or bicubic only)"
-    fp32 = "Whether or not to use full float32 precision"
-    precision = "Precision to use"
-    tiled = "Processing using overlapping tiles (reduce memory consumption)"
-    detect_res = "Pixel resolution for detection"
-    image_res = "Pixel resolution for output image"
-    safe_mode = "Whether or not to use safe mode"
-    scribble_mode = "Whether or not to use scribble mode"
-    scale_factor = "The factor by which to scale"
-    blend_alpha = (
-        "Blending factor. 0.0 = use input A only, 1.0 = use input B only, 0.5 = 50% mix of input A and input B."
-    )
-    num_1 = "The first number"
-    num_2 = "The second number"
-    mask = "The mask to use for the operation"
-
-
-class Input(str, Enum):
-    """
-    The type of input a field accepts.
-    - `Input.Direct`: The field must have its value provided directly, when the invocation and field \
-      are instantiated.
-    - `Input.Connection`: The field must have its value provided by a connection.
-    - `Input.Any`: The field may have its value provided either directly or by a connection.
-    """
-
-    Connection = "connection"
-    Direct = "direct"
-    Any = "any"
-
-
-class UIType(str, Enum):
-    """
-    Type hints for the UI.
-    If a field should be provided a data type that does not exactly match the python type of the field, \
-    use this to provide the type that should be used instead. See the node development docs for detail \
-    on adding a new field type, which involves client-side changes.
-    """
-
-    # region Primitives
-    Integer = "integer"
-    Float = "float"
-    Boolean = "boolean"
-    String = "string"
-    Array = "array"
-    Image = "ImageField"
-    Latents = "LatentsField"
-    Conditioning = "ConditioningField"
-    Control = "ControlField"
-    Color = "ColorField"
-    ImageCollection = "ImageCollection"
-    ConditioningCollection = "ConditioningCollection"
-    ColorCollection = "ColorCollection"
-    LatentsCollection = "LatentsCollection"
-    IntegerCollection = "IntegerCollection"
-    FloatCollection = "FloatCollection"
-    StringCollection = "StringCollection"
-    BooleanCollection = "BooleanCollection"
-    # endregion
-
-    # region Models
-    MainModel = "MainModelField"
-    SDXLMainModel = "SDXLMainModelField"
-    SDXLRefinerModel = "SDXLRefinerModelField"
-    ONNXModel = "ONNXModelField"
-    VaeModel = "VaeModelField"
-    LoRAModel = "LoRAModelField"
-    ControlNetModel = "ControlNetModelField"
-    UNet = "UNetField"
-    Vae = "VaeField"
-    CLIP = "ClipField"
-    # endregion
-
-    # region Iterate/Collect
-    Collection = "Collection"
-    CollectionItem = "CollectionItem"
-    # endregion
-
-    # region Misc
-    Enum = "enum"
-    Scheduler = "Scheduler"
-    WorkflowField = "WorkflowField"
-    IsIntermediate = "IsIntermediate"
-    MetadataField = "MetadataField"
-    # endregion
-
-
-class UIComponent(str, Enum):
-    """
-    The type of UI component to use for a field, used to override the default components, which are \
-    inferred from the field type.
-    """
-
-    None_ = "none"
-    Textarea = "textarea"
-    Slider = "slider"
-
-
-class _InputField(BaseModel):
-    """
-    *DO NOT USE*
-    This helper class is used to tell the client about our custom field attributes via OpenAPI
-    schema generation, and Typescript type generation from that schema. It serves no functional
-    purpose in the backend.
-    """
-
-    input: Input
-    ui_hidden: bool
-    ui_type: Optional[UIType]
-    ui_component: Optional[UIComponent]
-    ui_order: Optional[int]
-
-
-class _OutputField(BaseModel):
-    """
-    *DO NOT USE*
-    This helper class is used to tell the client about our custom field attributes via OpenAPI
-    schema generation, and Typescript type generation from that schema. It serves no functional
-    purpose in the backend.
-    """
-
-    ui_hidden: bool
-    ui_type: Optional[UIType]
-    ui_order: Optional[int]
-
-
-def InputField(
-    *args: Any,
-    default: Any = Undefined,
-    default_factory: Optional[NoArgAnyCallable] = None,
-    alias: Optional[str] = None,
-    title: Optional[str] = None,
-    description: Optional[str] = None,
-    exclude: Optional[Union[AbstractSet[Union[int, str]], Mapping[Union[int, str], Any], Any]] = None,
-    include: Optional[Union[AbstractSet[Union[int, str]], Mapping[Union[int, str], Any], Any]] = None,
-    const: Optional[bool] = None,
-    gt: Optional[float] = None,
-    ge: Optional[float] = None,
-    lt: Optional[float] = None,
-    le: Optional[float] = None,
-    multiple_of: Optional[float] = None,
-    allow_inf_nan: Optional[bool] = None,
-    max_digits: Optional[int] = None,
-    decimal_places: Optional[int] = None,
-    min_items: Optional[int] = None,
-    max_items: Optional[int] = None,
-    unique_items: Optional[bool] = None,
-    min_length: Optional[int] = None,
-    max_length: Optional[int] = None,
-    allow_mutation: bool = True,
-    regex: Optional[str] = None,
-    discriminator: Optional[str] = None,
-    repr: bool = True,
-    input: Input = Input.Any,
-    ui_type: Optional[UIType] = None,
-    ui_component: Optional[UIComponent] = None,
-    ui_hidden: bool = False,
-    ui_order: Optional[int] = None,
-    **kwargs: Any,
-) -> Any:
-    """
-    Creates an input field for an invocation.
-
-    This is a wrapper for Pydantic's [Field](https://docs.pydantic.dev/1.10/usage/schema/#field-customization) \
-    that adds a few extra parameters to support graph execution and the node editor UI.
-
-    :param Input input: [Input.Any] The kind of input this field requires. \
-      `Input.Direct` means a value must be provided on instantiation. \
-      `Input.Connection` means the value must be provided by a connection. \
-      `Input.Any` means either will do.
-
-    :param UIType ui_type: [None] Optionally provides an extra type hint for the UI. \
-      In some situations, the field's type is not enough to infer the correct UI type. \
-      For example, model selection fields should render a dropdown UI component to select a model. \
-      Internally, there is no difference between SD-1, SD-2 and SDXL model fields, they all use \
-      `MainModelField`. So to ensure the base-model-specific UI is rendered, you can use \
-      `UIType.SDXLMainModelField` to indicate that the field is an SDXL main model field.
-
-    :param UIComponent ui_component: [None] Optionally specifies a specific component to use in the UI. \
-      The UI will always render a suitable component, but sometimes you want something different than the default. \
-      For example, a `string` field will default to a single-line input, but you may want a multi-line textarea instead. \
-      For this case, you could provide `UIComponent.Textarea`.
-
-    : param bool ui_hidden: [False] Specifies whether or not this field should be hidden in the UI.
-    """
-    return Field(
-        *args,
-        default=default,
-        default_factory=default_factory,
-        alias=alias,
-        title=title,
-        description=description,
-        exclude=exclude,
-        include=include,
-        const=const,
-        gt=gt,
-        ge=ge,
-        lt=lt,
-        le=le,
-        multiple_of=multiple_of,
-        allow_inf_nan=allow_inf_nan,
-        max_digits=max_digits,
-        decimal_places=decimal_places,
-        min_items=min_items,
-        max_items=max_items,
-        unique_items=unique_items,
-        min_length=min_length,
-        max_length=max_length,
-        allow_mutation=allow_mutation,
-        regex=regex,
-        discriminator=discriminator,
-        repr=repr,
-        input=input,
-        ui_type=ui_type,
-        ui_component=ui_component,
-        ui_hidden=ui_hidden,
-        ui_order=ui_order,
-        **kwargs,
-    )
-
-
-def OutputField(
-    *args: Any,
-    default: Any = Undefined,
-    default_factory: Optional[NoArgAnyCallable] = None,
-    alias: Optional[str] = None,
-    title: Optional[str] = None,
-    description: Optional[str] = None,
-    exclude: Optional[Union[AbstractSet[Union[int, str]], Mapping[Union[int, str], Any], Any]] = None,
-    include: Optional[Union[AbstractSet[Union[int, str]], Mapping[Union[int, str], Any], Any]] = None,
-    const: Optional[bool] = None,
-    gt: Optional[float] = None,
-    ge: Optional[float] = None,
-    lt: Optional[float] = None,
-    le: Optional[float] = None,
-    multiple_of: Optional[float] = None,
-    allow_inf_nan: Optional[bool] = None,
-    max_digits: Optional[int] = None,
-    decimal_places: Optional[int] = None,
-    min_items: Optional[int] = None,
-    max_items: Optional[int] = None,
-    unique_items: Optional[bool] = None,
-    min_length: Optional[int] = None,
-    max_length: Optional[int] = None,
-    allow_mutation: bool = True,
-    regex: Optional[str] = None,
-    discriminator: Optional[str] = None,
-    repr: bool = True,
-    ui_type: Optional[UIType] = None,
-    ui_hidden: bool = False,
-    ui_order: Optional[int] = None,
-    **kwargs: Any,
-) -> Any:
-    """
-    Creates an output field for an invocation output.
-
-    This is a wrapper for Pydantic's [Field](https://docs.pydantic.dev/1.10/usage/schema/#field-customization) \
-    that adds a few extra parameters to support graph execution and the node editor UI.
-
-    :param UIType ui_type: [None] Optionally provides an extra type hint for the UI. \
-      In some situations, the field's type is not enough to infer the correct UI type. \
-      For example, model selection fields should render a dropdown UI component to select a model. \
-      Internally, there is no difference between SD-1, SD-2 and SDXL model fields, they all use \
-      `MainModelField`. So to ensure the base-model-specific UI is rendered, you can use \
-      `UIType.SDXLMainModelField` to indicate that the field is an SDXL main model field.
-
-    : param bool ui_hidden: [False] Specifies whether or not this field should be hidden in the UI. \
-    """
-    return Field(
-        *args,
-        default=default,
-        default_factory=default_factory,
-        alias=alias,
-        title=title,
-        description=description,
-        exclude=exclude,
-        include=include,
-        const=const,
-        gt=gt,
-        ge=ge,
-        lt=lt,
-        le=le,
-        multiple_of=multiple_of,
-        allow_inf_nan=allow_inf_nan,
-        max_digits=max_digits,
-        decimal_places=decimal_places,
-        min_items=min_items,
-        max_items=max_items,
-        unique_items=unique_items,
-        min_length=min_length,
-        max_length=max_length,
-        allow_mutation=allow_mutation,
-        regex=regex,
-        discriminator=discriminator,
-        repr=repr,
-        ui_type=ui_type,
-        ui_hidden=ui_hidden,
-        ui_order=ui_order,
-        **kwargs,
-    )
-
-
-class UIConfigBase(BaseModel):
-    """
-    Provides additional node configuration to the UI.
-    This is used internally by the @invocation decorator logic. Do not use this directly.
-    """
-
-    tags: Optional[list[str]] = Field(default_factory=None, description="The node's tags")
-    title: Optional[str] = Field(default=None, description="The node's display name")
-    category: Optional[str] = Field(default=None, description="The node's category")
-
-
 class InvocationContext:
     services: InvocationServices
     graph_execution_state_id: str
@@ -388,11 +23,10 @@ class InvocationContext:
 
 
 class BaseInvocationOutput(BaseModel):
-    """
-    Base class for all invocation outputs.
+    """Base class for all invocation outputs"""
 
-    All invocation outputs must use the `@invocation_output` decorator to provide their unique type.
-    """
+    # All outputs must include a type name like this:
+    # type: Literal['your_output_name']
 
     @classmethod
     def get_all_subclasses_tuple(cls):
@@ -405,36 +39,15 @@ class BaseInvocationOutput(BaseModel):
             toprocess.extend(next_subclasses)
         return tuple(subclasses)
 
-    class Config:
-        @staticmethod
-        def schema_extra(schema: dict[str, Any], model_class: Type[BaseModel]) -> None:
-            if "required" not in schema or not isinstance(schema["required"], list):
-                schema["required"] = list()
-            schema["required"].extend(["type"])
-
-
-class RequiredConnectionException(Exception):
-    """Raised when an field which requires a connection did not receive a value."""
-
-    def __init__(self, node_id: str, field_name: str):
-        super().__init__(f"Node {node_id} missing connections for field {field_name}")
-
-
-class MissingInputException(Exception):
-    """Raised when an field which requires some input, but did not receive a value."""
-
-    def __init__(self, node_id: str, field_name: str):
-        super().__init__(f"Node {node_id} missing value or connection for field {field_name}")
-
 
 class BaseInvocation(ABC, BaseModel):
-    """
-    A node to process inputs and produce outputs.
+    """A node to process inputs and produce outputs.
     May use dependency injection in __init__ to receive providers.
-
-    All invocations must use the `@invocation` decorator to provide their unique type.
     """
 
+    # All invocations must include a type name like this:
+    # type: Literal['your_output_name']
+
     @classmethod
     def get_all_subclasses(cls):
         subclasses = []
@@ -464,159 +77,70 @@ class BaseInvocation(ABC, BaseModel):
     def get_output_type(cls):
         return signature(cls.invoke).return_annotation
 
-    class Config:
-        @staticmethod
-        def schema_extra(schema: dict[str, Any], model_class: Type[BaseModel]) -> None:
-            uiconfig = getattr(model_class, "UIConfig", None)
-            if uiconfig and hasattr(uiconfig, "title"):
-                schema["title"] = uiconfig.title
-            if uiconfig and hasattr(uiconfig, "tags"):
-                schema["tags"] = uiconfig.tags
-            if uiconfig and hasattr(uiconfig, "category"):
-                schema["category"] = uiconfig.category
-            if "required" not in schema or not isinstance(schema["required"], list):
-                schema["required"] = list()
-            schema["required"].extend(["type", "id"])
-
     @abstractmethod
     def invoke(self, context: InvocationContext) -> BaseInvocationOutput:
         """Invoke with provided context and return outputs."""
         pass
 
-    def __init__(self, **data):
-        # nodes may have required fields, that can accept input from connections
-        # on instantiation of the model, we need to exclude these from validation
-        restore = dict()
-        try:
-            field_names = list(self.__fields__.keys())
-            for field_name in field_names:
-                # if the field is required and may get its value from a connection, exclude it from validation
-                field = self.__fields__[field_name]
-                _input = field.field_info.extra.get("input", None)
-                if _input in [Input.Connection, Input.Any] and field.required:
-                    if field_name not in data:
-                        restore[field_name] = self.__fields__.pop(field_name)
-            # instantiate the node, which will validate the data
-            super().__init__(**data)
-        finally:
-            # restore the removed fields
-            for field_name, field in restore.items():
-                self.__fields__[field_name] = field
-
-    def invoke_internal(self, context: InvocationContext) -> BaseInvocationOutput:
-        for field_name, field in self.__fields__.items():
-            _input = field.field_info.extra.get("input", None)
-            if field.required and not hasattr(self, field_name):
-                if _input == Input.Connection:
-                    raise RequiredConnectionException(self.__fields__["type"].default, field_name)
-                elif _input == Input.Any:
-                    raise MissingInputException(self.__fields__["type"].default, field_name)
-        return self.invoke(context)
-
-    id: str = Field(
-        description="The id of this instance of an invocation. Must be unique among all instances of invocations."
-    )
-    is_intermediate: bool = InputField(
-        default=False, description="Whether or not this is an intermediate invocation.", ui_type=UIType.IsIntermediate
-    )
-    workflow: Optional[str] = InputField(
-        default=None,
-        description="The workflow to save with the image",
-        ui_type=UIType.WorkflowField,
-    )
-
-    @validator("workflow", pre=True)
-    def validate_workflow_is_json(cls, v):
-        if v is None:
-            return None
-        try:
-            json.loads(v)
-        except json.decoder.JSONDecodeError:
-            raise ValueError("Workflow must be valid JSON")
-        return v
-
-    UIConfig: ClassVar[Type[UIConfigBase]]
+    # fmt: off
+    id: str = Field(description="The id of this node. Must be unique among all nodes.")
+    is_intermediate: bool = Field(default=False, description="Whether or not this node is an intermediate node.")
+    # fmt: on
 
 
-GenericBaseInvocation = TypeVar("GenericBaseInvocation", bound=BaseInvocation)
+# TODO: figure out a better way to provide these hints
+# TODO: when we can upgrade to python 3.11, we can use the`NotRequired` type instead of `total=False`
+class UIConfig(TypedDict, total=False):
+    type_hints: Dict[
+        str,
+        Literal[
+            "integer",
+            "float",
+            "boolean",
+            "string",
+            "enum",
+            "image",
+            "latents",
+            "model",
+            "control",
+            "image_collection",
+            "vae_model",
+            "lora_model",
+        ],
+    ]
+    tags: List[str]
+    title: str
 
 
-def invocation(
-    invocation_type: str, title: Optional[str] = None, tags: Optional[list[str]] = None, category: Optional[str] = None
-) -> Callable[[Type[GenericBaseInvocation]], Type[GenericBaseInvocation]]:
-    """
-    Adds metadata to an invocation.
+class CustomisedSchemaExtra(TypedDict):
+    ui: UIConfig
 
-    :param str invocation_type: The type of the invocation. Must be unique among all invocations.
-    :param Optional[str] title: Adds a title to the invocation. Use if the auto-generated title isn't quite right. Defaults to None.
-    :param Optional[list[str]] tags: Adds tags to the invocation. Invocations may be searched for by their tags. Defaults to None.
-    :param Optional[str] category: Adds a category to the invocation. Used to group the invocations in the UI. Defaults to None.
+
+class InvocationConfig(BaseConfig):
+    """Customizes pydantic's BaseModel.Config class for use by Invocations.
+
+    Provide `schema_extra` a `ui` dict to add hints for generated UIs.
+
+    `tags`
+    - A list of strings, used to categorise invocations.
+
+    `type_hints`
+    - A dict of field types which override the types in the invocation definition.
+    - Each key should be the name of one of the invocation's fields.
+    - Each value should be one of the valid types:
+      - `integer`, `float`, `boolean`, `string`, `enum`, `image`, `latents`, `model`
+
+    ```python
+    class Config(InvocationConfig):
+      schema_extra = {
+          "ui": {
+              "tags": ["stable-diffusion", "image"],
+              "type_hints": {
+                  "initial_image": "image",
+              },
+          },
+      }
+    ```
     """
 
-    def wrapper(cls: Type[GenericBaseInvocation]) -> Type[GenericBaseInvocation]:
-        # Validate invocation types on creation of invocation classes
-        # TODO: ensure unique?
-        if re.compile(r"^\S+$").match(invocation_type) is None:
-            raise ValueError(f'"invocation_type" must consist of non-whitespace characters, got "{invocation_type}"')
-
-        # Add OpenAPI schema extras
-        uiconf_name = cls.__qualname__ + ".UIConfig"
-        if not hasattr(cls, "UIConfig") or cls.UIConfig.__qualname__ != uiconf_name:
-            cls.UIConfig = type(uiconf_name, (UIConfigBase,), dict())
-        if title is not None:
-            cls.UIConfig.title = title
-        if tags is not None:
-            cls.UIConfig.tags = tags
-        if category is not None:
-            cls.UIConfig.category = category
-
-        # Add the invocation type to the pydantic model of the invocation
-        invocation_type_annotation = Literal[invocation_type]  # type: ignore
-        invocation_type_field = ModelField.infer(
-            name="type",
-            value=invocation_type,
-            annotation=invocation_type_annotation,
-            class_validators=None,
-            config=cls.__config__,
-        )
-        cls.__fields__.update({"type": invocation_type_field})
-        cls.__annotations__.update({"type": invocation_type_annotation})
-
-        return cls
-
-    return wrapper
-
-
-GenericBaseInvocationOutput = TypeVar("GenericBaseInvocationOutput", bound=BaseInvocationOutput)
-
-
-def invocation_output(
-    output_type: str,
-) -> Callable[[Type[GenericBaseInvocationOutput]], Type[GenericBaseInvocationOutput]]:
-    """
-    Adds metadata to an invocation output.
-
-    :param str output_type: The type of the invocation output. Must be unique among all invocation outputs.
-    """
-
-    def wrapper(cls: Type[GenericBaseInvocationOutput]) -> Type[GenericBaseInvocationOutput]:
-        # Validate output types on creation of invocation output classes
-        # TODO: ensure unique?
-        if re.compile(r"^\S+$").match(output_type) is None:
-            raise ValueError(f'"output_type" must consist of non-whitespace characters, got "{output_type}"')
-
-        # Add the output type to the pydantic model of the invocation output
-        output_type_annotation = Literal[output_type]  # type: ignore
-        output_type_field = ModelField.infer(
-            name="type",
-            value=output_type,
-            annotation=output_type_annotation,
-            class_validators=None,
-            config=cls.__config__,
-        )
-        cls.__fields__.update({"type": output_type_field})
-        cls.__annotations__.update({"type": output_type_annotation})
-
-        return cls
-
-    return wrapper
+    schema_extra: CustomisedSchemaExtra

invokeai/app/invocations/collections.py

@@ -1,22 +1,66 @@
 # Copyright (c) 2023 Kyle Schouviller (https://github.com/kyle0654) and the InvokeAI Team
 
+from typing import Literal
 
 import numpy as np
-from pydantic import validator
+from pydantic import Field, validator
 
-from invokeai.app.invocations.primitives import IntegerCollectionOutput
+from invokeai.app.models.image import ImageField
 from invokeai.app.util.misc import SEED_MAX, get_random_seed
 
-from .baseinvocation import BaseInvocation, InputField, InvocationContext, invocation
+from .baseinvocation import (BaseInvocation, BaseInvocationOutput,
+                             InvocationConfig, InvocationContext, UIConfig)
+
+
+class IntCollectionOutput(BaseInvocationOutput):
+    """A collection of integers"""
+
+    type: Literal["int_collection"] = "int_collection"
+
+    # Outputs
+    collection: list[int] = Field(default=[], description="The int collection")
+
+
+class FloatCollectionOutput(BaseInvocationOutput):
+    """A collection of floats"""
+
+    type: Literal["float_collection"] = "float_collection"
+
+    # Outputs
+    collection: list[float] = Field(
+        default=[], description="The float collection")
+
+
+class ImageCollectionOutput(BaseInvocationOutput):
+    """A collection of images"""
+
+    type: Literal["image_collection"] = "image_collection"
+
+    # Outputs
+    collection: list[ImageField] = Field(
+        default=[], description="The output images")
+
+    class Config:
+        schema_extra = {"required": ["type", "collection"]}
 
 
-@invocation("range", title="Integer Range", tags=["collection", "integer", "range"], category="collections")
 class RangeInvocation(BaseInvocation):
     """Creates a range of numbers from start to stop with step"""
 
-    start: int = InputField(default=0, description="The start of the range")
-    stop: int = InputField(default=10, description="The stop of the range")
-    step: int = InputField(default=1, description="The step of the range")
+    type: Literal["range"] = "range"
+
+    # Inputs
+    start: int = Field(default=0, description="The start of the range")
+    stop: int = Field(default=10, description="The stop of the range")
+    step: int = Field(default=1, description="The step of the range")
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Range",
+                "tags": ["range", "integer", "collection"]
+            },
+        }
 
     @validator("stop")
     def stop_gt_start(cls, v, values):
@@ -24,46 +68,94 @@ class RangeInvocation(BaseInvocation):
             raise ValueError("stop must be greater than start")
         return v
 
-    def invoke(self, context: InvocationContext) -> IntegerCollectionOutput:
-        return IntegerCollectionOutput(collection=list(range(self.start, self.stop, self.step)))
+    def invoke(self, context: InvocationContext) -> IntCollectionOutput:
+        return IntCollectionOutput(
+            collection=list(range(self.start, self.stop, self.step))
+        )
 
 
-@invocation(
-    "range_of_size",
-    title="Integer Range of Size",
-    tags=["collection", "integer", "size", "range"],
-    category="collections",
-)
 class RangeOfSizeInvocation(BaseInvocation):
     """Creates a range from start to start + size with step"""
 
-    start: int = InputField(default=0, description="The start of the range")
-    size: int = InputField(default=1, description="The number of values")
-    step: int = InputField(default=1, description="The step of the range")
+    type: Literal["range_of_size"] = "range_of_size"
 
-    def invoke(self, context: InvocationContext) -> IntegerCollectionOutput:
-        return IntegerCollectionOutput(collection=list(range(self.start, self.start + self.size, self.step)))
+    # Inputs
+    start: int = Field(default=0, description="The start of the range")
+    size: int = Field(default=1, description="The number of values")
+    step: int = Field(default=1, description="The step of the range")
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Sized Range",
+                "tags": ["range", "integer", "size", "collection"]
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> IntCollectionOutput:
+        return IntCollectionOutput(
+            collection=list(
+                range(
+                    self.start, self.start + self.size,
+                    self.step)))
 
 
-@invocation(
-    "random_range",
-    title="Random Range",
-    tags=["range", "integer", "random", "collection"],
-    category="collections",
-)
 class RandomRangeInvocation(BaseInvocation):
     """Creates a collection of random numbers"""
 
-    low: int = InputField(default=0, description="The inclusive low value")
-    high: int = InputField(default=np.iinfo(np.int32).max, description="The exclusive high value")
-    size: int = InputField(default=1, description="The number of values to generate")
-    seed: int = InputField(
+    type: Literal["random_range"] = "random_range"
+
+    # Inputs
+    low: int = Field(default=0, description="The inclusive low value")
+    high: int = Field(
+        default=np.iinfo(np.int32).max, description="The exclusive high value"
+    )
+    size: int = Field(default=1, description="The number of values to generate")
+    seed: int = Field(
         ge=0,
         le=SEED_MAX,
         description="The seed for the RNG (omit for random)",
         default_factory=get_random_seed,
     )
 
-    def invoke(self, context: InvocationContext) -> IntegerCollectionOutput:
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Random Range",
+                "tags": ["range", "integer", "random", "collection"]
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> IntCollectionOutput:
         rng = np.random.default_rng(self.seed)
-        return IntegerCollectionOutput(collection=list(rng.integers(low=self.low, high=self.high, size=self.size)))
+        return IntCollectionOutput(
+            collection=list(
+                rng.integers(
+                    low=self.low, high=self.high,
+                    size=self.size)))
+
+
+class ImageCollectionInvocation(BaseInvocation):
+    """Load a collection of images and provide it as output."""
+
+    # fmt: off
+    type: Literal["image_collection"] = "image_collection"
+
+    # Inputs
+    images: list[ImageField] = Field(
+        default=[], description="The image collection to load"
+    )
+    # fmt: on
+
+    def invoke(self, context: InvocationContext) -> ImageCollectionOutput:
+        return ImageCollectionOutput(collection=self.images)
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "type_hints": {
+                    "title": "Image Collection",
+                    "images": "image_collection",
+                }
+            },
+        }

invokeai/app/invocations/compel.py

@@ -1,132 +1,152 @@
+from typing import Literal, Optional, Union, List, Annotated
+from pydantic import BaseModel, Field
 import re
-from dataclasses import dataclass
-from typing import List, Union
-
 import torch
 from compel import Compel, ReturnedEmbeddingsType
-from compel.prompt_parser import Blend, Conjunction, CrossAttentionControlSubstitute, FlattenedPrompt, Fragment
-from invokeai.app.invocations.primitives import ConditioningField, ConditioningOutput
-
-from invokeai.backend.stable_diffusion.diffusion.shared_invokeai_diffusion import (
-    BasicConditioningInfo,
-    SDXLConditioningInfo,
-)
-
-from ...backend.model_management.models import ModelType
-from ...backend.model_management.lora import ModelPatcher
-from ...backend.model_management.models import ModelNotFoundException
-from ...backend.stable_diffusion.diffusion import InvokeAIDiffuserComponent
+from compel.prompt_parser import (Blend, Conjunction,
+                                  CrossAttentionControlSubstitute,
+                                  FlattenedPrompt, Fragment)
 from ...backend.util.devices import torch_dtype
-from .baseinvocation import (
-    BaseInvocation,
-    BaseInvocationOutput,
-    FieldDescriptions,
-    Input,
-    InputField,
-    InvocationContext,
-    OutputField,
-    UIComponent,
-    invocation,
-    invocation_output,
-)
+from ...backend.model_management import ModelType
+from ...backend.model_management.models import ModelNotFoundException
+from ...backend.model_management.lora import ModelPatcher
+from ...backend.stable_diffusion.diffusion import InvokeAIDiffuserComponent
+from .baseinvocation import (BaseInvocation, BaseInvocationOutput,
+                             InvocationConfig, InvocationContext)
 from .model import ClipField
+from dataclasses import dataclass
 
 
+class ConditioningField(BaseModel):
+    conditioning_name: Optional[str] = Field(
+        default=None, description="The name of conditioning data")
+
+    class Config:
+        schema_extra = {"required": ["conditioning_name"]}
+
+@dataclass
+class BasicConditioningInfo:
+    #type: Literal["basic_conditioning"] = "basic_conditioning"
+    embeds: torch.Tensor
+    extra_conditioning: Optional[InvokeAIDiffuserComponent.ExtraConditioningInfo]
+    # weight: float
+    # mode: ConditioningAlgo
+
+@dataclass
+class SDXLConditioningInfo(BasicConditioningInfo):
+    #type: Literal["sdxl_conditioning"] = "sdxl_conditioning"
+    pooled_embeds: torch.Tensor
+    add_time_ids: torch.Tensor
+
+ConditioningInfoType = Annotated[
+    Union[BasicConditioningInfo, SDXLConditioningInfo],
+    Field(discriminator="type")
+]
+
 @dataclass
 class ConditioningFieldData:
-    conditionings: List[BasicConditioningInfo]
-    # unconditioned: Optional[torch.Tensor]
+    conditionings: List[Union[BasicConditioningInfo, SDXLConditioningInfo]]
+    #unconditioned: Optional[torch.Tensor]
 
-
-# class ConditioningAlgo(str, Enum):
+#class ConditioningAlgo(str, Enum):
 #    Compose = "compose"
 #    ComposeEx = "compose_ex"
 #    PerpNeg = "perp_neg"
 
+class CompelOutput(BaseInvocationOutput):
+    """Compel parser output"""
+
+    #fmt: off
+    type: Literal["compel_output"] = "compel_output"
+
+    conditioning: ConditioningField = Field(default=None, description="Conditioning")
+    #fmt: on
+
 
-@invocation("compel", title="Prompt", tags=["prompt", "compel"], category="conditioning")
 class CompelInvocation(BaseInvocation):
     """Parse prompt using compel package to conditioning."""
 
-    prompt: str = InputField(
-        default="",
-        description=FieldDescriptions.compel_prompt,
-        ui_component=UIComponent.Textarea,
-    )
-    clip: ClipField = InputField(
-        title="CLIP",
-        description=FieldDescriptions.clip,
-        input=Input.Connection,
-    )
+    type: Literal["compel"] = "compel"
+
+    prompt: str = Field(default="", description="Prompt")
+    clip: ClipField = Field(None, description="Clip to use")
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Prompt (Compel)",
+                "tags": ["prompt", "compel"],
+                "type_hints": {
+                    "model": "model"
+                }
+            },
+        }
 
     @torch.no_grad()
-    def invoke(self, context: InvocationContext) -> ConditioningOutput:
+    def invoke(self, context: InvocationContext) -> CompelOutput:
         tokenizer_info = context.services.model_manager.get_model(
-            **self.clip.tokenizer.dict(),
-            context=context,
+            **self.clip.tokenizer.dict(), context=context,
         )
         text_encoder_info = context.services.model_manager.get_model(
-            **self.clip.text_encoder.dict(),
-            context=context,
+            **self.clip.text_encoder.dict(), context=context,
         )
 
         def _lora_loader():
             for lora in self.clip.loras:
-                lora_info = context.services.model_manager.get_model(**lora.dict(exclude={"weight"}), context=context)
+                lora_info = context.services.model_manager.get_model(
+                    **lora.dict(exclude={"weight"}), context=context)
                 yield (lora_info.context.model, lora.weight)
                 del lora_info
             return
 
-        # loras = [(context.services.model_manager.get_model(**lora.dict(exclude={"weight"})).context.model, lora.weight) for lora in self.clip.loras]
+        #loras = [(context.services.model_manager.get_model(**lora.dict(exclude={"weight"})).context.model, lora.weight) for lora in self.clip.loras]
 
         ti_list = []
         for trigger in re.findall(r"<[a-zA-Z0-9., _-]+>", self.prompt):
             name = trigger[1:-1]
             try:
                 ti_list.append(
-                    (
-                        name,
-                        context.services.model_manager.get_model(
-                            model_name=name,
-                            base_model=self.clip.text_encoder.base_model,
-                            model_type=ModelType.TextualInversion,
-                            context=context,
-                        ).context.model,
-                    )
+                    context.services.model_manager.get_model(
+                        model_name=name,
+                        base_model=self.clip.text_encoder.base_model,
+                        model_type=ModelType.TextualInversion,
+                        context=context,
+                    ).context.model
                 )
             except ModelNotFoundException:
                 # print(e)
-                # import traceback
-                # print(traceback.format_exc())
-                print(f'Warn: trigger: "{trigger}" not found')
+                #import traceback
+                #print(traceback.format_exc())
+                print(f"Warn: trigger: \"{trigger}\" not found")
+
+        with ModelPatcher.apply_lora_text_encoder(text_encoder_info.context.model, _lora_loader()),\
+                ModelPatcher.apply_ti(tokenizer_info.context.model, text_encoder_info.context.model, ti_list) as (tokenizer, ti_manager),\
+                ModelPatcher.apply_clip_skip(text_encoder_info.context.model, self.clip.skipped_layers),\
+                text_encoder_info as text_encoder:
 
-        with ModelPatcher.apply_lora_text_encoder(
-            text_encoder_info.context.model, _lora_loader()
-        ), ModelPatcher.apply_ti(tokenizer_info.context.model, text_encoder_info.context.model, ti_list) as (
-            tokenizer,
-            ti_manager,
-        ), ModelPatcher.apply_clip_skip(
-            text_encoder_info.context.model, self.clip.skipped_layers
-        ), text_encoder_info as text_encoder:
             compel = Compel(
                 tokenizer=tokenizer,
                 text_encoder=text_encoder,
                 textual_inversion_manager=ti_manager,
                 dtype_for_device_getter=torch_dtype,
-                truncate_long_prompts=False,
+                truncate_long_prompts=True,
             )
 
             conjunction = Compel.parse_prompt_string(self.prompt)
+            prompt: Union[FlattenedPrompt, Blend] = conjunction.prompts[0]
 
             if context.services.configuration.log_tokenization:
-                log_tokenization_for_conjunction(conjunction, tokenizer)
+                log_tokenization_for_prompt_object(prompt, tokenizer)
 
-            c, options = compel.build_conditioning_tensor_for_conjunction(conjunction)
+            c, options = compel.build_conditioning_tensor_for_prompt_object(
+                prompt)
 
             ec = InvokeAIDiffuserComponent.ExtraConditioningInfo(
-                tokens_count_including_eos_bos=get_max_token_count(tokenizer, conjunction),
-                cross_attention_control_args=options.get("cross_attention_control", None),
-            )
+                tokens_count_including_eos_bos=get_max_token_count(
+                    tokenizer, conjunction),
+                cross_attention_control_args=options.get(
+                    "cross_attention_control", None),)
 
         c = c.detach().to("cpu")
 
@@ -142,101 +162,140 @@ class CompelInvocation(BaseInvocation):
         conditioning_name = f"{context.graph_execution_state_id}_{self.id}_conditioning"
         context.services.latents.save(conditioning_name, conditioning_data)
 
-        return ConditioningOutput(
+        return CompelOutput(
             conditioning=ConditioningField(
                 conditioning_name=conditioning_name,
             ),
         )
 
-
 class SDXLPromptInvocationBase:
-    def run_clip_compel(
-        self,
-        context: InvocationContext,
-        clip_field: ClipField,
-        prompt: str,
-        get_pooled: bool,
-        lora_prefix: str,
-        zero_on_empty: bool,
-    ):
+    def run_clip_raw(self, context, clip_field, prompt, get_pooled):
         tokenizer_info = context.services.model_manager.get_model(
-            **clip_field.tokenizer.dict(),
-            context=context,
+            **clip_field.tokenizer.dict(), context=context,
         )
         text_encoder_info = context.services.model_manager.get_model(
-            **clip_field.text_encoder.dict(),
-            context=context,
+            **clip_field.text_encoder.dict(), context=context,
         )
 
-        # return zero on empty
-        if prompt == "" and zero_on_empty:
-            cpu_text_encoder = text_encoder_info.context.model
-            c = torch.zeros(
-                (1, cpu_text_encoder.config.max_position_embeddings, cpu_text_encoder.config.hidden_size),
-                dtype=text_encoder_info.context.cache.precision,
-            )
-            if get_pooled:
-                c_pooled = torch.zeros(
-                    (1, cpu_text_encoder.config.hidden_size),
-                    dtype=c.dtype,
-                )
-            else:
-                c_pooled = None
-            return c, c_pooled, None
-
         def _lora_loader():
             for lora in clip_field.loras:
-                lora_info = context.services.model_manager.get_model(**lora.dict(exclude={"weight"}), context=context)
+                lora_info = context.services.model_manager.get_model(
+                    **lora.dict(exclude={"weight"}), context=context)
                 yield (lora_info.context.model, lora.weight)
                 del lora_info
             return
 
-        # loras = [(context.services.model_manager.get_model(**lora.dict(exclude={"weight"})).context.model, lora.weight) for lora in self.clip.loras]
+        #loras = [(context.services.model_manager.get_model(**lora.dict(exclude={"weight"})).context.model, lora.weight) for lora in self.clip.loras]
 
         ti_list = []
         for trigger in re.findall(r"<[a-zA-Z0-9., _-]+>", prompt):
             name = trigger[1:-1]
             try:
                 ti_list.append(
-                    (
-                        name,
-                        context.services.model_manager.get_model(
-                            model_name=name,
-                            base_model=clip_field.text_encoder.base_model,
-                            model_type=ModelType.TextualInversion,
-                            context=context,
-                        ).context.model,
-                    )
+                    context.services.model_manager.get_model(
+                        model_name=name,
+                        base_model=clip_field.text_encoder.base_model,
+                        model_type=ModelType.TextualInversion,
+                        context=context,
+                    ).context.model
                 )
             except ModelNotFoundException:
                 # print(e)
-                # import traceback
-                # print(traceback.format_exc())
-                print(f'Warn: trigger: "{trigger}" not found')
+                #import traceback
+                #print(traceback.format_exc())
+                print(f"Warn: trigger: \"{trigger}\" not found")
+
+        with ModelPatcher.apply_lora_text_encoder(text_encoder_info.context.model, _lora_loader()),\
+                ModelPatcher.apply_ti(tokenizer_info.context.model, text_encoder_info.context.model, ti_list) as (tokenizer, ti_manager),\
+                ModelPatcher.apply_clip_skip(text_encoder_info.context.model, clip_field.skipped_layers),\
+                text_encoder_info as text_encoder:
+
+            text_inputs = tokenizer(
+                prompt,
+                padding="max_length",
+                max_length=tokenizer.model_max_length,
+                truncation=True,
+                return_tensors="pt",
+            )
+            text_input_ids = text_inputs.input_ids
+            prompt_embeds = text_encoder(
+                text_input_ids.to(text_encoder.device),
+                output_hidden_states=True,
+            )
+            if get_pooled:
+                c_pooled = prompt_embeds[0]
+            else:
+                c_pooled = None
+            c = prompt_embeds.hidden_states[-2]
+
+        del tokenizer
+        del text_encoder
+        del tokenizer_info
+        del text_encoder_info
+
+        c = c.detach().to("cpu")
+        if c_pooled is not None:
+            c_pooled = c_pooled.detach().to("cpu")
+
+        return c, c_pooled, None
+
+    def run_clip_compel(self, context, clip_field, prompt, get_pooled):
+        tokenizer_info = context.services.model_manager.get_model(
+            **clip_field.tokenizer.dict(), context=context,
+        )
+        text_encoder_info = context.services.model_manager.get_model(
+            **clip_field.text_encoder.dict(), context=context,
+        )
+
+        def _lora_loader():
+            for lora in clip_field.loras:
+                lora_info = context.services.model_manager.get_model(
+                    **lora.dict(exclude={"weight"}), context=context)
+                yield (lora_info.context.model, lora.weight)
+                del lora_info
+            return
+
+        #loras = [(context.services.model_manager.get_model(**lora.dict(exclude={"weight"})).context.model, lora.weight) for lora in self.clip.loras]
+
+        ti_list = []
+        for trigger in re.findall(r"<[a-zA-Z0-9., _-]+>", prompt):
+            name = trigger[1:-1]
+            try:
+                ti_list.append(
+                    context.services.model_manager.get_model(
+                        model_name=name,
+                        base_model=clip_field.text_encoder.base_model,
+                        model_type=ModelType.TextualInversion,
+                        context=context,
+                    ).context.model
+                )
+            except ModelNotFoundException:
+                # print(e)
+                #import traceback
+                #print(traceback.format_exc())
+                print(f"Warn: trigger: \"{trigger}\" not found")
+
+        with ModelPatcher.apply_lora_text_encoder(text_encoder_info.context.model, _lora_loader()),\
+                ModelPatcher.apply_ti(tokenizer_info.context.model, text_encoder_info.context.model, ti_list) as (tokenizer, ti_manager),\
+                ModelPatcher.apply_clip_skip(text_encoder_info.context.model, clip_field.skipped_layers),\
+                text_encoder_info as text_encoder:
 
-        with ModelPatcher.apply_lora(
-            text_encoder_info.context.model, _lora_loader(), lora_prefix
-        ), ModelPatcher.apply_ti(tokenizer_info.context.model, text_encoder_info.context.model, ti_list) as (
-            tokenizer,
-            ti_manager,
-        ), ModelPatcher.apply_clip_skip(
-            text_encoder_info.context.model, clip_field.skipped_layers
-        ), text_encoder_info as text_encoder:
             compel = Compel(
                 tokenizer=tokenizer,
                 text_encoder=text_encoder,
                 textual_inversion_manager=ti_manager,
                 dtype_for_device_getter=torch_dtype,
-                truncate_long_prompts=False,  # TODO:
-                returned_embeddings_type=ReturnedEmbeddingsType.PENULTIMATE_HIDDEN_STATES_NON_NORMALIZED,  # TODO: clip skip
-                requires_pooled=get_pooled,
+                truncate_long_prompts=True,  # TODO:
+                returned_embeddings_type=ReturnedEmbeddingsType.PENULTIMATE_HIDDEN_STATES_NON_NORMALIZED, # TODO: clip skip
+                requires_pooled=True,
             )
 
             conjunction = Compel.parse_prompt_string(prompt)
 
             if context.services.configuration.log_tokenization:
                 # TODO: better logging for and syntax
-                log_tokenization_for_conjunction(conjunction, tokenizer)
+                for prompt_obj in conjunction.prompts:
+                    log_tokenization_for_prompt_object(prompt_obj, tokenizer)
 
             # TODO: ask for optimizations? to not run text_encoder twice
             c, options = compel.build_conditioning_tensor_for_conjunction(conjunction)
@@ -261,69 +320,49 @@ class SDXLPromptInvocationBase:
 
         return c, c_pooled, ec
 
-
-@invocation(
-    "sdxl_compel_prompt",
-    title="SDXL Prompt",
-    tags=["sdxl", "compel", "prompt"],
-    category="conditioning",
-)
 class SDXLCompelPromptInvocation(BaseInvocation, SDXLPromptInvocationBase):
     """Parse prompt using compel package to conditioning."""
 
-    prompt: str = InputField(default="", description=FieldDescriptions.compel_prompt, ui_component=UIComponent.Textarea)
-    style: str = InputField(default="", description=FieldDescriptions.compel_prompt, ui_component=UIComponent.Textarea)
-    original_width: int = InputField(default=1024, description="")
-    original_height: int = InputField(default=1024, description="")
-    crop_top: int = InputField(default=0, description="")
-    crop_left: int = InputField(default=0, description="")
-    target_width: int = InputField(default=1024, description="")
-    target_height: int = InputField(default=1024, description="")
-    clip: ClipField = InputField(description=FieldDescriptions.clip, input=Input.Connection)
-    clip2: ClipField = InputField(description=FieldDescriptions.clip, input=Input.Connection)
+    type: Literal["sdxl_compel_prompt"] = "sdxl_compel_prompt"
+
+    prompt: str = Field(default="", description="Prompt")
+    style: str = Field(default="", description="Style prompt")
+    original_width: int = Field(1024, description="")
+    original_height: int = Field(1024, description="")
+    crop_top: int = Field(0, description="")
+    crop_left: int = Field(0, description="")
+    target_width: int = Field(1024, description="")
+    target_height: int = Field(1024, description="")
+    clip: ClipField = Field(None, description="Clip to use")
+    clip2: ClipField = Field(None, description="Clip2 to use")
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "SDXL Prompt (Compel)",
+                "tags": ["prompt", "compel"],
+                "type_hints": {
+                    "model": "model"
+                }
+            },
+        }
 
     @torch.no_grad()
-    def invoke(self, context: InvocationContext) -> ConditioningOutput:
-        c1, c1_pooled, ec1 = self.run_clip_compel(
-            context, self.clip, self.prompt, False, "lora_te1_", zero_on_empty=True
-        )
+    def invoke(self, context: InvocationContext) -> CompelOutput:
+        c1, c1_pooled, ec1 = self.run_clip_compel(context, self.clip, self.prompt, False)
         if self.style.strip() == "":
-            c2, c2_pooled, ec2 = self.run_clip_compel(
-                context, self.clip2, self.prompt, True, "lora_te2_", zero_on_empty=True
-            )
+            c2, c2_pooled, ec2 = self.run_clip_compel(context, self.clip2, self.prompt, True)
         else:
-            c2, c2_pooled, ec2 = self.run_clip_compel(
-                context, self.clip2, self.style, True, "lora_te2_", zero_on_empty=True
-            )
+            c2, c2_pooled, ec2 = self.run_clip_compel(context, self.clip2, self.style, True)
 
         original_size = (self.original_height, self.original_width)
         crop_coords = (self.crop_top, self.crop_left)
         target_size = (self.target_height, self.target_width)
 
-        add_time_ids = torch.tensor([original_size + crop_coords + target_size])
-
-        # [1, 77, 768], [1, 154, 1280]
-        if c1.shape[1] < c2.shape[1]:
-            c1 = torch.cat(
-                [
-                    c1,
-                    torch.zeros(
-                        (c1.shape[0], c2.shape[1] - c1.shape[1], c1.shape[2]), device=c1.device, dtype=c1.dtype
-                    ),
-                ],
-                dim=1,
-            )
-
-        elif c1.shape[1] > c2.shape[1]:
-            c2 = torch.cat(
-                [
-                    c2,
-                    torch.zeros(
-                        (c2.shape[0], c1.shape[1] - c2.shape[1], c2.shape[2]), device=c2.device, dtype=c2.dtype
-                    ),
-                ],
-                dim=1,
-            )
+        add_time_ids = torch.tensor([
+            original_size + crop_coords + target_size
+        ])
 
         conditioning_data = ConditioningFieldData(
             conditionings=[
@@ -339,41 +378,47 @@ class SDXLCompelPromptInvocation(BaseInvocation, SDXLPromptInvocationBase):
         conditioning_name = f"{context.graph_execution_state_id}_{self.id}_conditioning"
         context.services.latents.save(conditioning_name, conditioning_data)
 
-        return ConditioningOutput(
+        return CompelOutput(
             conditioning=ConditioningField(
                 conditioning_name=conditioning_name,
             ),
         )
 
-
-@invocation(
-    "sdxl_refiner_compel_prompt",
-    title="SDXL Refiner Prompt",
-    tags=["sdxl", "compel", "prompt"],
-    category="conditioning",
-)
 class SDXLRefinerCompelPromptInvocation(BaseInvocation, SDXLPromptInvocationBase):
     """Parse prompt using compel package to conditioning."""
 
-    style: str = InputField(
-        default="", description=FieldDescriptions.compel_prompt, ui_component=UIComponent.Textarea
-    )  # TODO: ?
-    original_width: int = InputField(default=1024, description="")
-    original_height: int = InputField(default=1024, description="")
-    crop_top: int = InputField(default=0, description="")
-    crop_left: int = InputField(default=0, description="")
-    aesthetic_score: float = InputField(default=6.0, description=FieldDescriptions.sdxl_aesthetic)
-    clip2: ClipField = InputField(description=FieldDescriptions.clip, input=Input.Connection)
+    type: Literal["sdxl_refiner_compel_prompt"] = "sdxl_refiner_compel_prompt"
+
+    style: str = Field(default="", description="Style prompt") # TODO: ?
+    original_width: int = Field(1024, description="")
+    original_height: int = Field(1024, description="")
+    crop_top: int = Field(0, description="")
+    crop_left: int = Field(0, description="")
+    aesthetic_score: float = Field(6.0, description="")
+    clip2: ClipField = Field(None, description="Clip to use")
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "SDXL Refiner Prompt (Compel)",
+                "tags": ["prompt", "compel"],
+                "type_hints": {
+                    "model": "model"
+                }
+            },
+        }
 
     @torch.no_grad()
-    def invoke(self, context: InvocationContext) -> ConditioningOutput:
-        # TODO: if there will appear lora for refiner - write proper prefix
-        c2, c2_pooled, ec2 = self.run_clip_compel(context, self.clip2, self.style, True, "<NONE>", zero_on_empty=False)
+    def invoke(self, context: InvocationContext) -> CompelOutput:
+        c2, c2_pooled, ec2 = self.run_clip_compel(context, self.clip2, self.style, True)
 
         original_size = (self.original_height, self.original_width)
         crop_coords = (self.crop_top, self.crop_left)
 
-        add_time_ids = torch.tensor([original_size + crop_coords + (self.aesthetic_score,)])
+        add_time_ids = torch.tensor([
+            original_size + crop_coords + (self.aesthetic_score,)
+        ])
 
         conditioning_data = ConditioningFieldData(
             conditionings=[
@@ -381,7 +426,7 @@ class SDXLRefinerCompelPromptInvocation(BaseInvocation, SDXLPromptInvocationBase
                     embeds=c2,
                     pooled_embeds=c2_pooled,
                     add_time_ids=add_time_ids,
-                    extra_conditioning=ec2,  # or None
+                    extra_conditioning=ec2, # or None
                 )
             ]
         )
@@ -389,26 +434,152 @@ class SDXLRefinerCompelPromptInvocation(BaseInvocation, SDXLPromptInvocationBase
         conditioning_name = f"{context.graph_execution_state_id}_{self.id}_conditioning"
         context.services.latents.save(conditioning_name, conditioning_data)
 
-        return ConditioningOutput(
+        return CompelOutput(
+            conditioning=ConditioningField(
+                conditioning_name=conditioning_name,
+            ),
+        )
+
+class SDXLRawPromptInvocation(BaseInvocation, SDXLPromptInvocationBase):
+    """Pass unmodified prompt to conditioning without compel processing."""
+
+    type: Literal["sdxl_raw_prompt"] = "sdxl_raw_prompt"
+
+    prompt: str = Field(default="", description="Prompt")
+    style: str = Field(default="", description="Style prompt")
+    original_width: int = Field(1024, description="")
+    original_height: int = Field(1024, description="")
+    crop_top: int = Field(0, description="")
+    crop_left: int = Field(0, description="")
+    target_width: int = Field(1024, description="")
+    target_height: int = Field(1024, description="")
+    clip: ClipField = Field(None, description="Clip to use")
+    clip2: ClipField = Field(None, description="Clip2 to use")
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "SDXL Prompt (Raw)",
+                "tags": ["prompt", "compel"],
+                "type_hints": {
+                    "model": "model"
+                }
+            },
+        }
+
+    @torch.no_grad()
+    def invoke(self, context: InvocationContext) -> CompelOutput:
+        c1, c1_pooled, ec1 = self.run_clip_raw(context, self.clip, self.prompt, False)
+        if self.style.strip() == "":
+            c2, c2_pooled, ec2 = self.run_clip_raw(context, self.clip2, self.prompt, True)
+        else:
+            c2, c2_pooled, ec2 = self.run_clip_raw(context, self.clip2, self.style, True)
+
+        original_size = (self.original_height, self.original_width)
+        crop_coords = (self.crop_top, self.crop_left)
+        target_size = (self.target_height, self.target_width)
+
+        add_time_ids = torch.tensor([
+            original_size + crop_coords + target_size
+        ])
+
+        conditioning_data = ConditioningFieldData(
+            conditionings=[
+                SDXLConditioningInfo(
+                    embeds=torch.cat([c1, c2], dim=-1),
+                    pooled_embeds=c2_pooled,
+                    add_time_ids=add_time_ids,
+                    extra_conditioning=ec1,
+                )
+            ]
+        )
+
+        conditioning_name = f"{context.graph_execution_state_id}_{self.id}_conditioning"
+        context.services.latents.save(conditioning_name, conditioning_data)
+
+        return CompelOutput(
+            conditioning=ConditioningField(
+                conditioning_name=conditioning_name,
+            ),
+        )
+
+class SDXLRefinerRawPromptInvocation(BaseInvocation, SDXLPromptInvocationBase):
+    """Parse prompt using compel package to conditioning."""
+
+    type: Literal["sdxl_refiner_raw_prompt"] = "sdxl_refiner_raw_prompt"
+
+    style: str = Field(default="", description="Style prompt") # TODO: ?
+    original_width: int = Field(1024, description="")
+    original_height: int = Field(1024, description="")
+    crop_top: int = Field(0, description="")
+    crop_left: int = Field(0, description="")
+    aesthetic_score: float = Field(6.0, description="")
+    clip2: ClipField = Field(None, description="Clip to use")
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "SDXL Refiner Prompt (Raw)",
+                "tags": ["prompt", "compel"],
+                "type_hints": {
+                    "model": "model"
+                }
+            },
+        }
+
+    @torch.no_grad()
+    def invoke(self, context: InvocationContext) -> CompelOutput:
+        c2, c2_pooled, ec2 = self.run_clip_raw(context, self.clip2, self.style, True)
+
+        original_size = (self.original_height, self.original_width)
+        crop_coords = (self.crop_top, self.crop_left)
+
+        add_time_ids = torch.tensor([
+            original_size + crop_coords + (self.aesthetic_score,)
+        ])
+
+        conditioning_data = ConditioningFieldData(
+            conditionings=[
+                SDXLConditioningInfo(
+                    embeds=c2,
+                    pooled_embeds=c2_pooled,
+                    add_time_ids=add_time_ids,
+                    extra_conditioning=ec2, # or None
+                )
+            ]
+        )
+
+        conditioning_name = f"{context.graph_execution_state_id}_{self.id}_conditioning"
+        context.services.latents.save(conditioning_name, conditioning_data)
+
+        return CompelOutput(
             conditioning=ConditioningField(
                 conditioning_name=conditioning_name,
             ),
         )
 
 
-@invocation_output("clip_skip_output")
 class ClipSkipInvocationOutput(BaseInvocationOutput):
     """Clip skip node output"""
+    type: Literal["clip_skip_output"] = "clip_skip_output"
+    clip: ClipField = Field(None, description="Clip with skipped layers")
 
-    clip: ClipField = OutputField(default=None, description=FieldDescriptions.clip, title="CLIP")
-
-
-@invocation("clip_skip", title="CLIP Skip", tags=["clipskip", "clip", "skip"], category="conditioning")
 class ClipSkipInvocation(BaseInvocation):
     """Skip layers in clip text_encoder model."""
+    type: Literal["clip_skip"] = "clip_skip"
 
-    clip: ClipField = InputField(description=FieldDescriptions.clip, input=Input.Connection, title="CLIP")
-    skipped_layers: int = InputField(default=0, description=FieldDescriptions.skipped_layers)
+    clip: ClipField = Field(None, description="Clip to use")
+    skipped_layers: int = Field(0, description="Number of layers to skip in text_encoder")
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "CLIP Skip",
+                "tags": ["clip", "skip"]
+            },
+        }
 
     def invoke(self, context: InvocationContext) -> ClipSkipInvocationOutput:
         self.clip.skipped_layers += self.skipped_layers
@@ -418,26 +589,46 @@ class ClipSkipInvocation(BaseInvocation):
 
 
 def get_max_token_count(
-    tokenizer, prompt: Union[FlattenedPrompt, Blend, Conjunction], truncate_if_too_long=False
-) -> int:
+        tokenizer, prompt: Union[FlattenedPrompt, Blend, Conjunction],
+        truncate_if_too_long=False) -> int:
     if type(prompt) is Blend:
         blend: Blend = prompt
-        return max([get_max_token_count(tokenizer, p, truncate_if_too_long) for p in blend.prompts])
+        return max(
+            [
+                get_max_token_count(tokenizer, p, truncate_if_too_long)
+                for p in blend.prompts
+            ]
+        )
     elif type(prompt) is Conjunction:
         conjunction: Conjunction = prompt
-        return sum([get_max_token_count(tokenizer, p, truncate_if_too_long) for p in conjunction.prompts])
+        return sum(
+            [
+                get_max_token_count(tokenizer, p, truncate_if_too_long)
+                for p in conjunction.prompts
+            ]
+        )
     else:
-        return len(get_tokens_for_prompt_object(tokenizer, prompt, truncate_if_too_long))
+        return len(
+            get_tokens_for_prompt_object(
+                tokenizer, prompt, truncate_if_too_long))
 
 
-def get_tokens_for_prompt_object(tokenizer, parsed_prompt: FlattenedPrompt, truncate_if_too_long=True) -> List[str]:
+def get_tokens_for_prompt_object(
+    tokenizer, parsed_prompt: FlattenedPrompt, truncate_if_too_long=True
+) -> List[str]:
     if type(parsed_prompt) is Blend:
-        raise ValueError("Blend is not supported here - you need to get tokens for each of its .children")
+        raise ValueError(
+            "Blend is not supported here - you need to get tokens for each of its .children"
+        )
 
     text_fragments = [
         x.text
         if type(x) is Fragment
-        else (" ".join([f.text for f in x.original]) if type(x) is CrossAttentionControlSubstitute else str(x))
+        else (
+            " ".join([f.text for f in x.original])
+            if type(x) is CrossAttentionControlSubstitute
+            else str(x)
+        )
         for x in parsed_prompt.children
     ]
     text = " ".join(text_fragments)
@@ -448,17 +639,25 @@ def get_tokens_for_prompt_object(tokenizer, parsed_prompt: FlattenedPrompt, trun
     return tokens
 
 
-def log_tokenization_for_conjunction(c: Conjunction, tokenizer, display_label_prefix=None):
+def log_tokenization_for_conjunction(
+    c: Conjunction, tokenizer, display_label_prefix=None
+):
     display_label_prefix = display_label_prefix or ""
     for i, p in enumerate(c.prompts):
         if len(c.prompts) > 1:
             this_display_label_prefix = f"{display_label_prefix}(conjunction part {i + 1}, weight={c.weights[i]})"
         else:
             this_display_label_prefix = display_label_prefix
-        log_tokenization_for_prompt_object(p, tokenizer, display_label_prefix=this_display_label_prefix)
+        log_tokenization_for_prompt_object(
+            p,
+            tokenizer,
+            display_label_prefix=this_display_label_prefix
+        )
 
 
-def log_tokenization_for_prompt_object(p: Union[Blend, FlattenedPrompt], tokenizer, display_label_prefix=None):
+def log_tokenization_for_prompt_object(
+    p: Union[Blend, FlattenedPrompt], tokenizer, display_label_prefix=None
+):
     display_label_prefix = display_label_prefix or ""
     if type(p) is Blend:
         blend: Blend = p
@@ -495,10 +694,13 @@ def log_tokenization_for_prompt_object(p: Union[Blend, FlattenedPrompt], tokeniz
             )
         else:
             text = " ".join([x.text for x in flattened_prompt.children])
-            log_tokenization_for_text(text, tokenizer, display_label=display_label_prefix)
+            log_tokenization_for_text(
+                text, tokenizer, display_label=display_label_prefix
+            )
 
 
-def log_tokenization_for_text(text, tokenizer, display_label=None, truncate_if_too_long=False):
+def log_tokenization_for_text(
+        text, tokenizer, display_label=None, truncate_if_too_long=False):
     """shows how the prompt is tokenized
     # usually tokens have '</w>' to indicate end-of-word,
     # but for readability it has been replaced with ' '

invokeai/app/invocations/controlnet_image_processors.py

@@ -6,53 +6,88 @@ from typing import Dict, List, Literal, Optional, Union
 
 import cv2
 import numpy as np
-from controlnet_aux import (
-    CannyDetector,
-    ContentShuffleDetector,
-    HEDdetector,
-    LeresDetector,
-    LineartAnimeDetector,
-    LineartDetector,
-    MediapipeFaceDetector,
-    MidasDetector,
-    MLSDdetector,
-    NormalBaeDetector,
-    OpenposeDetector,
-    PidiNetDetector,
-    SamDetector,
-    ZoeDetector,
-)
+from controlnet_aux import (CannyDetector, ContentShuffleDetector, HEDdetector,
+                            LeresDetector, LineartAnimeDetector,
+                            LineartDetector, MediapipeFaceDetector,
+                            MidasDetector, MLSDdetector, NormalBaeDetector,
+                            OpenposeDetector, PidiNetDetector, SamDetector,
+                            ZoeDetector)
 from controlnet_aux.util import HWC3, ade_palette
 from PIL import Image
 from pydantic import BaseModel, Field, validator
 
-from invokeai.app.invocations.primitives import ImageField, ImageOutput
+from ...backend.model_management import BaseModelType, ModelType
+from ..models.image import ImageCategory, ImageField, ResourceOrigin
+from .baseinvocation import (BaseInvocation, BaseInvocationOutput,
+                             InvocationConfig, InvocationContext)
+from ..models.image import ImageOutput, PILInvocationConfig
 
+CONTROLNET_DEFAULT_MODELS = [
+    ###########################################
+    # lllyasviel sd v1.5, ControlNet v1.0 models
+    ##############################################
+    "lllyasviel/sd-controlnet-canny",
+    "lllyasviel/sd-controlnet-depth",
+    "lllyasviel/sd-controlnet-hed",
+    "lllyasviel/sd-controlnet-seg",
+    "lllyasviel/sd-controlnet-openpose",
+    "lllyasviel/sd-controlnet-scribble",
+    "lllyasviel/sd-controlnet-normal",
+    "lllyasviel/sd-controlnet-mlsd",
 
-from ...backend.model_management import BaseModelType
-from ..models.image import ImageCategory, ResourceOrigin
-from .baseinvocation import (
-    BaseInvocation,
-    BaseInvocationOutput,
-    FieldDescriptions,
-    InputField,
-    Input,
-    InvocationContext,
-    OutputField,
-    UIType,
-    invocation,
-    invocation_output,
-)
+    #############################################
+    # lllyasviel sd v1.5, ControlNet v1.1 models
+    #############################################
+    "lllyasviel/control_v11p_sd15_canny",
+    "lllyasviel/control_v11p_sd15_openpose",
+    "lllyasviel/control_v11p_sd15_seg",
+    # "lllyasviel/control_v11p_sd15_depth",  # broken
+    "lllyasviel/control_v11f1p_sd15_depth",
+    "lllyasviel/control_v11p_sd15_normalbae",
+    "lllyasviel/control_v11p_sd15_scribble",
+    "lllyasviel/control_v11p_sd15_mlsd",
+    "lllyasviel/control_v11p_sd15_softedge",
+    "lllyasviel/control_v11p_sd15s2_lineart_anime",
+    "lllyasviel/control_v11p_sd15_lineart",
+    "lllyasviel/control_v11p_sd15_inpaint",
+    # "lllyasviel/control_v11u_sd15_tile",
+    # problem (temporary?) with huffingface "lllyasviel/control_v11u_sd15_tile",
+    # so for now replace  "lllyasviel/control_v11f1e_sd15_tile",
+    "lllyasviel/control_v11e_sd15_shuffle",
+    "lllyasviel/control_v11e_sd15_ip2p",
+    "lllyasviel/control_v11f1e_sd15_tile",
 
+    #################################################
+    #  thibaud sd v2.1 models (ControlNet v1.0? or v1.1?
+    ##################################################
+    "thibaud/controlnet-sd21-openpose-diffusers",
+    "thibaud/controlnet-sd21-canny-diffusers",
+    "thibaud/controlnet-sd21-depth-diffusers",
+    "thibaud/controlnet-sd21-scribble-diffusers",
+    "thibaud/controlnet-sd21-hed-diffusers",
+    "thibaud/controlnet-sd21-zoedepth-diffusers",
+    "thibaud/controlnet-sd21-color-diffusers",
+    "thibaud/controlnet-sd21-openposev2-diffusers",
+    "thibaud/controlnet-sd21-lineart-diffusers",
+    "thibaud/controlnet-sd21-normalbae-diffusers",
+    "thibaud/controlnet-sd21-ade20k-diffusers",
 
-CONTROLNET_MODE_VALUES = Literal["balanced", "more_prompt", "more_control", "unbalanced"]
-CONTROLNET_RESIZE_VALUES = Literal[
-    "just_resize",
-    "crop_resize",
-    "fill_resize",
-    "just_resize_simple",
+    ##############################################
+    #  ControlNetMediaPipeface, ControlNet v1.1
+    ##############################################
+    # ["CrucibleAI/ControlNetMediaPipeFace", "diffusion_sd15"],  # SD 1.5
+    #    diffusion_sd15 needs to be passed to from_pretrained() as subfolder arg
+    #    hacked t2l to split to model & subfolder if format is "model,subfolder"
+    "CrucibleAI/ControlNetMediaPipeFace,diffusion_sd15",  # SD 1.5
+    "CrucibleAI/ControlNetMediaPipeFace",  # SD 2.1?
 ]
 
+CONTROLNET_NAME_VALUES = Literal[tuple(CONTROLNET_DEFAULT_MODELS)]
+CONTROLNET_MODE_VALUES = Literal[tuple(
+    ["balanced", "more_prompt", "more_control", "unbalanced"])]
+CONTROLNET_RESIZE_VALUES = Literal[tuple(
+    ["just_resize", "crop_resize", "fill_resize", "just_resize_simple",])]
+
 
 class ControlNetModelField(BaseModel):
     """ControlNet model field"""
@@ -62,17 +97,22 @@ class ControlNetModelField(BaseModel):
 
 
 class ControlField(BaseModel):
-    image: ImageField = Field(description="The control image")
-    control_model: ControlNetModelField = Field(description="The ControlNet model to use")
-    control_weight: Union[float, List[float]] = Field(default=1, description="The weight given to the ControlNet")
+    image: ImageField = Field(default=None, description="The control image")
+    control_model: Optional[ControlNetModelField] = Field(
+        default=None, description="The ControlNet model to use")
+    # control_weight: Optional[float] = Field(default=1, description="weight given to controlnet")
+    control_weight: Union[float, List[float]] = Field(
+        default=1, description="The weight given to the ControlNet")
     begin_step_percent: float = Field(
-        default=0, ge=0, le=1, description="When the ControlNet is first applied (% of total steps)"
-    )
+        default=0, ge=0, le=1,
+        description="When the ControlNet is first applied (% of total steps)")
     end_step_percent: float = Field(
-        default=1, ge=0, le=1, description="When the ControlNet is last applied (% of total steps)"
-    )
-    control_mode: CONTROLNET_MODE_VALUES = Field(default="balanced", description="The control mode to use")
-    resize_mode: CONTROLNET_RESIZE_VALUES = Field(default="just_resize", description="The resize mode to use")
+        default=1, ge=0, le=1,
+        description="When the ControlNet is last applied (% of total steps)")
+    control_mode: CONTROLNET_MODE_VALUES = Field(
+        default="balanced", description="The control mode to use")
+    resize_mode: CONTROLNET_RESIZE_VALUES = Field(
+        default="just_resize", description="The resize mode to use")
 
     @validator("control_weight")
     def validate_control_weight(cls, v):
@@ -80,40 +120,65 @@ class ControlField(BaseModel):
         if isinstance(v, list):
             for i in v:
                 if i < -1 or i > 2:
-                    raise ValueError("Control weights must be within -1 to 2 range")
+                    raise ValueError(
+                        'Control weights must be within -1 to 2 range')
         else:
             if v < -1 or v > 2:
-                raise ValueError("Control weights must be within -1 to 2 range")
+                raise ValueError('Control weights must be within -1 to 2 range')
         return v
 
+    class Config:
+        schema_extra = {
+            "required": ["image", "control_model", "control_weight", "begin_step_percent", "end_step_percent"],
+            "ui": {
+                "type_hints": {
+                    "control_weight": "float",
+                    "control_model": "controlnet_model",
+                    # "control_weight": "number",
+                }
+            }
+        }
+
 
-@invocation_output("control_output")
 class ControlOutput(BaseInvocationOutput):
     """node output for ControlNet info"""
-
-    # Outputs
-    control: ControlField = OutputField(description=FieldDescriptions.control)
+    # fmt: off
+    type: Literal["control_output"] = "control_output"
+    control: ControlField = Field(default=None, description="The control info")
+    # fmt: on
 
 
-@invocation("controlnet", title="ControlNet", tags=["controlnet"], category="controlnet")
 class ControlNetInvocation(BaseInvocation):
     """Collects ControlNet info to pass to other nodes"""
+    # fmt: off
+    type: Literal["controlnet"] = "controlnet"
+    # Inputs
+    image: ImageField = Field(default=None, description="The control image")
+    control_model: ControlNetModelField = Field(default="lllyasviel/sd-controlnet-canny",
+                                                  description="control model used")
+    control_weight: Union[float, List[float]] = Field(default=1.0, description="The weight given to the ControlNet")
+    begin_step_percent: float = Field(default=0, ge=-1, le=2,
+                                      description="When the ControlNet is first applied (% of total steps)")
+    end_step_percent: float = Field(default=1, ge=0, le=1,
+                                    description="When the ControlNet is last applied (% of total steps)")
+    control_mode: CONTROLNET_MODE_VALUES = Field(default="balanced", description="The control mode used")
+    resize_mode: CONTROLNET_RESIZE_VALUES = Field(default="just_resize", description="The resize mode used")
+    # fmt: on
 
-    image: ImageField = InputField(description="The control image")
-    control_model: ControlNetModelField = InputField(
-        default="lllyasviel/sd-controlnet-canny", description=FieldDescriptions.controlnet_model, input=Input.Direct
-    )
-    control_weight: Union[float, List[float]] = InputField(
-        default=1.0, description="The weight given to the ControlNet", ui_type=UIType.Float
-    )
-    begin_step_percent: float = InputField(
-        default=0, ge=-1, le=2, description="When the ControlNet is first applied (% of total steps)"
-    )
-    end_step_percent: float = InputField(
-        default=1, ge=0, le=1, description="When the ControlNet is last applied (% of total steps)"
-    )
-    control_mode: CONTROLNET_MODE_VALUES = InputField(default="balanced", description="The control mode used")
-    resize_mode: CONTROLNET_RESIZE_VALUES = InputField(default="just_resize", description="The resize mode used")
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "ControlNet",
+                "tags": ["controlnet", "latents"],
+                "type_hints": {
+                    "model": "model",
+                    "control": "control",
+                    # "cfg_scale": "float",
+                    "cfg_scale": "number",
+                    "control_weight": "float",
+                }
+            },
+        }
 
     def invoke(self, context: InvocationContext) -> ControlOutput:
         return ControlOutput(
@@ -129,11 +194,22 @@ class ControlNetInvocation(BaseInvocation):
         )
 
 
-@invocation("image_processor", title="Base Image Processor", tags=["controlnet"], category="controlnet")
-class ImageProcessorInvocation(BaseInvocation):
+class ImageProcessorInvocation(BaseInvocation, PILInvocationConfig):
     """Base class for invocations that preprocess images for ControlNet"""
 
-    image: ImageField = InputField(description="The image to process")
+    # fmt: off
+    type: Literal["image_processor"] = "image_processor"
+    # Inputs
+    image: ImageField = Field(default=None, description="The image to process")
+    # fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Image Processor",
+                "tags": ["image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
         # superclass just passes through image without processing
@@ -144,6 +220,11 @@ class ImageProcessorInvocation(BaseInvocation):
         # image type should be PIL.PngImagePlugin.PngImageFile ?
         processed_image = self.run_processor(raw_image)
 
+        # FIXME: what happened to image metadata?
+        # metadata = context.services.metadata.build_metadata(
+        #     session_id=context.graph_execution_state_id, node=self
+        # )
+
         # currently can't see processed image in node UI without a showImage node,
         #    so for now setting image_type to RESULT instead of INTERMEDIATE so will get saved in gallery
         image_dto = context.services.images.create(
@@ -152,8 +233,7 @@ class ImageProcessorInvocation(BaseInvocation):
             image_category=ImageCategory.CONTROL,
             session_id=context.graph_execution_state_id,
             node_id=self.id,
-            is_intermediate=self.is_intermediate,
-            workflow=self.workflow,
+            is_intermediate=self.is_intermediate
         )
 
         """Builds an ImageOutput and its ImageField"""
@@ -168,324 +248,405 @@ class ImageProcessorInvocation(BaseInvocation):
         )
 
 
-@invocation(
-    "canny_image_processor",
-    title="Canny Processor",
-    tags=["controlnet", "canny"],
-    category="controlnet",
-)
-class CannyImageProcessorInvocation(ImageProcessorInvocation):
+class CannyImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Canny edge detection for ControlNet"""
+    # fmt: off
+    type: Literal["canny_image_processor"] = "canny_image_processor"
+    # Input
+    low_threshold: int = Field(default=100, ge=0, le=255, description="The low threshold of the Canny pixel gradient (0-255)")
+    high_threshold: int = Field(default=200, ge=0, le=255, description="The high threshold of the Canny pixel gradient (0-255)")
+    # fmt: on
 
-    low_threshold: int = InputField(
-        default=100, ge=0, le=255, description="The low threshold of the Canny pixel gradient (0-255)"
-    )
-    high_threshold: int = InputField(
-        default=200, ge=0, le=255, description="The high threshold of the Canny pixel gradient (0-255)"
-    )
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Canny Processor",
+                "tags": ["controlnet", "canny", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
         canny_processor = CannyDetector()
-        processed_image = canny_processor(image, self.low_threshold, self.high_threshold)
+        processed_image = canny_processor(
+            image, self.low_threshold, self.high_threshold)
         return processed_image
 
 
-@invocation(
-    "hed_image_processor",
-    title="HED (softedge) Processor",
-    tags=["controlnet", "hed", "softedge"],
-    category="controlnet",
-)
-class HedImageProcessorInvocation(ImageProcessorInvocation):
+class HedImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies HED edge detection to image"""
-
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
+    # fmt: off
+    type: Literal["hed_image_processor"] = "hed_image_processor"
+    # Inputs
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
     # safe not supported in controlnet_aux v0.0.3
-    # safe: bool = InputField(default=False, description=FieldDescriptions.safe_mode)
-    scribble: bool = InputField(default=False, description=FieldDescriptions.scribble_mode)
+    # safe: bool = Field(default=False, description="whether to use safe mode")
+    scribble: bool = Field(default=False, description="Whether to use scribble mode")
+    # fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Softedge(HED) Processor",
+                "tags": ["controlnet", "softedge", "hed", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
         hed_processor = HEDdetector.from_pretrained("lllyasviel/Annotators")
-        processed_image = hed_processor(
-            image,
-            detect_resolution=self.detect_resolution,
-            image_resolution=self.image_resolution,
-            # safe not supported in controlnet_aux v0.0.3
-            # safe=self.safe,
-            scribble=self.scribble,
-        )
+        processed_image = hed_processor(image,
+                                        detect_resolution=self.detect_resolution,
+                                        image_resolution=self.image_resolution,
+                                        # safe not supported in controlnet_aux v0.0.3
+                                        # safe=self.safe,
+                                        scribble=self.scribble,
+                                        )
         return processed_image
 
 
-@invocation(
-    "lineart_image_processor",
-    title="Lineart Processor",
-    tags=["controlnet", "lineart"],
-    category="controlnet",
-)
-class LineartImageProcessorInvocation(ImageProcessorInvocation):
+class LineartImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies line art processing to image"""
+    # fmt: off
+    type: Literal["lineart_image_processor"] = "lineart_image_processor"
+    # Inputs
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
+    coarse: bool = Field(default=False, description="Whether to use coarse mode")
+    # fmt: on
 
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
-    coarse: bool = InputField(default=False, description="Whether to use coarse mode")
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Lineart Processor",
+                "tags": ["controlnet", "lineart", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
-        lineart_processor = LineartDetector.from_pretrained("lllyasviel/Annotators")
+        lineart_processor = LineartDetector.from_pretrained(
+            "lllyasviel/Annotators")
         processed_image = lineart_processor(
-            image, detect_resolution=self.detect_resolution, image_resolution=self.image_resolution, coarse=self.coarse
-        )
+            image, detect_resolution=self.detect_resolution,
+            image_resolution=self.image_resolution, coarse=self.coarse)
         return processed_image
 
 
-@invocation(
-    "lineart_anime_image_processor",
-    title="Lineart Anime Processor",
-    tags=["controlnet", "lineart", "anime"],
-    category="controlnet",
-)
-class LineartAnimeImageProcessorInvocation(ImageProcessorInvocation):
+class LineartAnimeImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies line art anime processing to image"""
+    # fmt: off
+    type: Literal["lineart_anime_image_processor"] = "lineart_anime_image_processor"
+    # Inputs
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
+    # fmt: on
 
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Lineart Anime Processor",
+                "tags": ["controlnet", "lineart", "anime", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
-        processor = LineartAnimeDetector.from_pretrained("lllyasviel/Annotators")
-        processed_image = processor(
-            image,
-            detect_resolution=self.detect_resolution,
-            image_resolution=self.image_resolution,
-        )
+        processor = LineartAnimeDetector.from_pretrained(
+            "lllyasviel/Annotators")
+        processed_image = processor(image,
+                                    detect_resolution=self.detect_resolution,
+                                    image_resolution=self.image_resolution,
+                                    )
         return processed_image
 
 
-@invocation(
-    "openpose_image_processor",
-    title="Openpose Processor",
-    tags=["controlnet", "openpose", "pose"],
-    category="controlnet",
-)
-class OpenposeImageProcessorInvocation(ImageProcessorInvocation):
+class OpenposeImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies Openpose processing to image"""
+    # fmt: off
+    type: Literal["openpose_image_processor"] = "openpose_image_processor"
+    # Inputs
+    hand_and_face: bool = Field(default=False, description="Whether to use hands and face mode")
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
+    # fmt: on
 
-    hand_and_face: bool = InputField(default=False, description="Whether to use hands and face mode")
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Openpose Processor",
+                "tags": ["controlnet", "openpose", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
-        openpose_processor = OpenposeDetector.from_pretrained("lllyasviel/Annotators")
+        openpose_processor = OpenposeDetector.from_pretrained(
+            "lllyasviel/Annotators")
         processed_image = openpose_processor(
-            image,
-            detect_resolution=self.detect_resolution,
+            image, detect_resolution=self.detect_resolution,
             image_resolution=self.image_resolution,
-            hand_and_face=self.hand_and_face,
-        )
+            hand_and_face=self.hand_and_face,)
         return processed_image
 
 
-@invocation(
-    "midas_depth_image_processor",
-    title="Midas Depth Processor",
-    tags=["controlnet", "midas"],
-    category="controlnet",
-)
-class MidasDepthImageProcessorInvocation(ImageProcessorInvocation):
+class MidasDepthImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies Midas depth processing to image"""
-
-    a_mult: float = InputField(default=2.0, ge=0, description="Midas parameter `a_mult` (a = a_mult * PI)")
-    bg_th: float = InputField(default=0.1, ge=0, description="Midas parameter `bg_th`")
+    # fmt: off
+    type: Literal["midas_depth_image_processor"] = "midas_depth_image_processor"
+    # Inputs
+    a_mult: float = Field(default=2.0, ge=0, description="Midas parameter `a_mult` (a = a_mult * PI)")
+    bg_th: float = Field(default=0.1, ge=0, description="Midas parameter `bg_th`")
     # depth_and_normal not supported in controlnet_aux v0.0.3
-    # depth_and_normal: bool = InputField(default=False, description="whether to use depth and normal mode")
+    # depth_and_normal: bool = Field(default=False, description="whether to use depth and normal mode")
+    # fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Midas (Depth) Processor",
+                "tags": ["controlnet", "midas", "depth", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
         midas_processor = MidasDetector.from_pretrained("lllyasviel/Annotators")
-        processed_image = midas_processor(
-            image,
-            a=np.pi * self.a_mult,
-            bg_th=self.bg_th,
-            # dept_and_normal not supported in controlnet_aux v0.0.3
-            # depth_and_normal=self.depth_and_normal,
-        )
+        processed_image = midas_processor(image,
+                                          a=np.pi * self.a_mult,
+                                          bg_th=self.bg_th,
+                                          # dept_and_normal not supported in controlnet_aux v0.0.3
+                                          # depth_and_normal=self.depth_and_normal,
+                                          )
         return processed_image
 
 
-@invocation(
-    "normalbae_image_processor",
-    title="Normal BAE Processor",
-    tags=["controlnet"],
-    category="controlnet",
-)
-class NormalbaeImageProcessorInvocation(ImageProcessorInvocation):
+class NormalbaeImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies NormalBae processing to image"""
+    # fmt: off
+    type: Literal["normalbae_image_processor"] = "normalbae_image_processor"
+    # Inputs
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
+    # fmt: on
 
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Normal BAE Processor",
+                "tags": ["controlnet", "normal", "bae", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
-        normalbae_processor = NormalBaeDetector.from_pretrained("lllyasviel/Annotators")
+        normalbae_processor = NormalBaeDetector.from_pretrained(
+            "lllyasviel/Annotators")
         processed_image = normalbae_processor(
-            image, detect_resolution=self.detect_resolution, image_resolution=self.image_resolution
-        )
+            image, detect_resolution=self.detect_resolution,
+            image_resolution=self.image_resolution)
         return processed_image
 
 
-@invocation("mlsd_image_processor", title="MLSD Processor", tags=["controlnet", "mlsd"], category="controlnet")
-class MlsdImageProcessorInvocation(ImageProcessorInvocation):
+class MlsdImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies MLSD processing to image"""
+    # fmt: off
+    type: Literal["mlsd_image_processor"] = "mlsd_image_processor"
+    # Inputs
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
+    thr_v: float = Field(default=0.1, ge=0, description="MLSD parameter `thr_v`")
+    thr_d: float = Field(default=0.1, ge=0, description="MLSD parameter `thr_d`")
+    # fmt: on
 
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
-    thr_v: float = InputField(default=0.1, ge=0, description="MLSD parameter `thr_v`")
-    thr_d: float = InputField(default=0.1, ge=0, description="MLSD parameter `thr_d`")
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "MLSD Processor",
+                "tags": ["controlnet", "mlsd", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
         mlsd_processor = MLSDdetector.from_pretrained("lllyasviel/Annotators")
         processed_image = mlsd_processor(
-            image,
-            detect_resolution=self.detect_resolution,
-            image_resolution=self.image_resolution,
-            thr_v=self.thr_v,
-            thr_d=self.thr_d,
-        )
+            image, detect_resolution=self.detect_resolution,
+            image_resolution=self.image_resolution, thr_v=self.thr_v,
+            thr_d=self.thr_d)
         return processed_image
 
 
-@invocation("pidi_image_processor", title="PIDI Processor", tags=["controlnet", "pidi"], category="controlnet")
-class PidiImageProcessorInvocation(ImageProcessorInvocation):
+class PidiImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies PIDI processing to image"""
+    # fmt: off
+    type: Literal["pidi_image_processor"] = "pidi_image_processor"
+    # Inputs
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
+    safe: bool = Field(default=False, description="Whether to use safe mode")
+    scribble: bool = Field(default=False, description="Whether to use scribble mode")
+    # fmt: on
 
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
-    safe: bool = InputField(default=False, description=FieldDescriptions.safe_mode)
-    scribble: bool = InputField(default=False, description=FieldDescriptions.scribble_mode)
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "PIDI Processor",
+                "tags": ["controlnet", "pidi", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
-        pidi_processor = PidiNetDetector.from_pretrained("lllyasviel/Annotators")
+        pidi_processor = PidiNetDetector.from_pretrained(
+            "lllyasviel/Annotators")
         processed_image = pidi_processor(
-            image,
-            detect_resolution=self.detect_resolution,
-            image_resolution=self.image_resolution,
-            safe=self.safe,
-            scribble=self.scribble,
-        )
+            image, detect_resolution=self.detect_resolution,
+            image_resolution=self.image_resolution, safe=self.safe,
+            scribble=self.scribble)
         return processed_image
 
 
-@invocation(
-    "content_shuffle_image_processor",
-    title="Content Shuffle Processor",
-    tags=["controlnet", "contentshuffle"],
-    category="controlnet",
-)
-class ContentShuffleImageProcessorInvocation(ImageProcessorInvocation):
+class ContentShuffleImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies content shuffle processing to image"""
+    # fmt: off
+    type: Literal["content_shuffle_image_processor"] = "content_shuffle_image_processor"
+    # Inputs
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
+    h: Optional[int] = Field(default=512, ge=0, description="Content shuffle `h` parameter")
+    w: Optional[int] = Field(default=512, ge=0, description="Content shuffle `w` parameter")
+    f: Optional[int] = Field(default=256, ge=0, description="Content shuffle `f` parameter")
+    # fmt: on
 
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
-    h: Optional[int] = InputField(default=512, ge=0, description="Content shuffle `h` parameter")
-    w: Optional[int] = InputField(default=512, ge=0, description="Content shuffle `w` parameter")
-    f: Optional[int] = InputField(default=256, ge=0, description="Content shuffle `f` parameter")
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Content Shuffle Processor",
+                "tags": ["controlnet", "contentshuffle", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
         content_shuffle_processor = ContentShuffleDetector()
-        processed_image = content_shuffle_processor(
-            image,
-            detect_resolution=self.detect_resolution,
-            image_resolution=self.image_resolution,
-            h=self.h,
-            w=self.w,
-            f=self.f,
-        )
+        processed_image = content_shuffle_processor(image,
+                                                    detect_resolution=self.detect_resolution,
+                                                    image_resolution=self.image_resolution,
+                                                    h=self.h,
+                                                    w=self.w,
+                                                    f=self.f
+                                                    )
         return processed_image
 
 
 # should work with controlnet_aux >= 0.0.4 and timm <= 0.6.13
-@invocation(
-    "zoe_depth_image_processor",
-    title="Zoe (Depth) Processor",
-    tags=["controlnet", "zoe", "depth"],
-    category="controlnet",
-)
-class ZoeDepthImageProcessorInvocation(ImageProcessorInvocation):
+class ZoeDepthImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies Zoe depth processing to image"""
+    # fmt: off
+    type: Literal["zoe_depth_image_processor"] = "zoe_depth_image_processor"
+    # fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Zoe (Depth) Processor",
+                "tags": ["controlnet", "zoe", "depth", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
-        zoe_depth_processor = ZoeDetector.from_pretrained("lllyasviel/Annotators")
+        zoe_depth_processor = ZoeDetector.from_pretrained(
+            "lllyasviel/Annotators")
         processed_image = zoe_depth_processor(image)
         return processed_image
 
 
-@invocation(
-    "mediapipe_face_processor",
-    title="Mediapipe Face Processor",
-    tags=["controlnet", "mediapipe", "face"],
-    category="controlnet",
-)
-class MediapipeFaceProcessorInvocation(ImageProcessorInvocation):
+class MediapipeFaceProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies mediapipe face processing to image"""
+    # fmt: off
+    type: Literal["mediapipe_face_processor"] = "mediapipe_face_processor"
+    # Inputs
+    max_faces: int = Field(default=1, ge=1, description="Maximum number of faces to detect")
+    min_confidence: float = Field(default=0.5, ge=0, le=1, description="Minimum confidence for face detection")
+    # fmt: on
 
-    max_faces: int = InputField(default=1, ge=1, description="Maximum number of faces to detect")
-    min_confidence: float = InputField(default=0.5, ge=0, le=1, description="Minimum confidence for face detection")
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Mediapipe Processor",
+                "tags": ["controlnet", "mediapipe", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
         # MediaPipeFaceDetector throws an error if image has alpha channel
         #     so convert to RGB if needed
-        if image.mode == "RGBA":
-            image = image.convert("RGB")
+        if image.mode == 'RGBA':
+            image = image.convert('RGB')
         mediapipe_face_processor = MediapipeFaceDetector()
-        processed_image = mediapipe_face_processor(image, max_faces=self.max_faces, min_confidence=self.min_confidence)
+        processed_image = mediapipe_face_processor(
+            image, max_faces=self.max_faces, min_confidence=self.min_confidence)
         return processed_image
 
 
-@invocation(
-    "leres_image_processor",
-    title="Leres (Depth) Processor",
-    tags=["controlnet", "leres", "depth"],
-    category="controlnet",
-)
-class LeresImageProcessorInvocation(ImageProcessorInvocation):
+class LeresImageProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies leres processing to image"""
+    # fmt: off
+    type: Literal["leres_image_processor"] = "leres_image_processor"
+    # Inputs
+    thr_a: float = Field(default=0, description="Leres parameter `thr_a`")
+    thr_b: float = Field(default=0, description="Leres parameter `thr_b`")
+    boost: bool = Field(default=False, description="Whether to use boost mode")
+    detect_resolution: int = Field(default=512, ge=0, description="The pixel resolution for detection")
+    image_resolution: int = Field(default=512, ge=0, description="The pixel resolution for the output image")
+    # fmt: on
 
-    thr_a: float = InputField(default=0, description="Leres parameter `thr_a`")
-    thr_b: float = InputField(default=0, description="Leres parameter `thr_b`")
-    boost: bool = InputField(default=False, description="Whether to use boost mode")
-    detect_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.detect_res)
-    image_resolution: int = InputField(default=512, ge=0, description=FieldDescriptions.image_res)
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Leres (Depth) Processor",
+                "tags": ["controlnet", "leres", "depth", "image", "processor"]
+            },
+        }
 
     def run_processor(self, image):
         leres_processor = LeresDetector.from_pretrained("lllyasviel/Annotators")
         processed_image = leres_processor(
-            image,
-            thr_a=self.thr_a,
-            thr_b=self.thr_b,
-            boost=self.boost,
+            image, thr_a=self.thr_a, thr_b=self.thr_b, boost=self.boost,
             detect_resolution=self.detect_resolution,
-            image_resolution=self.image_resolution,
-        )
+            image_resolution=self.image_resolution)
         return processed_image
 
 
-@invocation(
-    "tile_image_processor",
-    title="Tile Resample Processor",
-    tags=["controlnet", "tile"],
-    category="controlnet",
-)
-class TileResamplerProcessorInvocation(ImageProcessorInvocation):
-    """Tile resampler processor"""
+class TileResamplerProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
 
-    # res: int = InputField(default=512, ge=0, le=1024, description="The pixel resolution for each tile")
-    down_sampling_rate: float = InputField(default=1.0, ge=1.0, le=8.0, description="Down sampling rate")
+    # fmt: off
+    type: Literal["tile_image_processor"] = "tile_image_processor"
+    # Inputs
+    #res: int = Field(default=512, ge=0, le=1024, description="The pixel resolution for each tile")
+    down_sampling_rate: float = Field(default=1.0, ge=1.0, le=8.0, description="Down sampling rate")
+    # fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Tile Resample Processor",
+                "tags": ["controlnet", "tile", "resample", "image", "processor"]
+            },
+        }
 
     # tile_resample copied from sd-webui-controlnet/scripts/processor.py
-    def tile_resample(
-        self,
-        np_img: np.ndarray,
-        res=512,  # never used?
-        down_sampling_rate=1.0,
-    ):
+    def tile_resample(self,
+                      np_img: np.ndarray,
+                      res=512,   # never used?
+                      down_sampling_rate=1.0,
+                      ):
         np_img = HWC3(np_img)
         if down_sampling_rate < 1.1:
             return np_img
@@ -497,35 +658,36 @@ class TileResamplerProcessorInvocation(ImageProcessorInvocation):
 
     def run_processor(self, img):
         np_img = np.array(img, dtype=np.uint8)
-        processed_np_image = self.tile_resample(
-            np_img,
-            # res=self.tile_size,
-            down_sampling_rate=self.down_sampling_rate,
-        )
+        processed_np_image = self.tile_resample(np_img,
+                                                # res=self.tile_size,
+                                                down_sampling_rate=self.down_sampling_rate
+                                                )
         processed_image = Image.fromarray(processed_np_image)
         return processed_image
 
 
-@invocation(
-    "segment_anything_processor",
-    title="Segment Anything Processor",
-    tags=["controlnet", "segmentanything"],
-    category="controlnet",
-)
-class SegmentAnythingProcessorInvocation(ImageProcessorInvocation):
+class SegmentAnythingProcessorInvocation(
+        ImageProcessorInvocation, PILInvocationConfig):
     """Applies segment anything processing to image"""
+    # fmt: off
+    type: Literal["segment_anything_processor"] = "segment_anything_processor"
+    # fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {"ui": {"title": "Segment Anything Processor", "tags": [
+            "controlnet", "segment", "anything", "sam", "image", "processor"]}, }
 
     def run_processor(self, image):
         # segment_anything_processor = SamDetector.from_pretrained("ybelkada/segment-anything", subfolder="checkpoints")
         segment_anything_processor = SamDetectorReproducibleColors.from_pretrained(
-            "ybelkada/segment-anything", subfolder="checkpoints"
-        )
+            "ybelkada/segment-anything", subfolder="checkpoints")
         np_img = np.array(image, dtype=np.uint8)
         processed_image = segment_anything_processor(np_img)
         return processed_image
 
 
 class SamDetectorReproducibleColors(SamDetector):
+
     # overriding SamDetector.show_anns() method to use reproducible colors for segmentation image
     #     base class show_anns() method randomizes colors,
     #     which seems to also lead to non-reproducible image generation
@@ -533,15 +695,19 @@ class SamDetectorReproducibleColors(SamDetector):
     def show_anns(self, anns: List[Dict]):
         if len(anns) == 0:
             return
-        sorted_anns = sorted(anns, key=(lambda x: x["area"]), reverse=True)
-        h, w = anns[0]["segmentation"].shape
-        final_img = Image.fromarray(np.zeros((h, w, 3), dtype=np.uint8), mode="RGB")
+        sorted_anns = sorted(anns, key=(lambda x: x['area']), reverse=True)
+        h, w = anns[0]['segmentation'].shape
+        final_img = Image.fromarray(
+            np.zeros((h, w, 3), dtype=np.uint8), mode="RGB")
         palette = ade_palette()
         for i, ann in enumerate(sorted_anns):
-            m = ann["segmentation"]
+            m = ann['segmentation']
             img = np.empty((m.shape[0], m.shape[1], 3), dtype=np.uint8)
             # doing modulo just in case number of annotated regions exceeds number of colors in palette
             ann_color = palette[i % len(palette)]
             img[:, :] = ann_color
-            final_img.paste(Image.fromarray(img, mode="RGB"), (0, 0), Image.fromarray(np.uint8(m * 255)))
+            final_img.paste(
+                Image.fromarray(img, mode="RGB"),
+                (0, 0),
+                Image.fromarray(np.uint8(m * 255)))
         return np.array(final_img, dtype=np.uint8)

invokeai/app/invocations/cv.py

@@ -1,26 +1,47 @@
 # Copyright (c) 2022 Kyle Schouviller (https://github.com/kyle0654)
 
+from typing import Literal
 
 import cv2 as cv
 import numpy
 from PIL import Image, ImageOps
-from invokeai.app.invocations.primitives import ImageField, ImageOutput
+from pydantic import BaseModel, Field
 
-from invokeai.app.models.image import ImageCategory, ResourceOrigin
-from .baseinvocation import BaseInvocation, InputField, InvocationContext, invocation
+from invokeai.app.models.image import ImageCategory, ImageField, ResourceOrigin
+from .baseinvocation import BaseInvocation, InvocationContext, InvocationConfig
+from .image import ImageOutput
 
 
-@invocation(
-    "cv_inpaint",
-    title="OpenCV Inpaint",
-    tags=["opencv", "inpaint"],
-    category="inpaint",
-)
-class CvInpaintInvocation(BaseInvocation):
+class CvInvocationConfig(BaseModel):
+    """Helper class to provide all OpenCV invocations with additional config"""
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "tags": ["cv", "image"],
+            },
+        }
+
+
+class CvInpaintInvocation(BaseInvocation, CvInvocationConfig):
     """Simple inpaint using opencv."""
 
-    image: ImageField = InputField(description="The image to inpaint")
-    mask: ImageField = InputField(description="The mask to use when inpainting")
+    # fmt: off
+    type: Literal["cv_inpaint"] = "cv_inpaint"
+
+    # Inputs
+    image: ImageField = Field(default=None, description="The image to inpaint")
+    mask: ImageField = Field(default=None, description="The mask to use when inpainting")
+    # fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "OpenCV Inpaint",
+                "tags": ["opencv", "inpaint"]
+            },
+        }
 
     def invoke(self, context: InvocationContext) -> ImageOutput:
         image = context.services.images.get_pil_image(self.image.image_name)
@@ -45,7 +66,6 @@ class CvInpaintInvocation(BaseInvocation):
             node_id=self.id,
             session_id=context.graph_execution_state_id,
             is_intermediate=self.is_intermediate,
-            workflow=self.workflow,
         )
 
         return ImageOutput(

invokeai/app/invocations/generate.py

@@ -0,0 +1,254 @@
+# Copyright (c) 2022 Kyle Schouviller (https://github.com/kyle0654)
+
+from functools import partial
+from typing import Literal, Optional, get_args
+
+import torch
+from pydantic import Field
+
+from invokeai.app.models.image import (ColorField, ImageCategory, ImageField,
+                                       ResourceOrigin)
+from invokeai.app.util.misc import SEED_MAX, get_random_seed
+from invokeai.backend.generator.inpaint import infill_methods
+
+from ...backend.generator import Inpaint, InvokeAIGenerator
+from ...backend.stable_diffusion import PipelineIntermediateState
+from ..util.step_callback import stable_diffusion_step_callback
+from .baseinvocation import BaseInvocation, InvocationConfig, InvocationContext
+from .image import ImageOutput
+
+from ...backend.model_management.lora import ModelPatcher
+from ...backend.stable_diffusion.diffusers_pipeline import StableDiffusionGeneratorPipeline
+from .model import UNetField, VaeField
+from .compel import ConditioningField
+from contextlib import contextmanager, ExitStack, ContextDecorator
+
+SAMPLER_NAME_VALUES = Literal[tuple(InvokeAIGenerator.schedulers())]
+INFILL_METHODS = Literal[tuple(infill_methods())]
+DEFAULT_INFILL_METHOD = (
+    "patchmatch" if "patchmatch" in get_args(INFILL_METHODS) else "tile"
+)
+
+
+from .latent import get_scheduler
+
+class OldModelContext(ContextDecorator):
+    model: StableDiffusionGeneratorPipeline
+
+    def __init__(self, model):
+        self.model = model
+
+    def __enter__(self):
+        return self.model
+
+    def __exit__(self, *exc):
+        return False
+
+class OldModelInfo:
+    name: str
+    hash: str
+    context: OldModelContext
+
+    def __init__(self, name: str, hash: str, model: StableDiffusionGeneratorPipeline):
+        self.name = name
+        self.hash = hash
+        self.context = OldModelContext(
+            model=model,
+        )
+
+
+class InpaintInvocation(BaseInvocation):
+    """Generates an image using inpaint."""
+
+    type: Literal["inpaint"] = "inpaint"
+
+    positive_conditioning: Optional[ConditioningField] = Field(description="Positive conditioning for generation")
+    negative_conditioning: Optional[ConditioningField] = Field(description="Negative conditioning for generation")
+    seed:        int = Field(ge=0, le=SEED_MAX, description="The seed to use (omit for random)", default_factory=get_random_seed)
+    steps:       int = Field(default=30, gt=0, description="The number of steps to use to generate the image")
+    width:       int = Field(default=512, multiple_of=8, gt=0, description="The width of the resulting image", )
+    height:      int = Field(default=512, multiple_of=8, gt=0, description="The height of the resulting image", )
+    cfg_scale: float = Field(default=7.5, ge=1, description="The Classifier-Free Guidance, higher values may result in a result closer to the prompt", )
+    scheduler: SAMPLER_NAME_VALUES = Field(default="euler", description="The scheduler to use" )
+    unet: UNetField = Field(default=None, description="UNet model")
+    vae: VaeField = Field(default=None, description="Vae model")
+
+    # Inputs
+    image: Optional[ImageField] = Field(description="The input image")
+    strength: float = Field(
+        default=0.75, gt=0, le=1, description="The strength of the original image"
+    )
+    fit: bool = Field(
+        default=True,
+        description="Whether or not the result should be fit to the aspect ratio of the input image",
+    )
+
+    # Inputs
+    mask: Optional[ImageField] = Field(description="The mask")
+    seam_size: int = Field(default=96, ge=1, description="The seam inpaint size (px)")
+    seam_blur: int = Field(
+        default=16, ge=0, description="The seam inpaint blur radius (px)"
+    )
+    seam_strength: float = Field(
+        default=0.75, gt=0, le=1, description="The seam inpaint strength"
+    )
+    seam_steps: int = Field(
+        default=30, ge=1, description="The number of steps to use for seam inpaint"
+    )
+    tile_size: int = Field(
+        default=32, ge=1, description="The tile infill method size (px)"
+    )
+    infill_method: INFILL_METHODS = Field(
+        default=DEFAULT_INFILL_METHOD,
+        description="The method used to infill empty regions (px)",
+    )
+    inpaint_width: Optional[int] = Field(
+        default=None,
+        multiple_of=8,
+        gt=0,
+        description="The width of the inpaint region (px)",
+    )
+    inpaint_height: Optional[int] = Field(
+        default=None,
+        multiple_of=8,
+        gt=0,
+        description="The height of the inpaint region (px)",
+    )
+    inpaint_fill: Optional[ColorField] = Field(
+        default=ColorField(r=127, g=127, b=127, a=255),
+        description="The solid infill method color",
+    )
+    inpaint_replace: float = Field(
+        default=0.0,
+        ge=0.0,
+        le=1.0,
+        description="The amount by which to replace masked areas with latent noise",
+    )
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "tags": ["stable-diffusion", "image"],
+                "title": "Inpaint"
+            },
+        }
+
+    def dispatch_progress(
+        self,
+        context: InvocationContext,
+        source_node_id: str,
+        intermediate_state: PipelineIntermediateState,
+    ) -> None:
+        stable_diffusion_step_callback(
+            context=context,
+            intermediate_state=intermediate_state,
+            node=self.dict(),
+            source_node_id=source_node_id,
+        )
+
+    def get_conditioning(self, context, unet):
+        positive_cond_data = context.services.latents.get(self.positive_conditioning.conditioning_name)
+        c = positive_cond_data.conditionings[0].embeds.to(device=unet.device, dtype=unet.dtype)
+        extra_conditioning_info = positive_cond_data.conditionings[0].extra_conditioning
+
+        negative_cond_data = context.services.latents.get(self.negative_conditioning.conditioning_name)
+        uc = negative_cond_data.conditionings[0].embeds.to(device=unet.device, dtype=unet.dtype)
+
+        return (uc, c, extra_conditioning_info)
+
+    @contextmanager
+    def load_model_old_way(self, context, scheduler):
+        def _lora_loader():
+            for lora in self.unet.loras:
+                lora_info = context.services.model_manager.get_model(
+                    **lora.dict(exclude={"weight"}), context=context,)
+                yield (lora_info.context.model, lora.weight)
+                del lora_info
+            return
+        
+        unet_info = context.services.model_manager.get_model(**self.unet.unet.dict(), context=context,)
+        vae_info = context.services.model_manager.get_model(**self.vae.vae.dict(), context=context,)
+
+        with vae_info as vae,\
+                ModelPatcher.apply_lora_unet(unet_info.context.model, _lora_loader()),\
+                unet_info as unet:
+
+            device = context.services.model_manager.mgr.cache.execution_device
+            dtype = context.services.model_manager.mgr.cache.precision
+
+            pipeline = StableDiffusionGeneratorPipeline(
+                vae=vae,
+                text_encoder=None,
+                tokenizer=None,
+                unet=unet,
+                scheduler=scheduler,
+                safety_checker=None,
+                feature_extractor=None,
+                requires_safety_checker=False,
+                precision="float16" if dtype == torch.float16 else "float32",
+                execution_device=device,
+            )
+
+            yield OldModelInfo(
+                name=self.unet.unet.model_name,
+                hash="<NO-HASH>",
+                model=pipeline,
+            )
+
+    def invoke(self, context: InvocationContext) -> ImageOutput:
+        image = (
+            None
+            if self.image is None
+            else context.services.images.get_pil_image(self.image.image_name)
+        )
+        mask = (
+            None
+            if self.mask is None
+            else context.services.images.get_pil_image(self.mask.image_name)
+        )
+
+        # Get the source node id (we are invoking the prepared node)
+        graph_execution_state = context.services.graph_execution_manager.get(
+            context.graph_execution_state_id
+        )
+        source_node_id = graph_execution_state.prepared_source_mapping[self.id]
+
+        scheduler = get_scheduler(
+            context=context,
+            scheduler_info=self.unet.scheduler,
+            scheduler_name=self.scheduler,
+        )
+
+        with self.load_model_old_way(context, scheduler) as model:
+            conditioning = self.get_conditioning(context, model.context.model.unet)
+
+            outputs = Inpaint(model).generate(
+                conditioning=conditioning,
+                scheduler=scheduler,
+                init_image=image,
+                mask_image=mask,
+                step_callback=partial(self.dispatch_progress, context, source_node_id),
+                **self.dict(
+                    exclude={"positive_conditioning", "negative_conditioning", "scheduler", "image", "mask"}
+                ),  # Shorthand for passing all of the parameters above manually
+            )
+
+            # Outputs is an infinite iterator that will return a new InvokeAIGeneratorOutput object
+            # each time it is called. We only need the first one.
+            generator_output = next(outputs)
+
+            image_dto = context.services.images.create(
+                image=generator_output.image,
+                image_origin=ResourceOrigin.INTERNAL,
+                image_category=ImageCategory.GENERAL,
+                session_id=context.graph_execution_state_id,
+                node_id=self.id,
+                is_intermediate=self.is_intermediate,
+            )
+
+            return ImageOutput(
+                image=ImageField(image_name=image_dto.image_name),
+                width=image_dto.width,
+                height=image_dto.height,
+            )

invokeai/app/invocations/infill.py

@@ -1,25 +1,28 @@
 # Copyright (c) 2022 Kyle Schouviller (https://github.com/kyle0654) and the InvokeAI Team
 
-import math
 from typing import Literal, Optional, get_args
 
 import numpy as np
+import math
 from PIL import Image, ImageOps
+from pydantic import Field
 
-from invokeai.app.invocations.primitives import ColorField, ImageField, ImageOutput
+from invokeai.app.invocations.image import ImageOutput
 from invokeai.app.util.misc import SEED_MAX, get_random_seed
-from invokeai.backend.image_util.lama import LaMA
 from invokeai.backend.image_util.patchmatch import PatchMatch
 
-from ..models.image import ImageCategory, ResourceOrigin
-from .baseinvocation import BaseInvocation, InputField, InvocationContext, invocation
+from ..models.image import ColorField, ImageCategory, ImageField, ResourceOrigin
+from .baseinvocation import (
+    BaseInvocation,
+    InvocationConfig,
+    InvocationContext,
+)
 
 
 def infill_methods() -> list[str]:
     methods = [
         "tile",
         "solid",
-        "lama",
     ]
     if PatchMatch.patchmatch_available():
         methods.insert(0, "patchmatch")
@@ -27,12 +30,9 @@ def infill_methods() -> list[str]:
 
 
 INFILL_METHODS = Literal[tuple(infill_methods())]
-DEFAULT_INFILL_METHOD = "patchmatch" if "patchmatch" in get_args(INFILL_METHODS) else "tile"
-
-
-def infill_lama(im: Image.Image) -> Image.Image:
-    lama = LaMA()
-    return lama(im)
+DEFAULT_INFILL_METHOD = (
+    "patchmatch" if "patchmatch" in get_args(INFILL_METHODS) else "tile"
+)
 
 
 def infill_patchmatch(im: Image.Image) -> Image.Image:
@@ -44,7 +44,9 @@ def infill_patchmatch(im: Image.Image) -> Image.Image:
         return im
 
     # Patchmatch (note, we may want to expose patch_size? Increasing it significantly impacts performance though)
-    im_patched_np = PatchMatch.inpaint(im.convert("RGB"), ImageOps.invert(im.split()[-1]), patch_size=3)
+    im_patched_np = PatchMatch.inpaint(
+        im.convert("RGB"), ImageOps.invert(im.split()[-1]), patch_size=3
+    )
     im_patched = Image.fromarray(im_patched_np, mode="RGB")
     return im_patched
 
@@ -66,7 +68,9 @@ def get_tile_images(image: np.ndarray, width=8, height=8):
     )
 
 
-def tile_fill_missing(im: Image.Image, tile_size: int = 16, seed: Optional[int] = None) -> Image.Image:
+def tile_fill_missing(
+    im: Image.Image, tile_size: int = 16, seed: Optional[int] = None
+) -> Image.Image:
     # Only fill if there's an alpha layer
     if im.mode != "RGBA":
         return im
@@ -97,9 +101,11 @@ def tile_fill_missing(im: Image.Image, tile_size: int = 16, seed: Optional[int]
         return im
 
     # Find all invalid tiles and replace with a random valid tile
-    replace_count = (tiles_mask == False).sum()  # noqa: E712
+    replace_count = (tiles_mask == False).sum()
     rng = np.random.default_rng(seed=seed)
-    tiles_all[np.logical_not(tiles_mask)] = filtered_tiles[rng.choice(filtered_tiles.shape[0], replace_count), :, :, :]
+    tiles_all[np.logical_not(tiles_mask)] = filtered_tiles[
+        rng.choice(filtered_tiles.shape[0], replace_count), :, :, :
+    ]
 
     # Convert back to an image
     tiles_all = tiles_all.reshape(tshape)
@@ -116,16 +122,26 @@ def tile_fill_missing(im: Image.Image, tile_size: int = 16, seed: Optional[int]
     return si
 
 
-@invocation("infill_rgba", title="Solid Color Infill", tags=["image", "inpaint"], category="inpaint")
 class InfillColorInvocation(BaseInvocation):
     """Infills transparent areas of an image with a solid color"""
 
-    image: ImageField = InputField(description="The image to infill")
-    color: ColorField = InputField(
+    type: Literal["infill_rgba"] = "infill_rgba"
+    image: Optional[ImageField] = Field(
+        default=None, description="The image to infill"
+    )
+    color: ColorField = Field(
         default=ColorField(r=127, g=127, b=127, a=255),
         description="The color to use to infill",
     )
 
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Color Infill",
+                "tags": ["image", "inpaint", "color", "infill"]
+            },
+        }
+
     def invoke(self, context: InvocationContext) -> ImageOutput:
         image = context.services.images.get_pil_image(self.image.image_name)
 
@@ -141,7 +157,6 @@ class InfillColorInvocation(BaseInvocation):
             node_id=self.id,
             session_id=context.graph_execution_state_id,
             is_intermediate=self.is_intermediate,
-            workflow=self.workflow,
         )
 
         return ImageOutput(
@@ -151,23 +166,36 @@ class InfillColorInvocation(BaseInvocation):
         )
 
 
-@invocation("infill_tile", title="Tile Infill", tags=["image", "inpaint"], category="inpaint")
 class InfillTileInvocation(BaseInvocation):
     """Infills transparent areas of an image with tiles of the image"""
 
-    image: ImageField = InputField(description="The image to infill")
-    tile_size: int = InputField(default=32, ge=1, description="The tile size (px)")
-    seed: int = InputField(
+    type: Literal["infill_tile"] = "infill_tile"
+
+    image: Optional[ImageField] = Field(
+        default=None, description="The image to infill"
+    )
+    tile_size: int = Field(default=32, ge=1, description="The tile size (px)")
+    seed: int = Field(
         ge=0,
         le=SEED_MAX,
         description="The seed to use for tile generation (omit for random)",
         default_factory=get_random_seed,
     )
 
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Tile Infill",
+                "tags": ["image", "inpaint", "tile", "infill"]
+            },
+        }
+
     def invoke(self, context: InvocationContext) -> ImageOutput:
         image = context.services.images.get_pil_image(self.image.image_name)
 
-        infilled = tile_fill_missing(image.copy(), seed=self.seed, tile_size=self.tile_size)
+        infilled = tile_fill_missing(
+            image.copy(), seed=self.seed, tile_size=self.tile_size
+        )
         infilled.paste(image, (0, 0), image.split()[-1])
 
         image_dto = context.services.images.create(
@@ -177,7 +205,6 @@ class InfillTileInvocation(BaseInvocation):
             node_id=self.id,
             session_id=context.graph_execution_state_id,
             is_intermediate=self.is_intermediate,
-            workflow=self.workflow,
         )
 
         return ImageOutput(
@@ -187,11 +214,22 @@ class InfillTileInvocation(BaseInvocation):
         )
 
 
-@invocation("infill_patchmatch", title="PatchMatch Infill", tags=["image", "inpaint"], category="inpaint")
 class InfillPatchMatchInvocation(BaseInvocation):
     """Infills transparent areas of an image using the PatchMatch algorithm"""
 
-    image: ImageField = InputField(description="The image to infill")
+    type: Literal["infill_patchmatch"] = "infill_patchmatch"
+
+    image: Optional[ImageField] = Field(
+        default=None, description="The image to infill"
+    )
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Patch Match Infill",
+                "tags": ["image", "inpaint", "patchmatch", "infill"]
+            },
+        }
 
     def invoke(self, context: InvocationContext) -> ImageOutput:
         image = context.services.images.get_pil_image(self.image.image_name)
@@ -201,34 +239,6 @@ class InfillPatchMatchInvocation(BaseInvocation):
         else:
             raise ValueError("PatchMatch is not available on this system")
 
-        image_dto = context.services.images.create(
-            image=infilled,
-            image_origin=ResourceOrigin.INTERNAL,
-            image_category=ImageCategory.GENERAL,
-            node_id=self.id,
-            session_id=context.graph_execution_state_id,
-            is_intermediate=self.is_intermediate,
-            workflow=self.workflow,
-        )
-
-        return ImageOutput(
-            image=ImageField(image_name=image_dto.image_name),
-            width=image_dto.width,
-            height=image_dto.height,
-        )
-
-
-@invocation("infill_lama", title="LaMa Infill", tags=["image", "inpaint"], category="inpaint")
-class LaMaInfillInvocation(BaseInvocation):
-    """Infills transparent areas of an image using the LaMa model"""
-
-    image: ImageField = InputField(description="The image to infill")
-
-    def invoke(self, context: InvocationContext) -> ImageOutput:
-        image = context.services.images.get_pil_image(self.image.image_name)
-
-        infilled = infill_lama(image.copy())
-
         image_dto = context.services.images.create(
             image=infilled,
             image_origin=ResourceOrigin.INTERNAL,

invokeai/app/invocations/math.py

@@ -1,62 +1,150 @@
 # Copyright (c) 2023 Kyle Schouviller (https://github.com/kyle0654)
 
+from typing import Literal
+
+from pydantic import BaseModel, Field
 import numpy as np
 
-from invokeai.app.invocations.primitives import IntegerOutput
-
-from .baseinvocation import BaseInvocation, FieldDescriptions, InputField, InvocationContext, invocation
+from .baseinvocation import (
+    BaseInvocation,
+    BaseInvocationOutput,
+    InvocationContext,
+    InvocationConfig,
+)
 
 
-@invocation("add", title="Add Integers", tags=["math", "add"], category="math")
-class AddInvocation(BaseInvocation):
+class MathInvocationConfig(BaseModel):
+    """Helper class to provide all math invocations with additional config"""
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "tags": ["math"],
+            }
+        }
+
+
+class IntOutput(BaseInvocationOutput):
+    """An integer output"""
+
+    # fmt: off
+    type: Literal["int_output"] = "int_output"
+    a: int = Field(default=None, description="The output integer")
+    # fmt: on
+
+
+class FloatOutput(BaseInvocationOutput):
+    """A float output"""
+
+    # fmt: off
+    type: Literal["float_output"] = "float_output"
+    param: float = Field(default=None, description="The output float")
+    # fmt: on
+
+
+class AddInvocation(BaseInvocation, MathInvocationConfig):
     """Adds two numbers"""
 
-    a: int = InputField(default=0, description=FieldDescriptions.num_1)
-    b: int = InputField(default=0, description=FieldDescriptions.num_2)
+    # fmt: off
+    type: Literal["add"] = "add"
+    a: int = Field(default=0, description="The first number")
+    b: int = Field(default=0, description="The second number")
+    # fmt: on
 
-    def invoke(self, context: InvocationContext) -> IntegerOutput:
-        return IntegerOutput(value=self.a + self.b)
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Add",
+                "tags": ["math", "add"]
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> IntOutput:
+        return IntOutput(a=self.a + self.b)
 
 
-@invocation("sub", title="Subtract Integers", tags=["math", "subtract"], category="math")
-class SubtractInvocation(BaseInvocation):
+class SubtractInvocation(BaseInvocation, MathInvocationConfig):
     """Subtracts two numbers"""
 
-    a: int = InputField(default=0, description=FieldDescriptions.num_1)
-    b: int = InputField(default=0, description=FieldDescriptions.num_2)
+    # fmt: off
+    type: Literal["sub"] = "sub"
+    a: int = Field(default=0, description="The first number")
+    b: int = Field(default=0, description="The second number")
+    # fmt: on
 
-    def invoke(self, context: InvocationContext) -> IntegerOutput:
-        return IntegerOutput(value=self.a - self.b)
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Subtract",
+                "tags": ["math", "subtract"]
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> IntOutput:
+        return IntOutput(a=self.a - self.b)
 
 
-@invocation("mul", title="Multiply Integers", tags=["math", "multiply"], category="math")
-class MultiplyInvocation(BaseInvocation):
+class MultiplyInvocation(BaseInvocation, MathInvocationConfig):
     """Multiplies two numbers"""
 
-    a: int = InputField(default=0, description=FieldDescriptions.num_1)
-    b: int = InputField(default=0, description=FieldDescriptions.num_2)
+    # fmt: off
+    type: Literal["mul"] = "mul"
+    a: int = Field(default=0, description="The first number")
+    b: int = Field(default=0, description="The second number")
+    # fmt: on
 
-    def invoke(self, context: InvocationContext) -> IntegerOutput:
-        return IntegerOutput(value=self.a * self.b)
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Multiply",
+                "tags": ["math", "multiply"]
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> IntOutput:
+        return IntOutput(a=self.a * self.b)
 
 
-@invocation("div", title="Divide Integers", tags=["math", "divide"], category="math")
-class DivideInvocation(BaseInvocation):
+class DivideInvocation(BaseInvocation, MathInvocationConfig):
     """Divides two numbers"""
 
-    a: int = InputField(default=0, description=FieldDescriptions.num_1)
-    b: int = InputField(default=0, description=FieldDescriptions.num_2)
+    # fmt: off
+    type: Literal["div"] = "div"
+    a: int = Field(default=0, description="The first number")
+    b: int = Field(default=0, description="The second number")
+    # fmt: on
 
-    def invoke(self, context: InvocationContext) -> IntegerOutput:
-        return IntegerOutput(value=int(self.a / self.b))
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Divide",
+                "tags": ["math", "divide"]
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> IntOutput:
+        return IntOutput(a=int(self.a / self.b))
 
 
-@invocation("rand_int", title="Random Integer", tags=["math", "random"], category="math")
 class RandomIntInvocation(BaseInvocation):
     """Outputs a single random integer."""
 
-    low: int = InputField(default=0, description="The inclusive low value")
-    high: int = InputField(default=np.iinfo(np.int32).max, description="The exclusive high value")
+    # fmt: off
+    type: Literal["rand_int"] = "rand_int"
+    low: int = Field(default=0, description="The inclusive low value")
+    high: int = Field(
+        default=np.iinfo(np.int32).max, description="The exclusive high value"
+    )
+    # fmt: on
 
-    def invoke(self, context: InvocationContext) -> IntegerOutput:
-        return IntegerOutput(value=np.random.randint(self.low, self.high))
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Random Integer",
+                "tags": ["math", "random", "integer"]
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> IntOutput:
+        return IntOutput(a=np.random.randint(self.low, self.high))

invokeai/app/invocations/metadata.py

@@ -1,38 +1,29 @@
-from typing import Optional
+from typing import Literal, Optional, Union
 
-from pydantic import Field
+from pydantic import BaseModel, Field
 
 from invokeai.app.invocations.baseinvocation import (
     BaseInvocation,
     BaseInvocationOutput,
-    InputField,
+    InvocationConfig,
     InvocationContext,
-    OutputField,
-    invocation,
-    invocation_output,
 )
 from invokeai.app.invocations.controlnet_image_processors import ControlField
 from invokeai.app.invocations.model import LoRAModelField, MainModelField, VAEModelField
-from invokeai.app.util.model_exclude_null import BaseModelExcludeNull
 
-from ...version import __version__
-
-
-class LoRAMetadataField(BaseModelExcludeNull):
+class LoRAMetadataField(BaseModel):
     """LoRA metadata for an image generated in InvokeAI."""
 
     lora: LoRAModelField = Field(description="The LoRA model")
     weight: float = Field(description="The weight of the LoRA model")
 
 
-class CoreMetadata(BaseModelExcludeNull):
+class CoreMetadata(BaseModel):
     """Core generation metadata for an image generated in InvokeAI."""
 
-    app_version: str = Field(default=__version__, description="The version of InvokeAI used to generate this image")
     generation_mode: str = Field(
         description="The generation mode that output this image",
     )
-    created_by: Optional[str] = Field(description="The name of the creator of the image")
     positive_prompt: str = Field(description="The positive prompt parameter")
     negative_prompt: str = Field(description="The negative prompt parameter")
     width: int = Field(description="The width parameter")
@@ -46,133 +37,148 @@ class CoreMetadata(BaseModelExcludeNull):
         description="The number of skipped CLIP layers",
     )
     model: MainModelField = Field(description="The main model used for inference")
-    controlnets: list[ControlField] = Field(description="The ControlNets used for inference")
+    controlnets: list[ControlField] = Field(
+        description="The ControlNets used for inference"
+    )
     loras: list[LoRAMetadataField] = Field(description="The LoRAs used for inference")
-    vae: Optional[VAEModelField] = Field(
+    vae: Union[VAEModelField, None] = Field(
         default=None,
         description="The VAE used for decoding, if the main model's default was not used",
     )
 
     # Latents-to-Latents
-    strength: Optional[float] = Field(
+    strength: Union[float, None] = Field(
         default=None,
         description="The strength used for latents-to-latents",
     )
-    init_image: Optional[str] = Field(default=None, description="The name of the initial image")
+    init_image: Union[str, None] = Field(
+        default=None, description="The name of the initial image"
+    )
 
     # SDXL
-    positive_style_prompt: Optional[str] = Field(default=None, description="The positive style prompt parameter")
-    negative_style_prompt: Optional[str] = Field(default=None, description="The negative style prompt parameter")
+    positive_style_prompt: Union[str, None] = Field(
+        default=None, description="The positive style prompt parameter"
+    )
+    negative_style_prompt: Union[str, None] = Field(
+        default=None, description="The negative style prompt parameter"
+    )
 
     # SDXL Refiner
-    refiner_model: Optional[MainModelField] = Field(default=None, description="The SDXL Refiner model used")
-    refiner_cfg_scale: Optional[float] = Field(
+    refiner_model: Union[MainModelField, None] = Field(
+        default=None, description="The SDXL Refiner model used"
+    )
+    refiner_cfg_scale: Union[float, None] = Field(
         default=None,
         description="The classifier-free guidance scale parameter used for the refiner",
     )
-    refiner_steps: Optional[int] = Field(default=None, description="The number of steps used for the refiner")
-    refiner_scheduler: Optional[str] = Field(default=None, description="The scheduler used for the refiner")
-    refiner_positive_aesthetic_store: Optional[float] = Field(
+    refiner_steps: Union[int, None] = Field(
+        default=None, description="The number of steps used for the refiner"
+    )
+    refiner_scheduler: Union[str, None] = Field(
+        default=None, description="The scheduler used for the refiner"
+    )
+    refiner_aesthetic_store: Union[float, None] = Field(
         default=None, description="The aesthetic score used for the refiner"
     )
-    refiner_negative_aesthetic_store: Optional[float] = Field(
-        default=None, description="The aesthetic score used for the refiner"
+    refiner_start: Union[float, None] = Field(
+        default=None, description="The start value used for refiner denoising"
     )
-    refiner_start: Optional[float] = Field(default=None, description="The start value used for refiner denoising")
 
 
-class ImageMetadata(BaseModelExcludeNull):
+class ImageMetadata(BaseModel):
     """An image's generation metadata"""
 
     metadata: Optional[dict] = Field(
         default=None,
         description="The image's core metadata, if it was created in the Linear or Canvas UI",
     )
-    graph: Optional[dict] = Field(default=None, description="The graph that created the image")
+    graph: Optional[dict] = Field(
+        default=None, description="The graph that created the image"
+    )
 
 
-@invocation_output("metadata_accumulator_output")
 class MetadataAccumulatorOutput(BaseInvocationOutput):
     """The output of the MetadataAccumulator node"""
 
-    metadata: CoreMetadata = OutputField(description="The core metadata for the image")
+    type: Literal["metadata_accumulator_output"] = "metadata_accumulator_output"
+
+    metadata: CoreMetadata = Field(description="The core metadata for the image")
 
 
-@invocation("metadata_accumulator", title="Metadata Accumulator", tags=["metadata"], category="metadata")
 class MetadataAccumulatorInvocation(BaseInvocation):
     """Outputs a Core Metadata Object"""
 
-    generation_mode: str = InputField(
+    type: Literal["metadata_accumulator"] = "metadata_accumulator"
+
+    generation_mode: str = Field(
         description="The generation mode that output this image",
     )
-    positive_prompt: str = InputField(description="The positive prompt parameter")
-    negative_prompt: str = InputField(description="The negative prompt parameter")
-    width: int = InputField(description="The width parameter")
-    height: int = InputField(description="The height parameter")
-    seed: int = InputField(description="The seed used for noise generation")
-    rand_device: str = InputField(description="The device used for random number generation")
-    cfg_scale: float = InputField(description="The classifier-free guidance scale parameter")
-    steps: int = InputField(description="The number of steps used for inference")
-    scheduler: str = InputField(description="The scheduler used for inference")
-    clip_skip: int = InputField(
+    positive_prompt: str = Field(description="The positive prompt parameter")
+    negative_prompt: str = Field(description="The negative prompt parameter")
+    width: int = Field(description="The width parameter")
+    height: int = Field(description="The height parameter")
+    seed: int = Field(description="The seed used for noise generation")
+    rand_device: str = Field(description="The device used for random number generation")
+    cfg_scale: float = Field(description="The classifier-free guidance scale parameter")
+    steps: int = Field(description="The number of steps used for inference")
+    scheduler: str = Field(description="The scheduler used for inference")
+    clip_skip: int = Field(
         description="The number of skipped CLIP layers",
     )
-    model: MainModelField = InputField(description="The main model used for inference")
-    controlnets: list[ControlField] = InputField(description="The ControlNets used for inference")
-    loras: list[LoRAMetadataField] = InputField(description="The LoRAs used for inference")
-    strength: Optional[float] = InputField(
+    model: MainModelField = Field(description="The main model used for inference")
+    controlnets: list[ControlField] = Field(
+        description="The ControlNets used for inference"
+    )
+    loras: list[LoRAMetadataField] = Field(description="The LoRAs used for inference")
+    strength: Union[float, None] = Field(
         default=None,
         description="The strength used for latents-to-latents",
     )
-    init_image: Optional[str] = InputField(
-        default=None,
-        description="The name of the initial image",
+    init_image: Union[str, None] = Field(
+        default=None, description="The name of the initial image"
     )
-    vae: Optional[VAEModelField] = InputField(
+    vae: Union[VAEModelField, None] = Field(
         default=None,
         description="The VAE used for decoding, if the main model's default was not used",
     )
 
     # SDXL
-    positive_style_prompt: Optional[str] = InputField(
-        default=None,
-        description="The positive style prompt parameter",
+    positive_style_prompt: Union[str, None] = Field(
+        default=None, description="The positive style prompt parameter"
     )
-    negative_style_prompt: Optional[str] = InputField(
-        default=None,
-        description="The negative style prompt parameter",
+    negative_style_prompt: Union[str, None] = Field(
+        default=None, description="The negative style prompt parameter"
     )
 
     # SDXL Refiner
-    refiner_model: Optional[MainModelField] = InputField(
-        default=None,
-        description="The SDXL Refiner model used",
+    refiner_model: Union[MainModelField, None] = Field(
+        default=None, description="The SDXL Refiner model used"
     )
-    refiner_cfg_scale: Optional[float] = InputField(
+    refiner_cfg_scale: Union[float, None] = Field(
         default=None,
         description="The classifier-free guidance scale parameter used for the refiner",
     )
-    refiner_steps: Optional[int] = InputField(
-        default=None,
-        description="The number of steps used for the refiner",
+    refiner_steps: Union[int, None] = Field(
+        default=None, description="The number of steps used for the refiner"
     )
-    refiner_scheduler: Optional[str] = InputField(
-        default=None,
-        description="The scheduler used for the refiner",
+    refiner_scheduler: Union[str, None] = Field(
+        default=None, description="The scheduler used for the refiner"
     )
-    refiner_positive_aesthetic_store: Optional[float] = InputField(
-        default=None,
-        description="The aesthetic score used for the refiner",
+    refiner_aesthetic_store: Union[float, None] = Field(
+        default=None, description="The aesthetic score used for the refiner"
     )
-    refiner_negative_aesthetic_store: Optional[float] = InputField(
-        default=None,
-        description="The aesthetic score used for the refiner",
-    )
-    refiner_start: Optional[float] = InputField(
-        default=None,
-        description="The start value used for refiner denoising",
+    refiner_start: Union[float, None] = Field(
+        default=None, description="The start value used for refiner denoising"
     )
 
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Metadata Accumulator",
+                "tags": ["image", "metadata", "generation"],
+            },
+        }
+
     def invoke(self, context: InvocationContext) -> MetadataAccumulatorOutput:
         """Collects and outputs a CoreMetadata object"""
 

invokeai/app/invocations/model.py

@@ -1,28 +1,20 @@
 import copy
-from typing import List, Optional
+from typing import List, Literal, Optional, Union
 
 from pydantic import BaseModel, Field
 
 from ...backend.model_management import BaseModelType, ModelType, SubModelType
-from .baseinvocation import (
-    BaseInvocation,
-    BaseInvocationOutput,
-    FieldDescriptions,
-    Input,
-    InputField,
-    InvocationContext,
-    OutputField,
-    UIType,
-    invocation,
-    invocation_output,
-)
+from .baseinvocation import (BaseInvocation, BaseInvocationOutput,
+                             InvocationConfig, InvocationContext)
 
 
 class ModelInfo(BaseModel):
     model_name: str = Field(description="Info to load submodel")
     base_model: BaseModelType = Field(description="Base model")
     model_type: ModelType = Field(description="Info to load submodel")
-    submodel: Optional[SubModelType] = Field(default=None, description="Info to load submodel")
+    submodel: Optional[SubModelType] = Field(
+        default=None, description="Info to load submodel"
+    )
 
 
 class LoraInfo(ModelInfo):
@@ -33,7 +25,6 @@ class UNetField(BaseModel):
     unet: ModelInfo = Field(description="Info to load unet submodel")
     scheduler: ModelInfo = Field(description="Info to load scheduler submodel")
     loras: List[LoraInfo] = Field(description="Loras to apply on model loading")
-    seamless_axes: List[str] = Field(default_factory=list, description='Axes("x" and "y") to which apply seamless')
 
 
 class ClipField(BaseModel):
@@ -42,28 +33,27 @@ class ClipField(BaseModel):
     skipped_layers: int = Field(description="Number of skipped layers in text_encoder")
     loras: List[LoraInfo] = Field(description="Loras to apply on model loading")
 
-
 class VaeField(BaseModel):
     # TODO: better naming?
     vae: ModelInfo = Field(description="Info to load vae submodel")
-    seamless_axes: List[str] = Field(default_factory=list, description='Axes("x" and "y") to which apply seamless')
 
 
-@invocation_output("model_loader_output")
 class ModelLoaderOutput(BaseInvocationOutput):
     """Model loader output"""
 
-    unet: UNetField = OutputField(description=FieldDescriptions.unet, title="UNet")
-    clip: ClipField = OutputField(description=FieldDescriptions.clip, title="CLIP")
-    vae: VaeField = OutputField(description=FieldDescriptions.vae, title="VAE")
+    # fmt: off
+    type: Literal["model_loader_output"] = "model_loader_output"
 
+    unet: UNetField = Field(default=None, description="UNet submodel")
+    clip: ClipField = Field(default=None, description="Tokenizer and text_encoder submodels")
+    vae: VaeField = Field(default=None, description="Vae submodel")
+    # fmt: on
 
 class MainModelField(BaseModel):
     """Main model field"""
 
     model_name: str = Field(description="Name of the model")
     base_model: BaseModelType = Field(description="Base model")
-    model_type: ModelType = Field(description="Model Type")
 
 
 class LoRAModelField(BaseModel):
@@ -72,14 +62,24 @@ class LoRAModelField(BaseModel):
     model_name: str = Field(description="Name of the LoRA model")
     base_model: BaseModelType = Field(description="Base model")
 
-
-@invocation("main_model_loader", title="Main Model", tags=["model"], category="model")
 class MainModelLoaderInvocation(BaseInvocation):
     """Loads a main model, outputting its submodels."""
 
-    model: MainModelField = InputField(description=FieldDescriptions.main_model, input=Input.Direct)
+    type: Literal["main_model_loader"] = "main_model_loader"
+
+    model: MainModelField = Field(description="The model to load")
     # TODO: precision?
 
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Model Loader",
+                "tags": ["model", "loader"],
+                "type_hints": {"model": "model"},
+            },
+        }
+
     def invoke(self, context: InvocationContext) -> ModelLoaderOutput:
         base_model = self.model.base_model
         model_name = self.model.model_name
@@ -154,6 +154,22 @@ class MainModelLoaderInvocation(BaseInvocation):
                 loras=[],
                 skipped_layers=0,
             ),
+            clip2=ClipField(
+                tokenizer=ModelInfo(
+                    model_name=model_name,
+                    base_model=base_model,
+                    model_type=model_type,
+                    submodel=SubModelType.Tokenizer2,
+                ),
+                text_encoder=ModelInfo(
+                    model_name=model_name,
+                    base_model=base_model,
+                    model_type=model_type,
+                    submodel=SubModelType.TextEncoder2,
+                ),
+                loras=[],
+                skipped_layers=0,
+            ),
             vae=VaeField(
                 vae=ModelInfo(
                     model_name=model_name,
@@ -164,27 +180,39 @@ class MainModelLoaderInvocation(BaseInvocation):
             ),
         )
 
-
-@invocation_output("lora_loader_output")
+    
 class LoraLoaderOutput(BaseInvocationOutput):
     """Model loader output"""
 
-    unet: Optional[UNetField] = OutputField(default=None, description=FieldDescriptions.unet, title="UNet")
-    clip: Optional[ClipField] = OutputField(default=None, description=FieldDescriptions.clip, title="CLIP")
+    # fmt: off
+    type: Literal["lora_loader_output"] = "lora_loader_output"
+
+    unet: Optional[UNetField] = Field(default=None, description="UNet submodel")
+    clip: Optional[ClipField] = Field(default=None, description="Tokenizer and text_encoder submodels")
+    # fmt: on
 
 
-@invocation("lora_loader", title="LoRA", tags=["model"], category="model")
 class LoraLoaderInvocation(BaseInvocation):
     """Apply selected lora to unet and text_encoder."""
 
-    lora: LoRAModelField = InputField(description=FieldDescriptions.lora_model, input=Input.Direct, title="LoRA")
-    weight: float = InputField(default=0.75, description=FieldDescriptions.lora_weight)
-    unet: Optional[UNetField] = InputField(
-        default=None, description=FieldDescriptions.unet, input=Input.Connection, title="UNet"
-    )
-    clip: Optional[ClipField] = InputField(
-        default=None, description=FieldDescriptions.clip, input=Input.Connection, title="CLIP"
+    type: Literal["lora_loader"] = "lora_loader"
+
+    lora: Union[LoRAModelField, None] = Field(
+        default=None, description="Lora model name"
     )
+    weight: float = Field(default=0.75, description="With what weight to apply lora")
+
+    unet: Optional[UNetField] = Field(description="UNet model for applying lora")
+    clip: Optional[ClipField] = Field(description="Clip model for applying lora")
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Lora Loader",
+                "tags": ["lora", "loader"],
+                "type_hints": {"lora": "lora_model"},
+            },
+        }
 
     def invoke(self, context: InvocationContext) -> LoraLoaderOutput:
         if self.lora is None:
@@ -200,10 +228,14 @@ class LoraLoaderInvocation(BaseInvocation):
         ):
             raise Exception(f"Unkown lora name: {lora_name}!")
 
-        if self.unet is not None and any(lora.model_name == lora_name for lora in self.unet.loras):
+        if self.unet is not None and any(
+            lora.model_name == lora_name for lora in self.unet.loras
+        ):
             raise Exception(f'Lora "{lora_name}" already applied to unet')
 
-        if self.clip is not None and any(lora.model_name == lora_name for lora in self.clip.loras):
+        if self.clip is not None and any(
+            lora.model_name == lora_name for lora in self.clip.loras
+        ):
             raise Exception(f'Lora "{lora_name}" already applied to clip')
 
         output = LoraLoaderOutput()
@@ -235,95 +267,6 @@ class LoraLoaderInvocation(BaseInvocation):
         return output
 
 
-@invocation_output("sdxl_lora_loader_output")
-class SDXLLoraLoaderOutput(BaseInvocationOutput):
-    """SDXL LoRA Loader Output"""
-
-    unet: Optional[UNetField] = OutputField(default=None, description=FieldDescriptions.unet, title="UNet")
-    clip: Optional[ClipField] = OutputField(default=None, description=FieldDescriptions.clip, title="CLIP 1")
-    clip2: Optional[ClipField] = OutputField(default=None, description=FieldDescriptions.clip, title="CLIP 2")
-
-
-@invocation("sdxl_lora_loader", title="SDXL LoRA", tags=["lora", "model"], category="model")
-class SDXLLoraLoaderInvocation(BaseInvocation):
-    """Apply selected lora to unet and text_encoder."""
-
-    lora: LoRAModelField = InputField(description=FieldDescriptions.lora_model, input=Input.Direct, title="LoRA")
-    weight: float = Field(default=0.75, description=FieldDescriptions.lora_weight)
-    unet: Optional[UNetField] = Field(
-        default=None, description=FieldDescriptions.unet, input=Input.Connection, title="UNET"
-    )
-    clip: Optional[ClipField] = Field(
-        default=None, description=FieldDescriptions.clip, input=Input.Connection, title="CLIP 1"
-    )
-    clip2: Optional[ClipField] = Field(
-        default=None, description=FieldDescriptions.clip, input=Input.Connection, title="CLIP 2"
-    )
-
-    def invoke(self, context: InvocationContext) -> SDXLLoraLoaderOutput:
-        if self.lora is None:
-            raise Exception("No LoRA provided")
-
-        base_model = self.lora.base_model
-        lora_name = self.lora.model_name
-
-        if not context.services.model_manager.model_exists(
-            base_model=base_model,
-            model_name=lora_name,
-            model_type=ModelType.Lora,
-        ):
-            raise Exception(f"Unknown lora name: {lora_name}!")
-
-        if self.unet is not None and any(lora.model_name == lora_name for lora in self.unet.loras):
-            raise Exception(f'Lora "{lora_name}" already applied to unet')
-
-        if self.clip is not None and any(lora.model_name == lora_name for lora in self.clip.loras):
-            raise Exception(f'Lora "{lora_name}" already applied to clip')
-
-        if self.clip2 is not None and any(lora.model_name == lora_name for lora in self.clip2.loras):
-            raise Exception(f'Lora "{lora_name}" already applied to clip2')
-
-        output = SDXLLoraLoaderOutput()
-
-        if self.unet is not None:
-            output.unet = copy.deepcopy(self.unet)
-            output.unet.loras.append(
-                LoraInfo(
-                    base_model=base_model,
-                    model_name=lora_name,
-                    model_type=ModelType.Lora,
-                    submodel=None,
-                    weight=self.weight,
-                )
-            )
-
-        if self.clip is not None:
-            output.clip = copy.deepcopy(self.clip)
-            output.clip.loras.append(
-                LoraInfo(
-                    base_model=base_model,
-                    model_name=lora_name,
-                    model_type=ModelType.Lora,
-                    submodel=None,
-                    weight=self.weight,
-                )
-            )
-
-        if self.clip2 is not None:
-            output.clip2 = copy.deepcopy(self.clip2)
-            output.clip2.loras.append(
-                LoraInfo(
-                    base_model=base_model,
-                    model_name=lora_name,
-                    model_type=ModelType.Lora,
-                    submodel=None,
-                    weight=self.weight,
-                )
-            )
-
-        return output
-
-
 class VAEModelField(BaseModel):
     """Vae model field"""
 
@@ -331,20 +274,32 @@ class VAEModelField(BaseModel):
     base_model: BaseModelType = Field(description="Base model")
 
 
-@invocation_output("vae_loader_output")
 class VaeLoaderOutput(BaseInvocationOutput):
-    """VAE output"""
+    """Model loader output"""
 
-    vae: VaeField = OutputField(description=FieldDescriptions.vae, title="VAE")
+    # fmt: off
+    type: Literal["vae_loader_output"] = "vae_loader_output"
+
+    vae: VaeField = Field(default=None, description="Vae model")
+    # fmt: on
 
 
-@invocation("vae_loader", title="VAE", tags=["vae", "model"], category="model")
 class VaeLoaderInvocation(BaseInvocation):
     """Loads a VAE model, outputting a VaeLoaderOutput"""
 
-    vae_model: VAEModelField = InputField(
-        description=FieldDescriptions.vae_model, input=Input.Direct, ui_type=UIType.VaeModel, title="VAE"
-    )
+    type: Literal["vae_loader"] = "vae_loader"
+
+    vae_model: VAEModelField = Field(description="The VAE to load")
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "VAE Loader",
+                "tags": ["vae", "loader"],
+                "type_hints": {"vae_model": "vae_model"},
+            },
+        }
 
     def invoke(self, context: InvocationContext) -> VaeLoaderOutput:
         base_model = self.vae_model.base_model
@@ -366,44 +321,3 @@ class VaeLoaderInvocation(BaseInvocation):
                 )
             )
         )
-
-
-@invocation_output("seamless_output")
-class SeamlessModeOutput(BaseInvocationOutput):
-    """Modified Seamless Model output"""
-
-    unet: Optional[UNetField] = OutputField(description=FieldDescriptions.unet, title="UNet")
-    vae: Optional[VaeField] = OutputField(description=FieldDescriptions.vae, title="VAE")
-
-
-@invocation("seamless", title="Seamless", tags=["seamless", "model"], category="model")
-class SeamlessModeInvocation(BaseInvocation):
-    """Applies the seamless transformation to the Model UNet and VAE."""
-
-    unet: Optional[UNetField] = InputField(
-        default=None, description=FieldDescriptions.unet, input=Input.Connection, title="UNet"
-    )
-    vae: Optional[VaeField] = InputField(
-        default=None, description=FieldDescriptions.vae_model, input=Input.Connection, title="VAE"
-    )
-    seamless_y: bool = InputField(default=True, input=Input.Any, description="Specify whether Y axis is seamless")
-    seamless_x: bool = InputField(default=True, input=Input.Any, description="Specify whether X axis is seamless")
-
-    def invoke(self, context: InvocationContext) -> SeamlessModeOutput:
-        # Conditionally append 'x' and 'y' based on seamless_x and seamless_y
-        unet = copy.deepcopy(self.unet)
-        vae = copy.deepcopy(self.vae)
-
-        seamless_axes_list = []
-
-        if self.seamless_x:
-            seamless_axes_list.append("x")
-        if self.seamless_y:
-            seamless_axes_list.append("y")
-
-        if unet is not None:
-            unet.seamless_axes = seamless_axes_list
-        if vae is not None:
-            vae.seamless_axes = seamless_axes_list
-
-        return SeamlessModeOutput(unet=unet, vae=vae)

invokeai/app/invocations/noise.py

@@ -1,22 +1,19 @@
 # Copyright (c) 2023 Kyle Schouviller (https://github.com/kyle0654) & the InvokeAI Team
 
+import math
+from typing import Literal
 
+from pydantic import Field, validator
 import torch
-from pydantic import validator
-
 from invokeai.app.invocations.latent import LatentsField
-from invokeai.app.util.misc import SEED_MAX, get_random_seed
 
+from invokeai.app.util.misc import SEED_MAX, get_random_seed
 from ...backend.util.devices import choose_torch_device, torch_dtype
 from .baseinvocation import (
     BaseInvocation,
     BaseInvocationOutput,
-    FieldDescriptions,
-    InputField,
+    InvocationConfig,
     InvocationContext,
-    OutputField,
-    invocation,
-    invocation_output,
 )
 
 """
@@ -61,50 +58,65 @@ Nodes
 """
 
 
-@invocation_output("noise_output")
 class NoiseOutput(BaseInvocationOutput):
     """Invocation noise output"""
 
-    noise: LatentsField = OutputField(default=None, description=FieldDescriptions.noise)
-    width: int = OutputField(description=FieldDescriptions.width)
-    height: int = OutputField(description=FieldDescriptions.height)
+    # fmt: off
+    type:  Literal["noise_output"] = "noise_output"
+
+    # Inputs
+    noise: LatentsField            = Field(default=None, description="The output noise")
+    width:                     int = Field(description="The width of the noise in pixels")
+    height:                    int = Field(description="The height of the noise in pixels")
+    # fmt: on
 
 
-def build_noise_output(latents_name: str, latents: torch.Tensor, seed: int):
+def build_noise_output(latents_name: str, latents: torch.Tensor):
     return NoiseOutput(
-        noise=LatentsField(latents_name=latents_name, seed=seed),
+        noise=LatentsField(latents_name=latents_name),
         width=latents.size()[3] * 8,
         height=latents.size()[2] * 8,
     )
 
 
-@invocation("noise", title="Noise", tags=["latents", "noise"], category="latents")
 class NoiseInvocation(BaseInvocation):
     """Generates latent noise."""
 
-    seed: int = InputField(
+    type: Literal["noise"] = "noise"
+
+    # Inputs
+    seed: int = Field(
         ge=0,
         le=SEED_MAX,
-        description=FieldDescriptions.seed,
+        description="The seed to use",
         default_factory=get_random_seed,
     )
-    width: int = InputField(
+    width: int = Field(
         default=512,
         multiple_of=8,
         gt=0,
-        description=FieldDescriptions.width,
+        description="The width of the resulting noise",
     )
-    height: int = InputField(
+    height: int = Field(
         default=512,
         multiple_of=8,
         gt=0,
-        description=FieldDescriptions.height,
+        description="The height of the resulting noise",
     )
-    use_cpu: bool = InputField(
+    use_cpu: bool = Field(
         default=True,
         description="Use CPU for noise generation (for reproducible results across platforms)",
     )
 
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Noise",
+                "tags": ["latents", "noise"],
+            },
+        }
+
     @validator("seed", pre=True)
     def modulo_seed(cls, v):
         """Returns the seed modulo (SEED_MAX + 1) to ensure it is within the valid range."""
@@ -120,4 +132,4 @@ class NoiseInvocation(BaseInvocation):
         )
         name = f"{context.graph_execution_state_id}__{self.id}"
         context.services.latents.save(name, noise)
-        return build_noise_output(latents_name=name, latents=noise, seed=self.seed)
+        return build_noise_output(latents_name=name, latents=noise)

invokeai/app/invocations/onnx.py

@@ -1,504 +0,0 @@
-# Copyright (c) 2023 Borisov Sergey (https://github.com/StAlKeR7779)
-
-import inspect
-import re
-
-# from contextlib import ExitStack
-from typing import List, Literal, Optional, Union
-
-import numpy as np
-import torch
-from diffusers.image_processor import VaeImageProcessor
-from pydantic import BaseModel, Field, validator
-from tqdm import tqdm
-
-from invokeai.app.invocations.metadata import CoreMetadata
-from invokeai.app.invocations.primitives import ConditioningField, ConditioningOutput, ImageField, ImageOutput
-from invokeai.app.util.step_callback import stable_diffusion_step_callback
-from invokeai.backend import BaseModelType, ModelType, SubModelType
-
-from ...backend.model_management import ONNXModelPatcher
-from ...backend.stable_diffusion import PipelineIntermediateState
-from ...backend.util import choose_torch_device
-from ..models.image import ImageCategory, ResourceOrigin
-from .baseinvocation import (
-    BaseInvocation,
-    BaseInvocationOutput,
-    FieldDescriptions,
-    InputField,
-    Input,
-    InvocationContext,
-    OutputField,
-    UIComponent,
-    UIType,
-    invocation,
-    invocation_output,
-)
-from .controlnet_image_processors import ControlField
-from .latent import SAMPLER_NAME_VALUES, LatentsField, LatentsOutput, build_latents_output, get_scheduler
-from .model import ClipField, ModelInfo, UNetField, VaeField
-
-ORT_TO_NP_TYPE = {
-    "tensor(bool)": np.bool_,
-    "tensor(int8)": np.int8,
-    "tensor(uint8)": np.uint8,
-    "tensor(int16)": np.int16,
-    "tensor(uint16)": np.uint16,
-    "tensor(int32)": np.int32,
-    "tensor(uint32)": np.uint32,
-    "tensor(int64)": np.int64,
-    "tensor(uint64)": np.uint64,
-    "tensor(float16)": np.float16,
-    "tensor(float)": np.float32,
-    "tensor(double)": np.float64,
-}
-
-PRECISION_VALUES = Literal[tuple(list(ORT_TO_NP_TYPE.keys()))]
-
-
-@invocation("prompt_onnx", title="ONNX Prompt (Raw)", tags=["prompt", "onnx"], category="conditioning")
-class ONNXPromptInvocation(BaseInvocation):
-    prompt: str = InputField(default="", description=FieldDescriptions.raw_prompt, ui_component=UIComponent.Textarea)
-    clip: ClipField = InputField(description=FieldDescriptions.clip, input=Input.Connection)
-
-    def invoke(self, context: InvocationContext) -> ConditioningOutput:
-        tokenizer_info = context.services.model_manager.get_model(
-            **self.clip.tokenizer.dict(),
-        )
-        text_encoder_info = context.services.model_manager.get_model(
-            **self.clip.text_encoder.dict(),
-        )
-        with tokenizer_info as orig_tokenizer, text_encoder_info as text_encoder:  # , ExitStack() as stack:
-            loras = [
-                (context.services.model_manager.get_model(**lora.dict(exclude={"weight"})).context.model, lora.weight)
-                for lora in self.clip.loras
-            ]
-
-            ti_list = []
-            for trigger in re.findall(r"<[a-zA-Z0-9., _-]+>", self.prompt):
-                name = trigger[1:-1]
-                try:
-                    ti_list.append(
-                        (
-                            name,
-                            context.services.model_manager.get_model(
-                                model_name=name,
-                                base_model=self.clip.text_encoder.base_model,
-                                model_type=ModelType.TextualInversion,
-                            ).context.model,
-                        )
-                    )
-                except Exception:
-                    # print(e)
-                    # import traceback
-                    # print(traceback.format_exc())
-                    print(f'Warn: trigger: "{trigger}" not found')
-            if loras or ti_list:
-                text_encoder.release_session()
-            with ONNXModelPatcher.apply_lora_text_encoder(text_encoder, loras), ONNXModelPatcher.apply_ti(
-                orig_tokenizer, text_encoder, ti_list
-            ) as (tokenizer, ti_manager):
-                text_encoder.create_session()
-
-                # copy from
-                # https://github.com/huggingface/diffusers/blob/3ebbaf7c96801271f9e6c21400033b6aa5ffcf29/src/diffusers/pipelines/stable_diffusion/pipeline_onnx_stable_diffusion.py#L153
-                text_inputs = tokenizer(
-                    self.prompt,
-                    padding="max_length",
-                    max_length=tokenizer.model_max_length,
-                    truncation=True,
-                    return_tensors="np",
-                )
-                text_input_ids = text_inputs.input_ids
-                """
-                untruncated_ids = tokenizer(prompt, padding="max_length", return_tensors="np").input_ids
-
-                if not np.array_equal(text_input_ids, untruncated_ids):
-                    removed_text = self.tokenizer.batch_decode(
-                        untruncated_ids[:, self.tokenizer.model_max_length - 1 : -1]
-                    )
-                    logger.warning(
-                        "The following part of your input was truncated because CLIP can only handle sequences up to"
-                        f" {self.tokenizer.model_max_length} tokens: {removed_text}"
-                    )
-                """
-
-                prompt_embeds = text_encoder(input_ids=text_input_ids.astype(np.int32))[0]
-
-        conditioning_name = f"{context.graph_execution_state_id}_{self.id}_conditioning"
-
-        # TODO: hacky but works ;D maybe rename latents somehow?
-        context.services.latents.save(conditioning_name, (prompt_embeds, None))
-
-        return ConditioningOutput(
-            conditioning=ConditioningField(
-                conditioning_name=conditioning_name,
-            ),
-        )
-
-
-# Text to image
-@invocation(
-    "t2l_onnx",
-    title="ONNX Text to Latents",
-    tags=["latents", "inference", "txt2img", "onnx"],
-    category="latents",
-)
-class ONNXTextToLatentsInvocation(BaseInvocation):
-    """Generates latents from conditionings."""
-
-    positive_conditioning: ConditioningField = InputField(
-        description=FieldDescriptions.positive_cond,
-        input=Input.Connection,
-    )
-    negative_conditioning: ConditioningField = InputField(
-        description=FieldDescriptions.negative_cond,
-        input=Input.Connection,
-    )
-    noise: LatentsField = InputField(
-        description=FieldDescriptions.noise,
-        input=Input.Connection,
-    )
-    steps: int = InputField(default=10, gt=0, description=FieldDescriptions.steps)
-    cfg_scale: Union[float, List[float]] = InputField(
-        default=7.5,
-        ge=1,
-        description=FieldDescriptions.cfg_scale,
-        ui_type=UIType.Float,
-    )
-    scheduler: SAMPLER_NAME_VALUES = InputField(
-        default="euler", description=FieldDescriptions.scheduler, input=Input.Direct, ui_type=UIType.Scheduler
-    )
-    precision: PRECISION_VALUES = InputField(default="tensor(float16)", description=FieldDescriptions.precision)
-    unet: UNetField = InputField(
-        description=FieldDescriptions.unet,
-        input=Input.Connection,
-    )
-    control: Optional[Union[ControlField, list[ControlField]]] = InputField(
-        default=None,
-        description=FieldDescriptions.control,
-        ui_type=UIType.Control,
-    )
-    # seamless:   bool = InputField(default=False, description="Whether or not to generate an image that can tile without seams", )
-    # seamless_axes: str = InputField(default="", description="The axes to tile the image on, 'x' and/or 'y'")
-
-    @validator("cfg_scale")
-    def ge_one(cls, v):
-        """validate that all cfg_scale values are >= 1"""
-        if isinstance(v, list):
-            for i in v:
-                if i < 1:
-                    raise ValueError("cfg_scale must be greater than 1")
-        else:
-            if v < 1:
-                raise ValueError("cfg_scale must be greater than 1")
-        return v
-
-    # based on
-    # https://github.com/huggingface/diffusers/blob/3ebbaf7c96801271f9e6c21400033b6aa5ffcf29/src/diffusers/pipelines/stable_diffusion/pipeline_onnx_stable_diffusion.py#L375
-    def invoke(self, context: InvocationContext) -> LatentsOutput:
-        c, _ = context.services.latents.get(self.positive_conditioning.conditioning_name)
-        uc, _ = context.services.latents.get(self.negative_conditioning.conditioning_name)
-        graph_execution_state = context.services.graph_execution_manager.get(context.graph_execution_state_id)
-        source_node_id = graph_execution_state.prepared_source_mapping[self.id]
-        if isinstance(c, torch.Tensor):
-            c = c.cpu().numpy()
-        if isinstance(uc, torch.Tensor):
-            uc = uc.cpu().numpy()
-        device = torch.device(choose_torch_device())
-        prompt_embeds = np.concatenate([uc, c])
-
-        latents = context.services.latents.get(self.noise.latents_name)
-        if isinstance(latents, torch.Tensor):
-            latents = latents.cpu().numpy()
-
-        # TODO: better execution device handling
-        latents = latents.astype(ORT_TO_NP_TYPE[self.precision])
-
-        # get the initial random noise unless the user supplied it
-        do_classifier_free_guidance = True
-        # latents_dtype = prompt_embeds.dtype
-        # latents_shape = (batch_size * num_images_per_prompt, 4, height // 8, width // 8)
-        # if latents.shape != latents_shape:
-        #    raise ValueError(f"Unexpected latents shape, got {latents.shape}, expected {latents_shape}")
-
-        scheduler = get_scheduler(
-            context=context,
-            scheduler_info=self.unet.scheduler,
-            scheduler_name=self.scheduler,
-            seed=0,  # TODO: refactor this node
-        )
-
-        def torch2numpy(latent: torch.Tensor):
-            return latent.cpu().numpy()
-
-        def numpy2torch(latent, device):
-            return torch.from_numpy(latent).to(device)
-
-        def dispatch_progress(
-            self, context: InvocationContext, source_node_id: str, intermediate_state: PipelineIntermediateState
-        ) -> None:
-            stable_diffusion_step_callback(
-                context=context,
-                intermediate_state=intermediate_state,
-                node=self.dict(),
-                source_node_id=source_node_id,
-            )
-
-        scheduler.set_timesteps(self.steps)
-        latents = latents * np.float64(scheduler.init_noise_sigma)
-
-        extra_step_kwargs = dict()
-        if "eta" in set(inspect.signature(scheduler.step).parameters.keys()):
-            extra_step_kwargs.update(
-                eta=0.0,
-            )
-
-        unet_info = context.services.model_manager.get_model(**self.unet.unet.dict())
-
-        with unet_info as unet:  # , ExitStack() as stack:
-            # loras = [(stack.enter_context(context.services.model_manager.get_model(**lora.dict(exclude={"weight"}))), lora.weight) for lora in self.unet.loras]
-            loras = [
-                (context.services.model_manager.get_model(**lora.dict(exclude={"weight"})).context.model, lora.weight)
-                for lora in self.unet.loras
-            ]
-
-            if loras:
-                unet.release_session()
-            with ONNXModelPatcher.apply_lora_unet(unet, loras):
-                # TODO:
-                _, _, h, w = latents.shape
-                unet.create_session(h, w)
-
-                timestep_dtype = next(
-                    (input.type for input in unet.session.get_inputs() if input.name == "timestep"), "tensor(float16)"
-                )
-                timestep_dtype = ORT_TO_NP_TYPE[timestep_dtype]
-                for i in tqdm(range(len(scheduler.timesteps))):
-                    t = scheduler.timesteps[i]
-                    # expand the latents if we are doing classifier free guidance
-                    latent_model_input = np.concatenate([latents] * 2) if do_classifier_free_guidance else latents
-                    latent_model_input = scheduler.scale_model_input(numpy2torch(latent_model_input, device), t)
-                    latent_model_input = latent_model_input.cpu().numpy()
-
-                    # predict the noise residual
-                    timestep = np.array([t], dtype=timestep_dtype)
-                    noise_pred = unet(sample=latent_model_input, timestep=timestep, encoder_hidden_states=prompt_embeds)
-                    noise_pred = noise_pred[0]
-
-                    # perform guidance
-                    if do_classifier_free_guidance:
-                        noise_pred_uncond, noise_pred_text = np.split(noise_pred, 2)
-                        noise_pred = noise_pred_uncond + self.cfg_scale * (noise_pred_text - noise_pred_uncond)
-
-                    # compute the previous noisy sample x_t -> x_t-1
-                    scheduler_output = scheduler.step(
-                        numpy2torch(noise_pred, device), t, numpy2torch(latents, device), **extra_step_kwargs
-                    )
-                    latents = torch2numpy(scheduler_output.prev_sample)
-
-                    state = PipelineIntermediateState(
-                        run_id="test", step=i, timestep=timestep, latents=scheduler_output.prev_sample
-                    )
-                    dispatch_progress(self, context=context, source_node_id=source_node_id, intermediate_state=state)
-
-                    # call the callback, if provided
-                    # if callback is not None and i % callback_steps == 0:
-                    #    callback(i, t, latents)
-
-        torch.cuda.empty_cache()
-
-        name = f"{context.graph_execution_state_id}__{self.id}"
-        context.services.latents.save(name, latents)
-        return build_latents_output(latents_name=name, latents=torch.from_numpy(latents))
-
-
-# Latent to image
-@invocation(
-    "l2i_onnx",
-    title="ONNX Latents to Image",
-    tags=["latents", "image", "vae", "onnx"],
-    category="image",
-)
-class ONNXLatentsToImageInvocation(BaseInvocation):
-    """Generates an image from latents."""
-
-    latents: LatentsField = InputField(
-        description=FieldDescriptions.denoised_latents,
-        input=Input.Connection,
-    )
-    vae: VaeField = InputField(
-        description=FieldDescriptions.vae,
-        input=Input.Connection,
-    )
-    metadata: Optional[CoreMetadata] = InputField(
-        default=None,
-        description=FieldDescriptions.core_metadata,
-        ui_hidden=True,
-    )
-    # tiled: bool = InputField(default=False, description="Decode latents by overlaping tiles(less memory consumption)")
-
-    def invoke(self, context: InvocationContext) -> ImageOutput:
-        latents = context.services.latents.get(self.latents.latents_name)
-
-        if self.vae.vae.submodel != SubModelType.VaeDecoder:
-            raise Exception(f"Expected vae_decoder, found: {self.vae.vae.model_type}")
-
-        vae_info = context.services.model_manager.get_model(
-            **self.vae.vae.dict(),
-        )
-
-        # clear memory as vae decode can request a lot
-        torch.cuda.empty_cache()
-
-        with vae_info as vae:
-            vae.create_session()
-
-            # copied from
-            # https://github.com/huggingface/diffusers/blob/3ebbaf7c96801271f9e6c21400033b6aa5ffcf29/src/diffusers/pipelines/stable_diffusion/pipeline_onnx_stable_diffusion.py#L427
-            latents = 1 / 0.18215 * latents
-            # image = self.vae_decoder(latent_sample=latents)[0]
-            # it seems likes there is a strange result for using half-precision vae decoder if batchsize>1
-            image = np.concatenate([vae(latent_sample=latents[i : i + 1])[0] for i in range(latents.shape[0])])
-
-            image = np.clip(image / 2 + 0.5, 0, 1)
-            image = image.transpose((0, 2, 3, 1))
-            image = VaeImageProcessor.numpy_to_pil(image)[0]
-
-        torch.cuda.empty_cache()
-
-        image_dto = context.services.images.create(
-            image=image,
-            image_origin=ResourceOrigin.INTERNAL,
-            image_category=ImageCategory.GENERAL,
-            node_id=self.id,
-            session_id=context.graph_execution_state_id,
-            is_intermediate=self.is_intermediate,
-            metadata=self.metadata.dict() if self.metadata else None,
-            workflow=self.workflow,
-        )
-
-        return ImageOutput(
-            image=ImageField(image_name=image_dto.image_name),
-            width=image_dto.width,
-            height=image_dto.height,
-        )
-
-
-@invocation_output("model_loader_output_onnx")
-class ONNXModelLoaderOutput(BaseInvocationOutput):
-    """Model loader output"""
-
-    unet: UNetField = OutputField(default=None, description=FieldDescriptions.unet, title="UNet")
-    clip: ClipField = OutputField(default=None, description=FieldDescriptions.clip, title="CLIP")
-    vae_decoder: VaeField = OutputField(default=None, description=FieldDescriptions.vae, title="VAE Decoder")
-    vae_encoder: VaeField = OutputField(default=None, description=FieldDescriptions.vae, title="VAE Encoder")
-
-
-class OnnxModelField(BaseModel):
-    """Onnx model field"""
-
-    model_name: str = Field(description="Name of the model")
-    base_model: BaseModelType = Field(description="Base model")
-    model_type: ModelType = Field(description="Model Type")
-
-
-@invocation("onnx_model_loader", title="ONNX Main Model", tags=["onnx", "model"], category="model")
-class OnnxModelLoaderInvocation(BaseInvocation):
-    """Loads a main model, outputting its submodels."""
-
-    model: OnnxModelField = InputField(
-        description=FieldDescriptions.onnx_main_model, input=Input.Direct, ui_type=UIType.ONNXModel
-    )
-
-    def invoke(self, context: InvocationContext) -> ONNXModelLoaderOutput:
-        base_model = self.model.base_model
-        model_name = self.model.model_name
-        model_type = ModelType.ONNX
-
-        # TODO: not found exceptions
-        if not context.services.model_manager.model_exists(
-            model_name=model_name,
-            base_model=base_model,
-            model_type=model_type,
-        ):
-            raise Exception(f"Unknown {base_model} {model_type} model: {model_name}")
-
-        """
-        if not context.services.model_manager.model_exists(
-            model_name=self.model_name,
-            model_type=SDModelType.Diffusers,
-            submodel=SDModelType.Tokenizer,
-        ):
-            raise Exception(
-                f"Failed to find tokenizer submodel in {self.model_name}! Check if model corrupted"
-            )
-
-        if not context.services.model_manager.model_exists(
-            model_name=self.model_name,
-            model_type=SDModelType.Diffusers,
-            submodel=SDModelType.TextEncoder,
-        ):
-            raise Exception(
-                f"Failed to find text_encoder submodel in {self.model_name}! Check if model corrupted"
-            )
-
-        if not context.services.model_manager.model_exists(
-            model_name=self.model_name,
-            model_type=SDModelType.Diffusers,
-            submodel=SDModelType.UNet,
-        ):
-            raise Exception(
-                f"Failed to find unet submodel from {self.model_name}! Check if model corrupted"
-            )
-        """
-
-        return ONNXModelLoaderOutput(
-            unet=UNetField(
-                unet=ModelInfo(
-                    model_name=model_name,
-                    base_model=base_model,
-                    model_type=model_type,
-                    submodel=SubModelType.UNet,
-                ),
-                scheduler=ModelInfo(
-                    model_name=model_name,
-                    base_model=base_model,
-                    model_type=model_type,
-                    submodel=SubModelType.Scheduler,
-                ),
-                loras=[],
-            ),
-            clip=ClipField(
-                tokenizer=ModelInfo(
-                    model_name=model_name,
-                    base_model=base_model,
-                    model_type=model_type,
-                    submodel=SubModelType.Tokenizer,
-                ),
-                text_encoder=ModelInfo(
-                    model_name=model_name,
-                    base_model=base_model,
-                    model_type=model_type,
-                    submodel=SubModelType.TextEncoder,
-                ),
-                loras=[],
-                skipped_layers=0,
-            ),
-            vae_decoder=VaeField(
-                vae=ModelInfo(
-                    model_name=model_name,
-                    base_model=base_model,
-                    model_type=model_type,
-                    submodel=SubModelType.VaeDecoder,
-                ),
-            ),
-            vae_encoder=VaeField(
-                vae=ModelInfo(
-                    model_name=model_name,
-                    base_model=base_model,
-                    model_type=model_type,
-                    submodel=SubModelType.VaeEncoder,
-                ),
-            ),
-        )

invokeai/app/invocations/param_easing.py

@@ -1,61 +1,61 @@
 import io
-from typing import Literal, Optional
-
-import matplotlib.pyplot as plt
-import numpy as np
+from typing import Literal, Optional, Any
 
+# from PIL.Image import Image
 import PIL.Image
-from easing_functions import (
-    BackEaseIn,
-    BackEaseInOut,
-    BackEaseOut,
-    BounceEaseIn,
-    BounceEaseInOut,
-    BounceEaseOut,
-    CircularEaseIn,
-    CircularEaseInOut,
-    CircularEaseOut,
-    CubicEaseIn,
-    CubicEaseInOut,
-    CubicEaseOut,
-    ElasticEaseIn,
-    ElasticEaseInOut,
-    ElasticEaseOut,
-    ExponentialEaseIn,
-    ExponentialEaseInOut,
-    ExponentialEaseOut,
-    LinearInOut,
-    QuadEaseIn,
-    QuadEaseInOut,
-    QuadEaseOut,
-    QuarticEaseIn,
-    QuarticEaseInOut,
-    QuarticEaseOut,
-    QuinticEaseIn,
-    QuinticEaseInOut,
-    QuinticEaseOut,
-    SineEaseIn,
-    SineEaseInOut,
-    SineEaseOut,
-)
 from matplotlib.ticker import MaxNLocator
+from matplotlib.figure import Figure
 
-from invokeai.app.invocations.primitives import FloatCollectionOutput
+from pydantic import BaseModel, Field
+import numpy as np
+import matplotlib.pyplot as plt
 
-from .baseinvocation import BaseInvocation, InputField, InvocationContext, invocation
+from easing_functions import (
+    LinearInOut,
+    QuadEaseInOut, QuadEaseIn, QuadEaseOut,
+    CubicEaseInOut, CubicEaseIn, CubicEaseOut,
+    QuarticEaseInOut, QuarticEaseIn, QuarticEaseOut,
+    QuinticEaseInOut, QuinticEaseIn, QuinticEaseOut,
+    SineEaseInOut, SineEaseIn, SineEaseOut,
+    CircularEaseIn, CircularEaseInOut, CircularEaseOut,
+    ExponentialEaseInOut, ExponentialEaseIn, ExponentialEaseOut,
+    ElasticEaseIn, ElasticEaseInOut, ElasticEaseOut,
+    BackEaseIn, BackEaseInOut, BackEaseOut,
+    BounceEaseIn, BounceEaseInOut, BounceEaseOut)
+
+from .baseinvocation import (
+    BaseInvocation,
+    BaseInvocationOutput,
+    InvocationContext,
+    InvocationConfig,
+)
+from ...backend.util.logging import InvokeAILogger
+from .collections import FloatCollectionOutput
 
 
-@invocation("float_range", title="Float Range", tags=["math", "range"], category="math")
 class FloatLinearRangeInvocation(BaseInvocation):
     """Creates a range"""
 
-    start: float = InputField(default=5, description="The first value of the range")
-    stop: float = InputField(default=10, description="The last value of the range")
-    steps: int = InputField(default=30, description="number of values to interpolate over (including start and stop)")
+    type: Literal["float_range"] = "float_range"
+
+    # Inputs
+    start: float = Field(default=5, description="The first value of the range")
+    stop: float = Field(default=10, description="The last value of the range")
+    steps: int = Field(default=30, description="number of values to interpolate over (including start and stop)")
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Linear Range (Float)",
+                "tags": ["math", "float", "linear", "range"]
+            },
+        }
 
     def invoke(self, context: InvocationContext) -> FloatCollectionOutput:
         param_list = list(np.linspace(self.start, self.stop, self.steps))
-        return FloatCollectionOutput(collection=param_list)
+        return FloatCollectionOutput(
+            collection=param_list
+        )
 
 
 EASING_FUNCTIONS_MAP = {
@@ -92,28 +92,43 @@ EASING_FUNCTIONS_MAP = {
     "BounceInOut": BounceEaseInOut,
 }
 
-EASING_FUNCTION_KEYS = Literal[tuple(list(EASING_FUNCTIONS_MAP.keys()))]
+EASING_FUNCTION_KEYS: Any = Literal[
+    tuple(list(EASING_FUNCTIONS_MAP.keys()))
+]
 
 
 # actually I think for now could just use CollectionOutput (which is list[Any]
-@invocation("step_param_easing", title="Step Param Easing", tags=["step", "easing"], category="step")
 class StepParamEasingInvocation(BaseInvocation):
     """Experimental per-step parameter easing for denoising steps"""
 
-    easing: EASING_FUNCTION_KEYS = InputField(default="Linear", description="The easing function to use")
-    num_steps: int = InputField(default=20, description="number of denoising steps")
-    start_value: float = InputField(default=0.0, description="easing starting value")
-    end_value: float = InputField(default=1.0, description="easing ending value")
-    start_step_percent: float = InputField(default=0.0, description="fraction of steps at which to start easing")
-    end_step_percent: float = InputField(default=1.0, description="fraction of steps after which to end easing")
+    type: Literal["step_param_easing"] = "step_param_easing"
+
+    # Inputs
+    # fmt: off
+    easing: EASING_FUNCTION_KEYS = Field(default="Linear", description="The easing function to use")
+    num_steps: int = Field(default=20, description="number of denoising steps")
+    start_value: float = Field(default=0.0, description="easing starting value")
+    end_value: float = Field(default=1.0, description="easing ending value")
+    start_step_percent: float = Field(default=0.0, description="fraction of steps at which to start easing")
+    end_step_percent: float = Field(default=1.0, description="fraction of steps after which to end easing")
     # if None, then start_value is used prior to easing start
-    pre_start_value: Optional[float] = InputField(default=None, description="value before easing start")
+    pre_start_value: Optional[float] = Field(default=None, description="value before easing start")
     # if None, then end value is used prior to easing end
-    post_end_value: Optional[float] = InputField(default=None, description="value after easing end")
-    mirror: bool = InputField(default=False, description="include mirror of easing function")
+    post_end_value: Optional[float] = Field(default=None, description="value after easing end")
+    mirror: bool = Field(default=False, description="include mirror of easing function")
     # FIXME: add alt_mirror option (alternative to default or mirror), or remove entirely
-    # alt_mirror: bool = InputField(default=False, description="alternative mirroring by dual easing")
-    show_easing_plot: bool = InputField(default=False, description="show easing plot")
+    # alt_mirror: bool = Field(default=False, description="alternative mirroring by dual easing")
+    show_easing_plot: bool = Field(default=False, description="show easing plot")
+    # fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Param Easing By Step",
+                "tags": ["param", "step", "easing"]
+            },
+        }
+
 
     def invoke(self, context: InvocationContext) -> FloatCollectionOutput:
         log_diagnostics = False
@@ -155,13 +170,12 @@ class StepParamEasingInvocation(BaseInvocation):
             # and create reverse copy of list[1:end-1]
             # but if even then number_of_steps/2 === ceil(number_of_steps/2), so can just use ceil always
 
-            base_easing_duration = int(np.ceil(num_easing_steps / 2.0))
-            if log_diagnostics:
-                context.services.logger.debug("base easing duration: " + str(base_easing_duration))
-            even_num_steps = num_easing_steps % 2 == 0  # even number of steps
-            easing_function = easing_class(
-                start=self.start_value, end=self.end_value, duration=base_easing_duration - 1
-            )
+            base_easing_duration = int(np.ceil(num_easing_steps/2.0))
+            if log_diagnostics: context.services.logger.debug("base easing duration: " + str(base_easing_duration))
+            even_num_steps = (num_easing_steps % 2 == 0)  # even number of steps
+            easing_function = easing_class(start=self.start_value,
+                                           end=self.end_value,
+                                           duration=base_easing_duration - 1)
             base_easing_vals = list()
             for step_index in range(base_easing_duration):
                 easing_val = easing_function.ease(step_index)
@@ -200,7 +214,9 @@ class StepParamEasingInvocation(BaseInvocation):
         #
 
         else:  # no mirroring (default)
-            easing_function = easing_class(start=self.start_value, end=self.end_value, duration=num_easing_steps - 1)
+            easing_function = easing_class(start=self.start_value,
+                                           end=self.end_value,
+                                           duration=num_easing_steps - 1)
             for step_index in range(num_easing_steps):
                 step_val = easing_function.ease(step_index)
                 easing_list.append(step_val)
@@ -224,11 +240,13 @@ class StepParamEasingInvocation(BaseInvocation):
             ax = plt.gca()
             ax.xaxis.set_major_locator(MaxNLocator(integer=True))
             buf = io.BytesIO()
-            plt.savefig(buf, format="png")
+            plt.savefig(buf, format='png')
             buf.seek(0)
             im = PIL.Image.open(buf)
             im.show()
             buf.close()
 
         # output array of size steps, each entry list[i] is param value for step i
-        return FloatCollectionOutput(collection=param_list)
+        return FloatCollectionOutput(
+            collection=param_list
+        )

invokeai/app/invocations/params.py

@@ -0,0 +1,70 @@
+# Copyright (c) 2023 Kyle Schouviller (https://github.com/kyle0654)
+
+from typing import Literal
+
+from pydantic import Field
+
+from .baseinvocation import (BaseInvocation, BaseInvocationOutput,
+                             InvocationConfig, InvocationContext)
+from .math import FloatOutput, IntOutput
+
+# Pass-through parameter nodes - used by subgraphs
+
+class ParamIntInvocation(BaseInvocation):
+    """An integer parameter"""
+    #fmt: off
+    type: Literal["param_int"] = "param_int"
+    a: int = Field(default=0, description="The integer value")
+    #fmt: on
+
+    class Config(InvocationConfig):
+      schema_extra = {
+          "ui": {
+              "tags": ["param", "integer"],
+              "title": "Integer Parameter"
+          },
+      }
+
+    def invoke(self, context: InvocationContext) -> IntOutput:
+        return IntOutput(a=self.a)
+
+class ParamFloatInvocation(BaseInvocation):
+    """A float parameter"""
+    #fmt: off
+    type: Literal["param_float"] = "param_float"
+    param: float = Field(default=0.0, description="The float value")
+    #fmt: on
+
+    class Config(InvocationConfig):
+      schema_extra = {
+          "ui": {
+              "tags": ["param", "float"],
+              "title": "Float Parameter"
+          },
+      }
+
+    def invoke(self, context: InvocationContext) -> FloatOutput:
+        return FloatOutput(param=self.param)
+
+class StringOutput(BaseInvocationOutput):
+    """A string output"""
+    type: Literal["string_output"] = "string_output"
+    text: str = Field(default=None, description="The output string")
+
+
+class ParamStringInvocation(BaseInvocation):
+    """A string parameter"""
+    type: Literal['param_string'] = 'param_string'
+    text: str = Field(default='', description='The string value')
+
+    class Config(InvocationConfig):
+      schema_extra = {
+          "ui": {
+              "tags": ["param", "string"],
+              "title": "String Parameter"
+          },
+      }
+
+    def invoke(self, context: InvocationContext) -> StringOutput:
+        return StringOutput(text=self.text)
+    

invokeai/app/invocations/primitives.py

@@ -1,463 +0,0 @@
-# Copyright (c) 2023 Kyle Schouviller (https://github.com/kyle0654)
-
-from typing import Optional, Tuple
-
-import torch
-from pydantic import BaseModel, Field
-
-from .baseinvocation import (
-    BaseInvocation,
-    BaseInvocationOutput,
-    FieldDescriptions,
-    Input,
-    InputField,
-    InvocationContext,
-    OutputField,
-    UIComponent,
-    UIType,
-    invocation,
-    invocation_output,
-)
-
-"""
-Primitives: Boolean, Integer, Float, String, Image, Latents, Conditioning, Color
-- primitive nodes
-- primitive outputs
-- primitive collection outputs
-"""
-
-# region Boolean
-
-
-@invocation_output("boolean_output")
-class BooleanOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single boolean"""
-
-    value: bool = OutputField(description="The output boolean")
-
-
-@invocation_output("boolean_collection_output")
-class BooleanCollectionOutput(BaseInvocationOutput):
-    """Base class for nodes that output a collection of booleans"""
-
-    collection: list[bool] = OutputField(description="The output boolean collection", ui_type=UIType.BooleanCollection)
-
-
-@invocation("boolean", title="Boolean Primitive", tags=["primitives", "boolean"], category="primitives")
-class BooleanInvocation(BaseInvocation):
-    """A boolean primitive value"""
-
-    value: bool = InputField(default=False, description="The boolean value")
-
-    def invoke(self, context: InvocationContext) -> BooleanOutput:
-        return BooleanOutput(value=self.value)
-
-
-@invocation(
-    "boolean_collection",
-    title="Boolean Collection Primitive",
-    tags=["primitives", "boolean", "collection"],
-    category="primitives",
-)
-class BooleanCollectionInvocation(BaseInvocation):
-    """A collection of boolean primitive values"""
-
-    collection: list[bool] = InputField(
-        default_factory=list, description="The collection of boolean values", ui_type=UIType.BooleanCollection
-    )
-
-    def invoke(self, context: InvocationContext) -> BooleanCollectionOutput:
-        return BooleanCollectionOutput(collection=self.collection)
-
-
-# endregion
-
-# region Integer
-
-
-@invocation_output("integer_output")
-class IntegerOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single integer"""
-
-    value: int = OutputField(description="The output integer")
-
-
-@invocation_output("integer_collection_output")
-class IntegerCollectionOutput(BaseInvocationOutput):
-    """Base class for nodes that output a collection of integers"""
-
-    collection: list[int] = OutputField(description="The int collection", ui_type=UIType.IntegerCollection)
-
-
-@invocation("integer", title="Integer Primitive", tags=["primitives", "integer"], category="primitives")
-class IntegerInvocation(BaseInvocation):
-    """An integer primitive value"""
-
-    value: int = InputField(default=0, description="The integer value")
-
-    def invoke(self, context: InvocationContext) -> IntegerOutput:
-        return IntegerOutput(value=self.value)
-
-
-@invocation(
-    "integer_collection",
-    title="Integer Collection Primitive",
-    tags=["primitives", "integer", "collection"],
-    category="primitives",
-)
-class IntegerCollectionInvocation(BaseInvocation):
-    """A collection of integer primitive values"""
-
-    collection: list[int] = InputField(
-        default_factory=list, description="The collection of integer values", ui_type=UIType.IntegerCollection
-    )
-
-    def invoke(self, context: InvocationContext) -> IntegerCollectionOutput:
-        return IntegerCollectionOutput(collection=self.collection)
-
-
-# endregion
-
-# region Float
-
-
-@invocation_output("float_output")
-class FloatOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single float"""
-
-    value: float = OutputField(description="The output float")
-
-
-@invocation_output("float_collection_output")
-class FloatCollectionOutput(BaseInvocationOutput):
-    """Base class for nodes that output a collection of floats"""
-
-    collection: list[float] = OutputField(description="The float collection", ui_type=UIType.FloatCollection)
-
-
-@invocation("float", title="Float Primitive", tags=["primitives", "float"], category="primitives")
-class FloatInvocation(BaseInvocation):
-    """A float primitive value"""
-
-    value: float = InputField(default=0.0, description="The float value")
-
-    def invoke(self, context: InvocationContext) -> FloatOutput:
-        return FloatOutput(value=self.value)
-
-
-@invocation(
-    "float_collection",
-    title="Float Collection Primitive",
-    tags=["primitives", "float", "collection"],
-    category="primitives",
-)
-class FloatCollectionInvocation(BaseInvocation):
-    """A collection of float primitive values"""
-
-    collection: list[float] = InputField(
-        default_factory=list, description="The collection of float values", ui_type=UIType.FloatCollection
-    )
-
-    def invoke(self, context: InvocationContext) -> FloatCollectionOutput:
-        return FloatCollectionOutput(collection=self.collection)
-
-
-# endregion
-
-# region String
-
-
-@invocation_output("string_output")
-class StringOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single string"""
-
-    value: str = OutputField(description="The output string")
-
-
-@invocation_output("string_collection_output")
-class StringCollectionOutput(BaseInvocationOutput):
-    """Base class for nodes that output a collection of strings"""
-
-    collection: list[str] = OutputField(description="The output strings", ui_type=UIType.StringCollection)
-
-
-@invocation("string", title="String Primitive", tags=["primitives", "string"], category="primitives")
-class StringInvocation(BaseInvocation):
-    """A string primitive value"""
-
-    value: str = InputField(default="", description="The string value", ui_component=UIComponent.Textarea)
-
-    def invoke(self, context: InvocationContext) -> StringOutput:
-        return StringOutput(value=self.value)
-
-
-@invocation(
-    "string_collection",
-    title="String Collection Primitive",
-    tags=["primitives", "string", "collection"],
-    category="primitives",
-)
-class StringCollectionInvocation(BaseInvocation):
-    """A collection of string primitive values"""
-
-    collection: list[str] = InputField(
-        default_factory=list, description="The collection of string values", ui_type=UIType.StringCollection
-    )
-
-    def invoke(self, context: InvocationContext) -> StringCollectionOutput:
-        return StringCollectionOutput(collection=self.collection)
-
-
-# endregion
-
-# region Image
-
-
-class ImageField(BaseModel):
-    """An image primitive field"""
-
-    image_name: str = Field(description="The name of the image")
-
-
-@invocation_output("image_output")
-class ImageOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single image"""
-
-    image: ImageField = OutputField(description="The output image")
-    width: int = OutputField(description="The width of the image in pixels")
-    height: int = OutputField(description="The height of the image in pixels")
-
-
-@invocation_output("image_collection_output")
-class ImageCollectionOutput(BaseInvocationOutput):
-    """Base class for nodes that output a collection of images"""
-
-    collection: list[ImageField] = OutputField(description="The output images", ui_type=UIType.ImageCollection)
-
-
-@invocation("image", title="Image Primitive", tags=["primitives", "image"], category="primitives")
-class ImageInvocation(BaseInvocation):
-    """An image primitive value"""
-
-    image: ImageField = InputField(description="The image to load")
-
-    def invoke(self, context: InvocationContext) -> ImageOutput:
-        image = context.services.images.get_pil_image(self.image.image_name)
-
-        return ImageOutput(
-            image=ImageField(image_name=self.image.image_name),
-            width=image.width,
-            height=image.height,
-        )
-
-
-@invocation(
-    "image_collection",
-    title="Image Collection Primitive",
-    tags=["primitives", "image", "collection"],
-    category="primitives",
-)
-class ImageCollectionInvocation(BaseInvocation):
-    """A collection of image primitive values"""
-
-    collection: list[ImageField] = InputField(
-        default_factory=list, description="The collection of image values", ui_type=UIType.ImageCollection
-    )
-
-    def invoke(self, context: InvocationContext) -> ImageCollectionOutput:
-        return ImageCollectionOutput(collection=self.collection)
-
-
-# endregion
-
-# region DenoiseMask
-
-
-class DenoiseMaskField(BaseModel):
-    """An inpaint mask field"""
-
-    mask_name: str = Field(description="The name of the mask image")
-    masked_latents_name: Optional[str] = Field(description="The name of the masked image latents")
-
-
-@invocation_output("denoise_mask_output")
-class DenoiseMaskOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single image"""
-
-    denoise_mask: DenoiseMaskField = OutputField(description="Mask for denoise model run")
-
-
-# endregion
-
-# region Latents
-
-
-class LatentsField(BaseModel):
-    """A latents tensor primitive field"""
-
-    latents_name: str = Field(description="The name of the latents")
-    seed: Optional[int] = Field(default=None, description="Seed used to generate this latents")
-
-
-@invocation_output("latents_output")
-class LatentsOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single latents tensor"""
-
-    latents: LatentsField = OutputField(
-        description=FieldDescriptions.latents,
-    )
-    width: int = OutputField(description=FieldDescriptions.width)
-    height: int = OutputField(description=FieldDescriptions.height)
-
-
-@invocation_output("latents_collection_output")
-class LatentsCollectionOutput(BaseInvocationOutput):
-    """Base class for nodes that output a collection of latents tensors"""
-
-    collection: list[LatentsField] = OutputField(
-        description=FieldDescriptions.latents,
-        ui_type=UIType.LatentsCollection,
-    )
-
-
-@invocation("latents", title="Latents Primitive", tags=["primitives", "latents"], category="primitives")
-class LatentsInvocation(BaseInvocation):
-    """A latents tensor primitive value"""
-
-    latents: LatentsField = InputField(description="The latents tensor", input=Input.Connection)
-
-    def invoke(self, context: InvocationContext) -> LatentsOutput:
-        latents = context.services.latents.get(self.latents.latents_name)
-
-        return build_latents_output(self.latents.latents_name, latents)
-
-
-@invocation(
-    "latents_collection",
-    title="Latents Collection Primitive",
-    tags=["primitives", "latents", "collection"],
-    category="primitives",
-)
-class LatentsCollectionInvocation(BaseInvocation):
-    """A collection of latents tensor primitive values"""
-
-    collection: list[LatentsField] = InputField(
-        description="The collection of latents tensors", ui_type=UIType.LatentsCollection
-    )
-
-    def invoke(self, context: InvocationContext) -> LatentsCollectionOutput:
-        return LatentsCollectionOutput(collection=self.collection)
-
-
-def build_latents_output(latents_name: str, latents: torch.Tensor, seed: Optional[int] = None):
-    return LatentsOutput(
-        latents=LatentsField(latents_name=latents_name, seed=seed),
-        width=latents.size()[3] * 8,
-        height=latents.size()[2] * 8,
-    )
-
-
-# endregion
-
-# region Color
-
-
-class ColorField(BaseModel):
-    """A color primitive field"""
-
-    r: int = Field(ge=0, le=255, description="The red component")
-    g: int = Field(ge=0, le=255, description="The green component")
-    b: int = Field(ge=0, le=255, description="The blue component")
-    a: int = Field(ge=0, le=255, description="The alpha component")
-
-    def tuple(self) -> Tuple[int, int, int, int]:
-        return (self.r, self.g, self.b, self.a)
-
-
-@invocation_output("color_output")
-class ColorOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single color"""
-
-    color: ColorField = OutputField(description="The output color")
-
-
-@invocation_output("color_collection_output")
-class ColorCollectionOutput(BaseInvocationOutput):
-    """Base class for nodes that output a collection of colors"""
-
-    collection: list[ColorField] = OutputField(description="The output colors", ui_type=UIType.ColorCollection)
-
-
-@invocation("color", title="Color Primitive", tags=["primitives", "color"], category="primitives")
-class ColorInvocation(BaseInvocation):
-    """A color primitive value"""
-
-    color: ColorField = InputField(default=ColorField(r=0, g=0, b=0, a=255), description="The color value")
-
-    def invoke(self, context: InvocationContext) -> ColorOutput:
-        return ColorOutput(color=self.color)
-
-
-# endregion
-
-# region Conditioning
-
-
-class ConditioningField(BaseModel):
-    """A conditioning tensor primitive value"""
-
-    conditioning_name: str = Field(description="The name of conditioning tensor")
-
-
-@invocation_output("conditioning_output")
-class ConditioningOutput(BaseInvocationOutput):
-    """Base class for nodes that output a single conditioning tensor"""
-
-    conditioning: ConditioningField = OutputField(description=FieldDescriptions.cond)
-
-
-@invocation_output("conditioning_collection_output")
-class ConditioningCollectionOutput(BaseInvocationOutput):
-    """Base class for nodes that output a collection of conditioning tensors"""
-
-    collection: list[ConditioningField] = OutputField(
-        description="The output conditioning tensors",
-        ui_type=UIType.ConditioningCollection,
-    )
-
-
-@invocation(
-    "conditioning",
-    title="Conditioning Primitive",
-    tags=["primitives", "conditioning"],
-    category="primitives",
-)
-class ConditioningInvocation(BaseInvocation):
-    """A conditioning tensor primitive value"""
-
-    conditioning: ConditioningField = InputField(description=FieldDescriptions.cond, input=Input.Connection)
-
-    def invoke(self, context: InvocationContext) -> ConditioningOutput:
-        return ConditioningOutput(conditioning=self.conditioning)
-
-
-@invocation(
-    "conditioning_collection",
-    title="Conditioning Collection Primitive",
-    tags=["primitives", "conditioning", "collection"],
-    category="primitives",
-)
-class ConditioningCollectionInvocation(BaseInvocation):
-    """A collection of conditioning tensor primitive values"""
-
-    collection: list[ConditioningField] = InputField(
-        default_factory=list,
-        description="The collection of conditioning tensors",
-        ui_type=UIType.ConditioningCollection,
-    )
-
-    def invoke(self, context: InvocationContext) -> ConditioningCollectionOutput:
-        return ConditioningCollectionOutput(collection=self.collection)
-
-
-# endregion

invokeai/app/invocations/prompt.py

@@ -1,24 +1,62 @@
 from os.path import exists
-from typing import Optional, Union
+from typing import Literal, Optional
 
 import numpy as np
-from dynamicprompts.generators import CombinatorialPromptGenerator, RandomPromptGenerator
-from pydantic import validator
+from pydantic import Field, validator
 
-from invokeai.app.invocations.primitives import StringCollectionOutput
+from .baseinvocation import BaseInvocation, BaseInvocationOutput, InvocationConfig, InvocationContext
+from dynamicprompts.generators import RandomPromptGenerator, CombinatorialPromptGenerator
 
-from .baseinvocation import BaseInvocation, InputField, InvocationContext, UIComponent, invocation
+class PromptOutput(BaseInvocationOutput):
+    """Base class for invocations that output a prompt"""
+    #fmt: off
+    type: Literal["prompt"] = "prompt"
+
+    prompt: str = Field(default=None, description="The output prompt")
+    #fmt: on
+
+    class Config:
+        schema_extra = {
+            'required': [
+                'type',
+                'prompt',
+            ]
+        }
+
+
+class PromptCollectionOutput(BaseInvocationOutput):
+    """Base class for invocations that output a collection of prompts"""
+
+    # fmt: off
+    type: Literal["prompt_collection_output"] = "prompt_collection_output"
+
+    prompt_collection: list[str] = Field(description="The output prompt collection")
+    count: int = Field(description="The size of the prompt collection")
+    # fmt: on
+
+    class Config:
+        schema_extra = {"required": ["type", "prompt_collection", "count"]}
 
 
-@invocation("dynamic_prompt", title="Dynamic Prompt", tags=["prompt", "collection"], category="prompt")
 class DynamicPromptInvocation(BaseInvocation):
     """Parses a prompt using adieyal/dynamicprompts' random or combinatorial generator"""
 
-    prompt: str = InputField(description="The prompt to parse with dynamicprompts", ui_component=UIComponent.Textarea)
-    max_prompts: int = InputField(default=1, description="The number of prompts to generate")
-    combinatorial: bool = InputField(default=False, description="Whether to use the combinatorial generator")
+    type: Literal["dynamic_prompt"] = "dynamic_prompt"
+    prompt: str = Field(description="The prompt to parse with dynamicprompts")
+    max_prompts: int = Field(default=1, description="The number of prompts to generate")
+    combinatorial: bool = Field(
+        default=False, description="Whether to use the combinatorial generator"
+    )
 
-    def invoke(self, context: InvocationContext) -> StringCollectionOutput:
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Dynamic Prompt",
+                "tags": ["prompt", "dynamic"]
+            },
+        }
+
+    def invoke(self, context: InvocationContext) -> PromptCollectionOutput:
         if self.combinatorial:
             generator = CombinatorialPromptGenerator()
             prompts = generator.generate(self.prompt, max_prompts=self.max_prompts)
@@ -26,22 +64,29 @@ class DynamicPromptInvocation(BaseInvocation):
             generator = RandomPromptGenerator()
             prompts = generator.generate(self.prompt, num_images=self.max_prompts)
 
-        return StringCollectionOutput(collection=prompts)
+        return PromptCollectionOutput(prompt_collection=prompts, count=len(prompts))
+    
 
-
-@invocation("prompt_from_file", title="Prompts from File", tags=["prompt", "file"], category="prompt")
 class PromptsFromFileInvocation(BaseInvocation):
-    """Loads prompts from a text file"""
+    '''Loads prompts from a text file'''
+    # fmt: off
+    type: Literal['prompt_from_file'] = 'prompt_from_file'
 
-    file_path: str = InputField(description="Path to prompt text file")
-    pre_prompt: Optional[str] = InputField(
-        default=None, description="String to prepend to each prompt", ui_component=UIComponent.Textarea
-    )
-    post_prompt: Optional[str] = InputField(
-        default=None, description="String to append to each prompt", ui_component=UIComponent.Textarea
-    )
-    start_line: int = InputField(default=1, ge=1, description="Line in the file to start start from")
-    max_prompts: int = InputField(default=1, ge=0, description="Max lines to read from file (0=all)")
+    # Inputs
+    file_path: str = Field(description="Path to prompt text file")
+    pre_prompt: Optional[str] = Field(description="String to prepend to each prompt")
+    post_prompt: Optional[str] = Field(description="String to append to each prompt")
+    start_line: int = Field(default=1, ge=1, description="Line in the file to start start from")
+    max_prompts: int = Field(default=1, ge=0, description="Max lines to read from file (0=all)")
+    #fmt: on
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Prompts From File",
+                "tags": ["prompt", "file"]
+            },
+        }
 
     @validator("file_path")
     def file_path_exists(cls, v):
@@ -49,14 +94,7 @@ class PromptsFromFileInvocation(BaseInvocation):
             raise ValueError(FileNotFoundError)
         return v
 
-    def promptsFromFile(
-        self,
-        file_path: str,
-        pre_prompt: Union[str, None],
-        post_prompt: Union[str, None],
-        start_line: int,
-        max_prompts: int,
-    ):
+    def promptsFromFile(self, file_path: str, pre_prompt: str, post_prompt: str, start_line: int, max_prompts: int):
         prompts = []
         start_line -= 1
         end_line = start_line + max_prompts
@@ -65,13 +103,11 @@ class PromptsFromFileInvocation(BaseInvocation):
         with open(file_path) as f:
             for i, line in enumerate(f):
                 if i >= start_line and i < end_line:
-                    prompts.append((pre_prompt or "") + line.strip() + (post_prompt or ""))
+                    prompts.append((pre_prompt or '') + line.strip() + (post_prompt or ''))
                 if i >= end_line:
                     break
         return prompts
 
-    def invoke(self, context: InvocationContext) -> StringCollectionOutput:
-        prompts = self.promptsFromFile(
-            self.file_path, self.pre_prompt, self.post_prompt, self.start_line, self.max_prompts
-        )
-        return StringCollectionOutput(collection=prompts)
+    def invoke(self, context: InvocationContext) -> PromptCollectionOutput:
+        prompts = self.promptsFromFile(self.file_path, self.pre_prompt, self.post_prompt, self.start_line, self.max_prompts)
+        return PromptCollectionOutput(prompt_collection=prompts, count=len(prompts))

invokeai/app/invocations/sdxl.py

@@ -1,47 +1,59 @@
+import torch
+import inspect
+from tqdm import tqdm
+from typing import List, Literal, Optional, Union
+
+from pydantic import Field, validator
+
 from ...backend.model_management import ModelType, SubModelType
-from .baseinvocation import (
-    BaseInvocation,
-    BaseInvocationOutput,
-    FieldDescriptions,
-    Input,
-    InputField,
-    InvocationContext,
-    OutputField,
-    UIType,
-    invocation,
-    invocation_output,
-)
-from .model import ClipField, MainModelField, ModelInfo, UNetField, VaeField
+from invokeai.app.util.step_callback import stable_diffusion_xl_step_callback
+from .baseinvocation import (BaseInvocation, BaseInvocationOutput,
+                             InvocationConfig, InvocationContext)
 
+from .model import UNetField, ClipField, VaeField, MainModelField, ModelInfo
+from .compel import ConditioningField
+from .latent import LatentsField, SAMPLER_NAME_VALUES, LatentsOutput, get_scheduler, build_latents_output
 
-@invocation_output("sdxl_model_loader_output")
 class SDXLModelLoaderOutput(BaseInvocationOutput):
     """SDXL base model loader output"""
 
-    unet: UNetField = OutputField(description=FieldDescriptions.unet, title="UNet")
-    clip: ClipField = OutputField(description=FieldDescriptions.clip, title="CLIP 1")
-    clip2: ClipField = OutputField(description=FieldDescriptions.clip, title="CLIP 2")
-    vae: VaeField = OutputField(description=FieldDescriptions.vae, title="VAE")
+    # fmt: off
+    type: Literal["sdxl_model_loader_output"] = "sdxl_model_loader_output"
 
+    unet: UNetField = Field(default=None, description="UNet submodel")
+    clip: ClipField = Field(default=None, description="Tokenizer and text_encoder submodels")
+    clip2: ClipField = Field(default=None, description="Tokenizer and text_encoder submodels")
+    vae: VaeField = Field(default=None, description="Vae submodel")
+    # fmt: on
 
-@invocation_output("sdxl_refiner_model_loader_output")
 class SDXLRefinerModelLoaderOutput(BaseInvocationOutput):
     """SDXL refiner model loader output"""
-
-    unet: UNetField = OutputField(description=FieldDescriptions.unet, title="UNet")
-    clip2: ClipField = OutputField(description=FieldDescriptions.clip, title="CLIP 2")
-    vae: VaeField = OutputField(description=FieldDescriptions.vae, title="VAE")
-
-
-@invocation("sdxl_model_loader", title="SDXL Main Model", tags=["model", "sdxl"], category="model")
+    # fmt: off
+    type: Literal["sdxl_refiner_model_loader_output"] = "sdxl_refiner_model_loader_output"
+    unet: UNetField = Field(default=None, description="UNet submodel")
+    clip2: ClipField = Field(default=None, description="Tokenizer and text_encoder submodels")
+    vae: VaeField = Field(default=None, description="Vae submodel")
+    # fmt: on
+    #fmt: on
+    
 class SDXLModelLoaderInvocation(BaseInvocation):
     """Loads an sdxl base model, outputting its submodels."""
 
-    model: MainModelField = InputField(
-        description=FieldDescriptions.sdxl_main_model, input=Input.Direct, ui_type=UIType.SDXLMainModel
-    )
+    type: Literal["sdxl_model_loader"] = "sdxl_model_loader"
+
+    model: MainModelField = Field(description="The model to load")
     # TODO: precision?
 
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "SDXL Model Loader",
+                "tags": ["model", "loader", "sdxl"],
+                "type_hints": {"model": "model"},
+            },
+        }
+
     def invoke(self, context: InvocationContext) -> SDXLModelLoaderOutput:
         base_model = self.model.base_model
         model_name = self.model.model_name
@@ -113,23 +125,23 @@ class SDXLModelLoaderInvocation(BaseInvocation):
             ),
         )
 
-
-@invocation(
-    "sdxl_refiner_model_loader",
-    title="SDXL Refiner Model",
-    tags=["model", "sdxl", "refiner"],
-    category="model",
-)
 class SDXLRefinerModelLoaderInvocation(BaseInvocation):
     """Loads an sdxl refiner model, outputting its submodels."""
+    type: Literal["sdxl_refiner_model_loader"] = "sdxl_refiner_model_loader"
 
-    model: MainModelField = InputField(
-        description=FieldDescriptions.sdxl_refiner_model,
-        input=Input.Direct,
-        ui_type=UIType.SDXLRefinerModel,
-    )
+    model: MainModelField = Field(description="The model to load")
     # TODO: precision?
 
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "SDXL Refiner Model Loader",
+                "tags": ["model", "loader", "sdxl_refiner"],
+                "type_hints": {"model": "refiner_model"},
+            },
+        }
+
     def invoke(self, context: InvocationContext) -> SDXLRefinerModelLoaderOutput:
         base_model = self.model.base_model
         model_name = self.model.model_name
@@ -184,3 +196,514 @@ class SDXLRefinerModelLoaderInvocation(BaseInvocation):
                 ),
             ),
         )
+    
+# Text to image
+class SDXLTextToLatentsInvocation(BaseInvocation):
+    """Generates latents from conditionings."""
+
+    type: Literal["t2l_sdxl"] = "t2l_sdxl"
+
+    # Inputs
+    # fmt: off
+    positive_conditioning: Optional[ConditioningField] = Field(description="Positive conditioning for generation")
+    negative_conditioning: Optional[ConditioningField] = Field(description="Negative conditioning for generation")
+    noise: Optional[LatentsField] = Field(description="The noise to use")
+    steps:       int = Field(default=10, gt=0, description="The number of steps to use to generate the image")
+    cfg_scale: Union[float, List[float]] = Field(default=7.5, ge=1, description="The Classifier-Free Guidance, higher values may result in a result closer to the prompt", )
+    scheduler: SAMPLER_NAME_VALUES = Field(default="euler", description="The scheduler to use" )
+    unet: UNetField = Field(default=None, description="UNet submodel")
+    denoising_end: float = Field(default=1.0, gt=0, le=1, description="")
+    #control: Union[ControlField, list[ControlField]] = Field(default=None, description="The control to use")
+    #seamless:   bool = Field(default=False, description="Whether or not to generate an image that can tile without seams", )
+    #seamless_axes: str = Field(default="", description="The axes to tile the image on, 'x' and/or 'y'")
+    # fmt: on
+
+    @validator("cfg_scale")
+    def ge_one(cls, v):
+        """validate that all cfg_scale values are >= 1"""
+        if isinstance(v, list):
+            for i in v:
+                if i < 1:
+                    raise ValueError('cfg_scale must be greater than 1')
+        else:
+            if v < 1:
+                raise ValueError('cfg_scale must be greater than 1')
+        return v
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "SDXL Text To Latents",
+                "tags": ["latents"],
+                "type_hints": {
+                  "model": "model",
+                  # "cfg_scale": "float",
+                  "cfg_scale": "number"
+                }
+            },
+        }
+
+    def dispatch_progress(
+        self,
+        context: InvocationContext,
+        source_node_id: str,
+        sample,
+        step,
+        total_steps,
+    ) -> None:
+        stable_diffusion_xl_step_callback(
+            context=context,
+            node=self.dict(),
+            source_node_id=source_node_id,
+            sample=sample,
+            step=step,
+            total_steps=total_steps,
+        )
+
+    # based on
+    # https://github.com/huggingface/diffusers/blob/3ebbaf7c96801271f9e6c21400033b6aa5ffcf29/src/diffusers/pipelines/stable_diffusion/pipeline_onnx_stable_diffusion.py#L375
+    @torch.no_grad()
+    def invoke(self, context: InvocationContext) -> LatentsOutput:
+        graph_execution_state = context.services.graph_execution_manager.get(
+            context.graph_execution_state_id
+        )
+        source_node_id = graph_execution_state.prepared_source_mapping[self.id]
+        latents = context.services.latents.get(self.noise.latents_name)
+
+        positive_cond_data = context.services.latents.get(self.positive_conditioning.conditioning_name)
+        prompt_embeds = positive_cond_data.conditionings[0].embeds
+        pooled_prompt_embeds = positive_cond_data.conditionings[0].pooled_embeds
+        add_time_ids = positive_cond_data.conditionings[0].add_time_ids
+
+        negative_cond_data = context.services.latents.get(self.negative_conditioning.conditioning_name)
+        negative_prompt_embeds = negative_cond_data.conditionings[0].embeds
+        negative_pooled_prompt_embeds = negative_cond_data.conditionings[0].pooled_embeds
+        add_neg_time_ids = negative_cond_data.conditionings[0].add_time_ids
+
+        scheduler = get_scheduler(
+            context=context,
+            scheduler_info=self.unet.scheduler,
+            scheduler_name=self.scheduler,
+        )
+
+        num_inference_steps = self.steps
+        scheduler.set_timesteps(num_inference_steps)
+        timesteps = scheduler.timesteps
+
+        latents = latents * scheduler.init_noise_sigma
+
+
+        unet_info = context.services.model_manager.get_model(
+            **self.unet.unet.dict(), context=context
+        )
+        do_classifier_free_guidance = True
+        cross_attention_kwargs = None
+        with unet_info as unet:
+
+            extra_step_kwargs = dict()
+            if "eta" in set(inspect.signature(scheduler.step).parameters.keys()):
+                extra_step_kwargs.update(
+                    eta=0.0,
+                )
+            if "generator" in set(inspect.signature(scheduler.step).parameters.keys()):
+                extra_step_kwargs.update(
+                    generator=torch.Generator(device=unet.device).manual_seed(0),
+                )
+
+            num_warmup_steps = len(timesteps) - self.steps * scheduler.order
+
+            # apply denoising_end
+            skipped_final_steps = int(round((1 - self.denoising_end) * self.steps))
+            num_inference_steps = num_inference_steps - skipped_final_steps
+            timesteps = timesteps[: num_warmup_steps + scheduler.order * num_inference_steps]
+
+            if not context.services.configuration.sequential_guidance:
+                prompt_embeds = torch.cat([negative_prompt_embeds, prompt_embeds], dim=0)
+                add_text_embeds = torch.cat([negative_pooled_prompt_embeds, pooled_prompt_embeds], dim=0)
+                add_time_ids = torch.cat([add_neg_time_ids, add_time_ids], dim=0)
+
+                prompt_embeds = prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                add_text_embeds = add_text_embeds.to(device=unet.device, dtype=unet.dtype)
+                add_time_ids = add_time_ids.to(device=unet.device, dtype=unet.dtype)
+                latents = latents.to(device=unet.device, dtype=unet.dtype)
+
+                with tqdm(total=num_inference_steps) as progress_bar:
+                    for i, t in enumerate(timesteps):
+                        # expand the latents if we are doing classifier free guidance
+                        latent_model_input = torch.cat([latents] * 2) if do_classifier_free_guidance else latents
+
+                        latent_model_input = scheduler.scale_model_input(latent_model_input, t)
+
+                        # predict the noise residual
+                        added_cond_kwargs = {"text_embeds": add_text_embeds, "time_ids": add_time_ids}
+                        noise_pred = unet(
+                            latent_model_input,
+                            t,
+                            encoder_hidden_states=prompt_embeds,
+                            cross_attention_kwargs=cross_attention_kwargs,
+                            added_cond_kwargs=added_cond_kwargs,
+                            return_dict=False,
+                        )[0]
+
+                        # perform guidance
+                        if do_classifier_free_guidance:
+                            noise_pred_uncond, noise_pred_text = noise_pred.chunk(2)
+                            noise_pred = noise_pred_uncond + self.cfg_scale * (noise_pred_text - noise_pred_uncond)
+                            #del noise_pred_uncond
+                            #del noise_pred_text
+
+                        #if do_classifier_free_guidance and guidance_rescale > 0.0:
+                        #    # Based on 3.4. in https://arxiv.org/pdf/2305.08891.pdf
+                        #    noise_pred = rescale_noise_cfg(noise_pred, noise_pred_text, guidance_rescale=guidance_rescale)
+
+                        # compute the previous noisy sample x_t -> x_t-1
+                        latents = scheduler.step(noise_pred, t, latents, **extra_step_kwargs, return_dict=False)[0]
+
+                        # call the callback, if provided
+                        if i == len(timesteps) - 1 or ((i + 1) > num_warmup_steps and (i + 1) % scheduler.order == 0):
+                            progress_bar.update()
+                            self.dispatch_progress(context, source_node_id, latents, i, num_inference_steps)
+                            #if callback is not None and i % callback_steps == 0:
+                            #    callback(i, t, latents)
+            else:
+                negative_pooled_prompt_embeds = negative_pooled_prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                negative_prompt_embeds = negative_prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                add_neg_time_ids = add_neg_time_ids.to(device=unet.device, dtype=unet.dtype)
+                pooled_prompt_embeds = pooled_prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                prompt_embeds = prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                add_time_ids = add_time_ids.to(device=unet.device, dtype=unet.dtype)
+                latents = latents.to(device=unet.device, dtype=unet.dtype)
+
+                with tqdm(total=num_inference_steps) as progress_bar:
+                    for i, t in enumerate(timesteps):
+                        # expand the latents if we are doing classifier free guidance
+                        #latent_model_input = torch.cat([latents] * 2) if do_classifier_free_guidance else latents
+
+                        latent_model_input = scheduler.scale_model_input(latents, t)
+
+                        #import gc
+                        #gc.collect()
+                        #torch.cuda.empty_cache()
+
+                        # predict the noise residual
+
+                        added_cond_kwargs = {"text_embeds": negative_pooled_prompt_embeds, "time_ids": add_neg_time_ids}
+                        noise_pred_uncond = unet(
+                            latent_model_input,
+                            t,
+                            encoder_hidden_states=negative_prompt_embeds,
+                            cross_attention_kwargs=cross_attention_kwargs,
+                            added_cond_kwargs=added_cond_kwargs,
+                            return_dict=False,
+                        )[0]
+
+                        added_cond_kwargs = {"text_embeds": pooled_prompt_embeds, "time_ids": add_time_ids}
+                        noise_pred_text = unet(
+                            latent_model_input,
+                            t,
+                            encoder_hidden_states=prompt_embeds,
+                            cross_attention_kwargs=cross_attention_kwargs,
+                            added_cond_kwargs=added_cond_kwargs,
+                            return_dict=False,
+                        )[0]
+
+                        # perform guidance
+                        noise_pred = noise_pred_uncond + self.cfg_scale * (noise_pred_text - noise_pred_uncond)
+
+                        #del noise_pred_text
+                        #del noise_pred_uncond
+                        #import gc
+                        #gc.collect()
+                        #torch.cuda.empty_cache()
+
+                        #if do_classifier_free_guidance and guidance_rescale > 0.0:
+                        #    # Based on 3.4. in https://arxiv.org/pdf/2305.08891.pdf
+                        #    noise_pred = rescale_noise_cfg(noise_pred, noise_pred_text, guidance_rescale=guidance_rescale)
+
+                        # compute the previous noisy sample x_t -> x_t-1
+                        latents = scheduler.step(noise_pred, t, latents, **extra_step_kwargs, return_dict=False)[0]
+
+                        #del noise_pred
+                        #import gc
+                        #gc.collect()
+                        #torch.cuda.empty_cache()
+
+                        # call the callback, if provided
+                        if i == len(timesteps) - 1 or ((i + 1) > num_warmup_steps and (i + 1) % scheduler.order == 0):
+                            progress_bar.update()
+                            self.dispatch_progress(context, source_node_id, latents, i, num_inference_steps)
+                            #if callback is not None and i % callback_steps == 0:
+                            #    callback(i, t, latents)
+
+
+
+        #################
+
+        latents = latents.to("cpu")
+        torch.cuda.empty_cache()
+
+        name = f'{context.graph_execution_state_id}__{self.id}'
+        context.services.latents.save(name, latents)
+        return build_latents_output(latents_name=name, latents=latents)
+
+class SDXLLatentsToLatentsInvocation(BaseInvocation):
+    """Generates latents from conditionings."""
+
+    type: Literal["l2l_sdxl"] = "l2l_sdxl"
+
+    # Inputs
+    # fmt: off
+    positive_conditioning: Optional[ConditioningField] = Field(description="Positive conditioning for generation")
+    negative_conditioning: Optional[ConditioningField] = Field(description="Negative conditioning for generation")
+    noise: Optional[LatentsField] = Field(description="The noise to use")
+    steps:       int = Field(default=10, gt=0, description="The number of steps to use to generate the image")
+    cfg_scale: Union[float, List[float]] = Field(default=7.5, ge=1, description="The Classifier-Free Guidance, higher values may result in a result closer to the prompt", )
+    scheduler: SAMPLER_NAME_VALUES = Field(default="euler", description="The scheduler to use" )
+    unet: UNetField = Field(default=None, description="UNet submodel")
+    latents: Optional[LatentsField] = Field(description="Initial latents")
+
+    denoising_start: float = Field(default=0.0, ge=0, le=1, description="")
+    denoising_end: float = Field(default=1.0, ge=0, le=1, description="")
+
+    #control: Union[ControlField, list[ControlField]] = Field(default=None, description="The control to use")
+    #seamless:   bool = Field(default=False, description="Whether or not to generate an image that can tile without seams", )
+    #seamless_axes: str = Field(default="", description="The axes to tile the image on, 'x' and/or 'y'")
+    # fmt: on
+
+    @validator("cfg_scale")
+    def ge_one(cls, v):
+        """validate that all cfg_scale values are >= 1"""
+        if isinstance(v, list):
+            for i in v:
+                if i < 1:
+                    raise ValueError('cfg_scale must be greater than 1')
+        else:
+            if v < 1:
+                raise ValueError('cfg_scale must be greater than 1')
+        return v
+
+    # Schema customisation
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "SDXL Latents to Latents",
+                "tags": ["latents"],
+                "type_hints": {
+                  "model": "model",
+                  # "cfg_scale": "float",
+                  "cfg_scale": "number"
+                }
+            },
+        }
+
+    def dispatch_progress(
+        self,
+        context: InvocationContext,
+        source_node_id: str,
+        sample,
+        step,
+        total_steps,
+    ) -> None:
+        stable_diffusion_xl_step_callback(
+            context=context,
+            node=self.dict(),
+            source_node_id=source_node_id,
+            sample=sample,
+            step=step,
+            total_steps=total_steps,
+        )
+
+    # based on
+    # https://github.com/huggingface/diffusers/blob/3ebbaf7c96801271f9e6c21400033b6aa5ffcf29/src/diffusers/pipelines/stable_diffusion/pipeline_onnx_stable_diffusion.py#L375
+    @torch.no_grad()
+    def invoke(self, context: InvocationContext) -> LatentsOutput:
+        graph_execution_state = context.services.graph_execution_manager.get(
+            context.graph_execution_state_id
+        )
+        source_node_id = graph_execution_state.prepared_source_mapping[self.id]
+        latents = context.services.latents.get(self.latents.latents_name)
+
+        positive_cond_data = context.services.latents.get(self.positive_conditioning.conditioning_name)
+        prompt_embeds = positive_cond_data.conditionings[0].embeds
+        pooled_prompt_embeds = positive_cond_data.conditionings[0].pooled_embeds
+        add_time_ids = positive_cond_data.conditionings[0].add_time_ids
+
+        negative_cond_data = context.services.latents.get(self.negative_conditioning.conditioning_name)
+        negative_prompt_embeds = negative_cond_data.conditionings[0].embeds
+        negative_pooled_prompt_embeds = negative_cond_data.conditionings[0].pooled_embeds
+        add_neg_time_ids = negative_cond_data.conditionings[0].add_time_ids
+
+        scheduler = get_scheduler(
+            context=context,
+            scheduler_info=self.unet.scheduler,
+            scheduler_name=self.scheduler,
+        )
+
+        # apply denoising_start
+        num_inference_steps = self.steps
+        scheduler.set_timesteps(num_inference_steps)
+
+        t_start = int(round(self.denoising_start * num_inference_steps))
+        timesteps = scheduler.timesteps[t_start * scheduler.order:]
+        num_inference_steps = num_inference_steps - t_start
+
+        # apply noise(if provided)
+        if self.noise is not None and timesteps.shape[0] > 0:
+            noise = context.services.latents.get(self.noise.latents_name)
+            latents = scheduler.add_noise(latents, noise, timesteps[:1])
+            del noise
+
+        unet_info = context.services.model_manager.get_model(
+            **self.unet.unet.dict(), context=context,
+        )
+        do_classifier_free_guidance = True
+        cross_attention_kwargs = None
+        with unet_info as unet:
+
+            # apply scheduler extra args
+            extra_step_kwargs = dict()
+            if "eta" in set(inspect.signature(scheduler.step).parameters.keys()):
+                extra_step_kwargs.update(
+                    eta=0.0,
+                )
+            if "generator" in set(inspect.signature(scheduler.step).parameters.keys()):
+                extra_step_kwargs.update(
+                    generator=torch.Generator(device=unet.device).manual_seed(0),
+                )
+
+            num_warmup_steps = max(len(timesteps) - num_inference_steps * scheduler.order, 0)
+
+            # apply denoising_end
+            skipped_final_steps = int(round((1 - self.denoising_end) * self.steps))
+            num_inference_steps = num_inference_steps - skipped_final_steps
+            timesteps = timesteps[: num_warmup_steps + scheduler.order * num_inference_steps]
+
+            if not context.services.configuration.sequential_guidance:
+                prompt_embeds = torch.cat([negative_prompt_embeds, prompt_embeds], dim=0)
+                add_text_embeds = torch.cat([negative_pooled_prompt_embeds, pooled_prompt_embeds], dim=0)
+                add_time_ids = torch.cat([add_neg_time_ids, add_time_ids], dim=0)
+
+                prompt_embeds = prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                add_text_embeds = add_text_embeds.to(device=unet.device, dtype=unet.dtype)
+                add_time_ids = add_time_ids.to(device=unet.device, dtype=unet.dtype)
+                latents = latents.to(device=unet.device, dtype=unet.dtype)
+
+                with tqdm(total=num_inference_steps) as progress_bar:
+                    for i, t in enumerate(timesteps):
+                        # expand the latents if we are doing classifier free guidance
+                        latent_model_input = torch.cat([latents] * 2) if do_classifier_free_guidance else latents
+
+                        latent_model_input = scheduler.scale_model_input(latent_model_input, t)
+
+                        # predict the noise residual
+                        added_cond_kwargs = {"text_embeds": add_text_embeds, "time_ids": add_time_ids}
+                        noise_pred = unet(
+                            latent_model_input,
+                            t,
+                            encoder_hidden_states=prompt_embeds,
+                            cross_attention_kwargs=cross_attention_kwargs,
+                            added_cond_kwargs=added_cond_kwargs,
+                            return_dict=False,
+                        )[0]
+
+                        # perform guidance
+                        if do_classifier_free_guidance:
+                            noise_pred_uncond, noise_pred_text = noise_pred.chunk(2)
+                            noise_pred = noise_pred_uncond + self.cfg_scale * (noise_pred_text - noise_pred_uncond)
+                            #del noise_pred_uncond
+                            #del noise_pred_text
+
+                        #if do_classifier_free_guidance and guidance_rescale > 0.0:
+                        #    # Based on 3.4. in https://arxiv.org/pdf/2305.08891.pdf
+                        #    noise_pred = rescale_noise_cfg(noise_pred, noise_pred_text, guidance_rescale=guidance_rescale)
+
+                        # compute the previous noisy sample x_t -> x_t-1
+                        latents = scheduler.step(noise_pred, t, latents, **extra_step_kwargs, return_dict=False)[0]
+
+                        # call the callback, if provided
+                        if i == len(timesteps) - 1 or ((i + 1) > num_warmup_steps and (i + 1) % scheduler.order == 0):
+                            progress_bar.update()
+                            self.dispatch_progress(context, source_node_id, latents, i, num_inference_steps)
+                            #if callback is not None and i % callback_steps == 0:
+                            #    callback(i, t, latents)
+            else:
+                negative_pooled_prompt_embeds = negative_pooled_prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                negative_prompt_embeds = negative_prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                add_neg_time_ids = add_neg_time_ids.to(device=unet.device, dtype=unet.dtype)
+                pooled_prompt_embeds = pooled_prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                prompt_embeds = prompt_embeds.to(device=unet.device, dtype=unet.dtype)
+                add_time_ids = add_time_ids.to(device=unet.device, dtype=unet.dtype)
+                latents = latents.to(device=unet.device, dtype=unet.dtype)
+
+                with tqdm(total=num_inference_steps) as progress_bar:
+                    for i, t in enumerate(timesteps):
+                        # expand the latents if we are doing classifier free guidance
+                        #latent_model_input = torch.cat([latents] * 2) if do_classifier_free_guidance else latents
+
+                        latent_model_input = scheduler.scale_model_input(latents, t)
+
+                        #import gc
+                        #gc.collect()
+                        #torch.cuda.empty_cache()
+
+                        # predict the noise residual
+
+                        added_cond_kwargs = {"text_embeds": negative_pooled_prompt_embeds, "time_ids": add_time_ids}
+                        noise_pred_uncond = unet(
+                            latent_model_input,
+                            t,
+                            encoder_hidden_states=negative_prompt_embeds,
+                            cross_attention_kwargs=cross_attention_kwargs,
+                            added_cond_kwargs=added_cond_kwargs,
+                            return_dict=False,
+                        )[0]
+
+                        added_cond_kwargs = {"text_embeds": pooled_prompt_embeds, "time_ids": add_time_ids}
+                        noise_pred_text = unet(
+                            latent_model_input,
+                            t,
+                            encoder_hidden_states=prompt_embeds,
+                            cross_attention_kwargs=cross_attention_kwargs,
+                            added_cond_kwargs=added_cond_kwargs,
+                            return_dict=False,
+                        )[0]
+
+                        # perform guidance
+                        noise_pred = noise_pred_uncond + self.cfg_scale * (noise_pred_text - noise_pred_uncond)
+
+                        #del noise_pred_text
+                        #del noise_pred_uncond
+                        #import gc
+                        #gc.collect()
+                        #torch.cuda.empty_cache()
+
+                        #if do_classifier_free_guidance and guidance_rescale > 0.0:
+                        #    # Based on 3.4. in https://arxiv.org/pdf/2305.08891.pdf
+                        #    noise_pred = rescale_noise_cfg(noise_pred, noise_pred_text, guidance_rescale=guidance_rescale)
+
+                        # compute the previous noisy sample x_t -> x_t-1
+                        latents = scheduler.step(noise_pred, t, latents, **extra_step_kwargs, return_dict=False)[0]
+
+                        #del noise_pred
+                        #import gc
+                        #gc.collect()
+                        #torch.cuda.empty_cache()
+
+                        # call the callback, if provided
+                        if i == len(timesteps) - 1 or ((i + 1) > num_warmup_steps and (i + 1) % scheduler.order == 0):
+                            progress_bar.update()
+                            self.dispatch_progress(context, source_node_id, latents, i, num_inference_steps)
+                            #if callback is not None and i % callback_steps == 0:
+                            #    callback(i, t, latents)
+
+
+
+        #################
+
+        latents = latents.to("cpu")
+        torch.cuda.empty_cache()
+
+        name = f'{context.graph_execution_state_id}__{self.id}'
+        context.services.latents.save(name, latents)
+        return build_latents_output(latents_name=name, latents=latents)

invokeai/app/invocations/upscale.py

@@ -1,17 +1,18 @@
 # Copyright (c) 2022 Kyle Schouviller (https://github.com/kyle0654) & the InvokeAI Team
 from pathlib import Path
-from typing import Literal
+from typing import Literal, Union
 
 import cv2 as cv
 import numpy as np
 from basicsr.archs.rrdbnet_arch import RRDBNet
 from PIL import Image
+from pydantic import Field
 from realesrgan import RealESRGANer
-from invokeai.app.invocations.primitives import ImageField, ImageOutput
 
-from invokeai.app.models.image import ImageCategory, ResourceOrigin
+from invokeai.app.models.image import ImageCategory, ImageField, ResourceOrigin
 
-from .baseinvocation import BaseInvocation, InputField, InvocationContext, invocation
+from .baseinvocation import BaseInvocation, InvocationConfig, InvocationContext
+from .image import ImageOutput
 
 # TODO: Populate this from disk?
 # TODO: Use model manager to load?
@@ -23,12 +24,22 @@ ESRGAN_MODELS = Literal[
 ]
 
 
-@invocation("esrgan", title="Upscale (RealESRGAN)", tags=["esrgan", "upscale"], category="esrgan")
 class ESRGANInvocation(BaseInvocation):
     """Upscales an image using RealESRGAN."""
 
-    image: ImageField = InputField(description="The input image")
-    model_name: ESRGAN_MODELS = InputField(default="RealESRGAN_x4plus.pth", description="The Real-ESRGAN model to use")
+    type: Literal["esrgan"] = "esrgan"
+    image: Union[ImageField, None] = Field(default=None, description="The input image")
+    model_name: ESRGAN_MODELS = Field(
+        default="RealESRGAN_x4plus.pth", description="The Real-ESRGAN model to use"
+    )
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "title": "Upscale (RealESRGAN)",
+                "tags": ["image", "upscale", "realesrgan"]
+            },
+        }
 
     def invoke(self, context: InvocationContext) -> ImageOutput:
         image = context.services.images.get_pil_image(self.image.image_name)
@@ -97,7 +108,9 @@ class ESRGANInvocation(BaseInvocation):
         upscaled_image, img_mode = upsampler.enhance(cv_image)
 
         # back to PIL
-        pil_image = Image.fromarray(cv.cvtColor(upscaled_image, cv.COLOR_BGR2RGB)).convert("RGBA")
+        pil_image = Image.fromarray(
+            cv.cvtColor(upscaled_image, cv.COLOR_BGR2RGB)
+        ).convert("RGBA")
 
         image_dto = context.services.images.create(
             image=pil_image,
@@ -106,7 +119,6 @@ class ESRGANInvocation(BaseInvocation):
             node_id=self.id,
             session_id=context.graph_execution_state_id,
             is_intermediate=self.is_intermediate,
-            workflow=self.workflow,
         )
 
         return ImageOutput(

invokeai/app/models/exceptions.py

@@ -1,4 +1,3 @@
 class CanceledException(Exception):
     """Execution canceled by user."""
-
     pass

invokeai/app/models/image.py

@@ -1,8 +1,30 @@
 from enum import Enum
-
+from typing import Optional, Tuple, Literal
 from pydantic import BaseModel, Field
 
 from invokeai.app.util.metaenum import MetaEnum
+from ..invocations.baseinvocation import (
+    BaseInvocationOutput,
+    InvocationConfig,
+)
+
+class ImageField(BaseModel):
+    """An image field used for passing image objects between invocations"""
+
+    image_name: Optional[str] = Field(default=None, description="The name of the image")
+
+    class Config:
+        schema_extra = {"required": ["image_name"]}
+
+
+class ColorField(BaseModel):
+    r: int = Field(ge=0, le=255, description="The red component")
+    g: int = Field(ge=0, le=255, description="The green component")
+    b: int = Field(ge=0, le=255, description="The blue component")
+    a: int = Field(ge=0, le=255, description="The alpha component")
+
+    def tuple(self) -> Tuple[int, int, int, int]:
+        return (self.r, self.g, self.b, self.a)
 
 
 class ProgressImage(BaseModel):
@@ -12,6 +34,47 @@ class ProgressImage(BaseModel):
     height: int = Field(description="The effective height of the image in pixels")
     dataURL: str = Field(description="The image data as a b64 data URL")
 
+class PILInvocationConfig(BaseModel):
+    """Helper class to provide all PIL invocations with additional config"""
+
+    class Config(InvocationConfig):
+        schema_extra = {
+            "ui": {
+                "tags": ["PIL", "image"],
+            },
+        }
+
+class ImageOutput(BaseInvocationOutput):
+    """Base class for invocations that output an image"""
+
+    # fmt: off
+    type: Literal["image_output"] = "image_output"
+    image:      ImageField = Field(default=None, description="The output image")
+    width:             int = Field(description="The width of the image in pixels")
+    height:            int = Field(description="The height of the image in pixels")
+    # fmt: on
+
+    class Config:
+        schema_extra = {"required": ["type", "image", "width", "height"]}
+
+
+class MaskOutput(BaseInvocationOutput):
+    """Base class for invocations that output a mask"""
+
+    # fmt: off
+    type: Literal["mask"] = "mask"
+    mask:      ImageField = Field(default=None, description="The output mask")
+    width:            int = Field(description="The width of the mask in pixels")
+    height:           int = Field(description="The height of the mask in pixels")
+    # fmt: on
+
+    class Config:
+        schema_extra = {
+            "required": [
+                "type",
+                "mask",
+            ]
+        }
 
 class ResourceOrigin(str, Enum, metaclass=MetaEnum):
     """The origin of a resource (eg image).
@@ -69,3 +132,5 @@ class InvalidImageCategoryException(ValueError):
 
     def __init__(self, message="Invalid image category."):
         super().__init__(message)
+
+

invokeai/app/services/board_image_record_storage.py

@@ -25,6 +25,7 @@ class BoardImageRecordStorageBase(ABC):
     @abstractmethod
     def remove_image_from_board(
         self,
+        board_id: str,
         image_name: str,
     ) -> None:
         """Removes an image from a board."""
@@ -153,6 +154,7 @@ class SqliteBoardImageRecordStorage(BoardImageRecordStorageBase):
 
     def remove_image_from_board(
         self,
+        board_id: str,
         image_name: str,
     ) -> None:
         try:
@@ -160,9 +162,9 @@ class SqliteBoardImageRecordStorage(BoardImageRecordStorageBase):
             self._cursor.execute(
                 """--sql
                 DELETE FROM board_images
-                WHERE image_name = ?;
+                WHERE board_id = ? AND image_name = ?;
                 """,
-                (image_name,),
+                (board_id, image_name),
             )
             self._conn.commit()
         except sqlite3.Error as e:
@@ -205,7 +207,9 @@ class SqliteBoardImageRecordStorage(BoardImageRecordStorageBase):
             raise e
         finally:
             self._lock.release()
-        return OffsetPaginatedResults(items=images, offset=offset, limit=limit, total=count)
+        return OffsetPaginatedResults(
+            items=images, offset=offset, limit=limit, total=count
+        )
 
     def get_all_board_image_names_for_board(self, board_id: str) -> list[str]:
         try:

invokeai/app/services/board_images.py

@@ -1,14 +1,18 @@
 from abc import ABC, abstractmethod
 from logging import Logger
-from typing import Optional
+from typing import List, Union, Optional
 from invokeai.app.services.board_image_record_storage import BoardImageRecordStorageBase
 from invokeai.app.services.board_record_storage import (
     BoardRecord,
     BoardRecordStorageBase,
 )
 
-from invokeai.app.services.image_record_storage import ImageRecordStorageBase
+from invokeai.app.services.image_record_storage import (
+    ImageRecordStorageBase,
+    OffsetPaginatedResults,
+)
 from invokeai.app.services.models.board_record import BoardDTO
+from invokeai.app.services.models.image_record import ImageDTO, image_record_to_dto
 from invokeai.app.services.urls import UrlServiceBase
 
 
@@ -27,6 +31,7 @@ class BoardImagesServiceABC(ABC):
     @abstractmethod
     def remove_image_from_board(
         self,
+        board_id: str,
         image_name: str,
     ) -> None:
         """Removes an image from a board."""
@@ -88,15 +93,18 @@ class BoardImagesService(BoardImagesServiceABC):
 
     def remove_image_from_board(
         self,
+        board_id: str,
         image_name: str,
     ) -> None:
-        self._services.board_image_records.remove_image_from_board(image_name)
+        self._services.board_image_records.remove_image_from_board(board_id, image_name)
 
     def get_all_board_image_names_for_board(
         self,
         board_id: str,
     ) -> list[str]:
-        return self._services.board_image_records.get_all_board_image_names_for_board(board_id)
+        return self._services.board_image_records.get_all_board_image_names_for_board(
+            board_id
+        )
 
     def get_board_for_image(
         self,
@@ -106,7 +114,9 @@ class BoardImagesService(BoardImagesServiceABC):
         return board_id
 
 
-def board_record_to_dto(board_record: BoardRecord, cover_image_name: Optional[str], image_count: int) -> BoardDTO:
+def board_record_to_dto(
+    board_record: BoardRecord, cover_image_name: Optional[str], image_count: int
+) -> BoardDTO:
     """Converts a board record to a board DTO."""
     return BoardDTO(
         **board_record.dict(exclude={"cover_image_name"}),

invokeai/app/services/board_record_storage.py

@@ -1,20 +1,23 @@
-import threading
-import uuid
 from abc import ABC, abstractmethod
-from typing import Optional, Union, cast
-
+from typing import Optional, cast
 import sqlite3
+import threading
+from typing import Optional, Union
+import uuid
 from invokeai.app.services.image_record_storage import OffsetPaginatedResults
 from invokeai.app.services.models.board_record import (
     BoardRecord,
     deserialize_board_record,
 )
+
 from pydantic import BaseModel, Field, Extra
 
 
 class BoardChanges(BaseModel, extra=Extra.forbid):
     board_name: Optional[str] = Field(description="The board's new name.")
-    cover_image_name: Optional[str] = Field(description="The name of the board's new cover image.")
+    cover_image_name: Optional[str] = Field(
+        description="The name of the board's new cover image."
+    )
 
 
 class BoardRecordNotFoundException(Exception):
@@ -229,7 +232,7 @@ class SqliteBoardRecordStorage(BoardRecordStorageBase):
             # Change the name of a board
             if changes.board_name is not None:
                 self._cursor.execute(
-                    """--sql
+                    f"""--sql
                     UPDATE boards
                     SET board_name = ?
                     WHERE board_id = ?;
@@ -240,7 +243,7 @@ class SqliteBoardRecordStorage(BoardRecordStorageBase):
             # Change the cover image of a board
             if changes.cover_image_name is not None:
                 self._cursor.execute(
-                    """--sql
+                    f"""--sql
                     UPDATE boards
                     SET cover_image_name = ?
                     WHERE board_id = ?;
@@ -289,7 +292,9 @@ class SqliteBoardRecordStorage(BoardRecordStorageBase):
 
             count = cast(int, self._cursor.fetchone()[0])
 
-            return OffsetPaginatedResults[BoardRecord](items=boards, offset=offset, limit=limit, total=count)
+            return OffsetPaginatedResults[BoardRecord](
+                items=boards, offset=offset, limit=limit, total=count
+            )
 
         except sqlite3.Error as e:
             self._conn.rollback()

invokeai/app/services/boards.py

@@ -108,12 +108,16 @@ class BoardService(BoardServiceABC):
 
     def get_dto(self, board_id: str) -> BoardDTO:
         board_record = self._services.board_records.get(board_id)
-        cover_image = self._services.image_records.get_most_recent_image_for_board(board_record.board_id)
+        cover_image = self._services.image_records.get_most_recent_image_for_board(
+            board_record.board_id
+        )
         if cover_image:
             cover_image_name = cover_image.image_name
         else:
             cover_image_name = None
-        image_count = self._services.board_image_records.get_image_count_for_board(board_id)
+        image_count = self._services.board_image_records.get_image_count_for_board(
+            board_id
+        )
         return board_record_to_dto(board_record, cover_image_name, image_count)
 
     def update(
@@ -122,44 +126,60 @@ class BoardService(BoardServiceABC):
         changes: BoardChanges,
     ) -> BoardDTO:
         board_record = self._services.board_records.update(board_id, changes)
-        cover_image = self._services.image_records.get_most_recent_image_for_board(board_record.board_id)
+        cover_image = self._services.image_records.get_most_recent_image_for_board(
+            board_record.board_id
+        )
         if cover_image:
             cover_image_name = cover_image.image_name
         else:
             cover_image_name = None
 
-        image_count = self._services.board_image_records.get_image_count_for_board(board_id)
+        image_count = self._services.board_image_records.get_image_count_for_board(
+            board_id
+        )
         return board_record_to_dto(board_record, cover_image_name, image_count)
 
     def delete(self, board_id: str) -> None:
         self._services.board_records.delete(board_id)
 
-    def get_many(self, offset: int = 0, limit: int = 10) -> OffsetPaginatedResults[BoardDTO]:
+    def get_many(
+        self, offset: int = 0, limit: int = 10
+    ) -> OffsetPaginatedResults[BoardDTO]:
         board_records = self._services.board_records.get_many(offset, limit)
         board_dtos = []
         for r in board_records.items:
-            cover_image = self._services.image_records.get_most_recent_image_for_board(r.board_id)
+            cover_image = self._services.image_records.get_most_recent_image_for_board(
+                r.board_id
+            )
             if cover_image:
                 cover_image_name = cover_image.image_name
             else:
                 cover_image_name = None
 
-            image_count = self._services.board_image_records.get_image_count_for_board(r.board_id)
+            image_count = self._services.board_image_records.get_image_count_for_board(
+                r.board_id
+            )
             board_dtos.append(board_record_to_dto(r, cover_image_name, image_count))
 
-        return OffsetPaginatedResults[BoardDTO](items=board_dtos, offset=offset, limit=limit, total=len(board_dtos))
+        return OffsetPaginatedResults[BoardDTO](
+            items=board_dtos, offset=offset, limit=limit, total=len(board_dtos)
+        )
 
     def get_all(self) -> list[BoardDTO]:
         board_records = self._services.board_records.get_all()
         board_dtos = []
         for r in board_records:
-            cover_image = self._services.image_records.get_most_recent_image_for_board(r.board_id)
+            cover_image = self._services.image_records.get_most_recent_image_for_board(
+                r.board_id
+            )
             if cover_image:
                 cover_image_name = cover_image.image_name
             else:
                 cover_image_name = None
 
-            image_count = self._services.board_image_records.get_image_count_for_board(r.board_id)
+            image_count = self._services.board_image_records.get_image_count_for_board(
+                r.board_id
+            )
             board_dtos.append(board_record_to_dto(r, cover_image_name, image_count))
 
-        return board_dtos
+        return board_dtos

invokeai/app/services/config.py

@@ -0,0 +1,559 @@
+# Copyright (c) 2023 Lincoln Stein (https://github.com/lstein) and the InvokeAI Development Team
+
+'''Invokeai configuration system.
+
+Arguments and fields are taken from the pydantic definition of the
+model.  Defaults can be set by creating a yaml configuration file that
+has a top-level key of "InvokeAI" and subheadings for each of the
+categories returned by `invokeai --help`. The file looks like this:
+
+[file: invokeai.yaml]
+
+InvokeAI:
+  Paths:
+    root: /home/lstein/invokeai-main
+    conf_path: configs/models.yaml
+    legacy_conf_dir: configs/stable-diffusion
+    outdir: outputs
+    autoimport_dir: null
+  Models:
+    model: stable-diffusion-1.5
+    embeddings: true
+  Memory/Performance:
+    xformers_enabled: false
+    sequential_guidance: false
+    precision: float16
+    max_cache_size: 6
+    max_vram_cache_size: 2.7
+    always_use_cpu: false
+    free_gpu_mem: false
+  Features:
+    restore: true
+    esrgan: true
+    patchmatch: true
+    internet_available: true
+    log_tokenization: false
+  Web Server:
+    host: 127.0.0.1
+    port: 8081
+    allow_origins: []
+    allow_credentials: true
+    allow_methods:
+    - '*'
+    allow_headers:
+    - '*'
+
+The default name of the configuration file is `invokeai.yaml`, located
+in INVOKEAI_ROOT. You can replace supersede this by providing any
+OmegaConf dictionary object initialization time:
+
+ omegaconf = OmegaConf.load('/tmp/init.yaml')
+ conf = InvokeAIAppConfig()
+ conf.parse_args(conf=omegaconf)
+
+InvokeAIAppConfig.parse_args() will parse the contents of `sys.argv`
+at initialization time. You may pass a list of strings in the optional
+`argv` argument to use instead of the system argv:
+
+ conf.parse_args(argv=['--xformers_enabled'])
+
+It is also possible to set a value at initialization time. However, if
+you call parse_args() it may be overwritten.
+
+ conf = InvokeAIAppConfig(xformers_enabled=True)
+ conf.parse_args(argv=['--no-xformers'])
+ conf.xformers_enabled
+ # False
+
+
+To avoid this, use `get_config()` to retrieve the application-wide
+configuration object. This will retain any properties set at object
+creation time:
+
+ conf = InvokeAIAppConfig.get_config(xformers_enabled=True)
+ conf.parse_args(argv=['--no-xformers'])
+ conf.xformers_enabled
+ # True
+
+Any setting can be overwritten by setting an environment variable of
+form: "INVOKEAI_<setting>", as in:
+
+  export INVOKEAI_port=8080
+
+Order of precedence (from highest):
+   1) initialization options
+   2) command line options
+   3) environment variable options
+   4) config file options
+   5) pydantic defaults
+
+Typical usage at the top level file:
+
+ from invokeai.app.services.config import InvokeAIAppConfig
+
+ # get global configuration and print its cache size
+ conf = InvokeAIAppConfig.get_config()
+ conf.parse_args()
+ print(conf.max_cache_size)
+
+Typical usage in a backend module:
+
+ from invokeai.app.services.config import InvokeAIAppConfig
+
+ # get global configuration and print its cache size value
+ conf = InvokeAIAppConfig.get_config()
+ print(conf.max_cache_size)
+
+
+Computed properties:
+
+The InvokeAIAppConfig object has a series of properties that
+resolve paths relative to the runtime root directory. They each return
+a Path object:
+
+ root_path          - path to InvokeAI root
+ output_path        - path to default outputs directory
+ model_conf_path    - path to models.yaml
+ conf               - alias for the above
+ embedding_path     - path to the embeddings directory
+ lora_path          - path to the LoRA directory
+
+In most cases, you will want to create a single InvokeAIAppConfig
+object for the entire application. The InvokeAIAppConfig.get_config() function
+does this:
+
+  config = InvokeAIAppConfig.get_config()
+  config.parse_args()   # read values from the command line/config file
+  print(config.root)
+
+# Subclassing
+
+If you wish to create a similar class, please subclass the
+`InvokeAISettings` class and define a Literal field named "type",
+which is set to the desired top-level name.  For example, to create a
+"InvokeBatch" configuration, define like this:
+
+  class InvokeBatch(InvokeAISettings):
+     type: Literal["InvokeBatch"] = "InvokeBatch"
+     node_count : int = Field(default=1, description="Number of nodes to run on", category='Resources')
+     cpu_count  : int = Field(default=8, description="Number of GPUs to run on per node", category='Resources')
+
+This will now read and write from the "InvokeBatch" section of the
+config file, look for environment variables named INVOKEBATCH_*, and
+accept the command-line arguments `--node_count` and `--cpu_count`. The
+two configs are kept in separate sections of the config file:
+
+  # invokeai.yaml
+
+  InvokeBatch:
+     Resources:
+        node_count: 1
+        cpu_count: 8
+
+  InvokeAI:
+     Paths:
+        root: /home/lstein/invokeai-main
+        conf_path: configs/models.yaml
+        legacy_conf_dir: configs/stable-diffusion
+        outdir: outputs
+     ...
+
+'''
+from __future__ import annotations
+import argparse
+import pydoc
+import os
+import sys
+from argparse import ArgumentParser
+from omegaconf import OmegaConf, DictConfig
+from pathlib import Path
+from pydantic import BaseSettings, Field, parse_obj_as
+from typing import ClassVar, Dict, List, Set, Literal, Union, get_origin, get_type_hints, get_args
+
+INIT_FILE = Path('invokeai.yaml')
+MODEL_CORE = Path('models/core')
+DB_FILE   = Path('invokeai.db')
+LEGACY_INIT_FILE = Path('invokeai.init')
+
+class InvokeAISettings(BaseSettings):
+    '''
+    Runtime configuration settings in which default values are
+    read from an omegaconf .yaml file.
+    '''
+    initconf             : ClassVar[DictConfig] = None
+    argparse_groups      : ClassVar[Dict] = {}
+
+    def parse_args(self, argv: list=sys.argv[1:]):
+        parser = self.get_parser()
+        opt = parser.parse_args(argv)
+        for name in self.__fields__:
+            if name not in self._excluded():
+                setattr(self, name, getattr(opt,name))
+
+    def to_yaml(self)->str:
+        """
+        Return a YAML string representing our settings. This can be used
+        as the contents of `invokeai.yaml` to restore settings later.
+        """
+        cls = self.__class__
+        type = get_args(get_type_hints(cls)['type'])[0]
+        field_dict = dict({type:dict()})
+        for name,field in self.__fields__.items():
+            if name in cls._excluded_from_yaml():
+                continue
+            category = field.field_info.extra.get("category") or "Uncategorized"
+            value = getattr(self,name)
+            if category not in field_dict[type]:
+                field_dict[type][category] = dict()
+            # keep paths as strings to make it easier to read
+            field_dict[type][category][name] = str(value) if isinstance(value,Path) else value
+        conf = OmegaConf.create(field_dict)
+        return OmegaConf.to_yaml(conf)
+
+    @classmethod
+    def add_parser_arguments(cls, parser):
+        if 'type' in get_type_hints(cls):
+            settings_stanza = get_args(get_type_hints(cls)['type'])[0]
+        else:
+            settings_stanza = "Uncategorized"
+
+        env_prefix = cls.Config.env_prefix if hasattr(cls.Config,'env_prefix') else settings_stanza.upper()
+
+        initconf = cls.initconf.get(settings_stanza) \
+            if cls.initconf and settings_stanza in cls.initconf \
+               else OmegaConf.create()
+
+        # create an upcase version of the environment in
+        # order to achieve case-insensitive environment
+        # variables (the way Windows does)
+        upcase_environ = dict()
+        for key,value in os.environ.items():
+            upcase_environ[key.upper()] = value
+
+        fields = cls.__fields__
+        cls.argparse_groups = {}
+
+        for name, field in fields.items():
+            if name not in cls._excluded():
+                current_default = field.default
+
+                category = field.field_info.extra.get("category","Uncategorized")
+                env_name = env_prefix + '_' + name
+                if category in initconf and name in initconf.get(category):
+                    field.default = initconf.get(category).get(name)
+                if env_name.upper() in upcase_environ:
+                    field.default = upcase_environ[env_name.upper()]
+                cls.add_field_argument(parser, name, field)
+
+                field.default = current_default
+
+    @classmethod
+    def cmd_name(self, command_field: str='type')->str:
+        hints = get_type_hints(self)
+        if command_field in hints:
+            return get_args(hints[command_field])[0]
+        else:
+            return 'Uncategorized'
+
+    @classmethod
+    def get_parser(cls)->ArgumentParser:
+        parser = PagingArgumentParser(
+            prog=cls.cmd_name(),
+            description=cls.__doc__,
+        )
+        cls.add_parser_arguments(parser)
+        return parser
+
+    @classmethod
+    def add_subparser(cls, parser: argparse.ArgumentParser):
+        parser.add_parser(cls.cmd_name(), help=cls.__doc__)
+
+    @classmethod
+    def _excluded(self)->List[str]:
+        # internal fields that shouldn't be exposed as command line options
+        return ['type','initconf']
+    
+    @classmethod
+    def _excluded_from_yaml(self)->List[str]:
+        # combination of deprecated parameters and internal ones that shouldn't be exposed as invokeai.yaml options
+        return ['type','initconf', 'gpu_mem_reserved', 'max_loaded_models', 'version', 'from_file', 'model', 'restore', 'root', 'nsfw_checker']
+
+    class Config:
+        env_file_encoding = 'utf-8'
+        arbitrary_types_allowed = True
+        case_sensitive = True
+
+    @classmethod
+    def add_field_argument(cls, command_parser, name: str, field, default_override = None):
+        field_type = get_type_hints(cls).get(name)
+        default = default_override if default_override is not None else field.default if field.default_factory is None else field.default_factory()
+        if category := field.field_info.extra.get("category"):
+            if category not in cls.argparse_groups:
+                cls.argparse_groups[category] = command_parser.add_argument_group(category)
+            argparse_group = cls.argparse_groups[category]
+        else:
+            argparse_group = command_parser
+
+        if get_origin(field_type) == Literal:
+            allowed_values = get_args(field.type_)
+            allowed_types = set()
+            for val in allowed_values:
+                allowed_types.add(type(val))
+            allowed_types_list = list(allowed_types)
+            field_type = allowed_types_list[0] if len(allowed_types) == 1 else Union[allowed_types_list]  # type: ignore
+
+            argparse_group.add_argument(
+                f"--{name}",
+                dest=name,
+                type=field_type,
+                default=default,
+                choices=allowed_values,
+                help=field.field_info.description,
+            )
+
+        elif get_origin(field_type) == list:
+            argparse_group.add_argument(
+                f"--{name}",
+                dest=name,
+                nargs='*',
+                type=field.type_,
+                default=default,
+                action=argparse.BooleanOptionalAction if field.type_==bool else 'store',
+                help=field.field_info.description,
+            )
+        else:
+            argparse_group.add_argument(
+                f"--{name}",
+                dest=name,
+                type=field.type_,
+                default=default,
+                action=argparse.BooleanOptionalAction if field.type_==bool else 'store',
+                help=field.field_info.description,
+            )
+def _find_root()->Path:
+    venv = Path(os.environ.get("VIRTUAL_ENV") or ".")
+    if os.environ.get("INVOKEAI_ROOT"):
+        root = Path(os.environ.get("INVOKEAI_ROOT")).resolve()
+    elif any([(venv.parent/x).exists() for x in [INIT_FILE, LEGACY_INIT_FILE, MODEL_CORE]]):
+        root = (venv.parent).resolve()
+    else:
+        root = Path("~/invokeai").expanduser().resolve()
+    return root
+
+class InvokeAIAppConfig(InvokeAISettings):
+    '''
+Generate images using Stable Diffusion. Use "invokeai" to launch
+the command-line client (recommended for experts only), or
+"invokeai-web" to launch the web server. Global options
+can be changed by editing the file "INVOKEAI_ROOT/invokeai.yaml" or by
+setting environment variables INVOKEAI_<setting>.
+     '''
+    singleton_config: ClassVar[InvokeAIAppConfig] = None
+    singleton_init: ClassVar[Dict] = None
+
+    #fmt: off
+    type: Literal["InvokeAI"] = "InvokeAI"
+    host                : str = Field(default="127.0.0.1", description="IP address to bind to", category='Web Server')
+    port                : int = Field(default=9090, description="Port to bind to", category='Web Server')
+    allow_origins       : List[str] = Field(default=[], description="Allowed CORS origins", category='Web Server')
+    allow_credentials   : bool = Field(default=True, description="Allow CORS credentials", category='Web Server')
+    allow_methods       : List[str] = Field(default=["*"], description="Methods allowed for CORS", category='Web Server')
+    allow_headers       : List[str] = Field(default=["*"], description="Headers allowed for CORS", category='Web Server')
+
+    esrgan              : bool = Field(default=True, description="Enable/disable upscaling code", category='Features')
+    internet_available  : bool = Field(default=True, description="If true, attempt to download models on the fly; otherwise only use local models", category='Features')
+    log_tokenization    : bool = Field(default=False, description="Enable logging of parsed prompt tokens.", category='Features')
+    patchmatch          : bool = Field(default=True, description="Enable/disable patchmatch inpaint code", category='Features')
+    restore             : bool = Field(default=True, description="Enable/disable face restoration code (DEPRECATED)", category='DEPRECATED')
+
+    always_use_cpu      : bool = Field(default=False, description="If true, use the CPU for rendering even if a GPU is available.", category='Memory/Performance')
+    free_gpu_mem        : bool = Field(default=False, description="If true, purge model from GPU after each generation.", category='Memory/Performance')
+    max_loaded_models   : int = Field(default=3, gt=0, description="(DEPRECATED: use max_cache_size) Maximum number of models to keep in memory for rapid switching", category='DEPRECATED')
+    max_cache_size      : float = Field(default=6.0, gt=0, description="Maximum memory amount used by model cache for rapid switching", category='Memory/Performance')
+    max_vram_cache_size : float = Field(default=2.75, ge=0, description="Amount of VRAM reserved for model storage", category='Memory/Performance')
+    gpu_mem_reserved    : float = Field(default=2.75, ge=0, description="DEPRECATED: use max_vram_cache_size. Amount of VRAM reserved for model storage", category='DEPRECATED')
+    nsfw_checker        : bool = Field(default=True, description="DEPRECATED: use Web settings to enable/disable", category='DEPRECATED')
+    precision           : Literal[tuple(['auto','float16','float32','autocast'])] = Field(default='auto',description='Floating point precision', category='Memory/Performance')
+    sequential_guidance : bool = Field(default=False, description="Whether to calculate guidance in serial instead of in parallel, lowering memory requirements", category='Memory/Performance')
+    xformers_enabled    : bool = Field(default=True, description="Enable/disable memory-efficient attention", category='Memory/Performance')
+    tiled_decode        : bool = Field(default=False, description="Whether to enable tiled VAE decode (reduces memory consumption with some performance penalty)", category='Memory/Performance')
+
+    root                : Path = Field(default=_find_root(), description='InvokeAI runtime root directory', category='Paths')
+    autoimport_dir      : Path = Field(default='autoimport', description='Path to a directory of models files to be imported on startup.', category='Paths')
+    lora_dir            : Path = Field(default=None, description='Path to a directory of LoRA/LyCORIS models to be imported on startup.', category='Paths')
+    embedding_dir       : Path = Field(default=None, description='Path to a directory of Textual Inversion embeddings to be imported on startup.', category='Paths')
+    controlnet_dir      : Path = Field(default=None, description='Path to a directory of ControlNet embeddings to be imported on startup.', category='Paths')
+    conf_path           : Path = Field(default='configs/models.yaml', description='Path to models definition file', category='Paths')
+    models_dir          : Path = Field(default='models', description='Path to the models directory', category='Paths')
+    legacy_conf_dir     : Path = Field(default='configs/stable-diffusion', description='Path to directory of legacy checkpoint config files', category='Paths')
+    db_dir              : Path = Field(default='databases', description='Path to InvokeAI databases directory', category='Paths')
+    outdir              : Path = Field(default='outputs', description='Default folder for output images', category='Paths')
+    from_file           : Path = Field(default=None, description='Take command input from the indicated file (command-line client only)', category='Paths')
+    use_memory_db       : bool = Field(default=False, description='Use in-memory database for storing image metadata', category='Paths')
+
+    model               : str = Field(default='stable-diffusion-1.5', description='Initial model name', category='Models')
+
+    log_handlers        : List[str] = Field(default=["console"], description='Log handler. Valid options are "console", "file=<path>", "syslog=path|address:host:port", "http=<url>"', category="Logging")
+    # note - would be better to read the log_format values from logging.py, but this creates circular dependencies issues
+    log_format          : Literal[tuple(['plain','color','syslog','legacy'])] = Field(default="color", description='Log format. Use "plain" for text-only, "color" for colorized output, "legacy" for 2.3-style logging and "syslog" for syslog-style', category="Logging")
+    log_level           : Literal[tuple(["debug","info","warning","error","critical"])] = Field(default="info", description="Emit logging messages at this level or  higher", category="Logging")
+
+    version             : bool = Field(default=False, description="Show InvokeAI version and exit", category="Other")
+    #fmt: on
+
+    def parse_args(self, argv: List[str]=None, conf: DictConfig = None, clobber=False):
+        '''
+        Update settings with contents of init file, environment, and
+        command-line settings.
+        :param conf: alternate Omegaconf dictionary object
+        :param argv: aternate sys.argv list
+        :param clobber: ovewrite any initialization parameters passed during initialization
+        '''
+        # Set the runtime root directory. We parse command-line switches here
+        # in order to pick up the --root_dir option.
+        super().parse_args(argv)
+        if conf is None:
+            try:
+                conf = OmegaConf.load(self.root_dir / INIT_FILE)
+            except:
+                pass
+        InvokeAISettings.initconf = conf
+
+        # parse args again in order to pick up settings in configuration file
+        super().parse_args(argv)
+
+        if self.singleton_init and not clobber:
+            hints = get_type_hints(self.__class__)
+            for k in self.singleton_init:
+                setattr(self,k,parse_obj_as(hints[k],self.singleton_init[k]))
+
+    @classmethod
+    def get_config(cls,**kwargs)->InvokeAIAppConfig:
+        '''
+        This returns a singleton InvokeAIAppConfig configuration object.
+        '''
+        if cls.singleton_config is None \
+           or type(cls.singleton_config)!=cls \
+           or (kwargs and cls.singleton_init != kwargs):
+            cls.singleton_config = cls(**kwargs)
+            cls.singleton_init = kwargs
+        return cls.singleton_config
+
+    @property
+    def root_path(self)->Path:
+        '''
+        Path to the runtime root directory
+        '''
+        if self.root:
+            return Path(self.root).expanduser().absolute()
+        else:
+            return self.find_root()
+
+    @property
+    def root_dir(self)->Path:
+        '''
+        Alias for above.
+        '''
+        return self.root_path
+
+    def _resolve(self,partial_path:Path)->Path:
+        return (self.root_path / partial_path).resolve()
+
+    @property
+    def init_file_path(self)->Path:
+        '''
+        Path to invokeai.yaml
+        '''
+        return self._resolve(INIT_FILE)
+
+    @property
+    def output_path(self)->Path:
+        '''
+        Path to defaults outputs directory.
+        '''
+        return self._resolve(self.outdir)
+
+    @property
+    def db_path(self)->Path:
+        '''
+        Path to the invokeai.db file.
+        '''
+        return self._resolve(self.db_dir) / DB_FILE
+
+    @property
+    def model_conf_path(self)->Path:
+        '''
+        Path to models configuration file.
+        '''
+        return self._resolve(self.conf_path)
+
+    @property
+    def legacy_conf_path(self)->Path:
+        '''
+        Path to directory of legacy configuration files (e.g. v1-inference.yaml)
+        '''
+        return self._resolve(self.legacy_conf_dir)
+
+    @property
+    def models_path(self)->Path:
+        '''
+        Path to the models directory
+        '''
+        return self._resolve(self.models_dir)
+
+    @property
+    def autoconvert_path(self)->Path:
+        '''
+        Path to the directory containing models to be imported automatically at startup.
+        '''
+        return self._resolve(self.autoconvert_dir) if self.autoconvert_dir else None
+
+    # the following methods support legacy calls leftover from the Globals era
+    @property
+    def full_precision(self)->bool:
+        """Return true if precision set to float32"""
+        return self.precision=='float32'
+
+    @property
+    def disable_xformers(self)->bool:
+        """Return true if xformers_enabled is false"""
+        return not self.xformers_enabled
+
+    @property
+    def try_patchmatch(self)->bool:
+        """Return true if patchmatch true"""
+        return self.patchmatch
+
+    @property
+    def nsfw_checker(self)->bool:
+        """ NSFW node is always active and disabled from Web UIe"""
+        return True
+
+    @property
+    def invisible_watermark(self)->bool:
+        """ invisible watermark node is always active and disabled from Web UIe"""
+        return True
+    
+    @staticmethod
+    def find_root()->Path:
+        '''
+        Choose the runtime root directory when not specified on command line or
+        init file.
+        '''
+        return _find_root()
+
+
+class PagingArgumentParser(argparse.ArgumentParser):
+    '''
+    A custom ArgumentParser that uses pydoc to page its output.
+    It also supports reading defaults from an init file.
+    '''
+    def print_help(self, file=None):
+        text = self.format_help()
+        pydoc.pager(text)
+
+def get_invokeai_config(**kwargs)->InvokeAIAppConfig:
+    '''
+    Legacy function which returns InvokeAIAppConfig.get_config()
+    '''
+    return InvokeAIAppConfig.get_config(**kwargs)

invokeai/app/services/config/__init__.py

@@ -1,9 +0,0 @@
-"""
-Init file for InvokeAI configure package
-"""
-
-from .invokeai_config import (  # noqa F401
-    InvokeAIAppConfig,
-    get_invokeai_config,
-)
-from .base import PagingArgumentParser  # noqa F401

invokeai/app/services/config/base.py

@@ -1,239 +0,0 @@
-# Copyright (c) 2023 Lincoln Stein (https://github.com/lstein) and the InvokeAI Development Team
-
-"""
-Base class for the InvokeAI configuration system.
-It defines a type of pydantic BaseSettings object that
-is able to read and write from an omegaconf-based config file,
-with overriding of settings from environment variables and/or
-the command line.
-"""
-
-from __future__ import annotations
-import argparse
-import os
-import pydoc
-import sys
-from argparse import ArgumentParser
-from omegaconf import OmegaConf, DictConfig, ListConfig
-from pathlib import Path
-from pydantic import BaseSettings
-from typing import ClassVar, Dict, List, Literal, Union, get_origin, get_type_hints, get_args
-
-
-class PagingArgumentParser(argparse.ArgumentParser):
-    """
-    A custom ArgumentParser that uses pydoc to page its output.
-    It also supports reading defaults from an init file.
-    """
-
-    def print_help(self, file=None):
-        text = self.format_help()
-        pydoc.pager(text)
-
-
-class InvokeAISettings(BaseSettings):
-    """
-    Runtime configuration settings in which default values are
-    read from an omegaconf .yaml file.
-    """
-
-    initconf: ClassVar[DictConfig] = None
-    argparse_groups: ClassVar[Dict] = {}
-
-    def parse_args(self, argv: list = sys.argv[1:]):
-        parser = self.get_parser()
-        opt = parser.parse_args(argv)
-        for name in self.__fields__:
-            if name not in self._excluded():
-                value = getattr(opt, name)
-                if isinstance(value, ListConfig):
-                    value = list(value)
-                elif isinstance(value, DictConfig):
-                    value = dict(value)
-                setattr(self, name, value)
-
-    def to_yaml(self) -> str:
-        """
-        Return a YAML string representing our settings. This can be used
-        as the contents of `invokeai.yaml` to restore settings later.
-        """
-        cls = self.__class__
-        type = get_args(get_type_hints(cls)["type"])[0]
-        field_dict = dict({type: dict()})
-        for name, field in self.__fields__.items():
-            if name in cls._excluded_from_yaml():
-                continue
-            category = field.field_info.extra.get("category") or "Uncategorized"
-            value = getattr(self, name)
-            if category not in field_dict[type]:
-                field_dict[type][category] = dict()
-            # keep paths as strings to make it easier to read
-            field_dict[type][category][name] = str(value) if isinstance(value, Path) else value
-        conf = OmegaConf.create(field_dict)
-        return OmegaConf.to_yaml(conf)
-
-    @classmethod
-    def add_parser_arguments(cls, parser):
-        if "type" in get_type_hints(cls):
-            settings_stanza = get_args(get_type_hints(cls)["type"])[0]
-        else:
-            settings_stanza = "Uncategorized"
-
-        env_prefix = cls.Config.env_prefix if hasattr(cls.Config, "env_prefix") else settings_stanza.upper()
-
-        initconf = (
-            cls.initconf.get(settings_stanza)
-            if cls.initconf and settings_stanza in cls.initconf
-            else OmegaConf.create()
-        )
-
-        # create an upcase version of the environment in
-        # order to achieve case-insensitive environment
-        # variables (the way Windows does)
-        upcase_environ = dict()
-        for key, value in os.environ.items():
-            upcase_environ[key.upper()] = value
-
-        fields = cls.__fields__
-        cls.argparse_groups = {}
-
-        for name, field in fields.items():
-            if name not in cls._excluded():
-                current_default = field.default
-
-                category = field.field_info.extra.get("category", "Uncategorized")
-                env_name = env_prefix + "_" + name
-                if category in initconf and name in initconf.get(category):
-                    field.default = initconf.get(category).get(name)
-                if env_name.upper() in upcase_environ:
-                    field.default = upcase_environ[env_name.upper()]
-                cls.add_field_argument(parser, name, field)
-
-                field.default = current_default
-
-    @classmethod
-    def cmd_name(self, command_field: str = "type") -> str:
-        hints = get_type_hints(self)
-        if command_field in hints:
-            return get_args(hints[command_field])[0]
-        else:
-            return "Uncategorized"
-
-    @classmethod
-    def get_parser(cls) -> ArgumentParser:
-        parser = PagingArgumentParser(
-            prog=cls.cmd_name(),
-            description=cls.__doc__,
-        )
-        cls.add_parser_arguments(parser)
-        return parser
-
-    @classmethod
-    def add_subparser(cls, parser: argparse.ArgumentParser):
-        parser.add_parser(cls.cmd_name(), help=cls.__doc__)
-
-    @classmethod
-    def _excluded(self) -> List[str]:
-        # internal fields that shouldn't be exposed as command line options
-        return ["type", "initconf"]
-
-    @classmethod
-    def _excluded_from_yaml(self) -> List[str]:
-        # combination of deprecated parameters and internal ones that shouldn't be exposed as invokeai.yaml options
-        return [
-            "type",
-            "initconf",
-            "version",
-            "from_file",
-            "model",
-            "root",
-            "max_cache_size",
-            "max_vram_cache_size",
-            "always_use_cpu",
-            "free_gpu_mem",
-            "xformers_enabled",
-            "tiled_decode",
-        ]
-
-    class Config:
-        env_file_encoding = "utf-8"
-        arbitrary_types_allowed = True
-        case_sensitive = True
-
-    @classmethod
-    def add_field_argument(cls, command_parser, name: str, field, default_override=None):
-        field_type = get_type_hints(cls).get(name)
-        default = (
-            default_override
-            if default_override is not None
-            else field.default
-            if field.default_factory is None
-            else field.default_factory()
-        )
-        if category := field.field_info.extra.get("category"):
-            if category not in cls.argparse_groups:
-                cls.argparse_groups[category] = command_parser.add_argument_group(category)
-            argparse_group = cls.argparse_groups[category]
-        else:
-            argparse_group = command_parser
-
-        if get_origin(field_type) == Literal:
-            allowed_values = get_args(field.type_)
-            allowed_types = set()
-            for val in allowed_values:
-                allowed_types.add(type(val))
-            allowed_types_list = list(allowed_types)
-            field_type = allowed_types_list[0] if len(allowed_types) == 1 else int_or_float_or_str
-
-            argparse_group.add_argument(
-                f"--{name}",
-                dest=name,
-                type=field_type,
-                default=default,
-                choices=allowed_values,
-                help=field.field_info.description,
-            )
-
-        elif get_origin(field_type) == Union:
-            argparse_group.add_argument(
-                f"--{name}",
-                dest=name,
-                type=int_or_float_or_str,
-                default=default,
-                help=field.field_info.description,
-            )
-
-        elif get_origin(field_type) == list:
-            argparse_group.add_argument(
-                f"--{name}",
-                dest=name,
-                nargs="*",
-                type=field.type_,
-                default=default,
-                action=argparse.BooleanOptionalAction if field.type_ == bool else "store",
-                help=field.field_info.description,
-            )
-        else:
-            argparse_group.add_argument(
-                f"--{name}",
-                dest=name,
-                type=field.type_,
-                default=default,
-                action=argparse.BooleanOptionalAction if field.type_ == bool else "store",
-                help=field.field_info.description,
-            )
-
-
-def int_or_float_or_str(value: str) -> Union[int, float, str]:
-    """
-    Workaround for argparse type checking.
-    """
-    try:
-        return int(value)
-    except Exception as e:  # noqa F841
-        pass
-    try:
-        return float(value)
-    except Exception as e:  # noqa F841
-        pass
-    return str(value)

invokeai/app/services/config/invokeai_config.py

@@ -1,448 +0,0 @@
-# Copyright (c) 2023 Lincoln Stein (https://github.com/lstein) and the InvokeAI Development Team
-
-"""Invokeai configuration system.
-
-Arguments and fields are taken from the pydantic definition of the
-model.  Defaults can be set by creating a yaml configuration file that
-has a top-level key of "InvokeAI" and subheadings for each of the
-categories returned by `invokeai --help`. The file looks like this:
-
-[file: invokeai.yaml]
-
-InvokeAI:
-  Web Server:
-    host: 127.0.0.1
-    port: 9090
-    allow_origins: []
-    allow_credentials: true
-    allow_methods:
-    - '*'
-    allow_headers:
-    - '*'
-  Features:
-    esrgan: true
-    internet_available: true
-    log_tokenization: false
-    patchmatch: true
-    ignore_missing_core_models: false
-  Paths:
-    autoimport_dir: autoimport
-    lora_dir: null
-    embedding_dir: null
-    controlnet_dir: null
-    conf_path: configs/models.yaml
-    models_dir: models
-    legacy_conf_dir: configs/stable-diffusion
-    db_dir: databases
-    outdir: /home/lstein/invokeai-main/outputs
-    use_memory_db: false
-  Logging:
-    log_handlers:
-    - console
-    log_format: plain
-    log_level: info
-  Model Cache:
-    ram: 13.5
-    vram: 0.25
-    lazy_offload: true
-  Device:
-    device: auto
-    precision: auto
-  Generation:
-    sequential_guidance: false
-    attention_type: xformers
-    attention_slice_size: auto
-    force_tiled_decode: false
-
-The default name of the configuration file is `invokeai.yaml`, located
-in INVOKEAI_ROOT. You can replace supersede this by providing any
-OmegaConf dictionary object initialization time:
-
- omegaconf = OmegaConf.load('/tmp/init.yaml')
- conf = InvokeAIAppConfig()
- conf.parse_args(conf=omegaconf)
-
-InvokeAIAppConfig.parse_args() will parse the contents of `sys.argv`
-at initialization time. You may pass a list of strings in the optional
-`argv` argument to use instead of the system argv:
-
- conf.parse_args(argv=['--log_tokenization'])
-
-It is also possible to set a value at initialization time. However, if
-you call parse_args() it may be overwritten.
-
- conf = InvokeAIAppConfig(log_tokenization=True)
- conf.parse_args(argv=['--no-log_tokenization'])
- conf.log_tokenization
- # False
-
-To avoid this, use `get_config()` to retrieve the application-wide
-configuration object. This will retain any properties set at object
-creation time:
-
- conf = InvokeAIAppConfig.get_config(log_tokenization=True)
- conf.parse_args(argv=['--no-log_tokenization'])
- conf.log_tokenization
- # True
-
-Any setting can be overwritten by setting an environment variable of
-form: "INVOKEAI_<setting>", as in:
-
-  export INVOKEAI_port=8080
-
-Order of precedence (from highest):
-   1) initialization options
-   2) command line options
-   3) environment variable options
-   4) config file options
-   5) pydantic defaults
-
-Typical usage at the top level file:
-
- from invokeai.app.services.config import InvokeAIAppConfig
-
- # get global configuration and print its cache size
- conf = InvokeAIAppConfig.get_config()
- conf.parse_args()
- print(conf.ram_cache_size)
-
-Typical usage in a backend module:
-
- from invokeai.app.services.config import InvokeAIAppConfig
-
- # get global configuration and print its cache size value
- conf = InvokeAIAppConfig.get_config()
- print(conf.ram_cache_size)
-
-Computed properties:
-
-The InvokeAIAppConfig object has a series of properties that
-resolve paths relative to the runtime root directory. They each return
-a Path object:
-
- root_path          - path to InvokeAI root
- output_path        - path to default outputs directory
- model_conf_path    - path to models.yaml
- conf               - alias for the above
- embedding_path     - path to the embeddings directory
- lora_path          - path to the LoRA directory
-
-In most cases, you will want to create a single InvokeAIAppConfig
-object for the entire application. The InvokeAIAppConfig.get_config() function
-does this:
-
-  config = InvokeAIAppConfig.get_config()
-  config.parse_args()   # read values from the command line/config file
-  print(config.root)
-
-# Subclassing
-
-If you wish to create a similar class, please subclass the
-`InvokeAISettings` class and define a Literal field named "type",
-which is set to the desired top-level name.  For example, to create a
-"InvokeBatch" configuration, define like this:
-
-  class InvokeBatch(InvokeAISettings):
-     type: Literal["InvokeBatch"] = "InvokeBatch"
-     node_count : int = Field(default=1, description="Number of nodes to run on", category='Resources')
-     cpu_count  : int = Field(default=8, description="Number of GPUs to run on per node", category='Resources')
-
-This will now read and write from the "InvokeBatch" section of the
-config file, look for environment variables named INVOKEBATCH_*, and
-accept the command-line arguments `--node_count` and `--cpu_count`. The
-two configs are kept in separate sections of the config file:
-
-  # invokeai.yaml
-
-  InvokeBatch:
-     Resources:
-        node_count: 1
-        cpu_count: 8
-
-  InvokeAI:
-     Paths:
-        root: /home/lstein/invokeai-main
-        conf_path: configs/models.yaml
-        legacy_conf_dir: configs/stable-diffusion
-        outdir: outputs
-     ...
-
-"""
-from __future__ import annotations
-
-import os
-from pathlib import Path
-from typing import ClassVar, Dict, List, Literal, Union, get_type_hints, Optional
-
-from omegaconf import OmegaConf, DictConfig
-from pydantic import Field, parse_obj_as
-
-from .base import InvokeAISettings
-
-INIT_FILE = Path("invokeai.yaml")
-DB_FILE = Path("invokeai.db")
-LEGACY_INIT_FILE = Path("invokeai.init")
-DEFAULT_MAX_VRAM = 0.5
-
-
-class InvokeAIAppConfig(InvokeAISettings):
-    """
-    Generate images using Stable Diffusion. Use "invokeai" to launch
-    the command-line client (recommended for experts only), or
-    "invokeai-web" to launch the web server. Global options
-    can be changed by editing the file "INVOKEAI_ROOT/invokeai.yaml" or by
-    setting environment variables INVOKEAI_<setting>.
-    """
-
-    singleton_config: ClassVar[InvokeAIAppConfig] = None
-    singleton_init: ClassVar[Dict] = None
-
-    # fmt: off
-    type: Literal["InvokeAI"] = "InvokeAI"
-
-    # WEB
-    host                : str = Field(default="127.0.0.1", description="IP address to bind to", category='Web Server')
-    port                : int = Field(default=9090, description="Port to bind to", category='Web Server')
-    allow_origins       : List[str] = Field(default=[], description="Allowed CORS origins", category='Web Server')
-    allow_credentials   : bool = Field(default=True, description="Allow CORS credentials", category='Web Server')
-    allow_methods       : List[str] = Field(default=["*"], description="Methods allowed for CORS", category='Web Server')
-    allow_headers       : List[str] = Field(default=["*"], description="Headers allowed for CORS", category='Web Server')
-
-    # FEATURES
-    esrgan              : bool = Field(default=True, description="Enable/disable upscaling code", category='Features')
-    internet_available  : bool = Field(default=True, description="If true, attempt to download models on the fly; otherwise only use local models", category='Features')
-    log_tokenization    : bool = Field(default=False, description="Enable logging of parsed prompt tokens.", category='Features')
-    patchmatch          : bool = Field(default=True, description="Enable/disable patchmatch inpaint code", category='Features')
-    ignore_missing_core_models : bool = Field(default=False, description='Ignore missing models in models/core/convert', category='Features')
-
-    # PATHS
-    root                : Path = Field(default=None, description='InvokeAI runtime root directory', category='Paths')
-    autoimport_dir      : Path = Field(default='autoimport', description='Path to a directory of models files to be imported on startup.', category='Paths')
-    lora_dir            : Path = Field(default=None, description='Path to a directory of LoRA/LyCORIS models to be imported on startup.', category='Paths')
-    embedding_dir       : Path = Field(default=None, description='Path to a directory of Textual Inversion embeddings to be imported on startup.', category='Paths')
-    controlnet_dir      : Path = Field(default=None, description='Path to a directory of ControlNet embeddings to be imported on startup.', category='Paths')
-    conf_path           : Path = Field(default='configs/models.yaml', description='Path to models definition file', category='Paths')
-    models_dir          : Path = Field(default='models', description='Path to the models directory', category='Paths')
-    legacy_conf_dir     : Path = Field(default='configs/stable-diffusion', description='Path to directory of legacy checkpoint config files', category='Paths')
-    db_dir              : Path = Field(default='databases', description='Path to InvokeAI databases directory', category='Paths')
-    outdir              : Path = Field(default='outputs', description='Default folder for output images', category='Paths')
-    use_memory_db       : bool = Field(default=False, description='Use in-memory database for storing image metadata', category='Paths')
-    from_file           : Path = Field(default=None, description='Take command input from the indicated file (command-line client only)', category='Paths')
-
-    # LOGGING
-    log_handlers        : List[str] = Field(default=["console"], description='Log handler. Valid options are "console", "file=<path>", "syslog=path|address:host:port", "http=<url>"', category="Logging")
-    # note - would be better to read the log_format values from logging.py, but this creates circular dependencies issues
-    log_format          : Literal['plain', 'color', 'syslog', 'legacy'] = Field(default="color", description='Log format. Use "plain" for text-only, "color" for colorized output, "legacy" for 2.3-style logging and "syslog" for syslog-style', category="Logging")
-    log_level           : Literal["debug", "info", "warning", "error", "critical"] = Field(default="info", description="Emit logging messages at this level or  higher", category="Logging")
-
-    dev_reload          : bool = Field(default=False, description="Automatically reload when Python sources are changed.", category="Development")
-
-    version             : bool = Field(default=False, description="Show InvokeAI version and exit", category="Other")
-
-    # CACHE
-    ram                 : Union[float, Literal["auto"]] = Field(default=6.0, gt=0, description="Maximum memory amount used by model cache for rapid switching (floating point number or 'auto')", category="Model Cache", )
-    vram                : Union[float, Literal["auto"]] = Field(default=0.25, ge=0, description="Amount of VRAM reserved for model storage (floating point number or 'auto')", category="Model Cache", )
-    lazy_offload        : bool = Field(default=True, description="Keep models in VRAM until their space is needed", category="Model Cache", )
-
-    # DEVICE
-    device              : Literal[tuple(["auto", "cpu", "cuda", "cuda:1", "mps"])] = Field(default="auto", description="Generation device", category="Device", )
-    precision: Literal[tuple(["auto", "float16", "float32", "autocast"])] = Field(default="auto", description="Floating point precision", category="Device", )
-
-    # GENERATION
-    sequential_guidance : bool = Field(default=False, description="Whether to calculate guidance in serial instead of in parallel, lowering memory requirements", category="Generation", )
-    attention_type      : Literal[tuple(["auto", "normal", "xformers", "sliced", "torch-sdp"])] = Field(default="auto", description="Attention type", category="Generation", )
-    attention_slice_size: Literal[tuple(["auto", "balanced", "max", 1, 2, 3, 4, 5, 6, 7, 8])] = Field(default="auto", description='Slice size, valid when attention_type=="sliced"', category="Generation", )
-    force_tiled_decode: bool = Field(default=False, description="Whether to enable tiled VAE decode (reduces memory consumption with some performance penalty)", category="Generation",)
-
-    # DEPRECATED FIELDS - STILL HERE IN ORDER TO OBTAN VALUES FROM PRE-3.1 CONFIG FILES
-    always_use_cpu      : bool = Field(default=False, description="If true, use the CPU for rendering even if a GPU is available.", category='Memory/Performance')
-    free_gpu_mem        : Optional[bool] = Field(default=None, description="If true, purge model from GPU after each generation.", category='Memory/Performance')
-    max_cache_size      : Optional[float] = Field(default=None, gt=0, description="Maximum memory amount used by model cache for rapid switching", category='Memory/Performance')
-    max_vram_cache_size : Optional[float] = Field(default=None, ge=0, description="Amount of VRAM reserved for model storage", category='Memory/Performance')
-    xformers_enabled    : bool = Field(default=True, description="Enable/disable memory-efficient attention", category='Memory/Performance')
-    tiled_decode        : bool = Field(default=False, description="Whether to enable tiled VAE decode (reduces memory consumption with some performance penalty)", category='Memory/Performance')
-
-    # See InvokeAIAppConfig subclass below for CACHE and DEVICE categories
-    # fmt: on
-
-    class Config:
-        validate_assignment = True
-
-    def parse_args(self, argv: List[str] = None, conf: DictConfig = None, clobber=False):
-        """
-        Update settings with contents of init file, environment, and
-        command-line settings.
-        :param conf: alternate Omegaconf dictionary object
-        :param argv: aternate sys.argv list
-        :param clobber: ovewrite any initialization parameters passed during initialization
-        """
-        # Set the runtime root directory. We parse command-line switches here
-        # in order to pick up the --root_dir option.
-        super().parse_args(argv)
-        if conf is None:
-            try:
-                conf = OmegaConf.load(self.root_dir / INIT_FILE)
-            except Exception:
-                pass
-        InvokeAISettings.initconf = conf
-
-        # parse args again in order to pick up settings in configuration file
-        super().parse_args(argv)
-
-        if self.singleton_init and not clobber:
-            hints = get_type_hints(self.__class__)
-            for k in self.singleton_init:
-                setattr(self, k, parse_obj_as(hints[k], self.singleton_init[k]))
-
-    @classmethod
-    def get_config(cls, **kwargs) -> InvokeAIAppConfig:
-        """
-        This returns a singleton InvokeAIAppConfig configuration object.
-        """
-        if (
-            cls.singleton_config is None
-            or type(cls.singleton_config) is not cls
-            or (kwargs and cls.singleton_init != kwargs)
-        ):
-            cls.singleton_config = cls(**kwargs)
-            cls.singleton_init = kwargs
-        return cls.singleton_config
-
-    @property
-    def root_path(self) -> Path:
-        """
-        Path to the runtime root directory
-        """
-        if self.root:
-            root = Path(self.root).expanduser().absolute()
-        else:
-            root = self.find_root().expanduser().absolute()
-        self.root = root  # insulate ourselves from relative paths that may change
-        return root
-
-    @property
-    def root_dir(self) -> Path:
-        """
-        Alias for above.
-        """
-        return self.root_path
-
-    def _resolve(self, partial_path: Path) -> Path:
-        return (self.root_path / partial_path).resolve()
-
-    @property
-    def init_file_path(self) -> Path:
-        """
-        Path to invokeai.yaml
-        """
-        return self._resolve(INIT_FILE)
-
-    @property
-    def output_path(self) -> Path:
-        """
-        Path to defaults outputs directory.
-        """
-        return self._resolve(self.outdir)
-
-    @property
-    def db_path(self) -> Path:
-        """
-        Path to the invokeai.db file.
-        """
-        return self._resolve(self.db_dir) / DB_FILE
-
-    @property
-    def model_conf_path(self) -> Path:
-        """
-        Path to models configuration file.
-        """
-        return self._resolve(self.conf_path)
-
-    @property
-    def legacy_conf_path(self) -> Path:
-        """
-        Path to directory of legacy configuration files (e.g. v1-inference.yaml)
-        """
-        return self._resolve(self.legacy_conf_dir)
-
-    @property
-    def models_path(self) -> Path:
-        """
-        Path to the models directory
-        """
-        return self._resolve(self.models_dir)
-
-    @property
-    def autoconvert_path(self) -> Path:
-        """
-        Path to the directory containing models to be imported automatically at startup.
-        """
-        return self._resolve(self.autoconvert_dir) if self.autoconvert_dir else None
-
-    # the following methods support legacy calls leftover from the Globals era
-    @property
-    def full_precision(self) -> bool:
-        """Return true if precision set to float32"""
-        return self.precision == "float32"
-
-    @property
-    def try_patchmatch(self) -> bool:
-        """Return true if patchmatch true"""
-        return self.patchmatch
-
-    @property
-    def nsfw_checker(self) -> bool:
-        """NSFW node is always active and disabled from Web UIe"""
-        return True
-
-    @property
-    def invisible_watermark(self) -> bool:
-        """invisible watermark node is always active and disabled from Web UIe"""
-        return True
-
-    @property
-    def ram_cache_size(self) -> float:
-        return self.max_cache_size or self.ram
-
-    @property
-    def vram_cache_size(self) -> float:
-        return self.max_vram_cache_size or self.vram
-
-    @property
-    def use_cpu(self) -> bool:
-        return self.always_use_cpu or self.device == "cpu"
-
-    @property
-    def disable_xformers(self) -> bool:
-        """
-        Return true if enable_xformers is false (reversed logic)
-        and attention type is not set to xformers.
-        """
-        disabled_in_config = not self.xformers_enabled
-        return disabled_in_config and self.attention_type != "xformers"
-
-    @staticmethod
-    def find_root() -> Path:
-        """
-        Choose the runtime root directory when not specified on command line or
-        init file.
-        """
-        return _find_root()
-
-
-def get_invokeai_config(**kwargs) -> InvokeAIAppConfig:
-    """
-    Legacy function which returns InvokeAIAppConfig.get_config()
-    """
-    return InvokeAIAppConfig.get_config(**kwargs)
-
-
-def _find_root() -> Path:
-    venv = Path(os.environ.get("VIRTUAL_ENV") or ".")
-    if os.environ.get("INVOKEAI_ROOT"):
-        root = Path(os.environ["INVOKEAI_ROOT"])
-    elif any([(venv.parent / x).exists() for x in [INIT_FILE, LEGACY_INIT_FILE]]):
-        root = (venv.parent).resolve()
-    else:
-        root = Path("~/invokeai").expanduser().resolve()
-    return root

invokeai/app/services/default_graphs.py

@@ -1,86 +1,63 @@
-from ..invocations.latent import LatentsToImageInvocation, DenoiseLatentsInvocation
+from ..invocations.latent import LatentsToImageInvocation, TextToLatentsInvocation
 from ..invocations.image import ImageNSFWBlurInvocation
 from ..invocations.noise import NoiseInvocation
 from ..invocations.compel import CompelInvocation
-from ..invocations.primitives import IntegerInvocation
+from ..invocations.params import ParamIntInvocation
 from .graph import Edge, EdgeConnection, ExposedNodeInput, ExposedNodeOutput, Graph, LibraryGraph
 from .item_storage import ItemStorageABC
 
 
-default_text_to_image_graph_id = "539b2af5-2b4d-4d8c-8071-e54a3255fc74"
+default_text_to_image_graph_id = '539b2af5-2b4d-4d8c-8071-e54a3255fc74'
 
 
 def create_text_to_image() -> LibraryGraph:
     return LibraryGraph(
         id=default_text_to_image_graph_id,
-        name="t2i",
-        description="Converts text to an image",
+        name='t2i',
+        description='Converts text to an image',
         graph=Graph(
             nodes={
-                "width": IntegerInvocation(id="width", value=512),
-                "height": IntegerInvocation(id="height", value=512),
-                "seed": IntegerInvocation(id="seed", value=-1),
-                "3": NoiseInvocation(id="3"),
-                "4": CompelInvocation(id="4"),
-                "5": CompelInvocation(id="5"),
-                "6": DenoiseLatentsInvocation(id="6"),
-                "7": LatentsToImageInvocation(id="7"),
-                "8": ImageNSFWBlurInvocation(id="8"),
+                'width': ParamIntInvocation(id='width', a=512),
+                'height': ParamIntInvocation(id='height', a=512),
+                'seed': ParamIntInvocation(id='seed', a=-1),
+                '3': NoiseInvocation(id='3'),
+                '4': CompelInvocation(id='4'),
+                '5': CompelInvocation(id='5'),
+                '6': TextToLatentsInvocation(id='6'),
+                '7': LatentsToImageInvocation(id='7'),
+                '8': ImageNSFWBlurInvocation(id='8'),
             },
             edges=[
-                Edge(
-                    source=EdgeConnection(node_id="width", field="value"),
-                    destination=EdgeConnection(node_id="3", field="width"),
-                ),
-                Edge(
-                    source=EdgeConnection(node_id="height", field="value"),
-                    destination=EdgeConnection(node_id="3", field="height"),
-                ),
-                Edge(
-                    source=EdgeConnection(node_id="seed", field="value"),
-                    destination=EdgeConnection(node_id="3", field="seed"),
-                ),
-                Edge(
-                    source=EdgeConnection(node_id="3", field="noise"),
-                    destination=EdgeConnection(node_id="6", field="noise"),
-                ),
-                Edge(
-                    source=EdgeConnection(node_id="6", field="latents"),
-                    destination=EdgeConnection(node_id="7", field="latents"),
-                ),
-                Edge(
-                    source=EdgeConnection(node_id="4", field="conditioning"),
-                    destination=EdgeConnection(node_id="6", field="positive_conditioning"),
-                ),
-                Edge(
-                    source=EdgeConnection(node_id="5", field="conditioning"),
-                    destination=EdgeConnection(node_id="6", field="negative_conditioning"),
-                ),
-                Edge(
-                    source=EdgeConnection(node_id="7", field="image"),
-                    destination=EdgeConnection(node_id="8", field="image"),
-                ),
-            ],
+                Edge(source=EdgeConnection(node_id='width', field='a'), destination=EdgeConnection(node_id='3', field='width')),
+                Edge(source=EdgeConnection(node_id='height', field='a'), destination=EdgeConnection(node_id='3', field='height')),
+                Edge(source=EdgeConnection(node_id='seed', field='a'), destination=EdgeConnection(node_id='3', field='seed')),
+                Edge(source=EdgeConnection(node_id='3', field='noise'), destination=EdgeConnection(node_id='6', field='noise')),
+                Edge(source=EdgeConnection(node_id='6', field='latents'), destination=EdgeConnection(node_id='7', field='latents')),
+                Edge(source=EdgeConnection(node_id='4', field='conditioning'), destination=EdgeConnection(node_id='6', field='positive_conditioning')),
+                Edge(source=EdgeConnection(node_id='5', field='conditioning'), destination=EdgeConnection(node_id='6', field='negative_conditioning')),
+                Edge(source=EdgeConnection(node_id='7', field='image'), destination=EdgeConnection(node_id='8', field='image')),
+            ]
         ),
         exposed_inputs=[
-            ExposedNodeInput(node_path="4", field="prompt", alias="positive_prompt"),
-            ExposedNodeInput(node_path="5", field="prompt", alias="negative_prompt"),
-            ExposedNodeInput(node_path="width", field="value", alias="width"),
-            ExposedNodeInput(node_path="height", field="value", alias="height"),
-            ExposedNodeInput(node_path="seed", field="value", alias="seed"),
+            ExposedNodeInput(node_path='4', field='prompt', alias='positive_prompt'),
+            ExposedNodeInput(node_path='5', field='prompt', alias='negative_prompt'),
+            ExposedNodeInput(node_path='width', field='a', alias='width'),
+            ExposedNodeInput(node_path='height', field='a', alias='height'),
+            ExposedNodeInput(node_path='seed', field='a', alias='seed'),
         ],
-        exposed_outputs=[ExposedNodeOutput(node_path="8", field="image", alias="image")],
-    )
+        exposed_outputs=[
+            ExposedNodeOutput(node_path='8', field='image', alias='image')
+        ])
 
 
 def create_system_graphs(graph_library: ItemStorageABC[LibraryGraph]) -> list[LibraryGraph]:
     """Creates the default system graphs, or adds new versions if the old ones don't match"""
-
+    
     # TODO: Uncomment this when we are ready to fix this up to prevent breaking changes
     graphs: list[LibraryGraph] = list()
 
     # text_to_image = graph_library.get(default_text_to_image_graph_id)
-
+    
     # # TODO: Check if the graph is the same as the default one, and if not, update it
     # #if text_to_image is None:
     text_to_image = create_text_to_image()