Merge remote-tracking branch 'upstream/main' into feat_save_attention_maps_redo

Author: damian0815

.dockerignore

@@ -1,12 +1,26 @@
 *
 !backend
-!configs
-!environments-and-requirements
 !frontend
-!installer
+!binary_installer
 !ldm
 !main.py
 !scripts
 !server
 !static
 !setup.py
+!docker-build
+!docs
+docker-build/Dockerfile
+
+# Guard against pulling in any models that might exist in the directory tree
+**/*.pt*
+
+# unignore configs, but only ignore the custom models.yaml, in case it exists
+!configs
+configs/models.yaml
+
+# unignore environment dirs/files, but ignore the environment.yml file or symlink in case it exists
+!environment*
+environment.yml
+
+**/__pycache__

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

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

README.md

@@ -1,10 +1,8 @@
 <div align="center">
 
-# InvokeAI: A Stable Diffusion Toolkit
-
-_Formerly known as lstein/stable-diffusion_
+![project logo](docs/assets/invoke_ai_banner.png)
 
-![project logo](docs/assets/logo.png)
+# InvokeAI: A Stable Diffusion Toolkit
 
 [![discord badge]][discord link]
 
@@ -48,7 +46,10 @@ _Note: InvokeAI is rapidly evolving. Please use the
 [Issues](https://github.com/invoke-ai/InvokeAI/issues) tab to report bugs and make feature
 requests. Be sure to use the provided templates. They will help us diagnose issues faster._
 
-## Installation Quick-Start
+# Getting Started with InvokeAI
+
+For full installation and upgrade instructions, please see:
+[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/)
 
 1. Go to the bottom of the [Latest Release Page](https://github.com/invoke-ai/InvokeAI/releases/tag/v2.2.3)
 2. Download the .zip file for your OS (Windows/macOS/Linux).
@@ -62,8 +63,6 @@ requests. Be sure to use the provided templates. They will help us diagnose issu
 <div align="center"><img src="docs/assets/invoke-web-server-1.png" width=640></div>
 
 
-For full installation and upgrade instructions, please see:
-[InvokeAI Installation Overview](https://invoke-ai.github.io/InvokeAI/installation/)
 
 ## Table of Contents
 
@@ -118,11 +117,12 @@ Similarly, specify full-precision mode on Apple M1 hardware.
 
 Precision is auto configured based on the device. If however you encounter
 errors like 'expected type Float but found Half' or 'not implemented for Half'
-you can try starting `invoke.py` with the `--precision=float32` flag:
+you can try starting `invoke.py` with the `--precision=float32` flag to your initialization command
 
 ```bash
 (invokeai) ~/InvokeAI$ python scripts/invoke.py --precision=float32
 ```
+Or by updating your InvokeAI configuration file with this argument.
 
 ### Features
 
@@ -151,39 +151,7 @@ you can try starting `invoke.py` with the `--precision=float32` flag:
 
 ### Latest Changes
 
-- v2.0.1 (13 November 2022)
-  - fix noisy images at high step count when using k* samplers
-  - dream.py script now calls invoke.py module directly rather than
-    via a new python process (which could break the environment)
-
-- v2.0.0 (9 November 2022)
-
-  - `dream.py` script renamed `invoke.py`. A `dream.py` script wrapper remains
-    for backward compatibility.
-  - Completely new WebGUI - launch with `python3 scripts/invoke.py --web`
-  - Support for <a href="https://invoke-ai.github.io/InvokeAI/features/INPAINTING/">inpainting</a> and <a href="https://invoke-ai.github.io/InvokeAI/features/OUTPAINTING/">outpainting</a>
-  - img2img runs on all k* samplers
-  - Support for <a href="https://invoke-ai.github.io/InvokeAI/features/PROMPTS/#negative-and-unconditioned-prompts">negative prompts</a>
-  - Support for CodeFormer face reconstruction
-  - Support for Textual Inversion on macOS
-  - Support in both WebGUI and CLI for <a href="https://invoke-ai.github.io/InvokeAI/features/POSTPROCESS/">post-processing of previously-generated images</a>
-    using facial reconstruction, ESRGAN upscaling, outcropping (similar to DALL-E infinite canvas),
-    and "embiggen" upscaling. See the `!fix` command.
-  - New `--hires` option on `invoke>` line allows <a href="https://invoke-ai.github.io/InvokeAI/features/CLI/#txt2img">larger images to be created without duplicating elements</a>, at the cost of some performance.
-  - New `--perlin` and `--threshold` options allow you to add and control variation
-    during image generation (see <a href="https://github.com/invoke-ai/InvokeAI/blob/main/docs/features/OTHER.md#thresholding-and-perlin-noise-initialization-options">Thresholding and Perlin Noise Initialization</a>
-  - Extensive metadata now written into PNG files, allowing reliable regeneration of images
-    and tweaking of previous settings.
-  - Command-line completion in `invoke.py` now works on Windows, Linux and macOS platforms.
-  - Improved <a href="https://invoke-ai.github.io/InvokeAI/features/CLI/">command-line completion behavior</a>.
-    New commands added:
-    - List command-line history with `!history`
-    - Search command-line history with `!search`
-    - Clear history with `!clear`
-  - Deprecated `--full_precision` / `-F`. Simply omit it and `invoke.py` will auto
-    configure. To switch away from auto use the new flag like `--precision=float32`.
-
-For older changelogs, please visit the **[CHANGELOG](https://invoke-ai.github.io/InvokeAI/CHANGELOG#v114-11-september-2022)**.
+For our latest changes, view our [Release Notes](https://github.com/invoke-ai/InvokeAI/releases)
 
 ### Troubleshooting
 
@@ -193,8 +161,9 @@ problems and other issues.
 # Contributing
 
 Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code
-cleanup, testing, or code reviews, is very much encouraged to do so. To join, just raise your hand on the InvokeAI
-Discord server or discussion board. 
+cleanup, testing, or code reviews, is very much encouraged to do so. 
+
+To join, just raise your hand on the InvokeAI Discord server (#dev-chat) or the GitHub discussion board. 
 
 If you are unfamiliar with how
 to contribute to GitHub projects, here is a

binary_installer/invoke.sh.in

@@ -2,6 +2,10 @@
 
 set -eu
 
+# ensure we're in the correct folder in case user's CWD is somewhere else
+scriptdir=$(dirname "$0")
+cd "$scriptdir"
+
 . .venv/bin/activate
 
 # set required env var for torch on mac MPS

configs/stable-diffusion/v1-inference.yaml

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

docker-build/Dockerfile.cloud

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

docker-build/Makefile

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