docstring args for ToolCallingAgent, CodeAgent and ManagedAgent #335
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@albertvillanova I was going to do this yesterday, but I thought it will cause issues and today I saw your PR, so I did the rest of them. |
albertvillanova
approved these changes
Jan 24, 2025
src/smolagents/agents.py
Outdated
| @@ -655,6 +655,14 @@ def planning_step(self, task, is_first_step: bool, step: int) -> None: | |||
| class ToolCallingAgent(MultiStepAgent): | |||
| """ | |||
| This agent uses JSON-like tool calls, using method `model.get_tool_call` to leverage the LLM engine's tool calling capabilities. | |||
|
|
|||
| Args: | |||
| tools (`list[Tool]`):List of tools that the agent can use. | |||
There was a problem hiding this comment.
Suggested change
| tools (`list[Tool]`):List of tools that the agent can use. | |
| tools (`list[Tool]`): List of tools that the agent can use. |
src/smolagents/agents.py
Outdated
| model (Callable[[list[dict[str, str]]], [`ChatMessage`]]): Model that will generate the agent's actions. | ||
| system_prompt (`str`, *optional*): System prompt that will be used to generate the agent's actions. | ||
| grammar (`dict[str, str]`, *optional*): Grammar used to parse the LLM output. | ||
| additional_authorized_imports (`list[str]`, *optional*): List of additional imports that are authorized for the agent. |
There was a problem hiding this comment.
I would not use its type (List) to define the parameter.
Comment on lines
+963
to
+968
| agent (`object`): The agent to be managed. | ||
| name (`str`): The name of the managed agent. | ||
| description (`str`): A description of the managed agent. | ||
| additional_prompting (`Optional[str]`, *optional*): Additional prompting for the managed agent. Defaults to None. | ||
| provide_run_summary (`bool`, *optional*): Whether to provide a run summary after the agent completes its task. Defaults to False. | ||
| managed_agent_prompt (`Optional[str]`, *optional*): Custom prompt for the managed agent. Defaults to None. |
There was a problem hiding this comment.
Let's align the definitions with the ones above: better not start the description with "the" or "a".
| agent (`object`): The agent to be managed. | ||
| name (`str`): The name of the managed agent. | ||
| description (`str`): A description of the managed agent. | ||
| additional_prompting (`Optional[str]`, *optional*): Additional prompting for the managed agent. Defaults to None. |
There was a problem hiding this comment.
Redundant Optional[] and *optional*. Better removing the first one.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add args to
ToolCallingAgent ``CodeAgentandManagedAgentdocstring.