Skip to content

horde_sdk.worker.generations

ImageGenerationInitKwargs

Bases: TypedDict

Optional keyword arguments accepted by ImageSingleGeneration from template helpers.

Source code in horde_sdk/worker/generations.py
class ImageGenerationInitKwargs(TypedDict, total=False):
    """Optional keyword arguments accepted by `ImageSingleGeneration` from template helpers."""

    generation_id: ID_TYPES | None
    dispatch_result_ids: Sequence[ID_TYPES] | None
    result_ids: list[ID_TYPES] | None
    requires_submit: bool
    safety_rules: SafetyRules
    black_box_mode: bool
    state_error_limits: Mapping[GENERATION_PROGRESS, int] | None
    strict_transition_mode: bool
    extra_logging: bool

generation_id instance-attribute

generation_id: ID_TYPES | None

dispatch_result_ids instance-attribute

dispatch_result_ids: Sequence[ID_TYPES] | None

result_ids instance-attribute

result_ids: list[ID_TYPES] | None

requires_submit instance-attribute

requires_submit: bool

safety_rules instance-attribute

safety_rules: SafetyRules

black_box_mode instance-attribute

black_box_mode: bool

state_error_limits instance-attribute

state_error_limits: Mapping[GENERATION_PROGRESS, int] | None

strict_transition_mode instance-attribute

strict_transition_mode: bool

extra_logging instance-attribute

extra_logging: bool

AlchemyGenerationInitKwargs

Bases: TypedDict

Optional keyword arguments accepted by AlchemySingleGeneration factory flows.

Source code in horde_sdk/worker/generations.py
class AlchemyGenerationInitKwargs(TypedDict, total=False):
    """Optional keyword arguments accepted by `AlchemySingleGeneration` factory flows."""

    generation_id: str | None
    dispatch_result_ids: Sequence[ID_TYPES] | None
    result_ids: list[ID_TYPES] | None
    requires_generation: bool
    requires_post_processing: bool
    requires_safety_check: bool
    requires_submit: bool
    safety_rules: SafetyRules
    black_box_mode: bool
    state_error_limits: Mapping[GENERATION_PROGRESS, int] | None
    strict_transition_mode: bool
    extra_logging: bool

generation_id instance-attribute

generation_id: str | None

dispatch_result_ids instance-attribute

dispatch_result_ids: Sequence[ID_TYPES] | None

result_ids instance-attribute

result_ids: list[ID_TYPES] | None

requires_generation instance-attribute

requires_generation: bool

requires_post_processing instance-attribute

requires_post_processing: bool

requires_safety_check instance-attribute

requires_safety_check: bool

requires_submit instance-attribute

requires_submit: bool

safety_rules instance-attribute

safety_rules: SafetyRules

black_box_mode instance-attribute

black_box_mode: bool

state_error_limits instance-attribute

state_error_limits: Mapping[GENERATION_PROGRESS, int] | None

strict_transition_mode instance-attribute

strict_transition_mode: bool

extra_logging instance-attribute

extra_logging: bool

TextGenerationInitKwargs

Bases: TypedDict

Optional keyword arguments accepted by TextSingleGeneration helpers.

Source code in horde_sdk/worker/generations.py
class TextGenerationInitKwargs(TypedDict, total=False):
    """Optional keyword arguments accepted by `TextSingleGeneration` helpers."""

    generation_id: ID_TYPES | None
    dispatch_result_ids: Sequence[ID_TYPES] | None
    result_ids: list[ID_TYPES] | None
    requires_post_processing: bool
    requires_safety_check: bool
    requires_submit: bool
    safety_rules: SafetyRules
    black_box_mode: bool
    state_error_limits: Mapping[GENERATION_PROGRESS, int] | None
    strict_transition_mode: bool
    extra_logging: bool

generation_id instance-attribute

generation_id: ID_TYPES | None

dispatch_result_ids instance-attribute

dispatch_result_ids: Sequence[ID_TYPES] | None

result_ids instance-attribute

result_ids: list[ID_TYPES] | None

requires_post_processing instance-attribute

requires_post_processing: bool

requires_safety_check instance-attribute

requires_safety_check: bool

requires_submit instance-attribute

requires_submit: bool

safety_rules instance-attribute

safety_rules: SafetyRules

black_box_mode instance-attribute

black_box_mode: bool

state_error_limits instance-attribute

state_error_limits: Mapping[GENERATION_PROGRESS, int] | None

strict_transition_mode instance-attribute

strict_transition_mode: bool

extra_logging instance-attribute

extra_logging: bool