Skip to content

base

Contains the class bases that encapsulate the parameters for the dispatching of a task to a worker.

This includes meta-parameters that are API-specific (ids), pertain to API expectations (time to live, etc), or otherwise required for the worker to complete the task (such as r2 upload URLs).

DispatchParameterBase

Bases: BaseModel

Base class for all dispatch parameter sets.

Source code in horde_sdk/worker/dispatch/base.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class DispatchParameterBase(BaseModel):
    """Base class for all dispatch parameter sets."""

    generation_ids: list[Any]
    """The identifiers for this generation. The request is expected to yield as many results as there are IDs."""

    dispatch_source: KNOWN_DISPATCH_SOURCE | str = KNOWN_DISPATCH_SOURCE.LOCAL_CUSTOM_3RD_PARTY
    """The source of the dispatch request. Defaults to KNOWN_DISPATCH_SOURCE.LOCAL_CUSTOM_3RD_PARTY."""

    ttl: int | None = None
    """The amount of seconds before this job is considered stale and aborted on the server. Defaults to None."""

    inference_backend: KNOWN_INFERENCE_BACKEND | str | None = None
    """The inference backend to use for this job. Defaults to None."""

    requested_backend_constraints: REQUESTED_BACKEND_CONSTRAINTS | str = REQUESTED_BACKEND_CONSTRAINTS.ANY
    """User/server request constraints on which backend to use. Defaults to REQUESTED_BACKEND_CONSTRAINTS.ANY."""

generation_ids instance-attribute 

generation_ids: list[Any]

The identifiers for this generation. The request is expected to yield as many results as there are IDs.

dispatch_source class-attribute instance-attribute 

dispatch_source: KNOWN_DISPATCH_SOURCE | str = (
    LOCAL_CUSTOM_3RD_PARTY
)

The source of the dispatch request. Defaults to KNOWN_DISPATCH_SOURCE.LOCAL_CUSTOM_3RD_PARTY.

ttl class-attribute instance-attribute 

ttl: int | None = None

The amount of seconds before this job is considered stale and aborted on the server. Defaults to None.

inference_backend class-attribute instance-attribute 

inference_backend: KNOWN_INFERENCE_BACKEND | str | None = (
    None
)

The inference backend to use for this job. Defaults to None.

requested_backend_constraints class-attribute instance-attribute 

requested_backend_constraints: (
    REQUESTED_BACKEND_CONSTRAINTS | str
) = ANY

User/server request constraints on which backend to use. Defaults to REQUESTED_BACKEND_CONSTRAINTS.ANY.