Skip to content

The agent engineering platform.

community: Fix a bug in handling kwargs overwrites in Predibase integration, and update the documentation. (#25893)

Alex Sherstinsky617a4e617b1c
diff --git a/docs/docs/integrations/llms/predibase.ipynb b/docs/docs/integrations/llms/predibase.ipynb
index 82ffeddda1..5c352792be 100644
--- a/docs/docs/integrations/llms/predibase.ipynb
+++ b/docs/docs/integrations/llms/predibase.ipynb
@@ -70,6 +70,10 @@
" predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)\n",
" adapter_id=\"e2e_nlg\",\n",
" adapter_version=1,\n",
+ " **{\n",
+ " \"api_token\": os.environ.get(\"HUGGING_FACE_HUB_TOKEN\"),\n",
+ " \"max_new_tokens\": 5, # default is 256\n",
+ " },\n",
")"
]
},
@@ -87,6 +91,10 @@
" predibase_api_key=os.environ.get(\"PREDIBASE_API_TOKEN\"),\n",
" predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)\n",
" adapter_id=\"predibase/e2e_nlg\",\n",
+ " **{\n",
+ " \"api_token\": os.environ.get(\"HUGGING_FACE_HUB_TOKEN\"),\n",
+ " \"max_new_tokens\": 5, # default is 256\n",
+ " },\n",
")"
]
},
@@ -96,7 +104,11 @@
"metadata": {},
"outputs": [],
"source": [
- "response = model.invoke(\"Can you recommend me a nice dry wine?\")\n",
+ "# Optionally use `kwargs` to dynamically overwrite \"generate()\" settings.\n",
+ "response = model.invoke(\n",
+ " \"Can you recommend me a nice dry wine?\",\n",
+ " **{\"temperature\": 0.5, \"max_new_tokens\": 1024},\n",
+ ")\n",
"print(response)"
]
},
@@ -127,6 +139,10 @@
" model=\"mistral-7b\",\n",
" predibase_api_key=os.environ.get(\"PREDIBASE_API_TOKEN\"),\n",
" predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)\n",
+ " **{\n",
+ " \"api_token\": os.environ.get(\"HUGGING_FACE_HUB_TOKEN\"),\n",
+ " \"max_new_tokens\": 5, # default is 256\n",
+ " },\n",
")"
]
},
@@ -147,6 +163,10 @@
" predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)\n",
" adapter_id=\"e2e_nlg\",\n",
" adapter_version=1,\n",
+ " **{\n",
+ " \"api_token\": os.environ.get(\"HUGGING_FACE_HUB_TOKEN\"),\n",
+ " \"max_new_tokens\": 5, # default is 256\n",
+ " },\n",
")"
]
},
@@ -162,6 +182,10 @@
" predibase_api_key=os.environ.get(\"PREDIBASE_API_TOKEN\"),\n",
" predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)\n",
" adapter_id=\"predibase/e2e_nlg\",\n",
+ " **{\n",
+ " \"api_token\": os.environ.get(\"HUGGING_FACE_HUB_TOKEN\"),\n",
+ " \"max_new_tokens\": 5, # default is 256\n",
+ " },\n",
")"
]
},
@@ -259,6 +283,10 @@
" predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)\n",
" adapter_id=\"my-finetuned-adapter-id\", # Supports both, Predibase-hosted and HuggingFace-hosted adapter repositories.\n",
" adapter_version=1, # required for Predibase-hosted adapters (ignored for HuggingFace-hosted adapters)\n",
+ " **{\n",
+ " \"api_token\": os.environ.get(\"HUGGING_FACE_HUB_TOKEN\"),\n",
+ " \"max_new_tokens\": 5, # default is 256\n",
+ " },\n",
")\n",
"# replace my-base-LLM with the name of your choice of a serverless base model in Predibase"
]
@@ -269,7 +297,8 @@
"metadata": {},
"outputs": [],
"source": [
- "# response = model.invoke(\"Can you help categorize the following emails into positive, negative, and neutral?\")"
+ "# Optionally use `kwargs` to dynamically overwrite \"generate()\" settings.\n",
+ "# response = model.invoke(\"Can you help categorize the following emails into positive, negative, and neutral?\", **{\"temperature\": 0.5, \"max_new_tokens\": 1024})"
]
}
],
diff --git a/docs/docs/integrations/providers/predibase.md b/docs/docs/integrations/providers/predibase.md
index 7ba380d133..dba020c883 100644
--- a/docs/docs/integrations/providers/predibase.md
+++ b/docs/docs/integrations/providers/predibase.md
@@ -21,9 +21,24 @@ model = Predibase(
model="mistral-7b",
predibase_api_key=os.environ.get("PREDIBASE_API_TOKEN"),
predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)
+ """
+ Optionally use `model_kwargs` to set new default "generate()" settings. For example:
+ {
+ "api_token": os.environ.get("HUGGING_FACE_HUB_TOKEN"),
+ "max_new_tokens": 5, # default is 256
+ }
+ """
+ **model_kwargs,
)
-response = model.invoke("Can you recommend me a nice dry wine?")
+"""
+Optionally use `kwargs` to dynamically overwrite "generate()" settings. For example:
+{
+ "temperature": 0.5, # default is the value in model_kwargs or 0.1 (initialization default)
+ "max_new_tokens": 1024, # default is the value in model_kwargs or 256 (initialization default)
+}
+"""
+response = model.invoke("Can you recommend me a nice dry wine?", **kwargs)
print(response)
```
@@ -42,9 +57,24 @@ model = Predibase(
predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)
adapter_id="e2e_nlg",
adapter_version=1,
+ """
+ Optionally use `model_kwargs` to set new default "generate()" settings. For example:
+ {
+ "api_token": os.environ.get("HUGGING_FACE_HUB_TOKEN"),
+ "max_new_tokens": 5, # default is 256
+ }
+ """
+ **model_kwargs,
)
-response = model.invoke("Can you recommend me a nice dry wine?")
+"""
+Optionally use `kwargs` to dynamically overwrite "generate()" settings. For example:
+{
+ "temperature": 0.5, # default is the value in model_kwargs or 0.1 (initialization default)
+ "max_new_tokens": 1024, # default is the value in model_kwargs or 256 (initialization default)
+}
+"""
+response = model.invoke("Can you recommend me a nice dry wine?", **kwargs)
print(response)
```
@@ -62,8 +92,23 @@ model = Predibase(
predibase_api_key=os.environ.get("PREDIBASE_API_TOKEN"),
predibase_sdk_version=None, # optional parameter (defaults to the latest Predibase SDK version if omitted)
adapter_id="predibase/e2e_nlg",
+ """
+ Optionally use `model_kwargs` to set new default "generate()" settings. For example:
+ {
+ "api_token": os.environ.get("HUGGING_FACE_HUB_TOKEN"),
+ "max_new_tokens": 5, # default is 256
+ }
+ """
+ **model_kwargs,
)
-response = model.invoke("Can you recommend me a nice dry wine?")
+"""
+Optionally use `kwargs` to dynamically overwrite "generate()" settings. For example:
+{
+ "temperature": 0.5, # default is the value in model_kwargs or 0.1 (initialization default)
+ "max_new_tokens": 1024, # default is the value in model_kwargs or 256 (initialization default)
+}
+"""
+response = model.invoke("Can you recommend me a nice dry wine?", **kwargs)
print(response)
```
diff --git a/libs/community/langchain_community/llms/predibase.py b/libs/community/langchain_community/llms/predibase.py
index 65aca86bcf..398c169b4a 100644
--- a/libs/community/langchain_community/llms/predibase.py
+++ b/libs/community/langchain_community/llms/predibase.py
@@ -50,8 +50,8 @@ class Predibase(LLM):
**kwargs: Any,
) -> str:
options: Dict[str, Union[str, float]] = {
- **(self.model_kwargs or {}),
**self.default_options_for_generation,
+ **(self.model_kwargs or {}),
**(kwargs or {}),
}
if self._is_deprecated_sdk_version():