Skip to content

consts

UNDERLYING_GENERATION_SCHEME

Bases: StrEnum

The underlying method the generation uses to produce results.

In the case that an outside service is used to produce results, this should be set to MODEL_FROM_SERVICE. This is to prevent potential confusion by identifying a service name as the "model".

Most generative AI is model-based, but certain alchemy or other operations may not have a traditional model and instead use alternative methods and in this case you can use NON_MODEL_ALGORITHM to indicate that.

Source code in horde_sdk/generation_parameters/generic/consts.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
class UNDERLYING_GENERATION_SCHEME(StrEnum):
    """The underlying method the generation uses to produce results.

    In the case that an outside service is used to produce results, this should be set to `MODEL_FROM_SERVICE`.
    This is to prevent potential confusion by identifying a service name as the "model".

    Most generative AI is model-based, but certain alchemy or other operations may not have a traditional model
    and instead use alternative methods and in this case you can use `NON_MODEL_ALGORITHM` to indicate that.
    """

    MODEL = auto()

    MODEL_FROM_SERVICE = auto()

    NON_MODEL_ALGORITHM = auto()

MODEL class-attribute instance-attribute 

MODEL = auto()

MODEL_FROM_SERVICE class-attribute instance-attribute 

MODEL_FROM_SERVICE = auto()

NON_MODEL_ALGORITHM class-attribute instance-attribute 

NON_MODEL_ALGORITHM = auto()

KNOWN_AUX_MODEL_SOURCE

Bases: StrEnum

The known sources of an auxiliary model (aux models are LoRas, TIs, etc).

Source code in horde_sdk/generation_parameters/generic/consts.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class KNOWN_AUX_MODEL_SOURCE(StrEnum):
    """The known sources of an auxiliary model (aux models are LoRas, TIs, etc)."""

    LOCAL = auto()
    """The aux model is worker-provided on their local machine."""

    CIVITAI = auto()
    """The aux model is provided by CivitAI."""

    HORDELING = auto()
    """The aux model is provided by the AI-Horde hordeling service."""

    def map_to_known_service(self) -> KNOWN_SERVICE:
        """Map the aux model source to a known service."""
        if self == KNOWN_AUX_MODEL_SOURCE.CIVITAI:
            return KNOWN_SERVICE.CIVITAI
        if self == KNOWN_AUX_MODEL_SOURCE.HORDELING:
            return KNOWN_SERVICE.AI_HORDE
        return KNOWN_SERVICE.UNKNOWN

LOCAL class-attribute instance-attribute 

LOCAL = auto()

The aux model is worker-provided on their local machine.

CIVITAI class-attribute instance-attribute 

CIVITAI = auto()

The aux model is provided by CivitAI.

HORDELING class-attribute instance-attribute 

HORDELING = auto()

The aux model is provided by the AI-Horde hordeling service.

map_to_known_service 

map_to_known_service() -> KNOWN_SERVICE

Map the aux model source to a known service.

Source code in horde_sdk/generation_parameters/generic/consts.py 
37
38
39
40
41
42
43
def map_to_known_service(self) -> KNOWN_SERVICE:
    """Map the aux model source to a known service."""
    if self == KNOWN_AUX_MODEL_SOURCE.CIVITAI:
        return KNOWN_SERVICE.CIVITAI
    if self == KNOWN_AUX_MODEL_SOURCE.HORDELING:
        return KNOWN_SERVICE.AI_HORDE
    return KNOWN_SERVICE.UNKNOWN