invoke-ai/InvokeAI v5.4.2rc1

on GitHub

This release candidate includes support for FLUX IP Adapter v2 and image "batching" for Workflows.

Image Batching for Workflows

Invoke's Workflow Editor now supports running a given workflow for each image in a collection of images.

Add an Image Batch node, drag some images into its image collection, and connect its output to any other node(s). Invoke will run the workflow once for each image in the collection.

Here are a few examples to help build intuition for the feature.

Example 1 - Single Batch -> Single Node

The simplest case is using a batch image output with a single node. Here's a workflow that resizes 5 images to 200x200 thumbnails.

Workflow

Results

This batch queues 5 graphs, each containing a single resize node with one of the 5 images in the batch list. Note the images are 200x200 pixels.

Example 2 - Single Batch -> Multiple Nodes

You can also use a batch image output with multiple nodes. This contrived workflow resizes the image to a 200x200 thumbnail, like the previous example, the pastes the thumbnail on the full size image.

Workflow

Results

This batch also queues 5 graphs, each of which contains one resize and one paste node. In each graph, the nodes get the image of the 5 images in the batch collection. The batch node can connect to any number of other nodes. For each queued graph, all connected nodes will get the same image.

Example 3 - Multiple Batches (Product Batching)

When multiple batches are used, they are combined such that all permutations are queued (e.g. the product of batches is taken).

Workflow

Results

In this case, the product of the two batches is 15 graphs. Each image of the 3-image batch is used as the base image, and a thumbnail of each tiger is pasted on top of it. We'll call this "product" batching.

Zipped Batching

The batching API supports "zipped" batches, where the batch collections are merged into a single batch.

For example, imagine two batches of 5 images. As described in the "product" example above, you'd get 5 images * 5 images = 25 graphs. Zipped batching would instead take the first image from each of the two batches and use them together in the first graph, then take the second two images for the second graph, and so on.

Zipped batching is not supported in the UI at this time.

Versus Iterate Nodes

We support similar functionality to batching with Iterate nodes, so why add batching? In short, Iterate nodes have some technical issues avoided by batching.

Batching also more intuitive - we run exactly this graph, once for each image.

Unlike Iterate nodes, Image Batch nodes' collections cannot be provided by other nodes in the graph. The collection must be defined up-front, so you cannot replace Iterate with Image Batch for all use-cases.

Nevertheless, we suggest using batching where possible.

Other Notes

• We've added Image Batch nodes first because it images are the highest-impact field type, but the batching API supports arbitrary field types. In fact, the Canvas uses both int and str fields internally. We'll save nodes for other field types for a future enhancement.
• If you want to batch over a board, you'll need to drag all images from the board into the batch collection. We'll explore a simpler way to use a board's images for a batch in a future enhancement.
• It is not possible to combine all outputs from a batch within the same workflow.

Other Changes

Enhancements

• Support for FLUX IP Adapter v2. We've optimized internal handling for v2, and you may find FLUX IP Adapter v1 results are degraded. Update to v2 to fix this.
• Updated image collection inputs for nodes. You may now drag images into collections directly.

Fixes

• Added padding to the metadata recall buttons in the metadata viewer, so they aren't cut off by other UI elements.
• The progress bar stopped throbbing in the last release. We apologize for this oversight. Throbbing has been restored.
• Addressed some edge cases that could cause the UI to crash with an error about an entity not found.
• Updated grid size for SD3.5 models to 16px. Thanks for the heads up @dunkeroni.

Internal

• Removed a node with a GPL-3 dependency (easing-functions), which had been contributed in the step_param_easing node that used it. While this node has been deprecated, please let us know if you were using this node, and the use-cases, so that we can better design inputs where these are found helpful.

Translations

We have had some issues communicating with "walk-in" translators on Weblate, resulting in translations being changed when they are already correct. To mitigate this, we are trying a more restricted Weblate translation setup. Access to contribute translations must be granted by @Harvester62. Please @ them in the #translators channel on discord to get access.

We apologize for any inconvenience this change may cause. Thanks to all our translators for their continued efforts!

• Updated Chinese (Simplified). Thanks @youo0o0!
• Updated Italian. Thanks @Harvester62!
• Updated Spanish. Thanks gallegonovato (weblate user)!

Installation and Updating

To install or update, download the latest installer and follow the installation instructions

To update, select the same installation location. Your user data (images, models, etc) will be retained.

What's Changed

• feat(ui): deferred invocation progress details for model loading by @maryhipp in #7320
• fix(ui): add padding to the metadata recall section so buttons are not blocked by @maryhipp in #7326
• ui: translations update from weblate by @weblate in #7323
• remove GPL-3 licensed package easing-functions by @maryhipp in #7337
• fix(ui): progress bar not throbbing when it should by @psychedelicious in #7332
• fix(ui): prevent entity not found errors by @psychedelicious in #7340
• XLabs FLUX IP-Adapter v2 by @RyanJDick in #7338
• feat(ui): image batching in workflows by @psychedelicious in #7343
• fix(ui): add sd-3 grid size of 16px to grid util by @psychedelicious in #7346
• chore: bump version to v5.4.2rc1 by @psychedelicious in #7344
• ui: translations update from weblate by @weblate in #7331

Full Changelog: v5.4.1...v5.4.2rc1