Unverified Commit ef3e25ce authored by Steven Liu's avatar Steven Liu Committed by GitHub
Browse files

[docs] Fix Agents and Tools docstring (#23313)

fix kwargs
parent a3975f94
...@@ -248,7 +248,7 @@ class Agent: ...@@ -248,7 +248,7 @@ class Agent:
Whether to just return code and not evaluate it. Whether to just return code and not evaluate it.
remote (`bool`, *optional*, defaults to `False`): remote (`bool`, *optional*, defaults to `False`):
Whether or not to use remote tools (inference endpoints) instead of local ones. 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. Any keyword argument to send to the agent when evaluating the code.
Example: Example:
...@@ -298,7 +298,7 @@ class Agent: ...@@ -298,7 +298,7 @@ class Agent:
Whether to just return code and not evaluate it. Whether to just return code and not evaluate it.
remote (`bool`, *optional*, defaults to `False`): remote (`bool`, *optional*, defaults to `False`):
Whether or not to use remote tools (inference endpoints) instead of local ones. 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. Any keyword argument to send to the agent when evaluating the code.
Example: Example:
......
...@@ -188,7 +188,7 @@ class Tool: ...@@ -188,7 +188,7 @@ class Tool:
`huggingface-cli login` (stored in `~/.huggingface`). `huggingface-cli login` (stored in `~/.huggingface`).
remote (`bool`, *optional*, defaults to `False`): remote (`bool`, *optional*, defaults to `False`):
Whether to use your tool by downloading the model or (if it is available) with an inference endpoint. 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 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 `cache_dir`, `revision`, `subfolder`) will be used when downloading the files for your tool, and the
others will be passed along to its init. others will be passed along to its init.
...@@ -438,7 +438,7 @@ class PipelineTool(Tool): ...@@ -438,7 +438,7 @@ class PipelineTool(Tool):
token (`str`, *optional*): token (`str`, *optional*):
The token to use as HTTP bearer authorization for remote files. If unset, will use the token generated when 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`). 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. 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 ...@@ -631,7 +631,7 @@ def load_tool(task_or_repo_id, model_repo_id=None, remote=False, token=None, **k
token (`str`, *optional*): token (`str`, *optional*):
The token to identify you on hf.co. If unset, will use the token generated when running `huggingface-cli The token to identify you on hf.co. If unset, will use the token generated when running `huggingface-cli
login` (stored in `~/.huggingface`). 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 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 `cache_dir`, `revision`, `subfolder`) will be used when downloading the files for your tool, and the others
will be passed along to its init. will be passed along to its init.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment