v 2.5.1

Add support `\n` for column texts

.gitignore

@@ -158,4 +158,4 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
-#
+

src/nodes/grid_annotation.py

@@ -7,14 +7,14 @@ from ..utils import Annotation
 
 
 class GridAnnotationNode(BaseNode):
-    RETURN_TYPES: tuple[str] = ("GRID_ANNOTATION",)
+    RETURN_TYPES: tuple[str, ...] = ("GRID_ANNOTATION",)
 
     @classmethod
     def INPUT_TYPES(cls) -> dict[str, t.Any]:
         return {
             "required": {
-                "column_texts": ("STRING", {"multiline": False}),
+                "column_texts": ("STRING", {"multiline": True}),
-                "row_texts": ("STRING", {"multiline": False}),
+                "row_texts": ("STRING", {"multiline": True}),
                 "font_size": ("INT", {"default": 50, "min": 1}),
             },
         }
@@ -26,24 +26,15 @@ class GridAnnotationNode(BaseNode):
         font_size: int,
     ) -> tuple[Annotation]:
         font = ImageFont.truetype(str(STATIC_PATH / "Roboto-Regular.ttf"), size=font_size)
-        column_texts_list = self._set_value_to_texts_list(
+        column_texts_list = self._get_texts_from_string(column_texts)
-            self._get_texts_from_string(column_texts),
+        row_texts_list = self._get_texts_from_string(row_texts)
-        )
-        row_texts_list = self._set_value_to_texts_list(
-            self._get_texts_from_string(row_texts),
-        )
 
         result = Annotation(column_texts=column_texts_list, row_texts=row_texts_list, font=font)
         return (result,)
 
     def _get_texts_from_string(self, string: str) -> list[str]:
         return [
-            result.replace("\\n", "\n")
+            result
             for i in string.split(";")
             if (result := i.strip()) != ""
         ]
-
-    def _set_value_to_texts_list(self, texts_list: list[str]) -> list[str]:
-        if not texts_list:
-            return ["None"]
-        return texts_list

src/nodes/image_combine.py

@@ -6,7 +6,7 @@ from ..base import BaseNode
 
 
 class ImageCombineNode(BaseNode):
-    RETURN_TYPES: tuple[str] = ("IMAGE",)
+    RETURN_TYPES: tuple[str, ...] = ("IMAGE",)
 
     @classmethod
     def INPUT_TYPES(cls) -> dict[str, t.Any]:

src/nodes/images_grid.py

@@ -12,7 +12,7 @@ from ..utils import (
 )
 
 class BaseImagesGridNode(BaseNode):
-    RETURN_TYPES: tuple[str] = ("IMAGE",)
+    RETURN_TYPES: tuple[str, ...] = ("IMAGE",)
 
     @classmethod
     def _create_input_types(cls, coordinate_name: str) -> dict[str, t.Any]:

src/nodes/latent_combine.py

@@ -6,7 +6,7 @@ from ..base import BaseNode
 
 
 class LatentCombineNode(BaseNode):
-    RETURN_TYPES: tuple[str] = ("LATENT",)
+    RETURN_TYPES: tuple[str, ...] = ("LATENT",)
 
     @classmethod
     def INPUT_TYPES(cls) -> dict[str, t.Any]:

src/utils/images_grid.py

@@ -5,6 +5,9 @@ from contextlib import suppress
 from PIL import Image, ImageDraw, ImageFont
 
 
+WIDEST_LETTER = "W"
+
+
 @dataclass
 class Annotation():
     column_texts: list[str]
@@ -12,13 +15,6 @@ class Annotation():
     font: ImageFont.FreeTypeFont
 
 
