hordelib

KNOWN_COMFYUI_IMAGE_SCHEDULERS module-attribute

KNOWN_COMFYUI_IMAGE_SCHEDULERS = KNOWN_IMAGE_SCHEDULERS

KNOWN_COMFYUI_CONTROLNETS module-attribute

KNOWN_COMFYUI_CONTROLNETS = KNOWN_IMAGE_CONTROLNETS

KNOWN_COMFYUI_IMAGE_SAMPLERS

Bases: StrEnum

The samplers that are known to the API.

(k_lms, k_heun, DDIM, etc)

Source code in horde_sdk/backend_parsing/image/comfyui/hordelib.py

class KNOWN_COMFYUI_IMAGE_SAMPLERS(StrEnum):
    """The samplers that are known to the API.

    (k_lms, k_heun, DDIM, etc)
    """

    euler = auto()
    euler_cfg_pp = auto()
    euler_ancestral = auto()
    euler_ancestral_cfg_pp = auto()
    heun = auto()
    heunpp2 = auto()
    dpm_2 = auto()
    dpm_2_ancestral = auto()
    lms = auto()
    dpm_fast = auto()
    dpm_adaptive = auto()
    dpmpp_2s_ancestral = auto()
    dpmpp_2s_ancestral_cfg_pp = auto()
    dpmpp_sde = auto()
    dpmpp_sde_gpu = auto()
    dpmpp_2m = auto()
    dpmpp_2m_cfg_pp = auto()
    dpmpp_2m_sde = auto()
    dpmpp_2m_sde_gpu = auto()
    dpmpp_3m_sde = auto()
    dpmpp_3m_sde_gpu = auto()
    ddpm = auto()
    lcm = auto()
    ipndm = auto()
    ipndm_v = auto()
    deis = auto()
    res_multistep = auto()
    res_multistep_cfg_pp = auto()
    res_multistep_ancestral = auto()
    res_multistep_ancestral_cfg_pp = auto()
    gradient_estimation = auto()

    ddim = auto()
    uni_pc = auto()
    uni_pc_bh2 = auto()

euler class-attribute instance-attribute

euler = auto()

euler_cfg_pp class-attribute instance-attribute

euler_cfg_pp = auto()

euler_ancestral class-attribute instance-attribute

euler_ancestral = auto()

euler_ancestral_cfg_pp class-attribute instance-attribute

euler_ancestral_cfg_pp = auto()

heun class-attribute instance-attribute

heun = auto()

heunpp2 class-attribute instance-attribute

heunpp2 = auto()

dpm_2 class-attribute instance-attribute

dpm_2 = auto()

dpm_2_ancestral class-attribute instance-attribute

dpm_2_ancestral = auto()

lms class-attribute instance-attribute

lms = auto()

dpm_fast class-attribute instance-attribute

dpm_fast = auto()

dpm_adaptive class-attribute instance-attribute

dpm_adaptive = auto()

dpmpp_2s_ancestral class-attribute instance-attribute

dpmpp_2s_ancestral = auto()

dpmpp_2s_ancestral_cfg_pp class-attribute instance-attribute

dpmpp_2s_ancestral_cfg_pp = auto()

dpmpp_sde class-attribute instance-attribute

dpmpp_sde = auto()

dpmpp_sde_gpu class-attribute instance-attribute

dpmpp_sde_gpu = auto()

dpmpp_2m class-attribute instance-attribute

dpmpp_2m = auto()

dpmpp_2m_cfg_pp class-attribute instance-attribute

dpmpp_2m_cfg_pp = auto()

dpmpp_2m_sde class-attribute instance-attribute

dpmpp_2m_sde = auto()

dpmpp_2m_sde_gpu class-attribute instance-attribute

dpmpp_2m_sde_gpu = auto()

dpmpp_3m_sde class-attribute instance-attribute

dpmpp_3m_sde = auto()

dpmpp_3m_sde_gpu class-attribute instance-attribute

dpmpp_3m_sde_gpu = auto()

ddpm class-attribute instance-attribute

ddpm = auto()

lcm class-attribute instance-attribute

lcm = auto()

ipndm class-attribute instance-attribute

ipndm = auto()

ipndm_v class-attribute instance-attribute

ipndm_v = auto()

deis class-attribute instance-attribute

deis = auto()

res_multistep class-attribute instance-attribute

res_multistep = auto()

res_multistep_cfg_pp class-attribute instance-attribute

res_multistep_cfg_pp = auto()

res_multistep_ancestral class-attribute instance-attribute

res_multistep_ancestral = auto()

res_multistep_ancestral_cfg_pp class-attribute instance-attribute

res_multistep_ancestral_cfg_pp = auto()

gradient_estimation class-attribute instance-attribute

gradient_estimation = auto()

ddim class-attribute instance-attribute

ddim = auto()

uni_pc class-attribute instance-attribute

uni_pc = auto()

uni_pc_bh2 class-attribute instance-attribute

