Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / agents-course /pr_545 /en /unit1 /tutorial.html

rtrm

about 1 month ago

download

raw

33 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Let’s Create Our First Agent Using smolagents","local":"lets-create-our-first-agent-using-smolagents","sections":[{"title":"What is smolagents?","local":"what-is-smolagents","sections":[],"depth":2},{"title":"Let’s build our Agent!","local":"lets-build-our-agent","sections":[{"title":"The Tools","local":"the-tools","sections":[],"depth":3},{"title":"The Agent","local":"the-agent","sections":[],"depth":3},{"title":"The System Prompt","local":"the-system-prompt","sections":[],"depth":3}],"depth":2}],"depth":1}">
	<link href="/docs/agents-course/pr_545/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/entry/start.1596c81c.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/scheduler.37c15a92.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/singletons.8a3d92bd.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/index.18351ede.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/paths.5b2602e7.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/entry/app.856a784e.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/index.2bf4358c.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/nodes/0.1cd5790a.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/each.e59479a4.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/nodes/33.a6c07feb.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/CodeBlock.4e987730.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/Heading.8ada512a.js">
	<link rel="modulepreload" href="/docs/agents-course/pr_545/en/_app/immutable/chunks/getInferenceSnippets.031140c2.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"Let’s Create Our First Agent Using smolagents","local":"lets-create-our-first-agent-using-smolagents","sections":[{"title":"What is smolagents?","local":"what-is-smolagents","sections":[],"depth":2},{"title":"Let’s build our Agent!","local":"lets-build-our-agent","sections":[{"title":"The Tools","local":"the-tools","sections":[],"depth":3},{"title":"The Agent","local":"the-agent","sections":[],"depth":3},{"title":"The System Prompt","local":"the-system-prompt","sections":[],"depth":3}],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <h1 class="relative group"><a id="lets-create-our-first-agent-using-smolagents" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#lets-create-our-first-agent-using-smolagents"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Let’s Create Our First Agent Using smolagents</span></h1> <p data-svelte-h="svelte-gmmoh4">In the last section, we learned how we can create Agents from scratch using Python code, and we <strong>saw just how tedious that process can be</strong>. Fortunately, many Agent libraries simplify this work by <strong>handling much of the heavy lifting for you</strong>.</p> <p data-svelte-h="svelte-isl0ka">In this tutorial, <strong>you’ll create your very first Agent</strong> capable of performing actions such as image generation, web search, time zone checking and much more!</p> <p data-svelte-h="svelte-zy1mev">You will also publish your agent <strong>on a Hugging Face Space so you can share it with friends and colleagues</strong>.</p> <p data-svelte-h="svelte-4b3xjd">Let’s get started!</p> <h2 class="relative group"><a id="what-is-smolagents" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#what-is-smolagents"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>What is smolagents?</span></h2> <img src="https://huggingface.co/datasets/agents-course/course-images/resolve/main/en/unit1/smolagents.png" alt="smolagents"> <p data-svelte-h="svelte-1bet7no">To make this Agent, we’re going to use <code>smolagents</code>, a library that <strong>provides a framework for developing your agents with ease</strong>.</p> <p data-svelte-h="svelte-oceeap">This lightweight library is designed for simplicity, but it abstracts away much of the complexity of building an Agent, allowing you to focus on designing your agent’s behavior.</p> <p data-svelte-h="svelte-1wfbi7x">We’re going to get deeper into smolagents in the next Unit. Meanwhile, you can also check this <a href="https://huggingface.co/blog/smolagents" target="_blank">blog post</a> or the library’s <a href="https://github.com/huggingface/smolagents" target="_blank">repo in GitHub</a>.</p> <p data-svelte-h="svelte-1kxxgvd">In short, <code>smolagents</code> is a library that focuses on <strong>codeAgent</strong>, a kind of agent that performs <strong>“Actions”</strong> through code blocks, and then <strong>“Observes”</strong> results by executing the code.</p> <p data-svelte-h="svelte-1x3dozw">Here is an example of what we’ll build!</p> <p data-svelte-h="svelte-1kwa3nr">We provided our agent with an <strong>Image generation tool</strong> and asked it to generate an image of a cat.</p> <p data-svelte-h="svelte-4nw0u8">The agent inside <code>smolagents</code> is going to have the <strong>same behaviors as the custom one we built previously</strong>: it’s going <strong>to think, act and observe in cycle</strong> until it reaches a final answer:</p> <iframe width="560" height="315" src="https://www.youtube.com/embed/PQDKcWiuln4?si=ysSTDZoi8y55FVvA" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen=""></iframe> <p data-svelte-h="svelte-1riubhm">Exciting, right?</p> <h2 class="relative group"><a id="lets-build-our-agent" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#lets-build-our-agent"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>Let’s build our Agent!</span></h2> <p data-svelte-h="svelte-3pukde">To start, duplicate this Space: <a href="https://huggingface.co/spaces/agents-course/First_agent_template" target="_blank">https://huggingface.co/spaces/agents-course/First_agent_template</a></p> <blockquote data-svelte-h="svelte-1lji2e8"><p>Thanks to <a href="https://huggingface.co/m-ric" target="_blank">Aymeric</a> for this template! 🙌</p></blockquote> <p data-svelte-h="svelte-xpoxi8">Duplicating this space means <strong>creating a local copy on your own profile</strong>:</p> <img src="https://huggingface.co/datasets/agents-course/course-images/resolve/main/en/unit1/duplicate-space.gif" alt="Duplicate"> <p data-svelte-h="svelte-1to4f3l">After duplicating the Space, you’ll need to add your Hugging Face API token so your agent can access the model API:</p> <ol data-svelte-h="svelte-1dpkmu0"><li>First, get your Hugging Face token from <a href="https://hf.co/settings/tokens" rel="nofollow">https://hf.co/settings/tokens</a> with permission for inference, if you don’t already have one</li> <li>Go to your duplicated Space and click on the <strong>Settings</strong> tab</li> <li>Scroll down to the <strong>Variables and Secrets</strong> section and click <strong>New Secret</strong></li> <li>Create a secret with the name <code>HF_TOKEN</code> and paste your token as the value</li> <li>Click <strong>Save</strong> to store your token securely</li></ol> <p data-svelte-h="svelte-e4oew5">Throughout this lesson, the only file you will need to modify is the (currently incomplete) <strong>“app.py”</strong>. You can see here the <a href="https://huggingface.co/spaces/agents-course/First_agent_template/blob/main/app.py" rel="nofollow">original one in the template</a>. To find yours, go to your copy of the space, then click the <code>Files</code> tab and then on <code>app.py</code> in the directory listing.</p> <p data-svelte-h="svelte-xgl3rm">Let’s break down the code together:</p> <ul data-svelte-h="svelte-g8ecnx"><li>The file begins with some simple but necessary library imports</li></ul> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START --><span class="hljs-keyword">from</span> smolagents <span class="hljs-keyword">import</span> CodeAgent, DuckDuckGoSearchTool, FinalAnswerTool, InferenceClientModel, load_tool, tool
	<span class="hljs-keyword">import</span> datetime
	<span class="hljs-keyword">import</span> requests
	<span class="hljs-keyword">import</span> pytz
	<span class="hljs-keyword">import</span> yaml<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-eq9rdr">As outlined earlier, we will directly use the <strong>CodeAgent</strong> class from <strong>smolagents</strong>.</p> <h3 class="relative group"><a id="the-tools" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#the-tools"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>The Tools</span></h3> <p data-svelte-h="svelte-1qrccm5">Now let’s get into the tools! If you want a refresher about tools, don’t hesitate to go back to the <a href="tools">Tools</a> section of the course.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START --><span class="hljs-meta">@tool</span>
	<span class="hljs-keyword">def</span> <span class="hljs-title function_">my_custom_tool</span>(<span class="hljs-params">arg1:<span class="hljs-built_in">str</span>, arg2:<span class="hljs-built_in">int</span></span>)-> <span class="hljs-built_in">str</span>: <span class="hljs-comment"># it's important to specify the return type</span>
	<span class="hljs-comment"># Keep this format for the tool description / args description but feel free to modify the tool</span>
	<span class="hljs-string">"""A tool that does nothing yet
	Args:
	arg1: the first argument
	arg2: the second argument
	"""</span>
	<span class="hljs-keyword">return</span> <span class="hljs-string">"What magic will you build ?"</span>

	<span class="hljs-meta">@tool</span>
	<span class="hljs-keyword">def</span> <span class="hljs-title function_">get_current_time_in_timezone</span>(<span class="hljs-params">timezone: <span class="hljs-built_in">str</span></span>) -> <span class="hljs-built_in">str</span>:
	<span class="hljs-string">"""A tool that fetches the current local time in a specified timezone.
	Args:
	timezone: A string representing a valid timezone (e.g., 'America/New_York').
	"""</span>
	<span class="hljs-keyword">try</span>:
	<span class="hljs-comment"># Create timezone object</span>
	tz = pytz.timezone(timezone)
	<span class="hljs-comment"># Get current time in that timezone</span>
	local_time = datetime.datetime.now(tz).strftime(<span class="hljs-string">"%Y-%m-%d %H:%M:%S"</span>)
	<span class="hljs-keyword">return</span> <span class="hljs-string">f"The current local time in <span class="hljs-subst">{timezone}</span> is: <span class="hljs-subst">{local_time}</span>"</span>
	<span class="hljs-keyword">except</span> Exception <span class="hljs-keyword">as</span> e:
	<span class="hljs-keyword">return</span> <span class="hljs-string">f"Error fetching time for timezone '<span class="hljs-subst">{timezone}</span>': <span class="hljs-subst">{<span class="hljs-built_in">str</span>(e)}</span>"</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-qrpozm">The Tools are what we are encouraging you to build in this section! We give you two examples:</p> <ol data-svelte-h="svelte-12muy28"><li>A <strong>non-working dummy Tool</strong> that you can modify to make something useful.</li> <li>An <strong>actually working Tool</strong> that gets the current time somewhere in the world.</li></ol> <p data-svelte-h="svelte-mmcol7">To define your tool it is important to:</p> <ol data-svelte-h="svelte-p349vr"><li>Provide input and output types for your function, like in <code>get_current_time_in_timezone(timezone: str) -> str:</code></li> <li><strong>A well formatted docstring</strong>. <code>smolagents</code> is expecting all the arguments to have a <strong>textual description in the docstring</strong>.</li></ol> <h3 class="relative group"><a id="the-agent" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#the-agent"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>The Agent</span></h3> <p data-svelte-h="svelte-16qafzg">It uses <a href="https://huggingface.co/Qwen/Qwen2.5-Coder-32B-Instruct" rel="nofollow"><code>Qwen/Qwen2.5-Coder-32B-Instruct</code></a> as the LLM engine. This is a very capable model that we’ll access via the serverless API.</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START -->final_answer = FinalAnswerTool()
	model = InferenceClientModel(
	max_tokens=<span class="hljs-number">2096</span>,
	temperature=<span class="hljs-number">0.5</span>,
	model_id=<span class="hljs-string">'Qwen/Qwen2.5-Coder-32B-Instruct'</span>,
	custom_role_conversions=<span class="hljs-literal">None</span>,
	)

	<span class="hljs-keyword">with</span> <span class="hljs-built_in">open</span>(<span class="hljs-string">"prompts.yaml"</span>, <span class="hljs-string">'r'</span>) <span class="hljs-keyword">as</span> stream:
	prompt_templates = yaml.safe_load(stream)

	<span class="hljs-comment"># We're creating our CodeAgent</span>
	agent = CodeAgent(
	model=model,
	tools=[final_answer], <span class="hljs-comment"># add your tools here (don't remove final_answer)</span>
	max_steps=<span class="hljs-number">6</span>,
	verbosity_level=<span class="hljs-number">1</span>,
	grammar=<span class="hljs-literal">None</span>,
	planning_interval=<span class="hljs-literal">None</span>,
	name=<span class="hljs-literal">None</span>,
	description=<span class="hljs-literal">None</span>,
	prompt_templates=prompt_templates
	)

	GradioUI(agent).launch()<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-k111f3">This Agent still uses the <code>InferenceClient</code> we saw in an earlier section behind the <strong>InferenceClientModel</strong> class!</p> <p data-svelte-h="svelte-t0wd0t">We will give more in-depth examples when we present the framework in Unit 2. For now, you need to focus on <strong>adding new tools to the list of tools</strong> using the <code>tools</code> parameter of your Agent.</p> <p data-svelte-h="svelte-1m08tlu">For example, you could use the <code>DuckDuckGoSearchTool</code> that was imported in the first line of the code, or you can examine the <code>image_generation_tool</code> that is loaded from the Hub later in the code.</p> <p data-svelte-h="svelte-13ckn13"><strong>Adding tools will give your agent new capabilities</strong>, try to be creative here!</p> <h3 class="relative group"><a id="the-system-prompt" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#the-system-prompt"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a> <span>The System Prompt</span></h3> <p data-svelte-h="svelte-1wl8y4j">The agent’s system prompt is stored in a separate <code>prompts.yaml</code> file. This file contains predefined instructions that guide the agent’s behavior.</p> <p data-svelte-h="svelte-dchyno">Storing prompts in a YAML file allows for easy customization and reuse across different agents or use cases.</p> <p data-svelte-h="svelte-1sn4nls">You can check the <a href="https://huggingface.co/spaces/agents-course/First_agent_template/tree/main" rel="nofollow">Space’s file structure</a> to see where the <code>prompts.yaml</code> file is located and how it’s organized within the project.</p> <p data-svelte-h="svelte-11duvvf">The complete “app.py”:</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg class="" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg> <div class="absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0"><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent; "></div> Copied</div></button></div> <pre class=""><!-- HTML_TAG_START --><span class="hljs-keyword">from</span> smolagents <span class="hljs-keyword">import</span> CodeAgent, DuckDuckGoSearchTool, InferenceClientModel, load_tool, tool
	<span class="hljs-keyword">import</span> datetime
	<span class="hljs-keyword">import</span> requests
	<span class="hljs-keyword">import</span> pytz
	<span class="hljs-keyword">import</span> yaml
	<span class="hljs-keyword">from</span> tools.final_answer <span class="hljs-keyword">import</span> FinalAnswerTool

	<span class="hljs-keyword">from</span> Gradio_UI <span class="hljs-keyword">import</span> GradioUI

	<span class="hljs-comment"># Below is an example of a tool that does nothing. Amaze us with your creativity!</span>
	<span class="hljs-meta">@tool</span>
	<span class="hljs-keyword">def</span> <span class="hljs-title function_">my_custom_tool</span>(<span class="hljs-params">arg1:<span class="hljs-built_in">str</span>, arg2:<span class="hljs-built_in">int</span></span>)-> <span class="hljs-built_in">str</span>: <span class="hljs-comment"># it's important to specify the return type</span>
	<span class="hljs-comment"># Keep this format for the tool description / args description but feel free to modify the tool</span>
	<span class="hljs-string">"""A tool that does nothing yet
	Args:
	arg1: the first argument
	arg2: the second argument
	"""</span>
	<span class="hljs-keyword">return</span> <span class="hljs-string">"What magic will you build ?"</span>

	<span class="hljs-meta">@tool</span>
	<span class="hljs-keyword">def</span> <span class="hljs-title function_">get_current_time_in_timezone</span>(<span class="hljs-params">timezone: <span class="hljs-built_in">str</span></span>) -> <span class="hljs-built_in">str</span>:
	<span class="hljs-string">"""A tool that fetches the current local time in a specified timezone.
	Args:
	timezone: A string representing a valid timezone (e.g., 'America/New_York').
	"""</span>
	<span class="hljs-keyword">try</span>:
	<span class="hljs-comment"># Create timezone object</span>
	tz = pytz.timezone(timezone)
	<span class="hljs-comment"># Get current time in that timezone</span>
	local_time = datetime.datetime.now(tz).strftime(<span class="hljs-string">"%Y-%m-%d %H:%M:%S"</span>)
	<span class="hljs-keyword">return</span> <span class="hljs-string">f"The current local time in <span class="hljs-subst">{timezone}</span> is: <span class="hljs-subst">{local_time}</span>"</span>
	<span class="hljs-keyword">except</span> Exception <span class="hljs-keyword">as</span> e:
	<span class="hljs-keyword">return</span> <span class="hljs-string">f"Error fetching time for timezone '<span class="hljs-subst">{timezone}</span>': <span class="hljs-subst">{<span class="hljs-built_in">str</span>(e)}</span>"</span>


	final_answer = FinalAnswerTool()
	model = InferenceClientModel(
	max_tokens=<span class="hljs-number">2096</span>,
	temperature=<span class="hljs-number">0.5</span>,
	model_id=<span class="hljs-string">'Qwen/Qwen2.5-Coder-32B-Instruct'</span>,
	custom_role_conversions=<span class="hljs-literal">None</span>,
	)


	<span class="hljs-comment"># Import tool from Hub</span>
	image_generation_tool = load_tool(<span class="hljs-string">"agents-course/text-to-image"</span>, trust_remote_code=<span class="hljs-literal">True</span>)

	<span class="hljs-comment"># Load system prompt from prompt.yaml file</span>
	<span class="hljs-keyword">with</span> <span class="hljs-built_in">open</span>(<span class="hljs-string">"prompts.yaml"</span>, <span class="hljs-string">'r'</span>) <span class="hljs-keyword">as</span> stream:
	prompt_templates = yaml.safe_load(stream)

	agent = CodeAgent(
	model=model,
	tools=[final_answer], <span class="hljs-comment"># add your tools here (don't remove final_answer)</span>
	max_steps=<span class="hljs-number">6</span>,
	verbosity_level=<span class="hljs-number">1</span>,
	grammar=<span class="hljs-literal">None</span>,
	planning_interval=<span class="hljs-literal">None</span>,
	name=<span class="hljs-literal">None</span>,
	description=<span class="hljs-literal">None</span>,
	prompt_templates=prompt_templates <span class="hljs-comment"># Pass system prompt to CodeAgent</span>
	)


	GradioUI(agent).launch()<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1djj761">Your <strong>Goal</strong> is to get familiar with the Space and the Agent.</p> <p data-svelte-h="svelte-1xqfrp">Currently, the agent in the template <strong>does not use any tools, so try to provide it with some of the pre-made ones or even make some new tools yourself!</strong></p> <p data-svelte-h="svelte-h3h5uq">We are eagerly waiting for your amazing agents output in the discord channel <strong>#agents-course-showcase</strong>!</p> <hr> <p data-svelte-h="svelte-1vcdjz4">Congratulations, you’ve built your first Agent! Don’t hesitate to share it with your friends and colleagues.</p> <p data-svelte-h="svelte-10mjkny">Since this is your first try, it’s perfectly normal if it’s a little buggy or slow. In future units, we’ll learn how to build even better Agents.</p> <p data-svelte-h="svelte-10xgfu5">The best way to learn is to try, so don’t hesitate to update it, add more tools, try with another model, etc.</p> <p data-svelte-h="svelte-1s9m3df">In the next section, you’re going to fill the final Quiz and get your certificate!</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/agents-course/blob/main/units/en/unit1/tutorial.mdx" target="_blank"><span data-svelte-h="svelte-1kd6by1"><</span> <span data-svelte-h="svelte-x0xyl0">></span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a> <p></p>

	<script>
	{
	__sveltekit_17hovx6 = {
	assets: "/docs/agents-course/pr_545/en",
	base: "/docs/agents-course/pr_545/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/agents-course/pr_545/en/_app/immutable/entry/start.1596c81c.js"),
	import("/docs/agents-course/pr_545/en/_app/immutable/entry/app.856a784e.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 33],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 33 kB
Xet hash:: 89f4058ab23f75fa1a5c7cf36e7d072fd7bab8fec1ac680333fce277f49592c7

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.