Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document returned value of MultiStepAgent.run() #888

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document returned value of MultiStepAgent.run() #888

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion src/smolagents/agents.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,11 +282,17 @@ def run(
additional_args (`dict`, *optional*): Any other variables that you want to pass to the agent run, for instance images or dataframes. Give them clear names!
max_steps (`int`, *optional*): Maximum number of steps the agent can take to solve the task. if not provided, will use the agent's default value.

Returns:
If `stream` is False:
- The final answer to the task
If `stream` is True:
- The output of each step, as it is taken, as a Generator

Example:
```py
from smolagents import CodeAgent
agent = CodeAgent(tools=[])
agent.run("What is the result of 2 power 3.7384?")
final_answer = agent.run("What is the result of 2 power 3.7384?")
```
"""
max_steps = max_steps or self.max_steps
Expand Down