Skip to content
InvokeAI Logo InvokeAI Documentation

Releases

InvokeAI v3.4.0

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry-leading web interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please visit our Documentation or join our Discord server!

🌟 What’s New in 3.4.0:

  • LCM-LoRAs are natively supported now supported in InvokeAI. See the note in Things to Know below.
  • Community Nodes can now be installed by adding them to the nodes folder of the InvokeAI installation
  • Core Nodes can be automatically updated via the Workflow Editor
  • Large performance improvements: reduced LoRA & text encoder loading times, improved token handling
  • HiRes Fix is has returned!
  • FreeU is supported for workflows
  • ControlNets & T2I-Adapters can now be used together
  • Multi-Image IP-Adapter is now available in Nodes Workflows (Instant LoRA!)
  • Intermediate images are no longer saved to disk
  • ControlNets in .safetensors format are now able to be used (SD1.5 & SD2 only). See the note in Things to Know below.
  • VAE is now able to be recalled with “Use All”
  • Color Picker Improvements
  • Expanded translations (Dutch, Italian and Chinese are almost entirely complete!)
  • InvokeAI now uses Pydantic2 and the latest FastAPI, making certain functions (like Iterate nodes) much more efficient.

‼️ Things to Know:

  • InvokeAI is only be supported for Python 3.10 and newer versions. Please upgrade your Python environment if you are using an older version.
  • Community nodes that were previously installed in the .venv will need to be moved to the nodes folder at the root level of the InvokeAI installation.
  • LCM-LoRAs are natively supported in diffusers format can be downloaded through the model manager using the HuggingFace RepoID. LCMs are supported through a custom node.
  • To support .safetensors ControlNets for SD1.5 & SD2, select option [6] from the launcher to “Re-run the configure script to fix a broken install or to complete a major upgrade”.

💿 Installation and Upgrading:

To install version 3.4.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 already have InvokeAI version 3.x installed, you can update by running invoke.sh / invoke.bat and selecting option [9] to upgrade, or you can download and run the installer in your existing InvokeAI installation location.

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

Download the installer:InvokeAI-installer-v3.4.0.zip

⚙️ 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 is welcome. To get started as a contributor, please refer to How to Contribute or reach out to imic on Discord!

New Contributors

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.3.0post3…v3.4.0

InvokeAI 3.3.0post3

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry-leading web interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please visit our Documentation or join our Discord server!

Post3 Update

3.3.0post3 is a hotfix release that fixes canvas locking issues, addresses a breaking change from v5.10 of python-socketio and adds translations

🌟 What’s New in 3.3.0:

  • T2I-Adapter is now supported
    • Models can be downloaded through the Model Manager or the model download function in the launcher script.
  • Multi IP-Adapter Support!
  • New nodes for working with faces
  • Improved model load times from disk
  • Hotkey fixes
  • Expanded translations (for many languages!)
  • Unified Canvas improvements and bug fixes

‼️ Things to Know:

  • Future updates will bring a couple of major changes:
    • Starting with 3.30, InvokeAI will only be supported for Python 3.10 and newer versions. Please begin preparing to upgrade your Python environment.
    • Community Nodes will need to update their import structure. InvokeAI internal services are being reorganized to better support Community Nodes and future development efforts.
  • T2I-Adapter and ControlNet cannot currently be used at the same time. This is prevented in the regular UI, but users will find that errors occur if they do not follow this guidance in Workflow development.
  • T2I-Adapters currently require an image output size that is a multiple of 64. This is enforced in the regular UI, but again, you will need to adhere to this constraint in workflow development

💿 Installation and Upgrading:

To install version 3.3.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 already have InvokeAI version 3.x installed, you can update by running invoke.sh / invoke.bat and selecting option [9] to upgrade, or you can download and run the installer in your existing InvokeAI installation location.

Download the installer: InvokeAI-installer-v3.3.0post3.zip

⚙️ 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 is welcome. To get started as a contributor, please refer to How to Contribute or reach out to imic on Discord!

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.3.0post2…v3.3.0post3

InvokeAI 3.3.0post2

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry-leading web interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please visit our Documentation or join our Discord server!

Post2 update

3.3.0post2 is a minor hotfix that corrects incompatibility issues when installing xformers, updates translations, and corrects incompatibilities with systems that have versions of glibc<2.3.3.

🌟 What’s New in 3.3.0:

  • T2I-Adapter is now supported
    • Models can be downloaded through the Model Manager or the model download function in the launcher script.
  • Multi IP-Adapter Support!
  • New nodes for working with faces
  • Improved model load times from disk
  • Hotkey fixes
  • Expanded translations (for many languages!)
  • Unified Canvas improvements and bug fixes

‼️ Things to Know:

  • Future updates will bring a couple of major changes:
    • Starting with 3.3, InvokeAI will only be supported for Python 3.10 and newer versions. Please begin preparing to upgrade your Python environment.
    • Community Nodes will need to update their import structure. InvokeAI internal services are being reorganized to better support Community Nodes and future development efforts.
  • T2I-Adapter and ControlNet cannot currently be used at the same time. This is prevented in the regular UI, but users will find that errors occur if they do not follow this guidance in Workflow development.
  • T2I-Adapters currently require an image output size that is a multiple of 64. This is enforced in the regular UI, but again, you will need to adhere to this constraint in workflow development

💿 Installation and Upgrading:

To install version 3.3.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 already have InvokeAI version 3.x installed, you can update by running invoke.sh / invoke.bat and selecting option [9] to upgrade, or you can download and run the installer in your existing InvokeAI installation location.

**Download the installer: InvokeAI-installer-v3.3.0post2.zip **

⚙️ 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 is welcome. To get started as a contributor, please refer to How to Contribute or reach out to imic on Discord!

New Contributors:

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.2.0…v3.3.0post2

InvokeAI 3.3.0post1

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry-leading web interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please visit our Documentation or join our Discord server!

🌟 What’s New in 3.3.0:

  • T2I-Adapter is now supported
    • Models can be downloaded through the Model Manager or the model download function in the launcher script.
  • Multi IP-Adapter Support!
  • New nodes for working with faces
  • Improved model load times from disk
  • Hotkey fixes
  • Expanded translations (for many languages!)
  • Unified Canvas improvements and bug fixes

‼️ Things to Know:

  • Future updates will bring a couple of major changes:
    • Starting with 3.3, InvokeAI will only be supported for Python 3.10 and newer versions. Please begin preparing to upgrade your Python environment.
    • Community Nodes will need to update their import structure. InvokeAI internal services are being reorganized to better support Community Nodes and future development efforts.
  • T2I-Adapter and ControlNet cannot currently be used at the same time. This is prevented in the regular UI, but users will find that errors occur if they do not follow this guidance in Workflow development.
  • T2I-Adapters currently require an image output size that is a multiple of 64. This is enforced in the regular UI, but again, you will need to adhere to this constraint in workflow development

💿 Installation and Upgrading:

To install version 3.3.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 already have InvokeAI version 3.x installed, you can update by running invoke.sh / invoke.bat and selecting option [9] to upgrade, or you can download and run the installer in your existing InvokeAI installation location.

**Download the installer: InvokeAI-installer-v3.3.0post1.zip **

⚙️ 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 is welcome. To get started as a contributor, please refer to How to Contribute or reach out to imic on Discord!

New Contributors:

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.2.0…v3.3.0

InvokeAI v3.2.0

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry-leading Web Interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please see our Documentation or join the Discord!

What’s New in 3.2.0:

  • Queueing
    • This is a powerful new feature that allows you to queue multiple image generations, create batches, manage the queue, and gain insight into generations.
  • IP-Adapter is now supported
    • Instructions on getting started with IP-Adapter are located in the “Things to Know” section below
  • TAESD is now supported. You can download TAESD or TAESDXL through the model manager UI
  • LoRAs and ControlNets are now able to be recalled with the “Use All” function
  • New nodes! Load prompts from a file, string manipulation, and expanded math functions
  • Node caching - improve performance by using previously cached generation values
  • V-prediction for SD1.5 is now supported
  • Importing images from previous versions of InvokeAI has been fixed
  • Database maintenance script can be run with invokeai-db-maintenance
  • View image metadata with the invokeai-metadata command
  • Workflow Editor UI/UX improvements
  • Unified Canvas improvements & bug fixes

Things to Know:

  • If you experience the server error, TypeError: Invoker.create_execution_state() got an unexpected keyword argument 'queue_id', try clearing your local browser cache or resetting the InvokAI UI (Settings -> Reset UI) before running a generation.

  • You might see a red alert icon on your nodes after loading a workflow. This indicates that the node in the workflow is from an older version of InvokeAI, or the node doesn’t have a version. If your workflow runs, you may safely ignore this, and we will add functionality to “upgrade” the un-versioned nodes in a future update. If the workflow does not work, you will need to delete and add the nodes.

  • To get started with IP-Adapter, you’ll need to download the image encoder and IP-Adapter for the desired based model. Once the models are installed, IP-Adapter is able to be used under the “Control Adapters” options.

    Image Encoders:

    IP-Adapter Models:

    These can be installed from the Model Manager by choosing “Import Models” and pasting in the repoIDs of the desired model. Remember to install the model and the image encoder! For example to get started with IP-Adapter for SD1.5 these are the repo IDs:

    • InvokeAI/ip_adapter_plus_sd15
    • InvokeAI/ip_adapter_sd_image_encoder

    or from the command line by starting the “Developer’s Console” from the invoke.bat launcher and pasting this command:

    invokeai-model-install --add InvokeAI/ip_adapter_sd_image_encoder InvokeAI/ip_adapter_sdxl_image_encoder InvokeAI/ip_adapter_sd15 InvokeAI/ip_adapter_plus_sd15 InvokeAI/ip_adapter_plus_face_sd15 InvokeAI/ip_adapter_sdxl

Installation and Upgrading:

To install v3.2.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 already have InvokeAI v3.x installed, you can update by running invoke.sh / invoke.bat and selecting option [9] to upgrade, or you can download and run the installer in your existing InvokeAI installation location.

Download the installer: InvokeAI-installer-v3.2.0.zip

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 is welcome. To get started as a contributor, please see How to Contribute or reach out to imic on Discord!

New Contributors

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.1.1…v3.2.0

InvokeAI 3.1.1

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry leading Web Interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please see our Documentation, and check out the 3.1 Release Landing Page for the Community Edition!

What’s New in 3.1.1:

  • Node versioning
  • Nodes now support polymorphic inputs (inputs which are a single of a given type or list of a given type, e.g. Union[str, list[str]])
  • SDXL Inpainting Model is now supported
  • Inpainting & Outpainting Improvements
  • Workflow Editor UI Improvements
  • Model Manager Improvements
  • Fixed configuration script trying to set VRAM on macOS

Things to Know:

  • You might see a red alert icon on your nodes after loading a workflow. This indicates that the node in the workflow is from an older version of InvokeAI, or the node doesn’t have a version. If your workflow runs, you may safely ignore this, and we will add functionality to “upgrade” the un-versioned nodes in a future update. If the workflow does not work, you will need to delete and add the nodes.

Installation and Upgrading

To install v3.1.1 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.

Download the installer: InvokeAI-installer-v3.1.1.zip

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 see How to Contribute.

New Contributors

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.1.0…v3.1.1

InvokeAI 3.1.0

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry leading Web Interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please see our Documentation, and check out the 3.1 Release Landing Page for the Community Edition!

Download the installer: InvokeAI-installer-v3.1.0.zip

What’s New in v3.1.0

Workflows

InvokeAI 3.1.0 introduces a new powerful tool to aide the image generation process in the Workflow Builder. Workflows combine the power of nodes-based software with the ease of use of a GUI to deliver the best of both worlds.

The Node Editor allows you to build the custom image generation workflows you need, as well as enables you to create and use custom nodes, making InvokeAI a fully extensible platform.

To get started with nodes in InvokeAI, take a look at our example workflows, or some of the custom Community Nodes.

A zip file of example workflows can be found at the bottom of this page under Assets.

Other New Features

  • Expanded SDXL support across all areas of InvokeAI.
  • Enhanced In-painting & Out-painting capabilities.
  • Improved Control Asset Usage, including from the Unified Canvas.
  • Newly added nodes for better functionality.
  • Seamless Tiling is back, with SDXL support!
  • Improved In-inpainting & Out-painting
  • Generation statistics can be viewed from the command line after generation
  • Hot-reloading is now available for python files in the application
  • LoRAs are sorted alphabetically
  • Symbolic links to directories in the autoimport folder are now supported
  • UI/UX Improvements
  • Interactively configure image generation options, the attention system, and the VRAM cache
  • …and so much more! You can view the full change log here

Installation / Upgrading

Installing using the InvokeAI zip file installer

To install v3.1.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 InvokeAI 2.3.5 or older installed, we 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.

In the event of an aborted install that has left the invokeai directory unusable, you may be able to recover it by asking the installer to install on top of the existing directory. This is a non-destructive operation that will not affect existing models or images.

InvokeAI-installer-v3.1.0.zip

Upgrading in place

All users can upgrade from 3.0.2 using the launcher’s “upgrade” facility. If you are on a Linux or Macintosh, you may also upgrade a 2.3.2 or higher version of InvokeAI to 3.1 using this recipe, but upgrading from 2.3 will not work on Windows due to a 2.3.5 bug (see workaround below):

  1. Enter the 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. Select option [1] to upgrade to the latest version.
  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 commands:
pip install "invokeai @ https://github.com/invoke-ai/InvokeAI/archive/refs/tags/v3.1.0.zip" --use-pep517 --upgrade
invokeai-configure --root .

This will produce a working 3.1.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”.

Note:

  • If you had issues with inpainting on a previous InvokeAI 3.0 version, delete your models/.cache folder before proceeding.

What to do if problems occur during the install

Due to the large number of Python libraries that InvokeAI requires, as well as the large size of the newer SDXL models, you may experience glitches during the install process. This particularly affects Windows users. Please see the Installation Troubleshooting Guide for solutions.

In the event that an update makes your environment unusable, you may use the zip installer to reinstall on top of your existing root directory. Models and generated images already in the directory will not be affected.

Migrating images from a 2.3 InvokeAI root directory to a 3.0 directory

We provide a script, invokeai-import-images, which will copy images from any previous version of InvokeAI 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-import-images

This will prompt you to select the destination and source directories, and allow you to select which image gallery board to import into.

Migrating models and settings from an old 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. You may provide the same --from and --to directories in order ot upgrade a 2.3 root directory in place. (The original models and configuration files will be backed up.)

Upgrading using pip

Developers and power users can upgrade to the current version by activating the InvokeAI environment and then using:

pip install --use-pep517 --upgrade InvokeAI
invokeai-configure --yes --skip-sd-weights

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

pip install --use-pep517 --upgrade  InvokeAI==3.1.0
invokeai-configure --yes --skip-sd-weights

Important: After doing the pip install, it is necessary to invokeai-configure in order to download new core models needed to load and convert Stable Diffusion XL .safetensors files. The web server will refuse to start if you do not do so.

Getting Started with SDXL

Stable Diffusion XL (SDXL) is the latest generation of StabilityAI’s image generation models, capable of producing high quality 1024x1024 photorealistic images as well as many other visual styles. SDXL comes with two models, a “base” model that generates the initial image, and a “refiner” model that takes the initial image and improves on it in an img2img manner. In many cases, just the base model will give satisfactory results.

To download the base and refiner SDXL models, you have several options:

  1. Select option [5] from the invoke.bat launcher script, and select the base model, and optionally the refiner, from the checkbox list of “starter” models.
  2. Use the Web’s Model Manager to select “Import Models” and when prompted provide the HuggingFace repo_ids for the two models:
    • stabilityai/stable-diffusion-xl-base-1.0
    • stabilityai/stable-diffusion-xl-refiner-1.0
  3. Download the models manually and cut and paste their paths into the Location field in “Import Models”

Also be aware that SDXL requires at 6-8 GB of VRAM in order to render 1024x1024 images and a minimum of 16 GB of RAM. For best performance, we recommend the following settings in invokeai.yaml:

precision: float16
ram: 12.0
vram: 0.5

Known Issues in 3.1

This is a list of known issues in 3.1.0 as well as features that are planned for inclusion in later releases:

  • The max_vram_cache and ram_cache settings in invokeai.yaml have been deprecated and renamed to vram and ram. To adjust cache size, we recommend using the configure script (option [6] in the launcher) to adjust them.
  • Variation generation was not fully functional and did not make it into the release.
  • High-res optimization has been removed from the basic user interface as we experiment with better ways to achieve good results with nodes. However, you will find a high-res optimization workflows attached and in the Community Nodes Discord channel at https://discord.com/channels/1020123559063990373/1130291608097661000 for use with the Workflow tool.

Getting Help

For support, please use this repository’s GitHub Issues tracking service, or join our Discord.

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 see How to Contribute.

New Contributors

Thank you to all of the new and existing contributors to InvokeAI. We appreciate your efforts and contributions!

Detailed Change Log since 3.0.2

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.0.2post1…v3.1.0rc1

InvokeAI v3.0.2post1

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry leading Web Interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please see our Documentation Pages.

What’s New in v3.0.2post1

  • Support for LoRA models in diffusers format
  • Warn instead of crashing when a corrupted model is detected
  • Bug fix for auto-adding to a board

What’s New in v3.0.2

  • LoRA support for SDXL is now available
  • Mutli-select actions are now supported in the Gallery
  • Images are automatically sent to the board that is selected at invocation
  • Images from previous versions of InvokeAI are able to imported with the invokeai-import-images command
  • Inpainting models imported from A1111 will now work with InvokeAI (see upgrading note)
  • Model merging functionality has been fixed
  • Improved Model Manager UI/UX
  • InvokeAI 3.0 can be served via HTTPS
  • Execution statistics are visible in the terminal after each invocation
  • ONNX models are now supported for use with Text2Image
  • Pydantic errors when upgrading inplace have been resolved
  • Code formatting is now part of the CI/CD pipeline
  • …and lots more! You can view the full change log here

Installation / Upgrading

Installing using the InvokeAI zip file installer

To install 3.0.2post1 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 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.

In the event of an aborted install that has left the invokeai directory unusable, you may be able to recover it by asking the installer to install on top of the existing directory. This is a non-destructive operation that will not affect existing models or images.

InvokeAI-installer-v3.0.2post1.zip

Upgrading in place

All users can upgrade from 3.0.1 using the launcher’s “upgrade” facility. If you are on a Linux or Macintosh, you may also upgrade a 2.3.2 or higher version of InvokeAI to 3.0.2 using this recipe, but upgrading from 2.3 will not work on Windows due to a 2.3.5 bug (see workaround below):

  1. Enter the 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. Select option [1] to upgrade to the latest version.
  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 commands:
pip install "invokeai @ https://github.com/invoke-ai/InvokeAI/archive/refs/tags/v3.0.2.zip" --use-pep517 --upgrade
invokeai-configure --root .

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”.

Note:

  • If you had issues with inpainting on a previous InvokeAI 3.0 version, delete your models/ .cache folder before proceeding.

What to do if problems occur during the install

Due to the large number of Python libraries that InvokeAI requires, as well as the large size of the newer SDXL models, you may experience glitches during the install process. This particularly affects Windows users. Please see the Installation Troubleshooting Guide for solutions.

In the event that an update makes your environment unusable, you may use the zip installer to reinstall on top of your existing root directory. Models and generated images already in the directory will not be affected.

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. You may provide the same --from and --to directories in order ot upgrade a 2.3 root directory in place. (The original models and configuration files will be backed up.)

Upgrading using pip

Developers and power users can upgrade to the current version by activating the InvokeAI environment and then using:

pip install --use-pep517 --upgrade InvokeAI
invokeai-configure --yes --skip-sd-weights

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

pip install --use-pep517 --upgrade  InvokeAI==3.0.2
invokeai-configure --yes --skip-sd-weights

Important: After doing the pip install, it is necessary to invokeai-configure in order to download new core models needed to load and convert Stable Diffusion XL .safetensors files. The web server will refuse to start if you do not do so.

Getting Started with SDXL

Stable Diffusion XL (SDXL) is the latest generation of StabilityAI’s image generation models, capable of producing high quality 1024x1024 photorealistic images as well as many other visual styles. SDXL comes with two models, a “base” model that generates the initial image, and a “refiner” model that takes the initial image and improves on it in an img2img manner. In many cases, just the base model will give satisfactory results.

To download the base and refiner SDXL models, you have several options:

  1. Select option [5] from the invoke.bat launcher script, and select the base model, and optionally the refiner, from the checkbox list of “starter” models.
  2. Use the Web’s Model Manager to select “Import Models” and when prompted provide the HuggingFace repo_ids for the two models:
    • stabilityai/stable-diffusion-xl-base-1.0
    • stabilityai/stable-diffusion-xl-refiner-1.0
  3. Download the models manually and cut and paste their paths into the Location field in “Import Models”

Also be aware that SDXL requires at 6-8 GB of VRAM in order to render 1024x1024 images and a minimum of 16 GB of RAM. For best performance, we recommend the following settings in invokeai.yaml:

precision: float16
max_cache_size: 12.0
max_vram_cache_size: 0.5

Known Issues in 3.0

This is a list of known bugs in 3.0.2rc1 as well as features that are planned for inclusion in later releases:

  • Variant generation was not fully functional and did not make it into the release. It will be added in the next point release.
  • Perlin noise and symmetrical tiling were not widely used and have been removed from the feature set.
  • High res optimization has been removed from the basic user interface as we experiment with better ways to achieve good results with nodes. However, you will find several community-contributed high-res optimization pipelines in the Community Nodes Discord channel at https://discord.com/channels/1020123559063990373/1130291608097661000 for use with the experimental Node Editor.

Getting Help

For support, please use this repository’s GitHub Issues tracking service, or join our Discord.

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 see How to Contribute.

New Contributors

Thank you to all of the new contributors to InvokeAI. We appreciate your efforts and contributions!

Detailed Change Long since 3.0.2

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.0.2…v3.0.2post1

InvokeAI Version 3.0.2

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry leading Web Interface and also serves as the foundation for multiple commercial products.

To learn more about InvokeAI, please see our Documentation Pages.

What’s New in v3.0.2

  • LoRA support for SDXL is now available
  • Mutli-select actions are now supported in the Gallery
  • Images are automatically sent to the board that is selected at invocation
  • Images from previous versions of InvokeAI are able to imported with the invokeai-import-images command
  • Inpainting models imported from A1111 will now work with InvokeAI (see upgrading note)
  • Model merging functionality has been fixed
  • Improved Model Manager UI/UX
  • InvokeAI 3.0 can be served via HTTPS
  • Execution statistics are visible in the terminal after each invocation
  • ONNX models are now supported for use with Text2Image
  • Pydantic errors when upgrading inplace have been resolved
  • Code formatting is now part of the CI/CD pipeline
  • …and lots more! You can view the full change log here

Installation / Upgrading

Installing using the InvokeAI zip file installer

To install 3.0.2 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 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.

In the event of an aborted install that has left the invokeai directory unusable, you may be able to recover it by asking the installer to install on top of the existing directory. This is a non-destructive operation that will not affect existing models or images.

InvokeAI-installer-v3.0.2.zip

Upgrading in place

All users can upgrade from 3.0.1 using the launcher’s “upgrade” facility. If you are on a Linux or Macintosh, you may also upgrade a 2.3.2 or higher version of InvokeAI to 3.0.2 using this recipe, but upgrading from 2.3 will not work on Windows due to a 2.3.5 bug (see workaround below):

  1. Enter the 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. Select option [1] to upgrade to the latest version.
  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 commands:
pip install "invokeai @ https://github.com/invoke-ai/InvokeAI/archive/refs/tags/v3.0.2.zip" --use-pep517 --upgrade
invokeai-configure --root .

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”.

Note:

  • If you had issues with inpainting on a previous InvokeAI 3.0 version, delete your models/ .cache folder before proceeding.

What to do if problems occur during the install

Due to the large number of Python libraries that InvokeAI requires, as well as the large size of the newer SDXL models, you may experience glitches during the install process. This particularly affects Windows users. Please see the Installation Troubleshooting Guide for solutions.

In the event that an update makes your environment unusable, you may use the zip installer to reinstall on top of your existing root directory. Models and generated images already in the directory will not be affected.

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. You may provide the same --from and --to directories in order ot upgrade a 2.3 root directory in place. (The original models and configuration files will be backed up.)

Upgrading using pip

Developers and power users can upgrade to the current version by activating the InvokeAI environment and then using:

pip install --use-pep517 --upgrade InvokeAI
invokeai-configure --yes --skip-sd-weights

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

pip install --use-pep517 --upgrade  InvokeAI==3.0.2
invokeai-configure --yes --skip-sd-weights

Important: After doing the pip install, it is necessary to invokeai-configure in order to download new core models needed to load and convert Stable Diffusion XL .safetensors files. The web server will refuse to start if you do not do so.

Getting Started with SDXL

Stable Diffusion XL (SDXL) is the latest generation of StabilityAI’s image generation models, capable of producing high quality 1024x1024 photorealistic images as well as many other visual styles. SDXL comes with two models, a “base” model that generates the initial image, and a “refiner” model that takes the initial image and improves on it in an img2img manner. In many cases, just the base model will give satisfactory results.

To download the base and refiner SDXL models, you have several options:

  1. Select option [5] from the invoke.bat launcher script, and select the base model, and optionally the refiner, from the checkbox list of “starter” models.
  2. Use the Web’s Model Manager to select “Import Models” and when prompted provide the HuggingFace repo_ids for the two models:
    • stabilityai/stable-diffusion-xl-base-1.0
    • stabilityai/stable-diffusion-xl-refiner-1.0
  3. Download the models manually and cut and paste their paths into the Location field in “Import Models”

Also be aware that SDXL requires at 6-8 GB of VRAM in order to render 1024x1024 images and a minimum of 16 GB of RAM. For best performance, we recommend the following settings in invokeai.yaml:

precision: float16
max_cache_size: 12.0
max_vram_cache_size: 0.5

Known Issues in 3.0

This is a list of known bugs in 3.0.2rc1 as well as features that are planned for inclusion in later releases:

  • Variant generation was not fully functional and did not make it into the release. It will be added in the next point release.
  • Perlin noise and symmetrical tiling were not widely used and have been removed from the feature set.
  • High res optimization has been removed from the basic user interface as we experiment with better ways to achieve good results with nodes. However, you will find several community-contributed high-res optimization pipelines in the Community Nodes Discord channel at https://discord.com/channels/1020123559063990373/1130291608097661000 for use with the experimental Node Editor.

Getting Help

For support, please use this repository’s GitHub Issues tracking service, or join our Discord.

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 see How to Contribute.

New Contributors

Thank you to all of the new contributors to InvokeAI. We appreciate your efforts and contributions!

Detailed Change Log

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.0.1rc3…v3.0.2

InvokeAI 3.0.1 (hotfix 3)

InvokeAI Version 3.0.1

InvokeAI is a leading creative engine built to empower professionals and enthusiasts alike. Generate and create stunning visual media using the latest AI-driven technologies. InvokeAI offers an industry leading Web Interface, interactive Command Line Interface, and also serves as the foundation for multiple commercial products.

InvokeAI version 3.0.1 adds support for rendering with Stable Diffusion XL Version 1.0 directly in the Text2Image and Image2Image panels, as well as many internal changes.

To learn more about InvokeAI, please see our Documentation Pages.

What’s New in v3.0.1

  • Stable Diffusion XL support in the Text2Image and Image2Image (but not the Unified Canvas).
  • Can install and run both diffusers-style and .safetensors-style SDXL models.
  • Download Stable Diffusion XL 1.0 (base and refiner) using the model installer or the Web UI-based Model Manager
  • Invisible watermarking, which is recommended for use with Stable Diffusion XL, is now available as an option in the Web UI settings dialogue.
  • The NSFW detector, which was missing in 3.0.0, is again available. It can be activated as an option in the settings dialogue.
  • During initial installation, a set of recommended ControlNet, LoRA and Textual Inversion embedding files will now be downloaded and installed by default, along with several “starter” main models.
  • User interface cleanup to reduce visual clutter and increase usability.

v3.0.1post3Hotfixes

This release containss a proposed hotfix for the Windows install OSError crashes that began appearing in 3.0.1. In addition, the following bugs have been addressed:

  • Correct issue of some SD-1 safetensors models could not be loaded or converted
  • The models_dir configuration variable used to customize the location of the models directory is now working properly
  • Fixed crashes of the text-based installer when the number of installed LoRAs and other models exceeded 72
  • SDXL metadata is now set and retrieved properly
  • Correct post1’s crash when performing configure with --yes flag.
  • Correct crashes in the CLI model installer

Installation / Upgrading

Installing using the InvokeAI zip file installer

To install 3.0.1 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 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.

In the event of an aborted install that has left the invokeai directory unusable, you may be able to recover it by asking the installer to install on top of the existing directory. This is a non-destructive operation that will not affect existing models or images.

