horde-engine 2.8.2__py3-none-any.whl

hordelib/initialisation.py

@@ -0,0 +1,107 @@
+# initialisation.py
+# Initialise hordelib.
+import os
+import shutil
+import sys
+
+from loguru import logger
+
+from hordelib import install_comfy
+from hordelib.config_path import get_hordelib_path, set_system_path
+from hordelib.consts import (
+    COMFYUI_VERSION,
+    RELEASE_VERSION,
+)
+from hordelib.utils.logger import HordeLog
+
+_is_initialised = False
+
+
+def initialise(
+    # model_managers_to_load: dict[MODEL_CATEGORY_NAMES, bool] = DEFAULT_MODEL_MANAGERS,
+    *,
+    setup_logging: bool | None = True,
+    clear_logs=False,
+    logging_verbosity=3,
+    process_id: int | None = None,
+    force_normal_vram_mode: bool = True,
+    extra_comfyui_args: list[str] | None = None,
+    disable_smart_memory: bool = False,
+):
+    """Initialise hordelib. This is required before using any other hordelib functions.
+
+    Args:
+        setup_logging (bool | None, optional): Whether to use hordelib's loguru logging system. Defaults to True.
+        clear_logs (bool, optional): Whether logs should be purged when loading loguru. Defaults to False.
+        logging_verbosity (int, optional): The message level of logging. Defaults to 3.
+        process_id (int | None, optional): If this is is being used in a child processes, the identifier. \
+            Defaults to None.
+        force_low_vram (bool, optional): Whether to forcibly disable ComfyUI's high/med vram modes. Defaults to False.
+        extra_comfyui_args (list[str] | None, optional): Any additional CLI args for comfyui that should be used. \
+            Defaults to None.
+    """
+    global _is_initialised
+
+    # Wipe existing logs if requested
+    if clear_logs and os.path.exists("./logs"):
+        shutil.rmtree("./logs")
+
+    if setup_logging is not None:
+        # Setup logging if requested
+        HordeLog.initialise(
+            setup_logging=setup_logging,
+            process_id=process_id,
+            verbosity_count=logging_verbosity,
+        )
+
+    # If developer mode, don't permit some things
+    if not RELEASE_VERSION and " " in str(get_hordelib_path()):
+        # Our runtime patching can't handle this
+        raise Exception(
+            "Do not run this project in developer mode from a path that " "contains spaces in directory names.",
+        )
+
+    # Ensure we have ComfyUI
+    logger.debug("Clearing command line args in sys.argv before ComfyUI load")
+    sys_arg_bkp = sys.argv.copy()
+    sys.argv = sys.argv[:1]
+    installer = install_comfy.Installer()
+    installer.install(COMFYUI_VERSION)
+
+    # Modify python path to include comfyui
+    set_system_path()
+
+    import hordelib.comfy_horde
+
+    hordelib.comfy_horde.do_comfy_import(
+        force_normal_vram_mode=force_normal_vram_mode,
+        extra_comfyui_args=extra_comfyui_args,
+        disable_smart_memory=disable_smart_memory,
+    )
+
+    vram_on_start_free = hordelib.comfy_horde.get_torch_free_vram_mb()
+    vram_total = hordelib.comfy_horde.get_torch_total_vram_mb()
+    vram_percent_used = round((vram_total - vram_on_start_free) / vram_total * 100, 2)
+    message_addendum = "This will almost certainly cause issues. "
+    message_addendum += "It is strongly recommended you close other applications before running the worker."
+    if vram_on_start_free < 2000:
+        logger.warning(f"You have less than 2GB of VRAM free. {message_addendum}")
+
+    if vram_percent_used > 60:
+        logger.warning(f"There was already {vram_percent_used}% of VRAM used on start. {message_addendum}")
+
+    if vram_total < 4000:
+        logger.warning("You have less than 4GB of VRAM total. It is likely that generations will happen very slowly.")
+
+    # Initialise model manager
+    from hordelib.shared_model_manager import SharedModelManager
+
+    SharedModelManager()
+
+    sys.argv = sys_arg_bkp
+
+    _is_initialised = True
+
+
+def is_initialised():
+    return _is_initialised

hordelib/install_comfy.py

@@ -0,0 +1,166 @@
+# install.py
+# Fetch a specific version of the upstream ComfyUI project
+import os
+import subprocess
+from pathlib import Path
+
+from loguru import logger
+
+from hordelib.config_path import get_comfyui_path, get_hordelib_path
+from hordelib.consts import RELEASE_VERSION
+
+CUSTOM_NODE_YAML = """
+hordelib:
+    base_path: ../
+    custom_nodes: hordelib/nodes
+"""
+
+
+class Installer:
+    """Handles the installation of ComfyUI."""
+
+    @classmethod
+    def get_commit_hash(cls) -> str:
+        if RELEASE_VERSION:
+            return ""
+        head_file = get_comfyui_path() / ".git" / "HEAD"
+        if not head_file.exists():
+            return "NOT FOUND"
+        try:
+            with open(head_file) as f:
+                head_contents = f.read().strip()
+
+            if not head_contents.startswith("ref:"):
+                return head_contents
+
+            ref_path = os.path.join(".git", *head_contents[5:].split("/"))
+
+            with open(ref_path) as f:
+                return f.read().strip()
+
+        except Exception:
+            return ""
+
+    @classmethod
+    def _run_get_result(cls, command, directory=None):
+        if directory is None:
+            directory = get_hordelib_path()
+        # Don't if we're a release version
+        if RELEASE_VERSION:
+            return None
+        return subprocess.run(
+            command,
+            shell=True,
+            text=True,
+            capture_output=True,
+            cwd=str(directory),
+        )
+
+    @classmethod
+    def _run(cls, command, directory=None) -> tuple[bool, str] | None:
+        if directory is None:
+            directory = get_hordelib_path()
+        # Don't if we're a release version
+        if RELEASE_VERSION:
+            return None
+        try:
+            result = cls._run_get_result(command, str(directory))
+        except Exception as Ex:
+            logger.error(Ex)
+            return None
+        if result.returncode:
+            logger.error(result.stderr)
+            return None
+        return (True, result.stdout)
+
+    @classmethod
+    def install(cls, comfy_version: str) -> None:
+        # Don't if we're a release version
+        if RELEASE_VERSION:
+            return
+        # Install if ComfyUI is missing completely
+        if not get_comfyui_path().exists():
+            install_dir = get_comfyui_path().parent
+            cls._run(
+                "git clone https://github.com/comfyanonymous/ComfyUI.git",
+                install_dir,
+            )
+            cls._run(f"git checkout {comfy_version}", str(get_comfyui_path()))
+            # Apply our patches to comfyui
+            cls.apply_patch(get_hordelib_path() / "install_comfy.patch")
+            return
+
+        # If it's installed, is it up to date?
+        version = cls.get_commit_hash()
+        if version == comfy_version:
+            # Yes, all done
+            return
+
+        # Update comfyui
+        logger.info(
+            f"Current ComfyUI version {version[:8]} requires {comfy_version[:8]}",
+        )
+        cls.reset_comfyui_to_version(comfy_version)
+        # Apply our patches to comfyui
+        cls.apply_patch(get_hordelib_path() / "install_comfy.patch")
+
+    @classmethod
+    def remove_local_comfyui_changes(cls):
+        # Don't if we're a release version
+        if RELEASE_VERSION:
+            return
+        cls._run("git reset --hard", get_comfyui_path())
+        cls._run("git clean -fd", get_comfyui_path())
+
+    @classmethod
+    def reset_comfyui_to_version(cls, comfy_version):
+        # Don't if we're a release version
+        if RELEASE_VERSION:
+            return
+        # Try hard to ensure we reset everything even if we have been
+        # hacking on ComfyUI or are in a weird repo state
+        cls.remove_local_comfyui_changes()
+        cls._run("git checkout master", get_comfyui_path())
+        cls._run("git pull", get_comfyui_path())
+        cls._run(f"git checkout {comfy_version}", get_comfyui_path())
+
+    @classmethod
+    def apply_patch(cls, patch_file: Path, skip_dot_patch: bool = True):
+        # Don't if we're a release version
+        if RELEASE_VERSION:
+            return
+        if not skip_dot_patch:  # FIXME
+            # Check if the patch has already been applied
+            result = cls._run_get_result(
+                f"git apply --check {patch_file}",
+                get_comfyui_path(),
+            )
+            could_apply = not result.returncode
+            result = cls._run_get_result(
+                f"git apply --reverse --check {patch_file}",
+                get_comfyui_path(),
+            )
+            could_reverse = not result.returncode
+            if could_apply:
+                # Apply the patch
+                logger.info(f"Applying patch {patch_file}")
+                result = cls._run_get_result(f"git apply {patch_file}", get_comfyui_path())
+                logger.debug(f"{result}")
+            elif could_reverse:
+                # Patch is already applied, all is well
+                logger.info(f"Already applied patch {patch_file}")
+            else:
+                # Couldn't apply or reverse? That's not so good, but maybe we are partially applied?
+                # Reset local changes
+                cls.remove_local_comfyui_changes()
+                # Try to apply the patch
+                logger.info(f"Applying patch {patch_file}")
+                result = cls._run_get_result(f"git apply {patch_file}", get_comfyui_path())
+                logger.debug(f"{result}")
+                if result.returncode:
+                    logger.error(f"Could not apply patch {patch_file}")
+
+        # Drop in custom node config
+        config_file = os.path.join(get_comfyui_path(), "extra_model_paths.yaml")
+        with open(config_file, "w") as outfile:
+            outfile.write(CUSTOM_NODE_YAML)

