feat(nodes): add version to node schemas

The `@invocation` decorator is extended with an optional `version` arg. On execution of the decorator, the version string is parsed using the `semver` package (this was an indirect dependency and has been added to `pyproject.toml`).

All built-in nodes are set with `version="1.0.0"`.

The version is added to the OpenAPI Schema for consumption by the client.

Author: psychedelicious

invokeai/app/invocations/baseinvocation.py

@@ -26,6 +26,7 @@
 from pydantic import BaseModel, Field, validator
 from pydantic.fields import Undefined, ModelField
 from pydantic.typing import NoArgAnyCallable
+import semver
 
 if TYPE_CHECKING:
     from ..services.invocation_services import InvocationServices
@@ -401,6 +402,9 @@ class UIConfigBase(BaseModel):
     tags: Optional[list[str]] = Field(default_factory=None, description="The node's tags")
     title: Optional[str] = Field(default=None, description="The node's display name")
     category: Optional[str] = Field(default=None, description="The node's category")
+    version: Optional[str] = Field(
+        default=None, description='The node\'s version. Should be a valid semver string e.g. "1.0.0" or "3.8.13".'
+    )
 
 
 class InvocationContext:
@@ -499,6 +503,8 @@ def schema_extra(schema: dict[str, Any], model_class: Type[BaseModel]) -> None:
                 schema["tags"] = uiconfig.tags
             if uiconfig and hasattr(uiconfig, "category"):
                 schema["category"] = uiconfig.category
+            if uiconfig and hasattr(uiconfig, "version"):
+                schema["version"] = uiconfig.version
             if "required" not in schema or not isinstance(schema["required"], list):
                 schema["required"] = list()
             schema["required"].extend(["type", "id"])
