github invoke-ai/InvokeAI v3.0.0+a8
InvokeAI Version 3.0.0-alpha 8 release
on GitHub

latest releases: v5.0.0, v5.0.0.rc2, v5.0.0.rc1...
pre-release15 months ago

We are pleased to announce an alpha release of InvokeAI 3.0 for developer and power user testing. This release is missing a number of features and certain functionality may be unstable.

  • What's New
  • What's Missing
  • Installation and Upgrading
  • Getting Help
  • Development Roadmap
  • Detailed Change Log

Recent bug fixes

Fixed in alpha-8

  • add LoRA interface
  • rebuild front end (will fix white screen of death issue)

Fixed in alpha-7

  • Model installer asks for confirmation before deleting unselected models
  • Fix VRAM memory leak during generation
  • Models with "/" in their names no longer break the model migration script
  • Preliminary work on web-based model manager UI

Fixed in alpha-6

Compared to alpha-5, an incomplete piece of testing code was reverted.

Fixed in alpha-5

  1. Fix white screen in web UI when upgrading using PIP
  2. Add debugging messages to aid in memory leak tracking.

Fixed in alpha-4

  1. Correctly parse and install models using their repo_ids on Windows systems
  2. Tell the migrate script about the k-* sampler names so that it doesn't crash when migrating invokeai.init files that refer to one of these samplers.
  3. Remove hard-coded "cuda" device from model manager so that models load correctly on Macintoshes using mps.

What's New in v3.0.0-alpha

Quite a lot has changed, both internally and externally

Web User Interface:

  • A ControlNet interface that gives you fine control over such things as the posture of figures in generated images by providing an image that illustrates the end result you wish to achieve.
  • A Dynamic Prompts interface that lets you generate combinations of prompt elements.
  • A redesigned user interface which makes it easier to access frequently-used elements, such as the random seed generator.
  • The ability to create multiple image galleries, allowing you to organize your generated images topically or chronologically.
  • A graphical node editor that lets you design and execute complex image generation operations using a point-and-click interface (see below for more about nodes)
  • Lots of new samplers/schedulers!

The WebUI is now launched from the command line using invokeai-web instead of invokeai --web.

Command Line Tool

  • The previous command line tool has been removed and replaced with a new developer-oriented tool invokeai-node-cli that allows you to experiment with InvokeAI nodes.

Installer

The console-based model installer, invokeai-model-install has been redesigned and now provides tabs for installing checkpoint models, diffusers models, ControlNet models, LoRAs, and Textual Inversion embeddings. You can install models stored locally on disk, or install them using their web URLs or Repo_IDs.

Internal

Internally the code base has been completely rewritten to be much easier to maintain and extend. Importantly, all image generation options are now represented as "nodes", which are small pieces of code that transform inputs into outputs and can be connected together into a graph of operations. Generation and image manipulation operations can now be easily extended by writing a new InvokeAI nodes.

What's Missing in v3.0.0-alpha

Several key features are not yet stable and have been omitted from this alpha release. These include:

  • Textual Inversion Support in the UI
  • A migration path to import 2.3-generated images into the 3.0 image gallery
  • Face restoration and upscaling are not currently working as expected.
  • Model management in the Web UI (add, delete, edit) is only partially functional.
  • Diffusers-style LoRA files (with a HuggingFace repository ID) can be imported but do not run.

Installation / Upgrading

Installing using the InvokeAI zip file installer

To install 3.0.0 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 have an earlier version of InvokeAI installed, we strongly recommend that you install into a new directory, such as invokeai-3 instead of the previously-used invokeai directory. We provide a script that will let you migrate your old models and settings into the new directory, described below.

InvokeAI-installer-v3.0.0+a8.zip

Upgrading in place

If you are on a Linux or Macintosh, you may upgrade a 2.3.2 or higher version of InvokeAI to 3.0 using the following recipe. Unfortunately it does not work on Windows due to a 2.3.5 bug:

  1. Enter the 2.3 root directory you wish to upgrade
  2. Launch invoke.sh or invoke.bat
  3. Select the upgrade menu option [9]
  4. Select "Manually enter the tag name for the version you wish to update to" option [3]
  5. When prompted for the tag, enter v3.0.0+a3
  6. When the upgrade is complete, the main menu will reappear. Choose "rerun the configure script to fix a broken install" option [7]

Windows users can instead follow this recipe:

    1. Enter the 2.3 root directory you wish to upgrade
  2. Launch invoke.sh or invoke.bat
  3. Select the "Developer's console" option [8]
  4. Type the following command: 
pip install "invokeai @ https://github.com/invoke-ai/InvokeAI/archive/refs/tags/v3.0.0+a7.zip" --use-pep517 --upgrade`

(Replace v3.0.0+a7 with the current version number.

This will produce a working 3.0 directory. You may now launch the WebUI in the usual way, by selecting option [1] from the launcher script

After you have confirmed everything is working, you may remove the following backup directories and files:

  • invokeai.init.orig
  • models.orig
  • configs/models.yaml.orig
  • embeddings
  • loras

To get back to a working 2.3 directory, rename all the '*.orig" files and directories to their original names (without the .orig), run the update script again, and select [1] "Update to the latest official release".

Migrating models and settings from a 2.3 InvokeAI root directory to a 3.0 directory

We provide a script, invokeai-migrate3, which will copy your models and settings from a 2.3-format root directory to a new 3.0 directory. To run it, execute the launcher and select option [8] "Developer's console". This will take you to a new command line interface. On the command line, type: 

invokeai-migrate3 --from <path to 2.3 directory> --to <path to 3.0 directory>

Provide the old and new directory names with the --from and --to arguments respectively. This will migrate your models as well as the settings inside invokeai.init. Currently the migration script does not migrate 2.3 images to the new 3.0 gallery. This feature will be added before the final release.

Upgrading using pip

Once 3.0.0 is released (out of alpha and beta), developers and power users can upgrade to the current version by activating the InvokeAI environment and then using: 

pip install --use-pep517 --upgrade InvokeAI

You may specify a particular version by adding the version number to the command, as in: 

pip install --use-pep517 --upgrade  InvokeAI==3.0.0+a3

To upgrade to an xformers version if you are not currently using xformers, use: 

pip install --use-pep517 --upgrade InvokeAI[xformers]

You can see which versions are available by going to The PyPI InvokeAI Project Page

Getting Help

Please see the InvokeAI Issues Board or the InvokeAI Discord for assistance from the development team.

Development Roadmap

If you are looking for a stable version of InvokeAI, either use this release, install from the v2.3 source code branch, or use the pre-nodes tag from the main branch. Developers seeking to contribute to InvokeAI should use the head of the main branch. Please be sure to check out the dev-chat channel of the InvokeAI Discord, and the architecture documentation located at Contributing to come up to speed.

Detailed Change Log

New Contributors

Full Changelog: v2.3.0...v3.0.0+a3

Check out latest releases or
releases around invoke-ai/InvokeAI v3.0.0+a8

Don't miss a new InvokeAI release

NewReleases is sending notifications on new releases.

Get notifications