chore: detail the difference between tags and trigger words

fix: no longer crash when internet is unavailable

.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish to Comfy registry
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - "pyproject.toml"
+
+jobs:
+  publish-node:
+    name: Publish Custom Node to registry
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+      - name: Publish Custom Node
+        uses: Comfy-Org/publish-node-action@main
+        with:
+          ## Add your own personal access token to your Github Repository secrets and reference it here.
+          personal_access_token: ${{ secrets.REGISTRY_ACCESS_TOKEN }}

README.md

@@ -1,38 +1,92 @@
 # ComfyUI-Lora-Auto-Trigger-Words
 
 This project is a fork of https://github.com/Extraltodeus/LoadLoraWithTags
-The aim of these custom nodes is to get an _easy_ access to the tags used to trigger a lora. 
+The aim of these custom nodes is to get an _easy_ access to the **trigger words** (or **tags**) used to trigger a lora. 
-This project is compatible with Stacked Loras from https://github.com/LucianoCirino/efficiency-nodes-comfyui/releases
+
-I talk about **lora**, but works with **lycoris** too.
+*Note that trigger words and tags are used interchangeably in this readme and means the same thing.*
+
+This project is compatible with Stacked Loras from https://github.com/jags111/efficiency-nodes-comfyui  
+When I talk about **lora**, I also mean **lycoris** too.
 
 ## Install
 Some of this project nodes depends on https://github.com/pythongosssss/ComfyUI-Custom-Scripts :
 - LoraLoaderAdvanced
 - LoraLoaderStackedAdvanced
-They get their vanilla equivalents. 
+- `View info...`
+
+They get their vanilla equivalents with less features
 
 Overall, Custom-Scripts is recommended to be able to know the content of the tag lists with the node `showText`
 
 ## Features
-### Main nodes
+### Lora Trigger Words
+Lora trigger words are imported from two sources : 
+- Civitai api (only for civitai models)
+
+![image](./images/CivitaiTriggerWords.png)
+- Model training metadata (when available)
+
 #### Vanilla vs Advanced
-Vanilla refers to nodes that have no lora preview from the menu, nor the lora list. But the features provided are the same.
+> Vanilla refers to nodes that have no lora preview from the menu, nor the lora list. But the features provided are the same.
+
 ![image](./images/main.png)
