Releases: invoke-ai/InvokeAI
v5.4.3rc1
This minor release adds arrow key nudge on Canvas, plus a handful of fixes and enhancements.
Changes
Enhancements
- Add 1-pixel
nudge
to the move tool on Canvas. Use the arrow keys to make fine adjustments to a layer's position. Thanks @hippalectryon-0! - Change the default infill method from
patchmatch
tolama
. You can usepatchmatch
. - Add empty state for Global Reference Images and Regional Guidance Reference Images, similar to the empty state for Control Layers. A blurb directs users to upload an image or drag an image from gallery to set the image.
Fixes
- Soft Edge (Lineart, Lineart Anime) Control Layers default to the Soft Edge filter correctly.
- Remove the nonfunctional
width
andheight
outputs from theImage Batch
node. If you want to usewidth
andheight
in a batch, route theimage
fromImage Batch
to anImage Primitive
node, which outputswidth
andheight
. - Ensure invocation templates have fully parsed before running studio init actions.
Internal
- Add redux actions for support video modal.
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
- fix(api): make sure Soft Edge Detection has preprocessor applied by @maryhipp in #7360
- fix(ui): disable width and height output on image batch output by @psychedelicious in #7361
- feat(ui): set default infill method to lama by @psychedelicious in #7362
- fix(ui): make sure schema has loaded before trying to load any workflows by @maryhipp in #7364
- feat(ui): add actions for video modal clicks by @maryhipp in #7365
- feat(ui): add empty state for regional guidance ref image by @psychedelicious in #7363
- feat(ui): nudge on canvas by @psychedelicious in #7368
- chore: bump version to v5.4.3rc1 by @psychedelicious in #7369
Full Changelog: v5.4.2...v5.4.3rc1
v5.4.2
This release includes support for FLUX IP Adapter v2 and image "batching" for Workflows.
Image Batching for Workflows
The 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. Click the arrow to expand each example.
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 which are addressed by batching.
Why `Iterate` Nodes are Scary
They result in unbounded graph complexity and size. If you don't know what these words mean, but they sound kinda scary, congrats! You are on the right track. They are indeed scary words.
- When using
Iterate
nodes, the graph is expanded with new nodes and edges during execution. Pretty scary. - We cannot know ahead of time how much the graph will expand, because iterate nodes' collections are dynamic. Terrifying.
- Multiple iterate nodes combine via Cartesian product, resulting in combinatorial explosion. Your graph could be running at the heat death of the universe. Existential dread.
Batch collections are defined up front and don't expand the graph. We know exactly the complexity we are getting into before the graph executes. Sanity restored!
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 bothint
andstr
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.
- Brought some of @dwringer's often-requested composition nodes into Invoke's core nodes. They have been renamed to not conflict with your existing install of the node pack. Thanks for your work on these very useful nodes @dwringer!
- Show tab-specific info in the Invoke button's tooltip.
- Update the
New from Image
context menu actions. The actions that resize the image after creating a new Canvas are clearly named. - Change the
Reset Canvas
button, which was too similar to theDelete Image
button, into a menu with more options:- New Canvas Session: Resets all generation settings, resets all layers, and enables Send to Canvas.
- New Gallery Session: Resets all generation settings, resets all layers, and enables Send to Gallery.
- Reset Generation Settings: Resets all generation settings, leaving layers alone.
- Reset Canvas Layers: Resets all layers, leaving generation settings alone.
- New Support Videos button in the bottom-left corner of the app, which lists and links to videos on our YouTube channel.
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 thestep_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.
Our Weblate also has an account issue and is currently locked. This is unrelated to the access restriction changes.
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
- feat: ingest composition node...
v5.4.2rc1
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.
Why `Iterate` Nodes are Scary
They result in unbounded graph complexity and size. If you don't know what these words mean, but they sound kinda scary, congrats! You are on the right track. They are indeed scary words.
- When using
Iterate
nodes, the graph is expanded with new nodes and edges during execution. Pretty scary. - We cannot know ahead of time how much the graph will expand, because iterate nodes' collections are dynamic. Terrifying.
- Multiple iterate nodes combine via Cartesian product, resulting in combinatorial explosion. Your graph could be running at the heat death of the universe. Existential dread.
Batch collections are defined up front and don't expand the graph. We know exactly the complexity we are getting into before the graph executes. Sanity restored!
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 bothint
andstr
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 thestep_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
v5.4.1
This release includes support for SD 3.5, plus a number of fixes and improvements.
We pulled v5.4.0 due to issues with model installation and loading. This release (v5.4.1) resolves those issues and includes all changes from v5.4.0.
Enhancements
- Support for SD 3.5 Medium and Large. You can download them in the starter models.
- Moved
Denoising Strength
slider to top of Layers panel with updated UI and info popover. - Update viewer styling to have a menubar-ish header. Also used for image comparison.
- Layer preview tooltip with larger sized preview.
- Empty state for Control Layers, guiding user to upload an image, drag an image from gallery or start drawing.
- "Simple" mode for control layers filtering, triggered when you select a control model. This automatically selects and processes the default filter for that model, if a default exists. If the user clicks
Advanced
, they get the full filter settings UI. Control Layers now start with no model selected, implicitly directing users into this flow. - Updated default control weight to 0.75 and end step % to 0.75. Updated label for the
Balanced
control mode, indicating it is the recommended setting. - The FLUX Denoise node now has a flag to skip adding noise to input latents. This is useful for switching models mid-generation and other fancy denoising techniques. Thanks @JPPhoto!
- Migrated the UI's drag-and-drop functionality to a new library, improving the overall performance of dnd. It also allows us to support external dnd. For example, dragging images from the OS directly into the canvas is now possible (not implemented in this release).
- Canvas layers may be sorted via drag-and-drop.
- When graph building fails, you will see an error toast. Previously, it only logged a message to the browser's JS console.
- Updated model warnings on Upscaling tab to not be misleading.
- More FLUX LoRA format support.
- Show alert over canvas/viewer with invocation progress event messages.
- Tweak gallery image selection styles to better differentiate between hovered and selected.
Output Only Masked Regions
renamed toOutput only Generated Regions
and now enabled by default.
Fixes
- Canvas progress images do not clear when canceling generation after at least one image has been staged.
- Tooltips on boards list stay open when scrolling, potentially causing the whole app to scroll.
- Saving canvas to gallery does not create a new image in gallery.
- Applying a filter could erase or otherwise change a layer's data unexpectedly, causing a range of user-facing generation issues.
- Unable to queue graphs with the Segment Anything node when its inputs were provided by connection.
- Unable to load a workflow from file when using the three-dots menu.
pip
downloadstorch
twice. This didn't cause any application issues - just a waste of time and bandwidth. We pinnedtorch
to<2.5.0
to preventpip
's dependency resolver from getting confused.mediapipe
install issue on Windows, related to its latest release. We pinnedmediapipe
to a known working version.- CLIP Vision error when using FLUX IP Adapter.
- Fit bbox to layers math could result in a slightly-too-large bbox.
- Outdated link to FLUX IP Adapter. Thanks @RadTechDad!
- Force a compatible precision for FLUX VAEs to prevent black outputs.
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 German. Thanks @rikublock!
- Updated Chinese (Simplified). Thanks @youo0o0!
- Updated Italian. Thanks @Harvester62 & @dakota2472!
- Updated Spanish. Thanks gallegonovato (weblate user)!
- Updated Vietnamese. Thanks Linos (weblate user)!
- Updated Japanese. Thanks @GGSSKK!
Internal
- Simplified parameter schema declarations. Thanks @rikublock!
- Simplified dnd image and gallery rendering, resulting in improved performance.
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
- Pin torch to <2.5.0 to prevent unnecessary downloads by @ebr in #7247
- fix(ui): misc fixes by @psychedelicious in #7252
- fix(nodes): relaxed validation for segment anything by @psychedelicious in #7253
- fix(ui): load workflow from file by @psychedelicious in #7254
- fix(deps): pin mediapipe strictly to a known working version by @ebr in #7258
- Ryan/sd3 diffusers by @maryhipp in #7222
- chore: bump version to v5.4.0 by @psychedelicious in #7259
- fix: Never throw an exception when finding the clip variant type by @brandonrising in #7263
- fix(ui): add some feedback while layers are merging by @maryhipp in #7265
- feat(api,ui): allow Whats New module to get content from back-end by @maryhipp in #7268
- fix(ui): fix link for infill method popover by @maryhipp in #7269
- update Whats New for 5.3.1 by @maryhipp in #7272
- fix(ui): bad merge conflict by @maryhipp in #7273
- fix: get_clip_variant_type should never return None by @brandonrising in #7275
- feat(ui): denoising strength UI by @maryhipp in #7262
- chore(gh): update pr template w/ reminder for what's new copy by @psychedelicious in #7274
- feat(ui): simplify parameter schema declaration by @rikublock in #7281
- feat(ui): new user ux improvements by @psychedelicious in #7279
- fix: Avoid downloading unsafe .bin files if a safetensors file is ava… by @brandonrising in #7282
- fix: Look in known subfolders for configs for clip variants by @brandonrising in #7283
- chore: release v5.4.1rc1 by @psychedelicious in #7285
- Update flux_denoise.py by @JPPhoto in #7270
- fix(app): silence pydantic protected namespace warning by @psychedelicious in #7291
- chore(ui): migrate dnd library by @psychedelicious in #7288
- chore: bump version to v5.4.1rc2 by @psychedelicious in #7293
- fix(ui): FLUX IP adapter clip vision model error by @psychedelicious in #7292
- fix(ui): excessive toasts when generating on canvas by @psychedelicious in #7294
- fix(ui): fit bbox to layers math by @psychedelicious in #7297
- fix(ui): restore missing image paste handler by @psychedelicious in #7298
- feat(ui): update warnings on upscaling tab based on model arch by @psychedelicious in #7299
- feat(ui): clarify denoising strength badge text by @psychedelicious in #7304
- Updated link to flux ip adapter model by @RadTechDad in #7309
- Flux Vae broke for float16, force bfloat16 or float32 were compatible by @Vargol in #7213
- Fix FLUX diffusers LoRA models with no
.proj_mlp
layers by @RyanJDick in #7313 - SD3 Image-to-Image and Inpainting by @RyanJDick in #7295
- (ui): update en string for full IP adapter by @maryhipp in #7312
- feat(ui, worker): add invocation progress events to model loading by @maryhipp in #7286
- feat(ui): tweak image selection/hover styling by @psychedelicious in #7302
- feat(ui): update output only masked regions by @psychedelicious in #7303
- fix(ui): image uploading handling by @psychedelicious in #7315
- fix(ui): unable to use text inputs within draggable by @psychedelicious in #7316
- fix(ui): multiple selection dnd sometimes doesn't get full selection by @psychedelicious in #7317
- fix(ui): remove progress message condition for canvas destinations by @psychedelicious in #7319
- ui: translations update from weblate by @weblate in #7242
New Contributors
- @RadTechDad made their fi...
v5.4.1rc2
This release brings support for SD 3.5 to Workflows, plus a number of fixes and improvements.
We pulled v5.4.0 due to issues with model installation and loading. This release (v5.4.1) resolves those issues and includes all changes from v5.4.0.
SD 3.5
We've added initial support for SD 3.5 in workflows. Currently, only Text-to-Image is supported. We'll add Image-to-Image support along Canvas support in the next few days.
Both SD 3.5 Large and Medium are supported and available via starter models. A sample workflow to get you started is in the Workflow Library. The node is marked as prototype; it's possible we will make some changes to it before marking it stable.
Other Changes
Enhancements
- Moved
Denoising Strength
slider to top of Layers panel with updated UI and info popover. - Update viewer styling to have a menubar-ish header. Also used for image comparison.
- Layer preview tooltip with larger sized preview.
- Empty state for Control Layers, guiding user to upload an image, drag an image from gallery or start drawing.
- "Simple" mode for control layers filtering, triggered when you select a control model. This automatically selects and processes the default filter for that model, if a default exists. If the user clicks
Advanced
, they get the full filter settings UI. Control Layers now start with no model selected, implicitly directing users into this flow. - Updated default control weight to 0.75 and end step % to 0.75. Updated label for the
Balanced
control mode, indicating it is the recommended setting. - The FLUX Denoise node now has a flag to skip adding noise to input latents. This is useful for switching models mid-generation and other fancy denoising techniques. Thanks @JPPhoto!
- Migrated the UI's drag-and-drop functionality to a new library, improving the overall performance of dnd. It also allows us to support external dnd. For example, dragging images from the OS directly into the canvas is now possible (not implemented in this release).
- Canvas layers may be sorted via drag-and-drop.
- When graph building fails, you will see an error toast. Previously, it only logged a message to the browser's JS console.
Fixes
- Canvas progress images do not clear when canceling generation after at least one image has been staged.
- Tooltips on boards list stay open when scrolling, potentially causing the whole app to scroll.
- Saving canvas to gallery does not create a new image in gallery.
- Applying a filter could erase or otherwise change a layer's data unexpectedly, causing a range of user-facing generation issues.
- Unable to queue graphs with the Segment Anything node when its inputs were provided by connection.
- Unable to load a workflow from file when using the three-dots menu.
pip
downloadstorch
twice. This didn't cause any application issues - just a waste of time and bandwidth. We pinnedtorch
to<2.5.0
to preventpip
's dependency resolver from getting confused.mediapipe
install issue on Windows, related to its latest release. We pinnedmediapipe
to a known working version.- CLIP Vision error when using FLUX IP Adapter.
Internal
- Simplified parameter schema declarations. Thanks @rikublock!
- Simplified dnd image and gallery rendering, resulting in improved performance.
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
- Pin torch to <2.5.0 to prevent unnecessary downloads by @ebr in #7247
- fix(ui): misc fixes by @psychedelicious in #7252
- fix(nodes): relaxed validation for segment anything by @psychedelicious in #7253
- fix(ui): load workflow from file by @psychedelicious in #7254
- fix(deps): pin mediapipe strictly to a known working version by @ebr in #7258
- Ryan/sd3 diffusers by @maryhipp in #7222
- chore: bump version to v5.4.0 by @psychedelicious in #7259
- fix: Never throw an exception when finding the clip variant type by @brandonrising in #7263
- fix(ui): add some feedback while layers are merging by @maryhipp in #7265
- feat(api,ui): allow Whats New module to get content from back-end by @maryhipp in #7268
- fix(ui): fix link for infill method popover by @maryhipp in #7269
- update Whats New for 5.3.1 by @maryhipp in #7272
- fix(ui): bad merge conflict by @maryhipp in #7273
- fix: get_clip_variant_type should never return None by @brandonrising in #7275
- feat(ui): denoising strength UI by @maryhipp in #7262
- chore(gh): update pr template w/ reminder for what's new copy by @psychedelicious in #7274
- feat(ui): simplify parameter schema declaration by @rikublock in #7281
- feat(ui): new user ux improvements by @psychedelicious in #7279
- fix: Avoid downloading unsafe .bin files if a safetensors file is ava… by @brandonrising in #7282
- fix: Look in known subfolders for configs for clip variants by @brandonrising in #7283
- chore: release v5.4.1rc1 by @psychedelicious in #7285
- Update flux_denoise.py by @JPPhoto in #7270
- fix(app): silence pydantic protected namespace warning by @psychedelicious in #7291
- chore(ui): migrate dnd library by @psychedelicious in #7288
- chore: bump version to v5.4.1rc2 by @psychedelicious in #7293
- fix(ui): FLUX IP adapter clip vision model error by @psychedelicious in #7292
- fix(ui): excessive toasts when generating on canvas by @psychedelicious in #7294
Full Changelog: v5.3.1...v5.4.1rc2
v5.4.1rc1
This release brings support for SD 3.5 to Workflows, plus a number of fixes and improvements.
We pulled v5.4.0 due to issues with model installation and loading. This release (v5.4.1) resolves those issues and includes all changes from v5.4.0.
SD 3.5
We've added initial support for SD 3.5 in workflows. Currently, only Text-to-Image is supported. We'll add Image-to-Image support along Canvas support in the next few days.
Both SD 3.5 Large and Medium are supported and available via starter models. A sample workflow to get you started is in the Workflow Library. The node is marked as prototype; it's possible we will make some changes to it before marking it stable.
Other Changes
Enhancements
- Moved
Denoising Strength
slider to top of Layers panel with updated UI and info popover. - Update viewer styling to have a menubar-ish header. Also used for image comparison.
- Layer preview tooltip with larger sized preview.
- Empty state for Control Layers, guiding user to upload an image, drag an image from gallery or start drawing.
- "Simple" mode for control layers filtering, triggered when you select a control model. This automatically selects and processes the default filter for that model, if a default exists. If the user clicks
Advanced
, they get the full filter settings UI. Control Layers now start with no model selected, implicitly directing users into this flow. - Update default control weight to 0.75, end step % to 0.75. Update label for the
Balanced
control mode, indicating it is the recommended setting.
Fixes
- Canvas progress images do not clear when canceling generation after at least one image has been staged.
- Tooltips on boards list stay open when scrolling, potentially causing the whole app to scroll.
- Saving canvas to gallery does not create a new image in gallery.
- Applying a filter could erase or otherwise change a layer's data unexpectedly, causing a range of user-facing generation issues.
- Unable to queue graphs with the Segment Anything node when its inputs were provided by connection.
- Unable to load a workflow from file when using the three-dots menu.
pip
downloadstorch
twice. This didn't cause any application issues - just a waste of time and bandwidth. We pinnedtorch
to<2.5.0
to preventpip
's dependency resolver from getting confused.mediapipe
install issue on Windows, related to its latest release. We pinnedmediapipe
to a known working version.
Internal
- Simplified parameter schema declarations. Thanks @rikublock!
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
- Pin torch to <2.5.0 to prevent unnecessary downloads by @ebr in #7247
- fix(ui): misc fixes by @psychedelicious in #7252
- fix(nodes): relaxed validation for segment anything by @psychedelicious in #7253
- fix(ui): load workflow from file by @psychedelicious in #7254
- fix(deps): pin mediapipe strictly to a known working version by @ebr in #7258
- Ryan/sd3 diffusers by @maryhipp in #7222
- chore: bump version to v5.4.0 by @psychedelicious in #7259
- fix: Never throw an exception when finding the clip variant type by @brandonrising in #7263
- fix(ui): add some feedback while layers are merging by @maryhipp in #7265
- feat(api,ui): allow Whats New module to get content from back-end by @maryhipp in #7268
- fix(ui): fix link for infill method popover by @maryhipp in #7269
- update Whats New for 5.3.1 by @maryhipp in #7272
- fix(ui): bad merge conflict by @maryhipp in #7273
- fix: get_clip_variant_type should never return None by @brandonrising in #7275
- feat(ui): denoising strength UI by @maryhipp in #7262
- chore(gh): update pr template w/ reminder for what's new copy by @psychedelicious in #7274
- feat(ui): simplify parameter schema declaration by @rikublock in #7281
- feat(ui): new user ux improvements by @psychedelicious in #7279
- fix: Avoid downloading unsafe .bin files if a safetensors file is ava… by @brandonrising in #7282
- fix: Look in known subfolders for configs for clip variants by @brandonrising in #7283
- chore: release v5.4.1rc1 by @psychedelicious in #7285
Full Changelog: v5.3.1...v5.4.1rc1
v5.4.0
This release brings support for SD 3.5 to Workflows, plus a number of fixes.
❗ We've discovered an issue with model installation and loading on this release. If you installed v5.4.0 and experience problems with model installation and loading, you can roll back to v5.3.1 by running the installer and choosing v5.3.1.
SD 3.5
We've added initial support for SD 3.5 in workflows. Currently, only Text-to-Image is supported. We'll add Image-to-Image support along Canvas support in the next few days.
Both SD 3.5 Large and Medium are supported and available via starter models. A sample workflow to get you started is in the Workflow Library. The node is marked as prototype; it's possible we will make some changes to it before marking it stable.
Fixes
- Canvas progress images do not clear when canceling generation after at least one image has been staged.
- Tooltips on boards list stay open when scrolling, potentially causing the whole app to scroll.
- Saving canvas to gallery does not create a new image in gallery.
- Applying a filter could erase or otherwise change a layer's data unexpectedly, causing a range of user-facing generation issues.
- Unable to queue graphs with the Segment Anything node when its inputs were provided by connection.
- Unable to load a workflow from file when using the three-dots menu.
pip
downloadstorch
twice. This didn't cause any application issues - just a waste of time and bandwidth. We pinnedtorch
to<2.5.0
to preventpip
's dependency resolver from getting confused.mediapipe
install issue on Windows, related to its latest release. We pinnedmediapipe
to a known working version.
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
- Pin torch to <2.5.0 to prevent unnecessary downloads by @ebr in #7247
- fix(ui): misc fixes by @psychedelicious in #7252
- fix(nodes): relaxed validation for segment anything by @psychedelicious in #7253
- fix(ui): load workflow from file by @psychedelicious in #7254
- fix(deps): pin mediapipe strictly to a known working version by @ebr in #7258
- Ryan/sd3 diffusers by @maryhipp in #7222
- chore: bump version to v5.4.0 by @psychedelicious in #7259
Full Changelog: v5.3.1...v5.4.0
v5.3.1
This release expands layer merging capabilities in the Canvas and makes a number of other fixes and enhancements.
Layer Merging
We've expanded layer merging capabilities to all layer types and made one change to the existing Merge Visible
operation.
Merge Down (new)
The selected layer and the one immediately below it are merged into a single layer. The two input layers are deleted as part of this process.
Merge Visible (changed)
Previously, in Invoke, Merge Visible
deleted all the layers that were merged together.
This has been changed to match image editors like Affinity Photo and PS, where the merged layer is added as a new layer, leaving all other layers untouched.
Merging Regional Guidance
When merging Regional Guidance
, the resultant merged Regional Guidance
has no prompt or reference image. It's not possible to merge those settings. Keep this in mind when doing a Merge Down
, which will delete the two input Regional Guidance
layers.
Merging Control Layers
When merging Control Layers
, the resultant merged Control Layer
has no model or control settings. Like Regional Guidance
, it's not possible to merge the settings, and Merge Down
will delete the two input layers.
Control Layers
require some special handling. For example, we display them with a "transparency effect" to help you visualize how they stack up. When merging them, we first apply a similar effect to the layer. Specifically, we use the "lighter" blend mode, optimizing for control images with black backgrounds.
All Changes
Enhancements
- Layer merging improvements.
- Updated "What's New" popover.
Inpaint Mask
andRegional Guidance
may be saved to assets.- Support for HF tokens in the model manager UI. This prepares Invoke's MM for SD3.5, which requires you to authenticate with HF to download the model. You can paste your token into the MM to allow the the model to download, instead of needing to configure it with the HF CLI.
- Add a safeguard for invocation classes, requiring they implement the
invoke
method and have a correct output annotation.
Fixes
- Canvas alerts prevent clicks on the metadata viewer tabs.
Save as
-ing a Filtered layer may result in the wrong image data being used during generation.- More resilient Filter handling.
- SDXL T2I OpenPose model gets input images with the correct channel order, which makes this model work correctly. Thanks @dunkeroni!
- T2I Adapters now work with any output size supported by the main model. Previously, they required output sizes to be in multiples of 32 or 64. Thanks @dunkeroni!
- Recall of seamless metadata settings. Thanks @rikublock!
- Fixed broken link in installer. Thanks @hippalectryon-0!
- Fixed (another) broken link in installer. Thanks @ventureOptimism!
Internal
- Bump
diffusers
,accelerate
andhuggingface-hub
dependencies to latest versions. - Refactored
CanvasCompositorModule
to support new merge capabilities. - Remove version pins for several packages including torch and numpy. This is in preparation for an updated installer and also makes it easier for advanced users to customize the versions of various packages.
- Canvas inpaint and outpaint graphs output one less intermediate image, saving one expensive PNG encode (and your disk space).
- Added caches for generation mode calculations in Canvas, providing a substantial reduction in intermediate images created and faster Invoke-to-Queue times.
Docs
- Updated
patchmatch
docs. Thanks @nirmal0001! - Updated FAQ. Thanks @JPPhoto!
- Updated dev docs. Thanks @hippalectryon-0!
Translations
- Updated German. Thanks @rikublock & @Atalanttore!
- Updated Chinese (Simplified). Thanks @qyouqme & @youo0o0!
- Updated Italian. Thanks @Harvester62 & @dakota2472!
- Updated French. Thanks @Ery4z!
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
- fix(ui): canvas alerts blocking metadata panel by @psychedelicious in #7210
- Bump
diffusers
version (andaccelerate
,hugginface-hub
) by @RyanJDick in #7174 - feat(ui): canvas graph improvements by @psychedelicious in #7218
- Fix SDXL t2i adapters expect BGR instead of RGB by @dunkeroni in #7205
- fix(ui): recall seamless settings by @rikublock in #7217
- feat(ui): update announcements for v5.3.0 by @maryhipp in #7221
- fix(ui): canvas filter and SAM module fixes by @psychedelicious in #7224
- feat(ui): canvas entity merging by @psychedelicious in #7219
- chore: bump version to v5.3.1rc1 by @psychedelicious in #7225
- fix(ui): compositor not setting processing flag when cleaning up by @psychedelicious in #7227
- fix(nodes): nodes denylist handling by @psychedelicious in #7235
- feat(ui,api): support for HF tokens in UI, handle Unauthorized and Forbidden responses from HF by @maryhipp in #7201
- Update patchmatch.md by @nirmal0001 in #7165
- Update FAQ.md by @JPPhoto in #6801
- Fix link in dev docs by @hippalectryon-0 in #7200
- feat(nodes): add validation for invoke method return types by @psychedelicious in #6279
- refactor(ui): layer interaction locking by @psychedelicious in #7234
- ui: translations update from weblate by @weblate in #7166
- feat(ui): filter/select-object do not exit on save-as by @psychedelicious in #7238
- fix broken link in installer by @hippalectryon-0 in #7211
- Adjust pins for torch, numpy, other dependencies by @ebr in #7232
- fix(ui): add missing translations by @psychedelicious in #7237
- removing periods from update link to prevent page not found error by @ventureOptimism in #6526
- fix(ui): canvas misc bugs by @psychedelicious in #7244
- Make T2I Adapters work with any resolution supported by the models by @dunkeroni in #7215
- chore: bump version to v5.3.1 by @psychedelicious in #7245
New Contributors
- @nirmal0001 made their first contribution in #7165
- @ventureOptimism made their first contribution in #6526
Full Changelog: v5.3.0...v5.3.1
v5.3.1rc1
This release candidate expands layer merging capabilities in Canvas, plus a number of other fixes and enhancements.
Layer Merging
We've expanded layer merging capabilities to all layer types and made one change to the existing Merge Visible
operation.
Merge Down (new)
The selected layer and the one immediately below it are merged into a single layer. The two input layers are deleted as part of this process.
Merge Visible (changed)
Previously, in Invoke, Merge Visible
deleted all the layers that were merged together.
This has been changed to match image editors like Affinity Photo and PS, where the merged is added as a new layer, leaving all other layers untouched.
Merging Regional Guidance
When merging Regional Guidance
, the resultant merged Regional Guidance
has no prompt or reference image. It's not possible to merge those settings. Keep this in mind when doing a Merge Down
, which will delete the two input Regional Guidance
layers.
Merging Control Layers
When merging Control Layers
, the resultant merged Control Layer
has no model or control settings. Like Regional Guidance
, it's not possible to merge the settings, and Merge Down
will delete the two input layers.
Control Layers
require some special handling. For example, we display them with a "transparency effect" to help you visualize how they stack up. When merging them, we first apply a similar effect to the layer. Specifically, we use the "lighter" blend mode, optimizing for control images with black backgrounds.
All Changes
Enhancements
- Layer merging improvements.
- Updated "What's New" popover.
Inpaint Mask
andRegional Guidance
may be saved to assets.
Performance
- Canvas inpaint and outpaint graphs output one less intermediate image, saving one expensive PNG encode (and your disk space).
- Added caches for generation mode calculations in Canvas, providing a substantial reduction in intermediate images created and faster Invoke-to-Queue times.
Fixes
- Canvas alerts prevent clicks on the metadata viewer tabs.
Save as
-ing a Filtered layer may result in the wrong image data being used during generation.- More resilient Filter handling.
- SDXL T2I OpenPose get get input images in the expected channel order. Thanks @dunkeroni!
- Recall of seamless metadata settings. Thanks @rikublock!
Internal
- Bump
diffusers
,accelerate
andhuggingface-hub
dependencies to latest versions. - Refactored
CanvasCompositorModule
to support new merge capabilities.
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
- fix(ui): canvas alerts blocking metadata panel by @psychedelicious in #7210
- Bump
diffusers
version (andaccelerate
,hugginface-hub
) by @RyanJDick in #7174 - feat(ui): canvas graph improvements by @psychedelicious in #7218
- Fix SDXL t2i adapters expect BGR instead of RGB by @dunkeroni in #7205
- fix(ui): recall seamless settings by @rikublock in #7217
- feat(ui): update announcements for v5.3.0 by @maryhipp in #7221
- fix(ui): canvas filter and SAM module fixes by @psychedelicious in #7224
- feat(ui): canvas entity merging by @psychedelicious in #7219
- chore: bump version to v5.3.1rc1 by @psychedelicious in #7225
- fix(ui): compositor not setting processing flag when cleaning up by @psychedelicious in #7227
Full Changelog: v5.3.0...v5.3.1rc1
v5.3.0
This release includes a number of enhancements and fixes. Standouts include:
- Object selection in Canvas (via Segment Anything).
- Support for XLabs FLUX IP Adapters.
- Installer improvements, which should resolve all
xformers
-related issues. - Improved FLUX support for MPS (Apple Silicon) devices.
- Reworked context menus, now with sub-menus.
Be sure to review the v5 release notes if you haven't already upgraded to v5.
Canvas Select Object
Click the Canvas to add Include
and Exclude
points to select an object in a layer, then use the selection as an Inpaint Mask.
select-object-save-as-inpaint-mask.mov
In the next example, we want to select the fox and the ground, but the model has a hard time with this, as it is trained to select single objects. We are able to work around this by selecting the background and inverting the selection.
select-object-invert-apply.mov
As demonstrated, applying the selection masks the layer with the selection. You can also save the selection as a Raster Layer, Control Layer or Regional Guidance. This enables some useful workflows.
select-object-apply-convert-control.mov
Internally, this uses Segment Anything v1. We'll upgrade to SAM v2, which substantially improves object selection, once support for it lands in transformers
.
FLUX IP Adapters
We now support XLabs FLUX IP Adapters. There's only the one model right now, which we've added to the starter models.
Workflow & Input Image | Output |
---|---|
Internally, IP Adapter requires CFG to work. For now, this is only exposed via workflows. Negative conditioning is also now available in workflows. We're exploring a sane way to expose this in the linear UI.
Negative conditioning requires a CFG value >1
. Leave CFG at 1
to disable it and ignore negative conditioning.
Note: CFG doubles denoising time, and negative conditioning requires a good additional chunk of VRAM.
All Changes
Enhancements
- Object selection in Canvas (via Segment Anything).
- Support for XLabs FLUX IP Adapters.
- Support for CFG and Negative Conditioning for FLUX in workflows only.
- Added
RealVisXL5
to SDXL Starter Model Bundle. - Model manager
in-place
checkbox remembers your choice. Thanks @rikublock! - Better tooltips in the model manager, including a starter bundle contents.
- Support for sub-menus, which are now used in the Image context menu and various Canvas context menus.
- Support more conversions between Canvas layers. Both in-place and copy conversions are supported. For example, convert between Inpaint Masks and Regional Guidance, or copy a Raster Layer into a new Inpaint Mask.
- Model descriptions are now displayed in model selection drop-downs. You can disable this in settings.
- We now track whether or not enabled model default settings are currently set. When they are not, we list the defaults that differ in a tooltip on the little button next to the main model drop-down.
- Always show staging images when staging starts, even if user hid them last staging session.
- Canvas alerts (e.g. the
Sending to Gallery
alert overlaid on the canvas) are moved to the top-left corner of the center panel. - Updated translations. Thanks @rikublock, @Vasyanator, @Harvester62, @Ery4z!
Fixes
- Improved FLUX support for MPS devices. Thanks @Vargol!
- FLUX denoise node erroneously required
controlnet_vae
field. - Uninstall
xformers
before installation, fixing issues w/xformers
version mismatch. - Fixed installer text output. Thanks @max-maag!
- Fixed ROCm PyPI indices. Thanks @max-maag!
- Normalize solid infill alpha values from 0-1 to 0-255 when building canvas graphs. This issue didn't cause any problems, because VAE ignores the alpha channel, but it should be fixed regardless.
- View/Hide Boards button cut off with certain translations.
- Fix a longstanding issue where nodes could mutate the objects (images, tensors, conditioning data) in disk-backed in-memory caches. For example, node 1 might retrieve image X and do some in-place operation on it to create image Y. Node 2 retrieves image X but gets image Y instead. This issue only affected the in-memory caches; mutations were not pushed to disk. The invocation API now returns clones of all objects, so nodes can safely mutate their inputs in-place.
Internal
- Reworked logging implementation.
- Directory traversal issue when deleting images.
Documentation
- Updated dev install docs. Thanks @hippalectryon-0!
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
- fix(app): directory traversal when deleting images by @psychedelicious in #7145
- Small improvements for the installer text output by @max-maag in #7150
- refactor(ui): logging config handling by @psychedelicious in #7143
- add starter model Architecture (RealVisXL5) by @maryhipp in #7151
- fix(nodes):
FluxDenoiseInvocation.controlnet_vae
missingdefault=None
by @psychedelicious in #7156 - Remove xformers before installation by @ebr in #7161
- FLUX CFG support by @RyanJDick in #7152
- FLUX XLabs IP-Adapter Support by @RyanJDick in #7157
- Fix AMD GPUs not being detected by @max-maag in #7147
- Load non quantized t5encoder using same dtype the model is saved in/ by @Vargol in #7140
- Get flux working with MPS on torch 2.4.1, with GGUF support by @Vargol in #7113
- ui: translations update from weblate by @weblate in #7135
- feat(ui): canvas auto-mask by @psychedelicious in #7163
- chore: bump version to v5.3.0rc1 by @psychedelicious in #7164
- feat(ui): move model manager in-place install state to redux by @rikublock in #7167
- feat(ui): canvas auto mask followups 1 by @psychedelicious in #7168
- fix(ui): normalize infill alpha to 0-255 when building infill nodes by @psychedelicious in #7172
- tweak(ui): prevent show/hide boards button cutoff by @psychedelicious in #7184
- feat(ui,api): misc model QoL by @maryhipp in #7173
- feat(ui): canvas auto mask followups 2 by @psychedelicious in #7180
- feat(ui): canvas auto mask followups 3 by @psychedelicious in #7189
- chore: bump version to v5.3.0rc2 by @psychedelicious in #7190
- feat(ui): canvas auto-mask followups 4 by @psychedelicious in #7193
- feat(ui): add setting for showing model descriptions in dropdown by @maryhipp in #7187
- feat(ui): add out of sync details to default settings button by @maryhipp in #7188
- feat: canvas auto mask followups 5 by @psychedelicious in #7196
- fix(nodes): return copies of objects in invocation ctx by @psychedelicious in #7195
- Improve dev install docs by @hippalectryon-0 in #7199
- feat(ui): canvas auto mask followups 6 by @psychedelicious in #7203
- chore: bump version to v5.3.0 by @psychedelicious in #7204
New Contributors
- @hippalectryon-0 made their first contribution in #7199
Full Changelog: v5.2.0...v5.3.0