Invokeai

_This is a **beta** release. There may be some hiccups, but overally, it is purring along nicely._

_This is an **alpha** release. We suggest [backing up your database](https://invoke-ai.github.io/InvokeAI/features/DATABASE/#database-backup) in case there are any issues and you need to roll back._

_This is an **alpha** release. We suggest [backing up your database](https://invoke-ai.github.io/InvokeAI/features/DATABASE/#database-backup) in case there are any issues and you need to roll back._

_This is an **alpha** release. We suggest [backing up your database](https://invoke-ai.github.io/InvokeAI/features/DATABASE/#database-backup) in case there are any issues and you need to roll back._

🧪 Regional Control

Regional Control (name may change) gives you control over specific areas of the image. Draw a mask and set a positive prompt, negative prompt, or any number of IP Adapters to be applied to the masked region.

To support this powerful feature, we are introducing a new canvas editor. Here's a brief demo:

https://github.com/invoke-ai/InvokeAI/assets/4822129/4bf5ee96-126d-4048-ab0f-54c62b664403

Full documentation to be included with the full release.

Your feedback is greatly appreciated as we continue to iterate on Regional Control.

🐛 Known Issues

Regional Control

These issues will be fixed for the full release.

- Occasionally, if you undo after deleting a layer's IP Adapter, the UI will error. You'll just need to click Reset if this happens.
- Occasionally, the Regional Control canvas may not show and brush strokes. Refresh the page to fix.

Other

- Inpainting models on Canvas sometimes kinda give up and output mush. Apologies for the delay in rolling this fix out.

- Minor updates that resolve performance issues on the canvas.
- Some installation/updating fixes to improve experience.

🎁 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

Learn more on the [Invoke Training repo](https://github.com/invoke-ai/invoke-training), as well as our [YT video on getting started](https://www.youtube.com/watch?v=OZIz2vvtlM4&lc=UgzFt_N_Ylhe4ZIeM7t4AaABAg)

💾 Installation and Upgrading

🚨 To install or upgrade to version 4.0, download the zip file from the release notes ("Assets" section), unzip it, and follow the [installation instructions](https://invoke-ai.github.io/InvokeAI/installation/010_INSTALL_AUTOMATED/). For upgrades, select the same installation location.

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

Models don't show up after upgrading

Follow [these steps](https://invoke-ai.github.io/InvokeAI/help/FAQ/#missing-models-after-updating-to-v4). If you are still missing some models, please create an issue on GitHub or ask for help on discord.

🤓 Developer Changes

Enhancements

- Backend and nodes implementation for regional prompting and regional IP Adapter (UI in v4.2.0)
- Secret option in Workflow Editor to convert a graph into a workflow. See 6181 for how to use it.
- Assortment of UI papercuts
- Favicon & page title indicate generation status jungleBadger
- Delete hotkey and button work with gallery selection jungleBadger
- Workflow editor perf improvements
- Edge labels in workflow editor
- Updated translations Harvester62, symant233, Vasyanator
- Updated docs sarashinai
- Improved torch device and precision handling

Fixes

- `multipleOf` for invocations (for example, the Noise invocation's width and height have a step of 8)
- Poor quality "fried" refiner outputs
- Poor quality inpainting with gradient denoising and refiner
- Canvas images appearing in the wrong places
- The little eye defaulting to off in canvas staging toolbar
- Premature OOM on windows (see [shared GPU memory FAQ](https://invoke-ai.github.io/InvokeAI/help/FAQ/#shared-gpu-memory-windows))
- ~1s delay between queue items
- Wonky model manager forms navigating away from UI clsn

Invocation API

- New method to get the filesystem path of an image: `context.images.get_path(image_name: str, thumbnail: bool)` fieldOfView

Internal

- Improved `knip` config webpro
- Updated python deps Malrama

💾 Installation and Updating

To install or update to v4.1.0, [download the installer](https://github.com/invoke-ai/InvokeAI/releases/download/v4.1.0/InvokeAI-installer-v4.1.0.zip) and follow the [installation instructions](https://invoke-ai.github.io/InvokeAI/installation/010_INSTALL_AUTOMATED/).

To update, select the same installation location. Your user data will not be touched.

Missing models after updating from v3 to v4

See [this FAQ](https://invoke-ai.github.io/InvokeAI/help/FAQ/#missing-models-after-updating-to-v4).

🐛 Known Issues

- Inpainting models on Canvas sometimes kinda give up and output mush. The fix didn't make it in to v4.1.0, we will aim to release a patch in by the weekend.

What's Changed
* fix(ui): handle multipleOf on number fields by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6167
* feat(backend): clean up choose_precision by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6171
* (feat) add a method to get the path of an image from invocationcontext by fieldOfView in https://github.com/invoke-ai/InvokeAI/pull/6176
* feat(ui): add graph-to-workflow debug helper by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6181
* fix: Update SDXL Refiner graphs to use Gradient Mask by blessedcoolant in https://github.com/invoke-ai/InvokeAI/pull/6158
* Regional Prompting (Node only) by RyanJDick in https://github.com/invoke-ai/InvokeAI/pull/5916
* Remove Prompt-to-Prompt Cross-Attention Control by RyanJDick in https://github.com/invoke-ai/InvokeAI/pull/6123
* Regional IP-Adapter (Backend Only) by RyanJDick in https://github.com/invoke-ai/InvokeAI/pull/5967
* Fix field ordering by JPPhoto in https://github.com/invoke-ai/InvokeAI/pull/6186
* Fix regional prompt mask padding by RyanJDick in https://github.com/invoke-ai/InvokeAI/pull/6187
* fix(ui): always enqueue with fresh staging area bbox by maryhipp in https://github.com/invoke-ai/InvokeAI/pull/6184
* fix(nodes): refined fixes for refiner inpainting by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6197
* [mm] clear the cache entry for a model that got an OOM during loading by lstein in https://github.com/invoke-ai/InvokeAI/pull/6193
* fix(queue): poll queue on finished queue item by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6191
* Remove type="submit" from all tsx files. by clsn in https://github.com/invoke-ai/InvokeAI/pull/6200
* Add Toggle for showing Bounding Box, fix Main Model info popover, fix Control Model description on hover by chainchompa in https://github.com/invoke-ai/InvokeAI/pull/6202
* Update INSTALL_DEVELOPMENT.md by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6201
* Correct stated location of Gallery panel in WEB.md by sarashinai in https://github.com/invoke-ai/InvokeAI/pull/6203
* Fix "recall all" when loras, controls, or high res fix are not present by chainchompa in https://github.com/invoke-ai/InvokeAI/pull/6211
* Modify title and favicon when item in progress (issue 2392) by jungleBadger in https://github.com/invoke-ai/InvokeAI/pull/6204
* remove hires fix badge from settings when using sdxl by chainchompa in https://github.com/invoke-ai/InvokeAI/pull/6218
* Enable multi deletion on keystroke by jungleBadger in https://github.com/invoke-ai/InvokeAI/pull/6216
* ui: translations update from weblate by weblate in https://github.com/invoke-ai/InvokeAI/pull/6170
* Fix up Knip config & enable --production mode by webpro in https://github.com/invoke-ai/InvokeAI/pull/6217
* Update deps to their lastest versions by Malrama in https://github.com/invoke-ai/InvokeAI/pull/6178
* feat(ui): edge labels by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6224
* perf(ui): misc ui improvements by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6225
* [util] Add generic torch device class by lstein in https://github.com/invoke-ai/InvokeAI/pull/6174
* [mm] Fix race condition when installing multi-file models by lstein in https://github.com/invoke-ai/InvokeAI/pull/6221
* Add IP Adapter Style & Composition Modes by blessedcoolant in https://github.com/invoke-ai/InvokeAI/pull/6213
* update IP adapter method labels to be designated as Beta by maryhipp in https://github.com/invoke-ai/InvokeAI/pull/6232
* ui: translations update from weblate by weblate in https://github.com/invoke-ai/InvokeAI/pull/6223
* chore: v4.1.0 by psychedelicious in https://github.com/invoke-ai/InvokeAI/pull/6234

New Contributors
* sarashinai made their first contribution in https://github.com/invoke-ai/InvokeAI/pull/6203
* jungleBadger made their first contribution in https://github.com/invoke-ai/InvokeAI/pull/6204
* webpro made their first contribution in https://github.com/invoke-ai/InvokeAI/pull/6217

**Full Changelog**: https://github.com/invoke-ai/InvokeAI/compare/v4.0.4...v4.1.0