hordelib/model_database/db_dep.json

@@ -0,0 +1,98 @@
+{
+    "sd-concepts-library": {
+      "type": "dependency",
+      "optional": true,
+      "config": {
+        "files": [
+          {
+            "path": "models/custom/sd-concepts-library/"
+          }
+        ],
+        "download": [
+          {
+            "file_name": "sd-concepts-library",
+            "file_path": "./models/custom/sd-concepts-library/",
+            "file_url": "https://github.com/sd-webui/sd-concepts-library/archive/refs/heads/main.zip",
+            "unzip": true,
+            "move_subfolder": "sd-concepts-library"
+          }
+        ]
+      },
+      "available": false
+    },
+    "clip-vit-large-patch14": {
+      "type": "dependency",
+      "optional": false,
+      "config": {
+        "files": [
+          {
+            "path": "models/clip-vit-large-patch14/config.json"
+          },
+          {
+            "path": "models/clip-vit-large-patch14/merges.txt"
+          },
+          {
+            "path": "models/clip-vit-large-patch14/preprocessor_config.json"
+          },
+          {
+            "path": "models/clip-vit-large-patch14/pytorch_model.bin"
+          },
+          {
+            "path": "models/clip-vit-large-patch14/special_tokens_map.json"
+          },
+          {
+            "path": "models/clip-vit-large-patch14/tokenizer.json"
+          },
+          {
+            "path": "models/clip-vit-large-patch14/tokenizer_config.json"
+          },
+          {
+            "path": "models/clip-vit-large-patch14/vocab.json"
+          }
+        ],
+        "download": [
+          {
+            "file_name": "config.json",
+            "file_path": "models/clip-vit-large-patch14",
+            "file_url": "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/config.json"
+          },
+          {
+            "file_name": "merges.txt",
+            "file_path": "models/clip-vit-large-patch14",
+            "file_url": "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/merges.txt"
+          },
+          {
+            "file_name": "preprocessor_config.json",
+            "file_path": "models/clip-vit-large-patch14",
+            "file_url": "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/preprocessor_config.json"
+          },
+          {
+            "file_name": "pytorch_model.bin",
+            "file_path": "models/clip-vit-large-patch14",
+            "file_url": "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/pytorch_model.bin"
+          },
+          {
+            "file_name": "special_tokens_map.json",
+            "file_path": "models/clip-vit-large-patch14",
+            "file_url": "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/special_tokens_map.json"
+          },
+          {
+            "file_name": "tokenizer.json",
+            "file_path": "models/clip-vit-large-patch14",
+            "file_url": "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/tokenizer.json"
+          },
+          {
+            "file_name": "tokenizer_config.json",
+            "file_path": "models/clip-vit-large-patch14",
+            "file_url": "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/tokenizer_config.json"
+          },
+          {
+            "file_name": "vocab.json",
+            "file_path": "models/clip-vit-large-patch14",
+            "file_url": "https://huggingface.co/openai/clip-vit-large-patch14/resolve/main/vocab.json"
+          }
+        ]
+      },
+      "available": false
+    }
+  }

hordelib/model_database/db_embeds.json

