Skip to content

Commit

Permalink
[docs] Fix Agents and Tools docstring (huggingface#23313)
Browse files Browse the repository at this point in the history
fix kwargs
  • Loading branch information
stevhliu authored May 12, 2023
1 parent a3975f9 commit ef3e25c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions src/transformers/tools/agents.py
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ def chat(self, task, *, return_code=False, remote=False, **kwargs):
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:
Expand Down Expand Up @@ -298,7 +298,7 @@ def run(self, task, *, return_code=False, remote=False, **kwargs):
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:
Expand Down
6 changes: 3 additions & 3 deletions src/transformers/tools/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ def from_hub(cls, repo_id, model_repo_id=None, token=None, remote=False, **kwarg
`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.
Expand Down Expand Up @@ -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.
"""

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit ef3e25c

Please sign in to comment.