|
| 1 | +from abc import ABC, abstractmethod |
| 2 | +from collections.abc import AsyncIterator |
| 3 | +from typing import ( |
| 4 | + Any, |
| 5 | + Generic, |
| 6 | + Literal, |
| 7 | + Optional, |
| 8 | + TypeVar, |
| 9 | +) |
| 10 | + |
| 11 | +from pydantic import Field |
| 12 | + |
| 13 | +from guidellm.objects import StandardBaseModel |
| 14 | +from guidellm.scheduler import ( |
| 15 | + RequestT, |
| 16 | + RequestTimingsT, |
| 17 | + ResponseT, |
| 18 | + ScheduledRequestInfo, |
| 19 | +) |
| 20 | + |
| 21 | + |
| 22 | +class BackendInterface(ABC, Generic[RequestT, RequestTimingsT, ResponseT]): |
| 23 | + """ |
| 24 | + Abstract interface for request processing backends. Note: before process_startup |
| 25 | + is invoked, the implementation must ensure all properties are pickleable. |
| 26 | + """ |
| 27 | + |
| 28 | + @property |
| 29 | + @abstractmethod |
| 30 | + def processes_limit(self) -> Optional[int]: |
| 31 | + """Maximum worker processes supported, or None if unlimited.""" |
| 32 | + |
| 33 | + @property |
| 34 | + @abstractmethod |
| 35 | + def requests_limit(self) -> Optional[int]: |
| 36 | + """Maximum concurrent requests supported, or None if unlimited.""" |
| 37 | + |
| 38 | + @abstractmethod |
| 39 | + def info(self) -> dict[str, Any]: |
| 40 | + """ |
| 41 | + :return: Backend metadata including model any initializaiton and |
| 42 | + configuration information. |
| 43 | + """ |
| 44 | + ... |
| 45 | + |
| 46 | + @abstractmethod |
| 47 | + async def process_startup(self) -> None: |
| 48 | + """ |
| 49 | + Perform backend initialization and startup procedures. |
| 50 | +
|
| 51 | + :raises: Implementation-specific exceptions for startup failures. |
| 52 | + """ |
| 53 | + |
| 54 | + @abstractmethod |
| 55 | + async def validate(self) -> None: |
| 56 | + """ |
| 57 | + Validate backend configuration and operational status. |
| 58 | +
|
| 59 | + :raises: Implementation-specific exceptions for validation failures. |
| 60 | + """ |
| 61 | + |
| 62 | + @abstractmethod |
| 63 | + async def process_shutdown(self) -> None: |
| 64 | + """ |
| 65 | + Perform backend cleanup and shutdown procedures. |
| 66 | +
|
| 67 | + :raises: Implementation-specific exceptions for shutdown failures. |
| 68 | + """ |
| 69 | + |
| 70 | + @abstractmethod |
| 71 | + async def resolve( |
| 72 | + self, |
| 73 | + request: RequestT, |
| 74 | + request_info: ScheduledRequestInfo[RequestTimingsT], |
| 75 | + history: Optional[list[tuple[RequestT, ResponseT]]] = None, |
| 76 | + ) -> AsyncIterator[tuple[ResponseT, ScheduledRequestInfo[RequestTimingsT]]]: |
| 77 | + """ |
| 78 | + Process a request and yield incremental response updates. |
| 79 | +
|
| 80 | + :param request: The request object to process. |
| 81 | + :param request_info: Scheduling metadata and timing information. |
| 82 | + :param history: Optional conversation history for multi-turn requests. |
| 83 | + :yield: Tuples of (response, updated_request_info) for each response chunk. |
| 84 | + :raises: Implementation-specific exceptions for processing failures. |
| 85 | + """ |
| 86 | + |
| 87 | + |
| 88 | +BackendT = TypeVar("BackendT", bound="BackendInterface") |
0 commit comments