@@ -0,0 +1,43 @@
+{
+	"bad_prompt": {
+		"EmbedName": "Bad Prompt",
+		"EmbedType": "Textual Inversion",
+		"DownloadPath": "https://raw.githubusercontent.com/db0/AI-Horde-image-model-reference/main/embeddings/ti/bad_prompt.ti.pt",
+		"Description": "Trains a negative prompt into an embedding - works well on hands",
+		"baseline": "stable diffusion 1",
+		"showcase": ""
+	},
+	"EasyNegative": {
+		"EmbedName": "Easy Negative",
+		"EmbedType": "Textual Inversion",
+		"DownloadPath": "https://raw.githubusercontent.com/db0/AI-Horde-image-model-reference/main/embeddings/ti/EasyNegative.ti.pt",
+		"Description": "A simple negative embedding for the creation of better images - trained for Counterfeit but has success in other models",
+		"baseline": "stable diffusion 1",
+		"showcase": ""
+	},
+	"nfixer": {
+		"EmbedName": "nfixer",
+		"EmbedType": "Textual Inversion",
+		"DownloadPath": "https://raw.githubusercontent.com/db0/AI-Horde-image-model-reference/main/embeddings/ti/nfixer.ti.pt",
+		"Description": "This negative embedding is intended for use with Illuminati Diffusion v1.1, feel free to use it elsewhere but I can't guarantee your success.",
+		"baseline": "stable diffusion 1",
+		"showcase": ""
+	},
+	"epiNoiseOffset_v2": {
+		"EmbedName": "epiNoiseOffset_v2",
+		"EmbedType": "LoRA",
+		"DownloadPath": "https://raw.githubusercontent.com/db0/AI-Horde-image-model-reference/main/embeddings/lora/epiNoiseoffset_v2.lora.safetensors",
+		"Description": "LORA based on the Noise Offset post for better contrast and darker images.",
+		"baseline": "stable diffusion 1",
+		"showcase": ""
+	},
+	"HyperSmoke": {
+		"EmbedName": "HyperSmoke",
+		"EmbedType": "Textual Inversion",
+		"DownloadPath": "https://raw.githubusercontent.com/db0/AI-Horde-image-model-reference/main/embeddings/ti/HyperSmoke.ti.pt",
+		"Description": "HyperSmoke is a supplementive embedding that, just like HyperFluid, simply adds smoke to your scene. Whether that is a bust made out of smoke or a smoke bomb in a street, HyperSmoke is there for you",
+		"baseline": "stable diffusion 2",
+		"showcase": ""
+	}
+
+}

hordelib/model_database/diffusers.json

@@ -0,0 +1,31 @@
+{
+	"stable_diffusion_inpainting": {
+		"name": "stable_diffusion_inpainting",
+		"baseline": "stable diffusion inpainting",
+		"type": "ckpt",
+		"description": "Generalist model specialized for modifying areas of existing images",
+		"showcases": [],
+		"version": "1.5",
+		"style": "diffusers",
+		"nsfw": false,
+		"download_all": true,
+		"config": {
+			"files": [
+				{
+					"path": "sd-v1-5-inpainting.ckpt"
+				},
+				{
+					"path": "v1-inpainting-inference.yaml"
+				}
+			],
+			"download": [
+				{
+					"file_name": "sd-v1-5-inpainting.ckpt",
+					"file_path": "",
+					"file_url": "https://huggingface.co/runwayml/stable-diffusion-inpainting/resolve/main/sd-v1-5-inpainting.ckpt"
+				}
+			]
+		},
+		"available": false
+	}
+}

hordelib/model_database/med_config.json

@@ -0,0 +1,21 @@
+{
+  "architectures": [
+    "BertModel"
+  ],
+  "attention_probs_dropout_prob": 0.1,
+  "hidden_act": "gelu",
+  "hidden_dropout_prob": 0.1,
+  "hidden_size": 768,
+  "initializer_range": 0.02,
+  "intermediate_size": 3072,
+  "layer_norm_eps": 1e-12,
+  "max_position_embeddings": 512,
+  "model_type": "bert",
+  "num_attention_heads": 12,
+  "num_hidden_layers": 12,
+  "pad_token_id": 0,
+  "type_vocab_size": 2,
+  "vocab_size": 30524,
+  "encoder_width": 768,
+  "add_cross_attention": true
+}

hordelib/model_manager/__init__.py

@@ -0,0 +1,3 @@
+from hordelib.model_manager.hyper import MODEL_MANAGERS_TYPE_LOOKUP
+
+__all__ = ["MODEL_MANAGERS_TYPE_LOOKUP"]