uni_pc_bh2 = auto()

ComfyUIBackendValuesMapper

Bases: ImageBackendValuesMapper[KNOWN_COMFYUI_IMAGE_SAMPLERS, KNOWN_COMFYUI_IMAGE_SCHEDULERS, KNOWN_COMFYUI_CONTROLNETS]

Mapper for ComfyUI backend values.

Source code in horde_sdk/backend_parsing/image/comfyui/hordelib.py

class ComfyUIBackendValuesMapper(
    ImageBackendValuesMapper[
        KNOWN_COMFYUI_IMAGE_SAMPLERS,
        KNOWN_COMFYUI_IMAGE_SCHEDULERS,
        KNOWN_COMFYUI_CONTROLNETS,
    ],
):
    """Mapper for ComfyUI backend values."""

    _COMFYUI_SAMPLERS_CONVERT_MAP: ClassVar[dict[KNOWN_COMFYUI_IMAGE_SAMPLERS | str, KNOWN_IMAGE_SAMPLERS]] = {
        KNOWN_COMFYUI_IMAGE_SAMPLERS.euler: KNOWN_IMAGE_SAMPLERS.k_euler,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.euler_ancestral: KNOWN_IMAGE_SAMPLERS.k_euler_a,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.heun: KNOWN_IMAGE_SAMPLERS.k_heun,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.dpm_2: KNOWN_IMAGE_SAMPLERS.k_dpm_2,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.dpm_2_ancestral: KNOWN_IMAGE_SAMPLERS.k_dpm_2_a,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.lms: KNOWN_IMAGE_SAMPLERS.k_lms,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.dpm_fast: KNOWN_IMAGE_SAMPLERS.k_dpm_fast,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.dpm_adaptive: KNOWN_IMAGE_SAMPLERS.k_dpm_adaptive,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.dpmpp_2s_ancestral: KNOWN_IMAGE_SAMPLERS.k_dpmpp_2s_a,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.dpmpp_sde: KNOWN_IMAGE_SAMPLERS.k_dpmpp_sde,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.dpmpp_2m: KNOWN_IMAGE_SAMPLERS.k_dpmpp_2m,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.ddim: KNOWN_IMAGE_SAMPLERS.DDIM,
        KNOWN_COMFYUI_IMAGE_SAMPLERS.lcm: KNOWN_IMAGE_SAMPLERS.lcm,
    }

    def __init__(self) -> None:
        """Initialize the ComfyUI backend values mapper."""
        super().__init__(
            backend_samplers_type=KNOWN_COMFYUI_IMAGE_SAMPLERS,
            backend_schedulers_type=KNOWN_COMFYUI_IMAGE_SCHEDULERS,
            backend_controlnets_type=KNOWN_COMFYUI_CONTROLNETS,
            sdk_samplers_map=self._COMFYUI_SAMPLERS_CONVERT_MAP,
            sdk_schedulers_map={},
            sdk_controlnets_map={},
        )

__init__

__init__() -> None

Initialize the ComfyUI backend values mapper.

Source code in horde_sdk/backend_parsing/image/comfyui/hordelib.py

def __init__(self) -> None:
    """Initialize the ComfyUI backend values mapper."""
    super().__init__(
        backend_samplers_type=KNOWN_COMFYUI_IMAGE_SAMPLERS,
        backend_schedulers_type=KNOWN_COMFYUI_IMAGE_SCHEDULERS,
        backend_controlnets_type=KNOWN_COMFYUI_CONTROLNETS,
        sdk_samplers_map=self._COMFYUI_SAMPLERS_CONVERT_MAP,
        sdk_schedulers_map={},
        sdk_controlnets_map={},
    )

map_to_sdk_sampler

map_to_sdk_sampler(
    backend_sampler: BackendSamplersTypeVar | str,
) -> KNOWN_IMAGE_SAMPLERS

Map a backend sampler to a SDK sampler.

Source code in horde_sdk/backend_parsing/object_models.py

def map_to_sdk_sampler(
    self,
    backend_sampler: BackendSamplersTypeVar | str,
) -> KNOWN_IMAGE_SAMPLERS:
    """Map a backend sampler to a SDK sampler."""
    return self._map_value(
        value=backend_sampler,
        mapping=self._to_sdk_sampler_map,
        known_input_type=self._backend_samplers_type,
        known_target_type=KNOWN_IMAGE_SAMPLERS,
    )

map_to_backend_sampler

map_to_backend_sampler(
    sdk_sampler: KNOWN_IMAGE_SAMPLERS | str,
) -> BackendSamplersTypeVar | str

Map a SDK sampler to a backend sampler.

Source code in horde_sdk/backend_parsing/object_models.py

