Invokeai

This is a Release Candidate. We strongly suggest [backing up your database](https://invoke-ai.github.io/InvokeAI/features/DATABASE/) before testing to prevent data loss in case of any issues.

Please let us know if you run into anything unexpected.

What's New in this RC

RC5 has improved the default hashing experience, updated default ControlNet Processor quality for SDXL outputs, and addressed other minor bugs/issues found in RC testing.

A new node has also been added for masking by ID.

This is a Release Candidate. We strongly suggest [backing up your database](https://invoke-ai.github.io/InvokeAI/features/DATABASE/) before testing to prevent data loss in case of any issues.

Please let us know if you run into anything unexpected.

What's New

We are now updated to use diffusers:0.27.0 and pytorch 2.2.1!

In RC4, the configs managed in invokeai.yaml are managed differently within the app. As a consequence of this, we will no longer be supporting passing in all configs as args on the `invokeai-web` cli command. Instead configs can be passed in via environment variables in the form of `INVOKEAI_<name_of_config>`
For example:
bash
INVOKEAI_REMOTE_API_TOKENS="[{\"url_regex\":\"huggingface.co/.*\", \"token\":\"example\"}]" invokeai-web

As seen in the example, JSON notation can be used for any config properties that are more complicated than a standard string.

Along with revamping how we manage configs, we've also removed the need for the `invokeai-configure` script which was previously required before installation.

RC1 supported the setting skip_model_hash in invokeai.yaml. In RC2, this is replaced by a more flexible setting [hashing_algorithm](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/#model-hashing).

New Model Manager
The model manager is rewritten in v4.0.0, both frontend and backend. This builds a foundation for future model architectures and brings some exciting new user-facing features:

- Queued model downloads
- Per-model preview images
- Per-model default settings - choose a model’s default VAE, Scheduler, CFG Scale, etc.
- User-defined trigger phrases for concepts/LoRAs and models - access by typing the < key in any prompt box
- [API key support for model marketplaces](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/#model-marketplace-api-keys)

Model Hashing

When you first run v4.0.0, it will take a while to start up as it does a one-time hash of all of your model files.

**Do not panic.**

Hashes provide a stable identifier for a model that is the same across every platform.

If you don’t care about this, you can [disable the hashing](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/#model-hashing) using the hashing_algorithm setting in [invokeai.yaml](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/#invokeai.app.services.config.config_default.InvokeAIAppConfig).

Canvas Improvements

The canvas uses a new method for compositing called gradient denoising. This eliminates the need for multiple “passes”, greatly reducing generation time on the canvas. This method also provides substantially improved visual coherence between the masked regions and the rest of the image.

The compositing settings on canvas allow for control over the gradient denoising process.

Major research & experimentation for this novel denoising implementation was led by dunkeroni, and blessedcoolant was responsible for managing integration into the canvas UI.

Bonus: Invoke Training (Beta)

As of v4.0.0, all references to training in the core invoke script now point to the Invoke Training Repo. Invoke Training offers a simple user interface for:

- Textual Inversion Training
- LoRA Training
- Dreambooth Training
- Pivotal Tuning Training

You can learn more about Invoke Training at https://github.com/invoke-ai/invoke-training

Minor UI/UX Enhancements:

- Canvas Brush Size Scroll can now be inverted (Thanks joshistoast!)
- Images in the Canvas Staging Area can now be discarded individually (Thanks joshistoast!)
- Many small bug fixes and resolved papercuts

Installation and Upgrading

To install or upgrade to version 4.0, download the zip file from the release notes ("Assets" section), unpack it, and follow the installation instructions. For upgrades, select the same installation location.

💾 [Download Installer](https://github.com/invoke-ai/InvokeAI/releases/download/v4.0.0rc4/InvokeAI-installer-v4.0.0rc4.zip)

💻 Developer Changes

This is a Release Candidate. We strongly suggest [backing up your database](https://invoke-ai.github.io/InvokeAI/features/DATABASE/) before testing to prevent data loss in case of any issues.

Please let us know if you run into anything unexpected.

What's New

RC1 supported the setting `skip_model_hash` in `invokeai.yaml`. In RC2, this is replaced by a more flexible setting [`hashing_algorithm`](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/#model-hashing).

New Model Manager

The model manager is rewritten in v4.0.0, both frontend and backend. This builds a foundation for future model architectures and brings some exciting new user-facing features:

- Queued model downloads
- Per-model preview images
- Per-model default settings - choose a model’s default VAE, Scheduler, CFG Scale, etc.
- User-defined trigger phrases for concepts/LoRAs and models - access by typing the `<` key in any prompt box
- [API key support for model marketplaces](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/#model-marketplace-api-keys)

Model Hashing

When you first run v4.0.0, **it will take a while to start up** as it does a one-time hash of all of your model files.

**Do not panic.**

Hashes provide a stable identifier for a model that is the same across every platform.

If you don’t care about this, you can [disable the hashing](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/#model-hashing) using the `hashing_algorithm` setting in [`invokeai.yaml`](https://invoke-ai.github.io/InvokeAI/features/CONFIGURATION/#invokeai.app.services.config.config_default.InvokeAIAppConfig).

Canvas Improvements

The canvas uses a new method for compositing called **gradient denoising**. This eliminates the need for multiple “passes”, greatly reducing generation time on the canvas. This method also provides substantially improved visual coherence between the masked regions and the rest of the image.

The compositing settings on canvas allow for control over the gradient denoising process.

Major research & experimentation for this novel denoising implementation was led by dunkeroni, and blessedcoolant was responsible for managing integration into the canvas UI.

Bonus: Invoke Training (Beta)

As of v4.0.0, all references to training in the core invoke script now point to the Invoke Training Repo. Invoke Training offers a simple user interface for:

- Textual Inversion Training
- LoRA Training
- Dreambooth Training
- Pivotal Tuning Training

You can learn more about Invoke Training at https://github.com/invoke-ai/invoke-training

Minor UI/UX Enhancements:

- Canvas Brush Size Scroll can now be inverted (Thanks joshistoast!)
- Images in the Canvas Staging Area can now be discarded individually (Thanks joshistoast!)
- Many small bug fixes and resolved papercuts

Installation and Upgrading

To install or upgrade to version 4.0, download the zip file from the release notes ("Assets" section), unpack it, and follow the installation instructions. For upgrades, select the same installation location.

💾 [Download Installer](https://github.com/invoke-ai/InvokeAI/releases/download/v4.0.0rc2/InvokeAI-installer-v4.0.0rc2.zip)

💻 Developer Changes

* ci: add missing permission to release workflow by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/5927


**Full Changelog**: https://github.com/invoke-ai/InvokeAI/compare/3.7.0...v4.0.0rc1

**Full Changelog**: https://github.com/invoke-ai/InvokeAI/compare/3.6.3...3.7.0

- Significantly improved generation speeds
- Workflow Library improvements
- New Unified Canvas Hotkeys - Ctrl+Mouse Scroll can now change the brush size!
- Installer & Updater improvements
- Model Manager updates to model conversion and saving
- Faster image saving - see "Other" in **Things to Know**


‼️ Things to Know:
Possible Update Issues
- When upgrading from 3.4 via the updater script, the UI will not render and will display an error: `{"detail":"Not Found"}`. To fix this error, download the installer and re-run it in the same location as your existing installation.
Invoke might revert to CPU (NVIDIA GPU only)
* Some users have experienced torch reverting to the CPU rather than their GPU. To fix this follow these steps:
1. Launch your invoke.bat / invoke.sh and select the option to open the developer console
2. Run: `pip install --force-reinstall torch==2.1.2 --index-url https://download.pytorch.org/whl/cu121`
3. If you run into an error with typing_extensions, run: `pip install -U typing-extensions`
4. If there is an error with fsspec, run `pip install -U fsspec==2023.5.0`

Other
- To take advantage of the image saving speed increase for existing installations, set your `png_compress_level` to **1** in your invoke.yaml file.
- Graph data was not being used and is longer saved in the database. You may experience an unusual pause during updating as this is data is deleted.
- Currently known issues:
* Scan for Models is currently disabled due to the Model Manager refactor



💿 Installation and Upgrading:

To install version 3.6.3, please download the zip file at the bottom of the release notes (under "Assets"), unpack it, and then double-click to launch the script `install.sh` (Macintosh, Linux) or `install.bat` (Windows). Alternatively, you can open a command-line window and execute the installation script directly.

If you already have Invoke version 3.x installed, you can update by running `invoke.sh` / `invoke.bat` and selecting "Updated Invoke" to upgrade, or you can download and run the installer in your existing Invoke installation location.

🚨 Please ensure your generation queue has no pending items before upgrading. Pending generations may fail after an upgrade. 🚨

**Download the installer:** [InvokeAI-installer-v3.6.3rc1.zip](https://github.com/invoke-ai/InvokeAI/releases/download/3.6.3rc1/InvokeAI-installer-v3.6.3rc1.zip)


💻 Developer Changes
There are a number of important changes for contributors to be aware of.

Model Manager
The Model Manager is partway through a redesign, to make it more capable and maintainable. The redesign will support a much better user experience for downloading, installing and managing models. The changes are in the repo, but implemented separately from the user-facing app.


<a name="contributing"></a>

⚙️ Contributing:

As a community-supported project, we rely on volunteers and enthusiasts for continued innovation and polish. Everything from minor documentation fixes to major feature additions are welcome. To get started as a contributor, please refer to [How to Contribute](https://invoke-ai.github.io/InvokeAI/contributing/CONTRIBUTING/) or reach out to **imic** on Discord!

New Contributors
* isNeil made their first contribution in https://github.com/invoke-ai/InvokeAI/pull/5526

**Full Changelog**: https://github.com/invoke-ai/InvokeAI/compare/v3.6.0...v3.6.3