mirror of https://github.com/HazyResearch/manifest
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
101 lines
2.6 KiB
Python
101 lines
2.6 KiB
Python
"""Client class."""
|
|
from abc import ABC, abstractmethod
|
|
from typing import Any, Callable, Dict, List, Optional, Tuple
|
|
|
|
|
|
class Client(ABC):
|
|
"""Client class."""
|
|
|
|
def __init__(
|
|
self, connection_str: Optional[str] = None, client_args: Dict[str, Any] = {}
|
|
):
|
|
"""
|
|
Initialize client.
|
|
|
|
kwargs are passed to client as default parameters.
|
|
|
|
For clients like OpenAI that do not require a connection,
|
|
the connection_str can be None.
|
|
|
|
Args:
|
|
connection_str: connection string for client.
|
|
client_args: client arguments.
|
|
"""
|
|
self.connect(connection_str, client_args)
|
|
|
|
@abstractmethod
|
|
def close(self) -> None:
|
|
"""Close the client."""
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_model_params(self) -> Dict:
|
|
"""
|
|
Get model params.
|
|
|
|
By getting model params from the server, we can add to request
|
|
and make sure cache keys are unique to model.
|
|
|
|
Returns:
|
|
model params.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_model_inputs(self) -> List:
|
|
"""
|
|
Get allowable model inputs.
|
|
|
|
Returns:
|
|
model inputs.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def connect(self, connection_str: str, client_args: Dict[str, Any]) -> None:
|
|
"""
|
|
Connect to client.
|
|
|
|
Args:
|
|
connection_str: connection string.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_request(
|
|
self, query: str, request_args: Dict[str, Any] = {}
|
|
) -> Tuple[Callable[[], Dict], Dict]:
|
|
"""
|
|
Get request function.
|
|
|
|
kwargs override default parameters.
|
|
|
|
Calling the returned function will run the request.
|
|
|
|
Args:
|
|
query: query string.
|
|
request_args: request arguments.
|
|
|
|
Returns:
|
|
request function that takes no input.
|
|
request parameters as dict.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_choice_logit_request(
|
|
self, query: str, gold_choices: List[str], request_args: Dict[str, Any] = {}
|
|
) -> Tuple[Callable[[], Dict], Dict]:
|
|
"""
|
|
Get request string function for choosing max choices.
|
|
|
|
Args:
|
|
query: query string.
|
|
gold_choices: choices for model to choose from via max logits.
|
|
|
|
Returns:
|
|
request function that takes no input.
|
|
request parameters as dict.
|
|
"""
|
|
raise NotImplementedError()
|