smolagents documentation

smolagents

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

smolagents

What is smolagents?

smolagents is an open-source Python library designed to make it extremely easy to build and run agents using just a few lines of code.

Key features of smolagents include:

Simplicity: The logic for agents fits in ~thousand lines of code. We kept abstractions to their minimal shape above raw code!

🧑‍💻 First-class support for Code Agents: CodeAgent writes its actions in code (as opposed to “agents being used to write code”) to invoke tools or perform computations, enabling natural composability (function nesting, loops, conditionals). To make it secure, we support executing in sandboxed environment via E2B or via Docker.

📡 Common Tool-Calling Agent Support: In addition to CodeAgents, ToolCallingAgent supports usual JSON/text-based tool-calling for scenarios where that paradigm is preferred.

🤗 Hub integrations: Seamlessly share and load agents and tools to/from the Hub as Gradio Spaces.

🌐 Model-agnostic: Easily integrate any large language model (LLM), whether it’s hosted on the Hub via Inference providers, accessed via APIs such as OpenAI, Anthropic, or many others via LiteLLM integration, or run locally using Transformers or Ollama. Powering an agent with your preferred LLM is straightforward and flexible.

👁️ Modality-agnostic: Beyond text, agents can handle vision, video, and audio inputs, broadening the range of possible applications. Check out this tutorial for vision.

🛠️ Tool-agnostic: You can use tools from any MCP server, from [LangChain]reference/tools#smolagents.Tool.from_langchain), you can even use a Hub Space as a tool.

💻 CLI Tools: Comes with command-line utilities (smolagent, webagent) for quickly running agents without writing boilerplate code.

Quickstart

Get started with smolagents in just a few minutes! This guide will show you how to create and run your first agent.

Installation

Install smolagents with pip:

pip install smolagents

For additional features, you can install optional dependencies:

pip install smolagents[toolkit]  # Includes default tools like web search

Create Your First Agent

Here’s a minimal example to create and run an agent:

from smolagents import CodeAgent, InferenceClientModel

# Initialize a model (using Hugging Face Inference API)
model = InferenceClientModel()  # Uses a default model

# Create an agent with no tools
agent = CodeAgent(tools=[], model=model)

# Run the agent with a task
result = agent.run("Calculate the sum of numbers from 1 to 10")
print(result)

That’s it! Your agent will use Python code to solve the task and return the result.

Adding Tools

Let’s make our agent more capable by adding some tools:

from smolagents import CodeAgent, InferenceClientModel

# Initialize with default tools (requires smolagents[toolkit])
model = InferenceClientModel()
agent = CodeAgent(
    tools=[],  # Empty list since we'll use default tools
    model=model,
    add_base_tools=True  # This adds web search and other default tools
)

# Now the agent can search the web!
result = agent.run("What is the current weather in Paris?")
print(result)

Using Different Models

You can use various models with your agent:

# Using a specific model from Hugging Face
model = InferenceClientModel(model_id="meta-llama/Llama-2-70b-chat-hf")

# Using OpenAI/Anthropic (requires smolagents[litellm])
from smolagents import LiteLLMModel
model = LiteLLMModel(model_id="gpt-4")

# Using local models (requires smolagents[transformers])
from smolagents import TransformersModel
model = TransformersModel(model_id="meta-llama/Llama-2-7b-chat-hf")

Next Steps

< > Update on GitHub