Skip to content

pop_strategy

AIHordeImageWorkerJobPopStrategy

Bases: JobPopStrategyGeneric[ImageSingleGeneration, ImageGenerationParameters]

Job pop strategy for AI Horde image worker jobs.

Source code in horde_sdk/worker/dispatch/ai_horde/pop_strategy.py 
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
class AIHordeImageWorkerJobPopStrategy(JobPopStrategyGeneric[ImageSingleGeneration, ImageGenerationParameters]):
    """Job pop strategy for AI Horde image worker jobs."""

    _image_worker_bridge_data: ImageWorkerBridgeData
    _bridge_agent_string: str = default_bridge_agent_string

    _sync_client_session: AIHordeAPIClientSession | None
    _async_client_session: AIHordeAPIAsyncClientSession | None

    _model_reference_manager: ModelReferenceManager

    def __init__(
        self,
        default_job_pop_time_spacing: float = JobPopStrategyGeneric._default_job_pop_time_spacing,
        *,
        image_worker_bridge_data: ImageWorkerBridgeData,
        bridge_agent_string: str = default_bridge_agent_string,
        sync_client_session: AIHordeAPIClientSession | None = None,
        async_client_session: AIHordeAPIAsyncClientSession | None = None,
        model_reference_manager: ModelReferenceManager,
    ) -> None:
        """Initialize the AI Horde image worker job pop strategy.

        Args:
            default_job_pop_time_spacing (float): Default minimum time spacing between job pops in seconds.
            image_worker_bridge_data (ImageWorkerBridgeData): The bridge data for the image worker.
            bridge_agent_string (str): The bridge agent string to use for the worker.
            sync_client_session (AIHordeAPIClientSession | None): Optional synchronous client session for API calls.
            async_client_session (AIHordeAPIAsyncClientSession | None): Optional asynchronous client session for API
                calls.
            model_reference_manager (ModelReferenceManager): The model reference manager for handling model references.
        """
        super().__init__(default_job_pop_time_spacing)

        self._bridge_agent_string = bridge_agent_string

        self._image_worker_bridge_data = image_worker_bridge_data

        self._sync_client_session = sync_client_session
        self._async_client_session = async_client_session

        self._model_reference_manager = model_reference_manager

    @override
    def get_worker_type(self) -> WORKER_TYPE:
        return WORKER_TYPE.image

    @override
    def get_dispatch_source(self) -> KNOWN_DISPATCH_SOURCE:
        return KNOWN_DISPATCH_SOURCE.AI_HORDE_API_OFFICIAL

    @override
    def pop_job(self) -> ImageWorkerJob | None:
        if self._sync_client_session is None:
            raise ValueError("Synchronous client session is not available.")

        job_pop_request = ImageGenerateJobPopRequest(
            apikey=self._image_worker_bridge_data.api_key,
            name=self._image_worker_bridge_data.dreamer_worker_name,
            models=self._image_worker_bridge_data.image_models_to_load,
            max_pixels=self._image_worker_bridge_data.max_pixels,
            bridge_agent=self._bridge_agent_string,
            blacklist=self._image_worker_bridge_data.blacklist,
            nsfw=self._image_worker_bridge_data.nsfw,
            threads=self._image_worker_bridge_data.max_threads,
            require_upfront_kudos=self._image_worker_bridge_data.require_upfront_kudos,
            allow_img2img=self._image_worker_bridge_data.allow_img2img,
            allow_painting=self._image_worker_bridge_data.allow_inpainting,
            allow_unsafe_ipaddr=self._image_worker_bridge_data.allow_unsafe_ip,
            allow_post_processing=self._image_worker_bridge_data.allow_post_processing,
            allow_controlnet=self._image_worker_bridge_data.allow_controlnet,
            allow_sdxl_controlnet=self._image_worker_bridge_data.allow_sdxl_controlnet,
            extra_slow_worker=self._image_worker_bridge_data.extra_slow_worker,
            limit_max_steps=self._image_worker_bridge_data.limit_max_steps,
            allow_lora=self._image_worker_bridge_data.allow_lora,
            amount=self._image_worker_bridge_data.max_batch,
        )

        job_pop_response = self._sync_client_session.submit_request(
            job_pop_request,
            ImageGenerateJobPopResponse,
        )

        if isinstance(job_pop_response, RequestErrorResponse):
            print(f"Error popping job: {job_pop_response.message}")
            return None

        generation, ai_horde_dispatch_parameters = convert_image_job_pop_response_to_parameters(
            api_response=job_pop_response,
            model_reference_manager=self._model_reference_manager,
        )

        raise NotImplementedError("Conversion from job pop response to parameters is not implemented.")  # FIXME

        return ImageWorkerJob(
            generation=generation,
            ai_horde_dispatch_parameters=ai_horde_dispatch_parameters,
        )

    @override
    async def async_pop_job(self) -> ImageWorkerJob | None:
        pass

__init__ 

__init__(
    default_job_pop_time_spacing: float = JobPopStrategyGeneric._default_job_pop_time_spacing,
    *,
    image_worker_bridge_data: ImageWorkerBridgeData,
    bridge_agent_string: str = default_bridge_agent_string,
    sync_client_session: (
        AIHordeAPIClientSession | None
    ) = None,
    async_client_session: (
        AIHordeAPIAsyncClientSession | None
    ) = None,
    model_reference_manager: ModelReferenceManager
) -> None

Initialize the AI Horde image worker job pop strategy.