-#### Nodes
+### Nodes
-- LoraLoader (Vanilla or Advanced)
+#### LoraLoader (Vanilla and Advanced)
-- LoraLoaderStacked (Vanilla or Avanced). The stacked lora input is optional.
+![image](./images/LoraLoader.png)
-Allow to load a lora, either the normal way, or the efficiency-nodes way.
+INPUT
-These loaders have two custom outputs:
+- `override_lora_name` (optional): Used to ignore the field `lora_name` and use the name passed. Should use [LoraListNames](#loralistnames) or the `lora_name` output.
-- civitai_tags_list: a python list of the tags related to this lora on civitai
+
-- meta_tags_list: a python list of the tags used for training the lora embeded in it (if any)
+FIELDS
-This outputs needs to be filtered by two othere nodes:
+- `force_fetch`: Force the civitai fetching of data even if there is already something saved
-- TagsFormater: Helper to show the available tag and their indexes
+- `enable_preview`: Toggle on/off the saved lora preview if any (only in advanced)
-- tagsSelector: allow to filter tags and apply a weight to it.
+- `append_lora_if_empty`: Add the name of the lora to the list of tags if the list is empty 
-    - TagSelector contains four parameters. First the selector (see Filtering next)
+
-    - The weight `(tag:weight)`
+OUTPUT
-    - The boolean `ensure_comma`. To properly append comma if a prefix or suffix is added.
+- `civitai_tags_list`: a python list of the tags related to this lora on civitai
-    - The boolean `append_loraname_if_empty` which will add the name of the lora in the list of outputs if they are empty.
+- `meta_tags_list`: a python list of the tags used for training the lora embeded in it (if any)
-#### Filtering
+- `lora_name`: the name of the current selected lora
+#### LoraLoaderStacked (Vanilla and Avanced). 
+![image](./images/LoraLoaderStacked.png)
+INPUT
+- `lora_stack` (optional): another stack of lora.
+- `override_lora_name` (optional): Used to ignore the field `lora_name` and use the name passed. Should use [LoraListNames](#loralistnames) or the `lora_name` output.
+
+FIELDS
+- `force_fetch`: Force the civitai fetching of data even if there is already something saved
+- `enable_preview`: Toggle on/off the saved lora preview if any (only in advanced)
+- `append_lora_if_empty`: Add the name of the lora to the list of tags if the list is empty 
+
+OUTPUT
+- `civitai_tags_list`: a python list of the tags related to this lora on civitai
+- `meta_tags_list`: a python list of the tags used for training the lora embeded in it (if any)
+- `lora_name`: the name of the current selected lora
+#### LoraTagsOnly 
+![image](./images/LoraTagsOnly.png)
+To get the tags without using the lora.
+- `override_lora_name` (optional): Used to ignore the field `lora_name` and use the name passed. Should use [LoraListNames](#loralistnames) or the `lora_name` output.
+
+OUTPUT
+- `civitai_tags_list`: a python list of the tags related to this lora on civitai
+- `meta_tags_list`: a python list of the tags used for training the lora embeded in it (if any)
+- `lora_name`: the name of the current selected lora
+
+#### TagsFormater
+![image](./images/TagsFormater.png)
+Helper to show the available tag and their indexes. Tags are sorted by training frequence. The more a tag was used, the higher in the list it is. Works for both `civitai_tags_list` and `meta_tags_list`
+
+#### TagsSelector
+![image](./images/TagsSelector.png)
+Allow to filter tags and apply a weight to it.  
+TagSelector contains four parameters. 
+- `selector` (see the [Filtering](#filtering) section next)
+- `weight`: to format the tag like `(tag:weight)`. Default set to 1 without the weight like `tag`.
+- `ensure_comma`. To properly append comma if a prefix or suffix is added.
+
+#### LoraListNames
+![image](./images/LoraListNames.png)
+List all the existing lora names. It is used as an input for `override_lora_name`
+
+### Filtering
 The format is simple. It's the same as python list index, but can select multiple index or ranges of indexes separated by comas.
 `Ex: 0, 3, 5:8, -8:`
 - Select a specific list of indexes: `0, 2, 3, 15`...
@@ -42,6 +96,11 @@ The format is simple. It's the same as python list index, but can select multipl
 - You can use negative indexes. Like `-1` to select the last tag
 - By default `:` selects everything
 
+### View Info
+![image](./images/ViewInfo.png)
+Pythongossss's [View Info...](https://github.com/pythongosssss/ComfyUI-Custom-Scripts?tab=readme-ov-file#checkpointloraembedding-info) feature from ComfyUI-Custom-Scripts
+
+### Examples
 #### Example of normal workflow
 ![image](./images/loaderAdvanced.png)
 
@@ -55,5 +114,5 @@ Lora Stack can also be chained together to load multiple loras into an efficient
 
 ### Side nodes I made and kept here
 - FusionText: takes two text input and join them together
-- Randomizer: takes two couples text+lorastack and return randomly one them
+- Randomizer: takes two couples text+lorastack and return randomly one of them
 - TextInputBasic: just a text input with two additional input for text chaining

__init__.py

@@ -5,4 +5,5 @@ from .nodes_utils import NODE_CLASS_MAPPINGS as nu_NCM
 
 NODE_CLASS_MAPPINGS = dict(na_NCM, **nu_NCM)
 #NODE_DISPLAY_NAME_MAPPINGS = dict(na_NDNM, **nu_NDNM)
-__all__ = ["NODE_CLASS_MAPPINGS"]#, "NODE_DISPLAY_NAME_MAPPINGS"]
+WEB_DIRECTORY = "./web"
+__all__ = ["NODE_CLASS_MAPPINGS", "WEB_DIRECTORY"]#, "NODE_DISPLAY_NAME_MAPPINGS"]

nodes_autotrigger.py

@@ -14,7 +14,6 @@ class LoraLoaderVanilla:
         return {
             "required": { 
                 "model": ("MODEL",),
-                "clip": ("CLIP", ),
                 "lora_name": (LORA_LIST, ),
                 "strength_model": ("FLOAT", {"default": 1.0, "min": -10.0, "max": 10.0, "step": 0.01}),
                 "strength_clip": ("FLOAT", {"default": 1.0, "min": -10.0, "max": 10.0, "step": 0.01}),
@@ -22,16 +21,19 @@ class LoraLoaderVanilla:
                 "append_loraname_if_empty": ("BOOLEAN", {"default": False}),
             },
             "optional": {
+                "clip": ("CLIP", ),
                 "override_lora_name":("STRING", {"forceInput": True}), 
             }
         }
     
-    RETURN_TYPES = ("MODEL", "CLIP", "LIST", "LIST")
+    RETURN_TYPES = ("MODEL", "CLIP", "LIST", "LIST", "STRING")
-    RETURN_NAMES = ("MODEL", "CLIP", "civitai_tags_list", "meta_tags_list")
+    RETURN_NAMES = ("MODEL", "CLIP", "civitai_tags_list", "meta_tags_list", "lora_name")
     FUNCTION = "load_lora"
     CATEGORY = "autotrigger"
 
-    def load_lora(self, model, clip, lora_name, strength_model, strength_clip, force_fetch, append_loraname_if_empty, override_lora_name=""):
+    def load_lora(self, model, lora_name, strength_model, strength_clip, force_fetch, append_loraname_if_empty, clip=None, override_lora_name=""):
+        if clip is None:
+            strength_clip=0
         if override_lora_name != "":
             lora_name = override_lora_name
         meta_tags_list = sort_tags_by_frequency(get_metadata(lora_name, "loras"))
@@ -56,7 +58,7 @@ class LoraLoaderVanilla:
 
         model_lora, clip_lora = load_lora_for_models(model, clip, lora, strength_model, strength_clip)
   
-        return (model_lora, clip_lora, civitai_tags_list, meta_tags_list)
+        return (model_lora, clip_lora, civitai_tags_list, meta_tags_list, lora_name)
 
 class LoraLoaderStackedVanilla:
     @classmethod
@@ -75,8 +77,8 @@ class LoraLoaderStackedVanilla:
             }
         }
 
-    RETURN_TYPES = ("LIST", "LIST", "LORA_STACK",)
+    RETURN_TYPES = ("LIST", "LIST", "LORA_STACK", "STRING")
-    RETURN_NAMES = ("civitai_tags_list", "meta_tags_list", "LORA_STACK",)
+    RETURN_NAMES = ("civitai_tags_list", "meta_tags_list", "LORA_STACK", "lora_name")
     FUNCTION = "set_stack"
     #OUTPUT_NODE = False
     CATEGORY = "autotrigger"
@@ -96,7 +98,7 @@ class LoraLoaderStackedVanilla:
         if lora_stack is not None:
             loras.extend(lora_stack)
 
-        return (civitai_tags_list, meta_tags_list, loras)
+        return (civitai_tags_list, meta_tags_list, loras, lora_name)
 
 class LoraLoaderAdvanced:
     def __init__(self):
@@ -109,7 +111,6 @@ class LoraLoaderAdvanced:
         return {
             "required": { 
                 "model": ("MODEL",),
-                "clip": ("CLIP", ),
                 "lora_name": (LORA_LIST, ),
                 "strength_model": ("FLOAT", {"default": 1.0, "min": -10.0, "max": 10.0, "step": 0.01}),
                 "strength_clip": ("FLOAT", {"default": 1.0, "min": -10.0, "max": 10.0, "step": 0.01}),
@@ -118,18 +119,23 @@ class LoraLoaderAdvanced:
                 "append_loraname_if_empty": ("BOOLEAN", {"default": False}),
             },
             "optional": {
+                "clip": ("CLIP", ),
                 "override_lora_name":("STRING", {"forceInput": True}), 
             }
         }
     
-    RETURN_TYPES = ("MODEL", "CLIP", "LIST", "LIST")
+    RETURN_TYPES = ("MODEL", "CLIP", "LIST", "LIST", "STRING")
-    RETURN_NAMES = ("MODEL", "CLIP", "civitai_tags_list", "meta_tags_list")
+    RETURN_NAMES = ("MODEL", "CLIP", "civitai_tags_list", "meta_tags_list", "lora_name")
     FUNCTION = "load_lora"
     CATEGORY = "autotrigger"
 
-    def load_lora(self, model, clip, lora_name, strength_model, strength_clip, force_fetch, enable_preview, append_loraname_if_empty, override_lora_name=""):
+    def load_lora(self, model, lora_name, strength_model, strength_clip, force_fetch, enable_preview, append_loraname_if_empty, clip=None, override_lora_name=""):
+        if clip is None:
+            strength_clip=0
         if override_lora_name != "":
-            lora_name = {"content": override_lora_name, "image": ""}
+            has_preview, prev = get_preview_path(override_lora_name, "loras")
+            prev = f"loras/{prev}" if has_preview else None
+            lora_name = {"content": override_lora_name, "image": prev, "type": "loras"}
         
         meta_tags_list = sort_tags_by_frequency(get_metadata(lora_name["content"], "loras"))
         civitai_tags_list = load_and_save_tags(lora_name["content"], force_fetch)
@@ -160,10 +166,10 @@ class LoraLoaderAdvanced:
                     "subfolder": "lora_preview",
                     "type": "temp"
                 }
-                return {"ui": {"images": [preview_output]}, "result": (model_lora, clip_lora, civitai_tags_list, meta_tags_list)}
+                return {"ui": {"images": [preview_output]}, "result": (model_lora, clip_lora, civitai_tags_list, meta_tags_list, lora_name["content"])}
 
 
-        return (model_lora, clip_lora, civitai_tags_list, meta_tags_list)
+        return (model_lora, clip_lora, civitai_tags_list, meta_tags_list, lora_name["content"])
 
 class LoraLoaderStackedAdvanced:
     @classmethod
@@ -184,15 +190,17 @@ class LoraLoaderStackedAdvanced:
             }
         }
 