InvokeAI-installer-v3.0.1post3.zip

Upgrading in place

All users can upgrade from 3.0.0 using the launcher’s “upgrade” facility. If you are on a Linux or Macintosh, you may also upgrade a 2.3.2 or higher version of InvokeAI to 3.0 using this recipe, but upgrading from 2.3 will not work on Windows due to a 2.3.5 bug (see workaround below):

  1. Enter the 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. Select option [1] to upgrade to the latest version.
  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 commands:
pip install "invokeai @ https://github.com/invoke-ai/InvokeAI/archive/refs/tags/v3.0.1post3.zip" --use-pep517 --upgrade
invokeai-configure --root .

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”.

What to do if problems occur during the install

Due to the large number of Python libraries that InvokeAI requires, as well as the large size of the newer SDXL models, you may experience glitches during the install process. This particularly affects Windows users. Please see the Installation Troubleshooting Guide for solutions.

In the event that an update makes your environment unusable, you may use the zip installer to reinstall on top of your existing root directory. Models and generated images already in the directory will not be affected.

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. You may provide the same --from and --to directories in order ot upgrade a 2.3 root directory in place. (The original models and configuration files will be backed up.)

Upgrading using pip

Developers and power users can upgrade to the current version by activating the InvokeAI environment and then using:

pip install --use-pep517 --upgrade InvokeAI
invokeai-configure --yes --skip-sd-weights

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

pip install --use-pep517 --upgrade  InvokeAI==3.0.1post3
invokeai-configure --yes --skip-sd-weights

Important: After doing the pip install, it is necessary to invokeai-configure in order to download new core models needed to load and convert Stable Diffusion XL .safetensors files. The web server will refuse to start if you do not do so.

Getting Started with SDXL

Stable Diffusion XL (SDXL) is the latest generation of StabilityAI’s image generation models, capable of producing high quality 1024x1024 photorealistic images as well as many other visual styles. SDXL comes with two models, a “base” model that generates the initial image, and a “refiner” model that takes the initial image and improves on it in an img2img manner. In many cases, just the base model will give satisfactory results.

To download the base and refiner SDXL models, you have several options:

  1. Select option [5] from the invoke.bat launcher script, and select the base model, and optionally the refiner, from the checkbox list of “starter” models.
  2. Use the Web’s Model Manager to select “Import Models” and when prompted provide the HuggingFace repo_ids for the two models:
    • stabilityai/stable-diffusion-xl-base-1.0
    • stabilityai/stable-diffusion-xl-refiner-1.0
  3. Download the models manually and cut and paste their paths into the Location field in “Import Models”

Also be aware that SDXL requires at 6-8 GB of VRAM in order to render 1024x1024 images and a minimum of 16 GB of RAM. For best performance, we recommend the following settings in invokeai.yaml:

precision: float16
max_cache_size: 12.0
max_vram_cache_size: 0.5

Known Bugs in 3.0

This is a list of known bugs in 3.0.1post3 as well as features that are planned for inclusion in later releases:

  • The merge script isn’t working, and crashes during startup (will be fixed soon)
  • Inpainting models generated using the A1111 merge module are not loading properly (will be fixed soon)
  • Variant generation was not fully functional and did not make it into the release. It will be added in the next point release.
  • Perlin noise and symmetrical tiling were not widely used and have been removed from the feature set.
  • Face restoration is no longer needed due to the improvent in recent SD 1.x, 2.x and XL models and has been removed from the feature set.
  • High res optimization has been removed from the basic user interface as we experiment with better ways to achieve good results with nodes. However, you will find several community-contributed high-res optimization pipelines in the Community Nodes Discord channel at https://discord.com/channels/1020123559063990373/1130291608097661000 for use with the experimental Node Editor.
  • There is no easy way to import a directory of version 2.3 generated images into the 3.0 gallery while preserving metadata. We hope to provide an import script in the not so distant future.

Getting Help

For support, please use this repository’s GitHub Issues tracking service, or join our Discord.

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 see How to Contribute.

What’s Changed

Full Changelog: https://github.com/invoke-ai/InvokeAI/compare/v3.0.1…v3.0.1post1

This site was designed and developed by Aether Fox Studio.