From ef3e25ce4e86b04b6c09383fdbd90cadfb379919 Mon Sep 17 00:00:00 2001 From: Steven Liu <59462357+stevhliu@users.noreply.github.com> Date: Fri, 12 May 2023 08:29:13 -0700 Subject: [PATCH] [docs] Fix Agents and Tools docstring (#23313) fix kwargs --- src/transformers/tools/agents.py | 4 ++-- src/transformers/tools/base.py | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/transformers/tools/agents.py b/src/transformers/tools/agents.py index a7b07a4932c..fb8649bafad 100644 --- a/src/transformers/tools/agents.py +++ b/src/transformers/tools/agents.py @@ -248,7 +248,7 @@ class Agent: Whether to just return code and not evaluate it. remote (`bool`, *optional*, defaults to `False`): Whether or not to use remote tools (inference endpoints) instead of local ones. - kwargs: + kwargs (additional keyword arguments, *optional*): Any keyword argument to send to the agent when evaluating the code. Example: @@ -298,7 +298,7 @@ class Agent: Whether to just return code and not evaluate it. remote (`bool`, *optional*, defaults to `False`): Whether or not to use remote tools (inference endpoints) instead of local ones. - kwargs: + kwargs (additional keyword arguments, *optional*): Any keyword argument to send to the agent when evaluating the code. Example: diff --git a/src/transformers/tools/base.py b/src/transformers/tools/base.py index b51868e7c60..b2abdc818c2 100644 --- a/src/transformers/tools/base.py +++ b/src/transformers/tools/base.py @@ -188,7 +188,7 @@ class Tool: `huggingface-cli login` (stored in `~/.huggingface`). remote (`bool`, *optional*, defaults to `False`): Whether to use your tool by downloading the model or (if it is available) with an inference endpoint. - kwargs: + kwargs (additional keyword arguments, *optional*): Additional keyword arguments that will be split in two: all arguments relevant to the Hub (such as `cache_dir`, `revision`, `subfolder`) will be used when downloading the files for your tool, and the others will be passed along to its init. @@ -438,7 +438,7 @@ class PipelineTool(Tool): token (`str`, *optional*): The token to use as HTTP bearer authorization for remote files. If unset, will use the token generated when running `huggingface-cli login` (stored in `~/.huggingface`). - hub_kwargs: + hub_kwargs (additional keyword arguments, *optional*): Any additional keyword argument to send to the methods that will load the data from the Hub. """ @@ -631,7 +631,7 @@ def load_tool(task_or_repo_id, model_repo_id=None, remote=False, token=None, **k token (`str`, *optional*): The token to identify you on hf.co. If unset, will use the token generated when running `huggingface-cli login` (stored in `~/.huggingface`). - kwargs: + kwargs (additional keyword arguments, *optional*): Additional keyword arguments that will be split in two: all arguments relevant to the Hub (such as `cache_dir`, `revision`, `subfolder`) will be used when downloading the files for your tool, and the others will be passed along to its init.