-    RETURN_TYPES = ("LIST", "LIST", "LORA_STACK",)
+    RETURN_TYPES = ("LIST", "LIST", "LORA_STACK", "STRING")
-    RETURN_NAMES = ("civitai_tags_list", "meta_tags_list", "LORA_STACK",)
+    RETURN_NAMES = ("civitai_tags_list", "meta_tags_list", "LORA_STACK", "lora_name")
     FUNCTION = "set_stack"
     #OUTPUT_NODE = False
     CATEGORY = "autotrigger"
 
     def set_stack(self, lora_name, lora_weight, force_fetch, enable_preview, append_loraname_if_empty, lora_stack=None, override_lora_name=""):
         if override_lora_name != "":
-            lora_name = {"content": override_lora_name, "image": ""}
+            has_preview, prev = get_preview_path(override_lora_name, "loras")
+            prev = f"loras/{prev}" if has_preview else None
+            lora_name = {"content": override_lora_name, "image": prev, "type": "loras"}
         
         civitai_tags_list = load_and_save_tags(lora_name["content"], force_fetch)
 
@@ -214,9 +222,9 @@ class LoraLoaderStackedAdvanced:
                     "subfolder": "lora_preview",
                     "type": "temp"
                 }
-                return {"ui": {"images": [preview_output]}, "result": (civitai_tags_list, meta_tags_list, loras)}
+                return {"ui": {"images": [preview_output]}, "result": (civitai_tags_list, meta_tags_list, loras, lora_name["content"])}
         
