From 9095a93cdf23f9310a4f3e94ce3100a0f2df6282 Mon Sep 17 00:00:00 2001 From: svlandeg Date: Thu, 31 Aug 2023 16:37:14 +0200 Subject: [PATCH] fix parameters for REST models --- website/docs/api/large-language-models.mdx | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/website/docs/api/large-language-models.mdx b/website/docs/api/large-language-models.mdx index 1627ca7dd..3fe455978 100644 --- a/website/docs/api/large-language-models.mdx +++ b/website/docs/api/large-language-models.mdx @@ -648,13 +648,14 @@ implementations can have other signatures, like These models all take the same parameters: -| Argument | Description | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | Model name, i. e. any supported variant for this particular model. Default depends on the specific model (cf. below) ~~str~~ | -| `config` | Further configuration passed on to the model. Defaults to `{}`. ~~Dict[Any, Any]~~ | -| `strict` | If `True`, raises an error if the LLM API returns a malformed response. Otherwise, return the error responses as is. Defaults to `True`. ~~bool~~ | -| `max_tries` | Max. number of tries for API request. Defaults to `3`. ~~int~~ | -| `timeout` | Timeout for API request in seconds. Defaults to `30`. ~~int~~ | +| Argument | Description | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | Model name, i. e. any supported variant for this particular model. Default depends on the specific model (cf. below) ~~str~~ | +| `config` | Further configuration passed on to the model. Defaults to `{}`. ~~Dict[Any, Any]~~ | +| `strict` | If `True`, raises an error if the LLM API returns a malformed response. Otherwise, return the error responses as is. Defaults to `True`. ~~bool~~ | +| `max_tries` | Max. number of tries for API request. Defaults to `5`. ~~int~~ | +| `max_request_time` | Max. time (in seconds) to wait for request to terminate before raising an exception. Defaults to `30.0`. ~~float~~ | +| `interval` | Time interval (in seconds) for API retries in seconds. Defaults to `1.0`. ~~float~~ | | Model | Provider | Supported names | Default name | | ----------------------------- | --------- | ------------------------------------------------------------------------------------ | -------------------- | @@ -690,7 +691,6 @@ keys as environment variables. > config = {"temperature": 0.0} > ``` - #### API Keys {id="api-keys"} Note that when using hosted services, you have to ensure that the proper API @@ -717,7 +717,6 @@ and for Anthropic export ANTHROPIC_API_KEY="..." ``` - ### Models via HuggingFace {id="models-hf"} These models all take the same parameters: @@ -743,7 +742,6 @@ can [define the cached directory](https://huggingface.co/docs/huggingface_hub/main/en/guides/manage-cache) by setting the environmental variable `HF_HOME`. - #### Installation with HuggingFace {id="install-hf"} To use models from HuggingFace, ideally you have a GPU enabled and have @@ -766,7 +764,6 @@ result in extremely slow queries. python -m pip install "accelerate>=0.16.0,<1.0" ``` - ### LangChain models {id="langchain-models"} To use [LangChain](https://github.com/hwchase17/langchain) for the API retrieval