@@ -567,7 +573,11 @@ def validate_workflow_is_json(cls, v):
 
 
 def invocation(
-    invocation_type: str, title: Optional[str] = None, tags: Optional[list[str]] = None, category: Optional[str] = None
+    invocation_type: str,
+    title: Optional[str] = None,
+    tags: Optional[list[str]] = None,
+    category: Optional[str] = None,
+    version: Optional[str] = None,
 ) -> Callable[[Type[GenericBaseInvocation]], Type[GenericBaseInvocation]]:
     """
     Adds metadata to an invocation.
@@ -594,6 +604,9 @@ def wrapper(cls: Type[GenericBaseInvocation]) -> Type[GenericBaseInvocation]:
             cls.UIConfig.tags = tags
         if category is not None:
             cls.UIConfig.category = category
+        if version is not None:
+            semver.Version.parse(version)  # raises ValueError if invalid semver
+            cls.UIConfig.version = version
 
         # Add the invocation type to the pydantic model of the invocation
         invocation_type_annotation = Literal[invocation_type]  # type: ignore

invokeai/app/invocations/collections.py

@@ -10,7 +10,9 @@
 from .baseinvocation import BaseInvocation, InputField, InvocationContext, invocation
 
 
-@invocation("range", title="Integer Range", tags=["collection", "integer", "range"], category="collections")
+@invocation(
+    "range", title="Integer Range", tags=["collection", "integer", "range"], category="collections", version="1.0.0"
+)
 class RangeInvocation(BaseInvocation):
     """Creates a range of numbers from start to stop with step"""
 
@@ -33,6 +35,7 @@ def invoke(self, context: InvocationContext) -> IntegerCollectionOutput:
     title="Integer Range of Size",
     tags=["collection", "integer", "size", "range"],
     category="collections",
+    version="1.0.0",
 )
 class RangeOfSizeInvocation(BaseInvocation):
     """Creates a range from start to start + size with step"""
@@ -50,6 +53,7 @@ def invoke(self, context: InvocationContext) -> IntegerCollectionOutput:
     title="Random Range",
     tags=["range", "integer", "random", "collection"],
     category="collections",
+    version="1.0.0",
 )
 class RandomRangeInvocation(BaseInvocation):
     """Creates a collection of random numbers"""

invokeai/app/invocations/compel.py

@@ -44,7 +44,7 @@ class ConditioningFieldData:
 #    PerpNeg = "perp_neg"
 
 
-@invocation("compel", title="Prompt", tags=["prompt", "compel"], category="conditioning")
+@invocation("compel", title="Prompt", tags=["prompt", "compel"], category="conditioning", version="1.0.0")
 class CompelInvocation(BaseInvocation):
     """Parse prompt using compel package to conditioning."""
 
@@ -267,6 +267,7 @@ def _lora_loader():
     title="SDXL Prompt",
     tags=["sdxl", "compel", "prompt"],
     category="conditioning",
+    version="1.0.0",
 )
 class SDXLCompelPromptInvocation(BaseInvocation, SDXLPromptInvocationBase):
     """Parse prompt using compel package to conditioning."""
@@ -351,6 +352,7 @@ def invoke(self, context: InvocationContext) -> ConditioningOutput:
     title="SDXL Refiner Prompt",
     tags=["sdxl", "compel", "prompt"],
     category="conditioning",
+    version="1.0.0",
 )
 class SDXLRefinerCompelPromptInvocation(BaseInvocation, SDXLPromptInvocationBase):
     """Parse prompt using compel package to conditioning."""
@@ -403,7 +405,7 @@ class ClipSkipInvocationOutput(BaseInvocationOutput):
     clip: ClipField = OutputField(default=None, description=FieldDescriptions.clip, title="CLIP")
 
 
-@invocation("clip_skip", title="CLIP Skip", tags=["clipskip", "clip", "skip"], category="conditioning")
+@invocation("clip_skip", title="CLIP Skip", tags=["clipskip", "clip", "skip"], category="conditioning", version="1.0.0")
 class ClipSkipInvocation(BaseInvocation):
     """Skip layers in clip text_encoder model."""
 

invokeai/app/invocations/controlnet_image_processors.py

@@ -95,7 +95,7 @@ class ControlOutput(BaseInvocationOutput):
     control: ControlField = OutputField(description=FieldDescriptions.control)
 
 
-@invocation("controlnet", title="ControlNet", tags=["controlnet"], category="controlnet")
+@invocation("controlnet", title="ControlNet", tags=["controlnet"], category="controlnet", version="1.0.0")
 class ControlNetInvocation(BaseInvocation):
     """Collects ControlNet info to pass to other nodes"""
 
@@ -127,7 +127,9 @@ def invoke(self, context: InvocationContext) -> ControlOutput:
         )
 
 
-@invocation("image_processor", title="Base Image Processor", tags=["controlnet"], category="controlnet")
+@invocation(
+    "image_processor", title="Base Image Processor", tags=["controlnet"], category="controlnet", version="1.0.0"
+)
 class ImageProcessorInvocation(BaseInvocation):
     """Base class for invocations that preprocess images for ControlNet"""
 
@@ -171,6 +173,7 @@ def invoke(self, context: InvocationContext) -> ImageOutput:
     title="Canny Processor",
     tags=["controlnet", "canny"],
     category="controlnet",
+    version="1.0.0",
 )
 class CannyImageProcessorInvocation(ImageProcessorInvocation):
     """Canny edge detection for ControlNet"""
@@ -193,6 +196,7 @@ def run_processor(self, image):
     title="HED (softedge) Processor",
     tags=["controlnet", "hed", "softedge"],
     category="controlnet",
+    version="1.0.0",
 )
 class HedImageProcessorInvocation(ImageProcessorInvocation):
     """Applies HED edge detection to image"""
@@ -221,6 +225,7 @@ def run_processor(self, image):
     title="Lineart Processor",
     tags=["controlnet", "lineart"],
     category="controlnet",
+    version="1.0.0",
 )
 class LineartImageProcessorInvocation(ImageProcessorInvocation):
     """Applies line art processing to image"""
@@ -242,6 +247,7 @@ def run_processor(self, image):
     title="Lineart Anime Processor",
     tags=["controlnet", "lineart", "anime"],
     category="controlnet",
+    version="1.0.0",
 )
 class LineartAnimeImageProcessorInvocation(ImageProcessorInvocation):
     """Applies line art anime processing to image"""
@@ -264,6 +270,7 @@ def run_processor(self, image):
     title="Openpose Processor",
     tags=["controlnet", "openpose", "pose"],
     category="controlnet",
+    version="1.0.0",
 )
 class OpenposeImageProcessorInvocation(ImageProcessorInvocation):
     """Applies Openpose processing to image"""
@@ -288,6 +295,7 @@ def run_processor(self, image):
     title="Midas Depth Processor",
     tags=["controlnet", "midas"],
     category="controlnet",
+    version="1.0.0",
 )
 class MidasDepthImageProcessorInvocation(ImageProcessorInvocation):
     """Applies Midas depth processing to image"""
@@ -314,6 +322,7 @@ def run_processor(self, image):
     title="Normal BAE Processor",
     tags=["controlnet"],
     category="controlnet",
+    version="1.0.0",
 )
 class NormalbaeImageProcessorInvocation(ImageProcessorInvocation):
     """Applies NormalBae processing to image"""
@@ -329,7 +338,9 @@ def run_processor(self, image):
         return processed_image
 
 
-@invocation("mlsd_image_processor", title="MLSD Processor", tags=["controlnet", "mlsd"], category="controlnet")
+@invocation(
+    "mlsd_image_processor", title="MLSD Processor", tags=["controlnet", "mlsd"], category="controlnet", version="1.0.0"
+)
 class MlsdImageProcessorInvocation(ImageProcessorInvocation):
     """Applies MLSD processing to image"""
 
@@ -350,7 +361,9 @@ def run_processor(self, image):
         return processed_image
 
 
-@invocation("pidi_image_processor", title="PIDI Processor", tags=["controlnet", "pidi"], category="controlnet")
+@invocation(
+    "pidi_image_processor", title="PIDI Processor", tags=["controlnet", "pidi"], category="controlnet", version="1.0.0"
+)
 class PidiImageProcessorInvocation(ImageProcessorInvocation):
     """Applies PIDI processing to image"""
 
@@ -376,6 +389,7 @@ def run_processor(self, image):
     title="Content Shuffle Processor",
     tags=["controlnet", "contentshuffle"],
     category="controlnet",
+    version="1.0.0",
 )
 class ContentShuffleImageProcessorInvocation(ImageProcessorInvocation):
     """Applies content shuffle processing to image"""
@@ -405,6 +419,7 @@ def run_processor(self, image):
     title="Zoe (Depth) Processor",
     tags=["controlnet", "zoe", "depth"],
     category="controlnet",
+    version="1.0.0",
 )
 class ZoeDepthImageProcessorInvocation(ImageProcessorInvocation):
     """Applies Zoe depth processing to image"""
@@ -420,6 +435,7 @@ def run_processor(self, image):
     title="Mediapipe Face Processor",
     tags=["controlnet", "mediapipe", "face"],
     category="controlnet",
+    version="1.0.0",
 )
 class MediapipeFaceProcessorInvocation(ImageProcessorInvocation):
     """Applies mediapipe face processing to image"""
@@ -442,6 +458,7 @@ def run_processor(self, image):
     title="Leres (Depth) Processor",
     tags=["controlnet", "leres", "depth"],
     category="controlnet",
+    version="1.0.0",
 )
 class LeresImageProcessorInvocation(ImageProcessorInvocation):
     """Applies leres processing to image"""
@@ -470,6 +487,7 @@ def run_processor(self, image):
     title="Tile Resample Processor",
     tags=["controlnet", "tile"],
     category="controlnet",
+    version="1.0.0",
 )
 class TileResamplerProcessorInvocation(ImageProcessorInvocation):
     """Tile resampler processor"""
@@ -509,6 +527,7 @@ def run_processor(self, img):
     title="Segment Anything Processor",
     tags=["controlnet", "segmentanything"],
     category="controlnet",
+    version="1.0.0",
 )
 class SegmentAnythingProcessorInvocation(ImageProcessorInvocation):
     """Applies segment anything processing to image"""

invokeai/app/invocations/cv.py

@@ -10,12 +10,7 @@
 from .baseinvocation import BaseInvocation, InputField, InvocationContext, invocation
 
 
-@invocation(
-    "cv_inpaint",
-    title="OpenCV Inpaint",
-    tags=["opencv", "inpaint"],
-    category="inpaint",
-)
+@invocation("cv_inpaint", title="OpenCV Inpaint", tags=["opencv", "inpaint"], category="inpaint", version="1.0.0")
 class CvInpaintInvocation(BaseInvocation):
     """Simple inpaint using opencv."""