Skip to content

consts

Constants for the worker chaining system.

The chaining system describes a unit of work as a directed acyclic graph of stages. It is descriptive rather than prescriptive: a worker's own orchestration remains the executor of record and drives the chain state from generation-progress milestones, while simple consumers can use the reference executor in horde_sdk.worker.chaining.executors.

CHAIN_NODE_KIND

Bases: StrEnum

The kind of work a chain node represents.

Source code in horde_sdk/worker/chaining/consts.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CHAIN_NODE_KIND(StrEnum):
    """The kind of work a chain node represents."""

    GENERATE = auto()
    """A round of inference or other primary computation."""

    POST_PROCESS = auto()
    """Post-processing of a previous stage's output (e.g., upscaling or face fixing)."""

    SAFETY_CHECK = auto()
    """A safety evaluation of a previous stage's output."""

    SUBMIT = auto()
    """Delivery of the finished results to the dispatch source."""

    CUSTOM = auto()
    """A custom stage not otherwise classified."""

GENERATE class-attribute instance-attribute 

GENERATE = auto()

A round of inference or other primary computation.

POST_PROCESS class-attribute instance-attribute 

POST_PROCESS = auto()

Post-processing of a previous stage's output (e.g., upscaling or face fixing).

SAFETY_CHECK class-attribute instance-attribute 

SAFETY_CHECK = auto()

A safety evaluation of a previous stage's output.

SUBMIT class-attribute instance-attribute 

SUBMIT = auto()

Delivery of the finished results to the dispatch source.

CUSTOM class-attribute instance-attribute 

CUSTOM = auto()

A custom stage not otherwise classified.

CHAIN_NODE_STATE

Bases: StrEnum

The execution state of a chain node.

Source code in horde_sdk/worker/chaining/consts.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class CHAIN_NODE_STATE(StrEnum):
    """The execution state of a chain node."""

    PENDING = auto()
    """The node has unmet dependencies and cannot start yet."""

    READY = auto()
    """All dependencies are met; the node is eligible to start."""

    EXECUTING = auto()
    """The node's work is in progress."""

    COMPLETED = auto()
    """The node's work finished successfully."""

    FAILED = auto()
    """The node's work failed terminally."""

    SKIPPED = auto()
    """The node was not executed, either because it is optional or because a dependency failed."""

PENDING class-attribute instance-attribute 

PENDING = auto()

The node has unmet dependencies and cannot start yet.

READY class-attribute instance-attribute 

READY = auto()

All dependencies are met; the node is eligible to start.

EXECUTING class-attribute instance-attribute 

EXECUTING = auto()

The node's work is in progress.

COMPLETED class-attribute instance-attribute 

COMPLETED = auto()

The node's work finished successfully.

FAILED class-attribute instance-attribute 

FAILED = auto()

The node's work failed terminally.

SKIPPED class-attribute instance-attribute 

SKIPPED = auto()

The node was not executed, either because it is optional or because a dependency failed.

CHAIN_CAPABILITY

Bases: StrEnum

The lane capability a chain node requires from the executing worker.

Workers map these tokens onto their own process lanes; the SDK attaches no scheduling semantics to them.

Source code in horde_sdk/worker/chaining/consts.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
class CHAIN_CAPABILITY(StrEnum):
    """The lane capability a chain node requires from the executing worker.

    Workers map these tokens onto their own process lanes; the SDK attaches no scheduling semantics to them.
    """

    INFERENCE = auto()
    """Requires a process holding the primary (e.g., checkpoint-loaded) inference backend."""

    POST_PROCESSING = auto()
    """Requires a process holding post-processing models (upscalers, facefixers, background removal)."""

    SAFETY = auto()
    """Requires a process holding the safety evaluation stack."""

    CUSTOM = auto()
    """Requires a worker-defined capability outside the standard set."""

INFERENCE class-attribute instance-attribute 

INFERENCE = auto()

