Restore instantx_control_mode field on FLUX ControlNet invocation.

Author: RyanJDick

invokeai/app/invocations/fields.py

@@ -192,6 +192,7 @@ class FieldDescriptions:
     freeu_s2 = 'Scaling factor for stage 2 to attenuate the contributions of the skip features. This is done to mitigate the "oversmoothing effect" in the enhanced denoising process.'
     freeu_b1 = "Scaling factor for stage 1 to amplify the contributions of backbone features."
     freeu_b2 = "Scaling factor for stage 2 to amplify the contributions of backbone features."
+    instantx_control_mode = "The control mode for InstantX ControlNet union models. Ignored for other ControlNet models. The standard mapping is: canny (0), tile (1), depth (2), blur (3), pose (4), gray (5), low quality (6). Negative values will be treated as 'None'."
 
 
 class ImageField(BaseModel):

invokeai/app/invocations/flux_controlnet.py

@@ -25,6 +25,7 @@ class FluxControlNetField(BaseModel):
         default=1, ge=0, le=1, description="When the ControlNet is last applied (% of total steps)"
     )
     resize_mode: CONTROLNET_RESIZE_VALUES = Field(default="just_resize", description="The resize mode to use")
+    instantx_control_mode: int | None = Field(default=-1, description=FieldDescriptions.instantx_control_mode)
 
     @field_validator("control_weight")
     @classmethod
@@ -70,6 +71,8 @@ class FluxControlNetInvocation(BaseInvocation):
         default=1, ge=0, le=1, description="When the ControlNet is last applied (% of total steps)"
     )
     resize_mode: CONTROLNET_RESIZE_VALUES = InputField(default="just_resize", description="The resize mode used")
+    # Note: We default to -1 instead of None, because in the workflow editor UI None is not currently supported.
+    instantx_control_mode: int | None = InputField(default=-1, description=FieldDescriptions.instantx_control_mode)
 
     @field_validator("control_weight")
     @classmethod
@@ -91,5 +94,6 @@ def invoke(self, context: InvocationContext) -> FluxControlNetOutput:
                 begin_step_percent=self.begin_step_percent,
                 end_step_percent=self.end_step_percent,
                 resize_mode=self.resize_mode,
+                instantx_control_mode=self.instantx_control_mode,
             ),
         )

invokeai/app/invocations/flux_denoise.py

@@ -389,9 +389,9 @@ def _prep_controlnet_extensions(
                 )
             elif isinstance(model, InstantXControlNetFlux):
                 instantx_control_mode: torch.Tensor | None = None
-                # if controlnet.instantx_control_mode is not None:
-                #     instantx_control_mode = torch.tensor(controlnet.instantx_control_mode, dtype=torch.long)
-                #     instantx_control_mode = instantx_control_mode.reshape([-1, 1])
+                if controlnet.instantx_control_mode is not None and controlnet.instantx_control_mode >= 0:
+                    instantx_control_mode = torch.tensor(controlnet.instantx_control_mode, dtype=torch.long)
+                    instantx_control_mode = instantx_control_mode.reshape([-1, 1])
 
                 controlnet_extensions.append(
                     InstantXControlNetExtension(

invokeai/frontend/web/src/services/api/schema.ts

@@ -6323,6 +6323,12 @@ export type components = {
              * @enum {string}
              */
             resize_mode?: "just_resize" | "crop_resize" | "fill_resize" | "just_resize_simple";
+            /**
+             * Instantx Control Mode
+             * @description The control mode for InstantX ControlNet union models. Ignored for other ControlNet models. The standard mapping is: canny (0), tile (1), depth (2), blur (3), pose (4), gray (5), low quality (6). Negative values will be treated as 'None'.
+             * @default -1
+             */
+            instantx_control_mode?: number | null;
         };
         /**
          * FLUX ControlNet
@@ -6381,6 +6387,12 @@ export type components = {
              * @enum {string}
              */
             resize_mode?: "just_resize" | "crop_resize" | "fill_resize" | "just_resize_simple";
+            /**
+             * Instantx Control Mode
+             * @description The control mode for InstantX ControlNet union models. Ignored for other ControlNet models. The standard mapping is: canny (0), tile (1), depth (2), blur (3), pose (4), gray (5), low quality (6). Negative values will be treated as 'None'.
+             * @default -1
+             */
+            instantx_control_mode?: number | null;
             /**
              * type
              * @default flux_controlnet