Parameters:

  • default_job_pop_time_spacing (float, default: _default_job_pop_time_spacing ) –

    Default minimum time spacing between job pops in seconds.

  • image_worker_bridge_data (ImageWorkerBridgeData) –

    The bridge data for the image worker.

  • bridge_agent_string (str, default: default_bridge_agent_string ) –

    The bridge agent string to use for the worker.

  • sync_client_session (AIHordeAPIClientSession | None, default: None ) –

    Optional synchronous client session for API calls.

  • async_client_session (AIHordeAPIAsyncClientSession | None, default: None ) –

    Optional asynchronous client session for API calls.

  • model_reference_manager (ModelReferenceManager) –

    The model reference manager for handling model references.

Source code in horde_sdk/worker/dispatch/ai_horde/pop_strategy.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def __init__(
    self,
    default_job_pop_time_spacing: float = JobPopStrategyGeneric._default_job_pop_time_spacing,
    *,
    image_worker_bridge_data: ImageWorkerBridgeData,
    bridge_agent_string: str = default_bridge_agent_string,
    sync_client_session: AIHordeAPIClientSession | None = None,
    async_client_session: AIHordeAPIAsyncClientSession | None = None,
    model_reference_manager: ModelReferenceManager,
) -> None:
    """Initialize the AI Horde image worker job pop strategy.

    Args:
        default_job_pop_time_spacing (float): Default minimum time spacing between job pops in seconds.
        image_worker_bridge_data (ImageWorkerBridgeData): The bridge data for the image worker.
        bridge_agent_string (str): The bridge agent string to use for the worker.
        sync_client_session (AIHordeAPIClientSession | None): Optional synchronous client session for API calls.
        async_client_session (AIHordeAPIAsyncClientSession | None): Optional asynchronous client session for API
            calls.
        model_reference_manager (ModelReferenceManager): The model reference manager for handling model references.
    """
    super().__init__(default_job_pop_time_spacing)

    self._bridge_agent_string = bridge_agent_string

    self._image_worker_bridge_data = image_worker_bridge_data

    self._sync_client_session = sync_client_session
    self._async_client_session = async_client_session

    self._model_reference_manager = model_reference_manager

get_worker_type 

get_worker_type() -> WORKER_TYPE
Source code in horde_sdk/worker/dispatch/ai_horde/pop_strategy.py 
63
64
65
@override
def get_worker_type(self) -> WORKER_TYPE:
    return WORKER_TYPE.image

get_dispatch_source 

get_dispatch_source() -> KNOWN_DISPATCH_SOURCE
Source code in horde_sdk/worker/dispatch/ai_horde/pop_strategy.py 
67
68
69
@override
def get_dispatch_source(self) -> KNOWN_DISPATCH_SOURCE:
    return KNOWN_DISPATCH_SOURCE.AI_HORDE_API_OFFICIAL

pop_job 

pop_job() -> ImageWorkerJob | None
Source code in horde_sdk/worker/dispatch/ai_horde/pop_strategy.py 
 71
 72
 73
 74
 75
 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
108
109
110
111
112
113
114
115
116
117
@override
def pop_job(self) -> ImageWorkerJob | None:
    if self._sync_client_session is None:
        raise ValueError("Synchronous client session is not available.")

    job_pop_request = ImageGenerateJobPopRequest(
        apikey=self._image_worker_bridge_data.api_key,
        name=self._image_worker_bridge_data.dreamer_worker_name,
        models=self._image_worker_bridge_data.image_models_to_load,
        max_pixels=self._image_worker_bridge_data.max_pixels,
        bridge_agent=self._bridge_agent_string,
        blacklist=self._image_worker_bridge_data.blacklist,
        nsfw=self._image_worker_bridge_data.nsfw,
        threads=self._image_worker_bridge_data.max_threads,
        require_upfront_kudos=self._image_worker_bridge_data.require_upfront_kudos,
        allow_img2img=self._image_worker_bridge_data.allow_img2img,
        allow_painting=self._image_worker_bridge_data.allow_inpainting,
        allow_unsafe_ipaddr=self._image_worker_bridge_data.allow_unsafe_ip,
        allow_post_processing=self._image_worker_bridge_data.allow_post_processing,
        allow_controlnet=self._image_worker_bridge_data.allow_controlnet,
        allow_sdxl_controlnet=self._image_worker_bridge_data.allow_sdxl_controlnet,
        extra_slow_worker=self._image_worker_bridge_data.extra_slow_worker,
        limit_max_steps=self._image_worker_bridge_data.limit_max_steps,
        allow_lora=self._image_worker_bridge_data.allow_lora,
        amount=self._image_worker_bridge_data.max_batch,
    )

    job_pop_response = self._sync_client_session.submit_request(
        job_pop_request,
        ImageGenerateJobPopResponse,
    )

    if isinstance(job_pop_response, RequestErrorResponse):
        print(f"Error popping job: {job_pop_response.message}")
        return None

    generation, ai_horde_dispatch_parameters = convert_image_job_pop_response_to_parameters(
        api_response=job_pop_response,
        model_reference_manager=self._model_reference_manager,
    )

    raise NotImplementedError("Conversion from job pop response to parameters is not implemented.")  # FIXME

    return ImageWorkerJob(
        generation=generation,
        ai_horde_dispatch_parameters=ai_horde_dispatch_parameters,
    )

async_pop_job async 

async_pop_job() -> ImageWorkerJob | None
Source code in horde_sdk/worker/dispatch/ai_horde/pop_strategy.py 
119
120
121
@override
async def async_pop_job(self) -> ImageWorkerJob | None:
    pass