def map_to_backend_sampler(
    self,
    sdk_sampler: KNOWN_IMAGE_SAMPLERS | str,
) -> BackendSamplersTypeVar | str:
    """Map a SDK sampler to a backend sampler."""
    return self._map_value(
        value=sdk_sampler,
        mapping=self._to_backend_sampler_map,
        known_input_type=KNOWN_IMAGE_SAMPLERS,
        known_target_type=self._backend_samplers_type,
    )

is_valid_backend_sampler

is_valid_backend_sampler(
    backend_sampler: BackendSamplersTypeVar | str,
) -> bool

Check if a backend sampler is valid.

Source code in horde_sdk/backend_parsing/object_models.py

def is_valid_backend_sampler(
    self,
    backend_sampler: BackendSamplersTypeVar | str,
) -> bool:
    """Check if a backend sampler is valid."""
    return self._is_valid_value(
        value=backend_sampler,
        known_type=self._backend_samplers_type,
    )

map_to_sdk_scheduler

map_to_sdk_scheduler(
    backend_scheduler: BackendSchedulersTypeVar | str,
) -> KNOWN_IMAGE_SCHEDULERS

Map a backend scheduler to a SDK scheduler.

Source code in horde_sdk/backend_parsing/object_models.py

def map_to_sdk_scheduler(
    self,
    backend_scheduler: BackendSchedulersTypeVar | str,
) -> KNOWN_IMAGE_SCHEDULERS:
    """Map a backend scheduler to a SDK scheduler."""
    return self._map_value(
        value=backend_scheduler,
        mapping=self._to_sdk_scheduler_map,
        known_input_type=self._backend_schedulers_type,
        known_target_type=KNOWN_IMAGE_SCHEDULERS,
    )

map_to_backend_scheduler

map_to_backend_scheduler(
    sdk_scheduler: KNOWN_IMAGE_SCHEDULERS | str,
) -> BackendSchedulersTypeVar | str

Map a SDK scheduler to a backend scheduler.

Source code in horde_sdk/backend_parsing/object_models.py

def map_to_backend_scheduler(
    self,
    sdk_scheduler: KNOWN_IMAGE_SCHEDULERS | str,
) -> BackendSchedulersTypeVar | str:
    """Map a SDK scheduler to a backend scheduler."""
    return self._map_value(
        value=sdk_scheduler,
        mapping=self._to_backend_scheduler_map,
        known_input_type=KNOWN_IMAGE_SCHEDULERS,
        known_target_type=self._backend_schedulers_type,
    )

is_valid_backend_scheduler

is_valid_backend_scheduler(
    backend_scheduler: BackendSchedulersTypeVar | str,
) -> bool

Check if a backend scheduler is valid.

Source code in horde_sdk/backend_parsing/object_models.py

def is_valid_backend_scheduler(
    self,
    backend_scheduler: BackendSchedulersTypeVar | str,
) -> bool:
    """Check if a backend scheduler is valid."""
    return self._is_valid_value(
        value=backend_scheduler,
        known_type=self._backend_schedulers_type,
    )

map_to_sdk_controlnet

map_to_sdk_controlnet(
    backend_controlnet: BackendControlnetsTypeVar | str,
) -> KNOWN_IMAGE_CONTROLNETS

Map a backend controlnet to a SDK controlnet.

Source code in horde_sdk/backend_parsing/object_models.py

def map_to_sdk_controlnet(
    self,
    backend_controlnet: BackendControlnetsTypeVar | str,
) -> KNOWN_IMAGE_CONTROLNETS:
    """Map a backend controlnet to a SDK controlnet."""
    return self._map_value(
        value=backend_controlnet,
        mapping=self._to_sdk_controlnet_map,
        known_input_type=self._backend_controlnets,
        known_target_type=KNOWN_IMAGE_CONTROLNETS,
    )

map_to_backend_controlnet

map_to_backend_controlnet(
    sdk_controlnet: KNOWN_IMAGE_CONTROLNETS | str,
) -> BackendControlnetsTypeVar | str

Map a SDK controlnet to a backend controlnet.

Source code in horde_sdk/backend_parsing/object_models.py

def map_to_backend_controlnet(
    self,
    sdk_controlnet: KNOWN_IMAGE_CONTROLNETS | str,
) -> BackendControlnetsTypeVar | str:
    """Map a SDK controlnet to a backend controlnet."""
    return self._map_value(
        value=sdk_controlnet,
        mapping=self._to_backend_controlnet_map,
        known_input_type=KNOWN_IMAGE_CONTROLNETS,
        known_target_type=self._backend_controlnets,
    )

is_valid_backend_controlnet

is_valid_backend_controlnet(
    backend_controlnet: BackendControlnetsTypeVar | str,
) -> bool

Check if a backend controlnet is valid.

Source code in horde_sdk/backend_parsing/object_models.py

def is_valid_backend_controlnet(
    self,
    backend_controlnet: BackendControlnetsTypeVar | str,
) -> bool:
    """Check if a backend controlnet is valid."""
    return self._is_valid_value(
        value=backend_controlnet,
        known_type=self._backend_controlnets,
    )