-        return {"result": (civitai_tags_list, meta_tags_list, loras)}
+        return {"result": (civitai_tags_list, meta_tags_list, loras, lora_name["content"])}
 
 class LoraTagsOnly:
     @classmethod
@@ -249,7 +257,6 @@ class LoraTagsOnly:
 
         return (civitai_tags_list, meta_tags_list)
 
-
 # A dictionary that contains all nodes you want to export with their names
 # NOTE: names should be globally unique
 NODE_CLASS_MAPPINGS = {

pyproject.toml

@@ -0,0 +1,14 @@
+[project]
+name = "comfyui-lora-auto-trigger-words"
+description = "The aim of these custom nodes is to get an easy access to the tags used to trigger a lora / lycoris. Extract the tags from civitai or from the safetensors metadatas when available."
+version = "1.0.4"
+license = "MIT"
+
+[project.urls]
+Repository = "https://github.com/idrirap/ComfyUI-Lora-Auto-Trigger-Words"
+#  Used by Comfy Registry https://comfyregistry.org
+
+[tool.comfy]
+PublisherId = "dijkstra"
+DisplayName = "ComfyUI-Lora-Auto-Trigger-Words"
+Icon = ""

utils.py

@@ -15,11 +15,14 @@ def get_preview_path(name, type):
     
     file_path_no_ext = os.path.splitext(file_path)[0]
     item_image=None
-    for ext in ["png", "jpg", "jpeg", "preview.png"]:
+    for ext in ["png", "jpg", "jpeg", "gif"]:
-        has_image = os.path.isfile(file_path_no_ext + "." + ext)
+        if item_image is not None:
-        if has_image:
-            item_image = f"{file_name}.{ext}"
             break
+        for ext2 in ["", ".preview"]:
+            has_image = os.path.isfile(file_path_no_ext + ext2 + "." + ext)
+            if has_image:
+                item_image = f"{file_name}{ext2}.{ext}"
+                break
         
     return has_image, item_image
 
@@ -31,6 +34,8 @@ def copy_preview_to_temp(file_name):
     lora_less = "/".join(file_name.split("/")[1:])
 
     file_path = folder_paths.get_full_path("loras", lora_less)
+    if file_path is None:
+        return None, None
 
     temp_path = folder_paths.get_temp_directory()
     preview_path = os.path.join(temp_path, "lora_preview")
@@ -66,7 +71,7 @@ def load_json_from_file(file_path):
         return None
     except json.JSONDecodeError:
         print(f"Error decoding JSON in file: {file_path}")
-        return None
+        raise
 
 def save_dict_to_json(data_dict, file_path):
     try:
@@ -78,8 +83,11 @@ def save_dict_to_json(data_dict, file_path):
 
 def get_model_version_info(hash_value):
     api_url = f"https://civitai.com/api/v1/model-versions/by-hash/{hash_value}"
-    response = requests.get(api_url)
+    try:
-    
+        response = requests.get(api_url)
+    except Exception as e:
+        print(f"[Lora-Auto-Trigger] {e}")
+        return None
     if response.status_code == 200:
         return response.json()
     else:
@@ -219,4 +227,4 @@ def append_lora_name_if_empty(tags_list, lora_path, enabled):
     filename = os.path.basename(filename)
 
     tags_list.append(filename)
-    return tags_list
+    return tags_list

web/js/loraInfo.js

@@ -0,0 +1,36 @@
+import { app } from "../../../scripts/app.js";
+import { LoraInfoDialog } from "../../ComfyUI-Custom-Scripts/js/modelInfo.js";
+
+const infoHandlers = {
+    "LoraLoaderVanilla":true,
+    "LoraLoaderStackedVanilla":true,
+    "LoraLoaderAdvanced":true,
+    "LoraLoaderStackedAdvanced":true
+}
+
+app.registerExtension({
+    name: "autotrigger.LoraInfo",
+    beforeRegisterNodeDef(nodeType) {
+        if (! infoHandlers[nodeType.comfyClass]) {
+            return;
+        }
+        const getExtraMenuOptions = nodeType.prototype.getExtraMenuOptions;
+        nodeType.prototype.getExtraMenuOptions = function (_, options) {
+            let value = this.widgets[0].value;
+            if (!value) {
+                return;
+            }
+            if (value.content) {
+                value = value.content;
+            }
+            options.unshift({
+                content: "View info...",
+                callback: async () => {
+                    new LoraInfoDialog(value).show("loras", value);
+                },
+            });
+
+            return getExtraMenuOptions?.apply(this, arguments);
+        };
+    }
+});