Requires a process holding the primary (e.g., checkpoint-loaded) inference backend.

POST_PROCESSING class-attribute instance-attribute 

POST_PROCESSING = auto()

Requires a process holding post-processing models (upscalers, facefixers, background removal).

SAFETY class-attribute instance-attribute 

SAFETY = auto()

Requires a process holding the safety evaluation stack.

CUSTOM class-attribute instance-attribute 

CUSTOM = auto()

Requires a worker-defined capability outside the standard set.

CHAIN_EDGE_KIND

Bases: StrEnum

The known chain edges.

Source code in horde_sdk/worker/chaining/consts.py 
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
class CHAIN_EDGE_KIND(StrEnum):
    """The known chain edges."""

    CUSTOM = auto()
    """A custom chain edge."""

    SAME_GENERATION = auto()
    """The same generation object flows from one stage to the next within a single unit of work."""

    RESULTING_IMAGE_AS_SOURCE = auto()
    """The resulting image of the previous generation is used as the source for the next generation."""

    RESULTING_TEXT_AS_PROMPT = auto()
    """The resulting text of the previous generation is used as the prompt for the next generation."""

    RESULTING_IMAGE_AS_MASK = auto()
    """The resulting image of the previous generation is used as the mask for the next generation."""

    RESULTING_IMAGE_AS_CONTROL_MAP = auto()
    """The resulting image of the previous generation is used as the control map for the next generation."""

    IMAGE_TO_ALCHEMY_UPSCALE = auto()
    """The resulting image from image generation is used as the source for alchemy upscaling."""

    IMAGE_TO_ALCHEMY_FACEFIX = auto()
    """The resulting image from image generation is used as the source for alchemy face fixing."""

    ALCHEMY_TO_ALCHEMY = auto()
    """The resulting image from one alchemy operation is used as the source for another alchemy operation."""

    TEXT_TO_IMAGE_PROMPT = auto()
    """The resulting text from text generation is used as the prompt for image generation."""

CUSTOM class-attribute instance-attribute 

CUSTOM = auto()

A custom chain edge.

SAME_GENERATION class-attribute instance-attribute 

SAME_GENERATION = auto()

The same generation object flows from one stage to the next within a single unit of work.

RESULTING_IMAGE_AS_SOURCE class-attribute instance-attribute 

RESULTING_IMAGE_AS_SOURCE = auto()

The resulting image of the previous generation is used as the source for the next generation.

RESULTING_TEXT_AS_PROMPT class-attribute instance-attribute 

RESULTING_TEXT_AS_PROMPT = auto()

The resulting text of the previous generation is used as the prompt for the next generation.

RESULTING_IMAGE_AS_MASK class-attribute instance-attribute 

RESULTING_IMAGE_AS_MASK = auto()

The resulting image of the previous generation is used as the mask for the next generation.

RESULTING_IMAGE_AS_CONTROL_MAP class-attribute instance-attribute 

RESULTING_IMAGE_AS_CONTROL_MAP = auto()

The resulting image of the previous generation is used as the control map for the next generation.

IMAGE_TO_ALCHEMY_UPSCALE class-attribute instance-attribute 

IMAGE_TO_ALCHEMY_UPSCALE = auto()

The resulting image from image generation is used as the source for alchemy upscaling.

IMAGE_TO_ALCHEMY_FACEFIX class-attribute instance-attribute 

IMAGE_TO_ALCHEMY_FACEFIX = auto()

The resulting image from image generation is used as the source for alchemy face fixing.

ALCHEMY_TO_ALCHEMY class-attribute instance-attribute 

ALCHEMY_TO_ALCHEMY = auto()

The resulting image from one alchemy operation is used as the source for another alchemy operation.

TEXT_TO_IMAGE_PROMPT class-attribute instance-attribute 

TEXT_TO_IMAGE_PROMPT = auto()

The resulting text from text generation is used as the prompt for image generation.