-@dataclass
-class _GridInfo():
-    image: Image.Image
-    gap: int
-    one_image_size: tuple[int, int]
-
-
 def create_images_grid_by_columns(
     images: list[Image.Image],
     gap: int,
@@ -39,6 +35,13 @@ def create_images_grid_by_rows(
     return _create_images_grid(images, gap, max_columns, max_rows, annotation)
 
 
+@dataclass
+class _GridInfo():
+    image: Image.Image
+    gap: int
+    one_image_size: tuple[int, int]
+
+
 def _create_images_grid(
     images: list[Image.Image],
     gap: int,
@@ -56,7 +59,7 @@ def _create_images_grid(
 
     if annotation is None:
         return grid_image
-    return _create_grid_annotations(
+    return _create_grid_annotation(
         grid_info=_GridInfo(
             image=grid_image,
             gap=gap,
@@ -77,27 +80,36 @@ def _arrange_images_on_grid(
     gap: int,
 ):
     for i, image in enumerate(images):
-        if image.size != size:
-            image = image.crop((0, 0, *size))
         x = (i % max_columns) * (size[0] + gap)
         y = (i // max_columns) * (size[1] + gap)
 
         grid_image.paste(image, (x, y))
 
 
-def _create_grid_annotations(
+def _create_grid_annotation(
     grid_info: _GridInfo,
-    column_texts,
+    column_texts: list[str],
-    row_texts,
+    row_texts: list[str],
     font: ImageFont.FreeTypeFont,
 ) -> Image.Image:
-    if not column_texts or not row_texts:
+    if not column_texts and not row_texts:
-        raise ValueError("Column text or row text is empty")
+        raise ValueError("Column text and row text is empty")
 
     grid = grid_info.image
-    margin = font.size // 2
+    left_padding = 0
-    left_padding = int(max(map(font.getlength, row_texts))) + 2*margin
+    top_padding = 0
-    top_padding = font.size + 2*margin
+
+    if row_texts:
+        left_padding = int(
+            max(
+                font.getlength(splitted_text)
+                for raw_text in row_texts
+                for splitted_text in raw_text.split("\n")
+            )
+            + font.getlength(WIDEST_LETTER)*2
+        )
+    if column_texts:
+        top_padding = max(elem.count("\n") for elem in column_texts) * int(font.size) + int(font.size * 2)
 
     image = Image.new(
         "RGB",
@@ -105,23 +117,26 @@ def _create_grid_annotations(
         color="white",
     )
     draw = ImageDraw.Draw(image)
+    # https://github.com/python-pillow/Pillow/blob/9.5.x/docs/reference/ImageDraw.rst
     draw.font = font  # type: ignore
 
     _paste_image_to_lower_left_corner(image, grid)
-    _draw_column_text(
+    if column_texts:
-        draw=draw,
+        _draw_column_text(
-        texts=column_texts,
+            draw=draw,
-        grid_info=grid_info,
+            texts=column_texts,
-        left_padding=left_padding,
+            grid_info=grid_info,
-        top_padding=top_padding,
+            left_padding=left_padding,
-    )
+            top_padding=top_padding,
-    _draw_row_text(
+        )
-        draw=draw,
+    if row_texts:
-        texts=row_texts,
+        _draw_row_text(
-        grid_info=grid_info,
+            draw=draw,
-        left_padding=left_padding,
+            texts=row_texts,
-        top_padding=top_padding,
+            grid_info=grid_info,
-    )
+            left_padding=left_padding,
+            top_padding=top_padding,
+        )
 
     return image
 

workflows/efficiency.json

@@ -1,20 +1,207 @@
 {
-  "last_node_id": 8,
+  "last_node_id": 19,
-  "last_link_id": 16,
+  "last_link_id": 36,
   "nodes": [
+    {
+      "id": 6,
+      "type": "VAEDecode",
+      "pos": [
+        1083,
+        263
+      ],
+      "size": {
+        "0": 210,
+        "1": 46
+      },
+      "flags": {
+        "pinned": true,
+        "collapsed": true
+      },
+      "order": 4,
+      "mode": 0,
+      "inputs": [
+        {
+          "name": "samples",
+          "type": "LATENT",
+          "link": 11,
+          "slot_index": 0
+        },
+        {
+          "name": "vae",
+          "type": "VAE",
+          "link": 12
+        }
+      ],
+      "outputs": [
+        {
+          "name": "IMAGE",
+          "type": "IMAGE",
+          "links": [
+            29
+          ],
+          "slot_index": 0
+        }
+      ],
+      "properties": {
+        "Node name for S&R": "VAE Decode"
+      }
+    },
+    {
+      "id": 3,
+      "type": "XY Plot",
+      "pos": [
+        529,
+        778
+      ],
+      "size": {
+        "0": 225.0937042236328,
+        "1": 244
+      },
+      "flags": {},
+      "order": 0,
+      "mode": 0,
+      "outputs": [
+        {
+          "name": "script",
+          "type": "SCRIPT",
+          "links": [
+            23
+          ],
+          "slot_index": 0
+        }
+      ],
+      "properties": {
+        "Node name for S&R": "XY Plot"
+      },
+      "widgets_values": [
+        "Steps",
+        "20;30;40",
+        "CFG Scale",
+        "7;9;11",
+        10,
+        "False",
+        0,
+        "____________EXAMPLES____________\n(X/Y_types)     (X/Y_values)\nLatent Batch    n/a\nSeeds++ Batch   3\nSteps           15;20;25\nCFG Scale       5;10;15;20\nSampler(1)      dpmpp_2s_ancestral;euler;ddim\nSampler(2)      dpmpp_2m,karras;heun,normal\nDenoise         .3;.4;.5;.6;.7\nVAE             vae_1; vae_2; vae_3\n\n____________SAMPLERS____________\neuler;\neuler_ancestral;\nheun;\ndpm_2;\ndpm_2_ancestral;\nlms;\ndpm_fast;\ndpm_adaptive;\ndpmpp_2s_ancestral;\ndpmpp_sde;\ndpmpp_2m;\nddim;\nuni_pc;\nuni_pc_bh2\n\n___________SCHEDULERS___________\nkarras;\nnormal;\nsimple;\nddim_uniform\n\n______________VAE_______________\nkl-f8-anime2.ckpt;\nnovelai.vae.pt;\nvae-ft-mse-840000-ema-pruned.ckpt\n\n_____________NOTES______________\n- During a 'Latent Batch', the corresponding X/Y_value is ignored.\n- During a 'Latent Batch', the latent_id is ignored.\n- For a 'Seeds++ Batch', starting seed is defined by the KSampler.\n- Trailing semicolons are ignored in the X/Y_values.\n- Parameter types not set by this node are defined in the KSampler."
+      ],
+      "color": "#223",
+      "bgcolor": "#335"
+    },
+    {
+      "id": 2,
+      "type": "KSampler (Efficient)",
+      "pos": [
+        767,
+        252
+      ],
+      "size": {
+        "0": 288.36614990234375,
+        "1": 374
+      },
+      "flags": {},
+      "order": 3,
+      "mode": 0,
+      "inputs": [
+        {
+          "name": "model",
+          "type": "MODEL",
+          "link": 1
+        },
+        {
+          "name": "positive",
+          "type": "CONDITIONING",
+          "link": 2
+        },
+        {
+          "name": "negative",
+          "type": "CONDITIONING",
+          "link": 3
+        },
+        {
+          "name": "latent_image",
+          "type": "LATENT",
+          "link": 4
+        },
+        {
+          "name": "optional_vae",
+          "type": "VAE",
+          "link": 5
+        },
+        {
+          "name": "script",
+          "type": "SCRIPT",
+          "link": 23,
+          "slot_index": 5
+        }
+      ],
+      "outputs": [
+        {
+          "name": "MODEL",
+          "type": "MODEL",
+          "links": []
+        },
+        {
+          "name": "CONDITIONING+",
+          "type": "CONDITIONING",
+          "links": []
+        },
+        {
+          "name": "CONDITIONING-",
+          "type": "CONDITIONING",
+          "links": null
+        },
+        {
+          "name": "LATENT",
+          "type": "LATENT",
+          "links": [
+            11
+          ],
+          "slot_index": 3
+        },
+        {
+          "name": "VAE",
+          "type": "VAE",
+          "links": [
+            12
+          ],
+          "slot_index": 4
+        },
+        {
+          "name": "IMAGE",
+          "type": "IMAGE",
+          "links": null
+        }
+      ],
+      "properties": {
+        "Node name for S&R": "KSampler (Efficient)"
+      },
+      "widgets_values": [
+        "Script",
+        0,
+        428398671204662,
+        false,
+        20,
+        7,
+        "dpmpp_2m",
+        "karras",
+        1,
+        "Enabled"
+      ],
+      "color": "#223",
+      "bgcolor": "#335"
+    },
     {
       "id": 1,
       "type": "Efficient Loader",
       "pos": [
-        214,
+        529,
-        242
+        251
       ],
       "size": {
-        "0": 446.5,
+        "0": 222.70794677734375,
-        "1": 499.79998779296875
+        "1": 490.5440673828125
       },
       "flags": {},
-      "order": 0,
+      "order": 1,
       "mode": 0,
       "outputs": [
         {
@@ -79,16 +266,63 @@
       "color": "#223",
       "bgcolor": "#335"
     },
+    {
+      "id": 5,
+      "type": "ImagesGridByColumns",
+      "pos": [
+        1293,
+        247
+      ],
+      "size": [
+        315,
+        102
+      ],
+      "flags": {},
+      "order": 5,
+      "mode": 0,
+      "inputs": [
+        {
+          "name": "images",
+          "type": "IMAGE",
+          "link": 29,
+          "slot_index": 0
+        },
+        {
+          "name": "annotation",
+          "type": "GRID_ANNOTATION",
+          "link": 36
+        }
+      ],
+      "outputs": [
+        {
+          "name": "IMAGE",
+          "type": "IMAGE",
+          "links": [
+            15
+          ],
+          "slot_index": 0
+        }
+      ],
+      "properties": {
+        "Node name for S&R": "ImagesGridByColumns"
+      },
+      "widgets_values": [
+        5,
+        3
+      ],
+      "color": "#322",
+      "bgcolor": "#533"
+    },
     {
       "id": 7,
       "type": "PreviewImage",
       "pos": [
-        1703,
+        1290,
-        302
+        388
       ],
       "size": {
-        "0": 334.94000244140625,
+        "0": 737.5480346679688,
-        "1": 239.1999969482422
+        "1": 635.1529541015625
       },
       "flags": {
         "collapsed": false
@@ -107,71 +341,25 @@
       }
     },
     {
-      "id": 5,
+      "id": 19,
-      "type": "ImagesGridByColumns",
-      "pos": [
-        1369,
-        302
-      ],
-      "size": {
-        "0": 315,
-        "1": 102
-      },
-      "flags": {},
-      "order": 5,
-      "mode": 0,
-      "inputs": [
-        {
-          "name": "images",
-          "type": "IMAGE",
-          "link": 14
-        },
-        {
-          "name": "annotation",
-          "type": "GRID_ANNOTATION",
-          "link": 16
-        }
-      ],
-      "outputs": [
-        {
-          "name": "IMAGE",
-          "type": "IMAGE",
-          "links": [
-            15
-          ],
-          "slot_index": 0
-        }
-      ],
-      "properties": {
-        "Node name for S&R": "ImagesGridByColumns"
-      },
-      "widgets_values": [
-        0,
-        3
-      ],
-      "color": "#322",
-      "bgcolor": "#533"
-    },
-    {
-      "id": 8,
       "type": "GridAnnotation",
       "pos": [
-        1041,
+        1070,
-        386
+        305
+      ],
+      "size": [
+        210,
+        326
       ],
-      "size": {
-        "0": 315,
-        "1": 106
-      },
       "flags": {},
-      "order": 1,
+      "order": 2,
       "mode": 0,
       "outputs": [
         {
           "name": "GRID_ANNOTATION",
           "type": "GRID_ANNOTATION",
           "links": [
-            16
+            36
           ],
           "slot_index": 0
         }
@@ -180,198 +368,12 @@
         "Node name for S&R": "GridAnnotation"
       },
       "widgets_values": [
-        "Steps: 20; Steps: 30; Steps: 40;",
+        "Steps: 20;Steps: 30;Steps: 40",
-        "CGF: 7; CGF: 9; CGF: 11;",
+        "CGF: 7\nQuality: 10/10;\nCGF: 9\nQuality: 9/10;\nCGF: 11\nQuality: 5/10;",
         50
       ],
       "color": "#322",
       "bgcolor": "#533"
-    },
-    {
-      "id": 6,
-      "type": "VAEDecode",
-      "pos": [
-        1218,
-        329
-      ],
-      "size": {
-        "0": 210,
-        "1": 46
-      },
-      "flags": {
-        "pinned": true,
-        "collapsed": true
-      },
-      "order": 4,
-      "mode": 0,
-      "inputs": [
-        {
-          "name": "samples",
-          "type": "LATENT",
-          "link": 11,
-          "slot_index": 0
-        },
-        {
-          "name": "vae",
-          "type": "VAE",
-          "link": 12
-        }
-      ],
-      "outputs": [
-        {
-          "name": "IMAGE",
-          "type": "IMAGE",
-          "links": [
-            14
-          ],
-          "slot_index": 0
-        }
-      ],
-      "properties": {
-        "Node name for S&R": "VAE Decode"
-      }
-    },
-    {
-      "id": 3,
-      "type": "XY Plot",
-      "pos": [
-        258,
-        783
-      ],
-      "size": [
-        403.35785644531256,
-        244
-      ],
-      "flags": {},
-      "order": 2,
-      "mode": 0,
-      "outputs": [
-        {
-          "name": "script",
-          "type": "SCRIPT",
-          "links": [
-            6
-          ],
-          "slot_index": 0
-        }
-      ],
-      "properties": {
-        "Node name for S&R": "XY Plot"
-      },
-      "widgets_values": [
-        "Steps",
-        "20;30;40",
-        "CFG Scale",
-        "7;9;11",
-        0,
-        "False",
-        0,
-        "____________EXAMPLES____________\n(X/Y_types)     (X/Y_values)\nLatent Batch    n/a\nSeeds++ Batch   3\nSteps           15;20;25\nCFG Scale       5;10;15;20\nSampler(1)      dpmpp_2s_ancestral;euler;ddim\nSampler(2)      dpmpp_2m,karras;heun,normal\nDenoise         .3;.4;.5;.6;.7\nVAE             vae_1; vae_2; vae_3\n\n____________SAMPLERS____________\neuler;\neuler_ancestral;\nheun;\ndpm_2;\ndpm_2_ancestral;\nlms;\ndpm_fast;\ndpm_adaptive;\ndpmpp_2s_ancestral;\ndpmpp_sde;\ndpmpp_2m;\nddim;\nuni_pc;\nuni_pc_bh2\n\n___________SCHEDULERS___________\nkarras;\nnormal;\nsimple;\nddim_uniform\n\n______________VAE_______________\nkl-f8-anime2.ckpt;\nnovelai.vae.pt;\nvae-ft-mse-840000-ema-pruned.ckpt\n\n_____________NOTES______________\n- During a 'Latent Batch', the corresponding X/Y_value is ignored.\n- During a 'Latent Batch', the latent_id is ignored.\n- For a 'Seeds++ Batch', starting seed is defined by the KSampler.\n- Trailing semicolons are ignored in the X/Y_values.\n- Parameter types not set by this node are defined in the KSampler."
-      ],
-      "color": "#223",
-      "bgcolor": "#335"
-    },
-    {
-      "id": 2,
-      "type": "KSampler (Efficient)",
-      "pos": [
-        685,
-        242
-      ],
-      "size": {
-        "0": 330,
-        "1": 374
-      },
-      "flags": {},
-      "order": 3,
-      "mode": 0,
-      "inputs": [
-        {
-          "name": "model",
-          "type": "MODEL",
-          "link": 1
-        },
-        {
-          "name": "positive",
-          "type": "CONDITIONING",
-          "link": 2
-        },
-        {
-          "name": "negative",
-          "type": "CONDITIONING",
-          "link": 3
-        },
-        {
-          "name": "latent_image",
-          "type": "LATENT",
-          "link": 4
-        },
-        {
-          "name": "optional_vae",
-          "type": "VAE",
-          "link": 5
-        },
-        {
-          "name": "script",
-          "type": "SCRIPT",
-          "link": 6
-        }
-      ],
-      "outputs": [
-        {
-          "name": "MODEL",
-          "type": "MODEL",
-          "links": null
-        },
-        {
-          "name": "CONDITIONING+",
-          "type": "CONDITIONING",
-          "links": null
-        },
-        {
-          "name": "CONDITIONING-",
-          "type": "CONDITIONING",
-          "links": null
-        },
-        {
-          "name": "LATENT",
-          "type": "LATENT",
-          "links": [
-            11
-          ],
-          "slot_index": 3
-        },
-        {
-          "name": "VAE",
-          "type": "VAE",
-          "links": [
-            12
-          ],
-          "slot_index": 4
-        },
-        {
-          "name": "IMAGE",
-          "type": "IMAGE",
-          "links": null
-        }
-      ],
-      "properties": {
-        "Node name for S&R": "KSampler (Efficient)"
-      },
-      "widgets_values": [
-        "Script",
-        0,
-        428398671204662,
-        false,
-        20,
-        7,
-        "dpmpp_2m",
-        "karras",
-        1,
-        "Enabled"
-      ],
-      "color": "#223",
-      "bgcolor": "#335"
     }
   ],
   "links": [
@@ -415,14 +417,6 @@
       4,
       "VAE"
     ],
-    [
-      6,
-      3,
-      0,
-      2,
-      5,
-      "SCRIPT"
-    ],
     [
       11,
       2,
@@ -439,14 +433,6 @@
       1,
       "VAE"
     ],
-    [
-      14,
-      6,
-      0,
-      5,
-      0,
-      "IMAGE"
-    ],
     [
       15,
       5,
@@ -456,8 +442,24 @@
       "IMAGE"
     ],
     [
-      16,
+      23,
-      8,
+      3,
+      0,
+      2,
+      5,
+      "SCRIPT"
+    ],
+    [
+      29,
+      6,
+      0,
+      5,
+      0,
+      "IMAGE"
+    ],
+    [
+      36,
+      19,
       0,
       5,
       1,