Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / transformers /pr_36839 /en /agents.html

rtrm

3 months ago

download

raw

50.4 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Agents","local":"agents","sections":[{"title":"LLM","local":"llm","sections":[],"depth":2},{"title":"System prompt","local":"system-prompt","sections":[],"depth":2},{"title":"Code execution","local":"code-execution","sections":[],"depth":2},{"title":"Multi-agent","local":"multi-agent","sections":[],"depth":2},{"title":"Gradio integration","local":"gradio-integration","sections":[],"depth":2},{"title":"Troubleshoot","local":"troubleshoot","sections":[],"depth":2},{"title":"Resources","local":"resources","sections":[],"depth":2}],"depth":1}">
	<link href="/docs/transformers/pr_36839/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/entry/start.6be8d590.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/scheduler.01eeda35.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/singletons.177df05e.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/index.4862150a.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/paths.517376d1.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/entry/app.09748b4b.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/index.6dd51b66.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/nodes/0.8897c14d.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/each.e59479a4.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/nodes/5.0d96465e.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/Tip.de9bae2b.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/CodeBlock.864da1b0.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/DocNotebookDropdown.54e76c6c.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/globals.7f7f1b26.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/EditOnGithub.7faefd25.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/HfOption.f7f04550.js">
	<link rel="modulepreload" href="/docs/transformers/pr_36839/en/_app/immutable/chunks/stores.318eade7.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"Agents","local":"agents","sections":[{"title":"LLM","local":"llm","sections":[],"depth":2},{"title":"System prompt","local":"system-prompt","sections":[],"depth":2},{"title":"Code execution","local":"code-execution","sections":[],"depth":2},{"title":"Multi-agent","local":"multi-agent","sections":[],"depth":2},{"title":"Gradio integration","local":"gradio-integration","sections":[],"depth":2},{"title":"Troubleshoot","local":"troubleshoot","sections":[],"depth":2},{"title":"Resources","local":"resources","sections":[],"depth":2}],"depth":1}"><!-- HEAD_svelte-u9bgzb_END --> <p></p> <div class="course-tip course-tip-orange bg-gradient-to-br dark:bg-gradient-to-r before:border-orange-500 dark:before:border-orange-800 from-orange-50 dark:from-gray-900 to-white dark:to-gray-950 border border-orange-50 text-orange-700 dark:text-gray-400"><p data-svelte-h="svelte-7z04h0">Agents and tools are being spun out into the standalone <a href="https://huggingface.co/docs/smolagents/index" rel="nofollow">smolagents</a> library. These docs will be deprecated in the future!</p></div> <h1 class="relative group"><a id="agents" 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="#agents"><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>Agents</span></h1> <div class="flex space-x-1 absolute z-10 right-0 top-0"> <div class="relative colab-dropdown "> <button class=" " type="button"> <img alt="Open In Colab" class="!m-0" src="https://colab.research.google.com/assets/colab-badge.svg"> </button> </div> <div class="relative colab-dropdown "> <button class=" " type="button"> <img alt="Open In Studio Lab" class="!m-0" src="https://studiolab.sagemaker.aws/studiolab.svg"> </button> </div></div> <p data-svelte-h="svelte-12g5d3e">An agent is a system where a large language model (LLM) can execute more complex tasks through <em>planning</em> and using <em>tools</em>.</p> <ul data-svelte-h="svelte-1vhi93u"><li><p>Planning helps a LLM reason its way through a task by breaking it down into smaller subtasks. For example, <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.CodeAgent">CodeAgent</a> plans a series of actions to take and then generates Python code to execute all the actions at once.</p> <p>Another planning method is by self-reflection and refinement of its previous actions to improve its performance. The <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.ReactJsonAgent">ReactJsonAgent</a> is an example of this type of planning, and it’s based on the <a href="https://hf.co/papers/2210.03629" rel="nofollow">ReAct</a> framework. This agent plans and executes actions one at a time based on the feedback it receives from each action.</p></li> <li><p>Tools give a LLM access to external functions or APIs that it can use to help it complete a task. For example, <a href="https://github.com/freddyaboulton/gradio-tools" rel="nofollow">gradio-tools</a> gives a LLM access to any of the <a href="https://www.gradio.app/" rel="nofollow">Gradio</a> apps available on Hugging Face <a href="https://hf.co/spaces" rel="nofollow">Spaces</a>. These apps can be used for a wide range of tasks such as image generation, video generation, audio transcription, and more.</p></li></ul> <p data-svelte-h="svelte-1pgqage">To use agents in Transformers, make sure you have the extra <code>agents</code> dependencies installed.</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 -->!pip install transformers[agents]<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1gox29o">Create an agent instance (refer to the <a href="./main_classes/agent#agents">Agents</a> API for supported agents in Transformers) and a list of tools available for it to use, then <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.ReactAgent.run">run()</a> the agent on your task. The example below demonstrates how a ReAct agent reasons through a task.</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> transformers <span class="hljs-keyword">import</span> ReactCodeAgent

	agent = ReactCodeAgent(tools=[])
	agent.run(
	<span class="hljs-string">"How many more blocks (also denoted as layers) in BERT base encoder than the encoder from the architecture proposed in Attention is All You Need?"</span>,
	)<!-- HTML_TAG_END --></pre></div> <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 -->======== New task ========
	How many more blocks (also denoted as layers) <span class="hljs-keyword">in</span> BERT base encoder than the encoder from the architecture proposed <span class="hljs-keyword">in</span> Attention is All You Need?
	==== Agent is executing the code below:
	bert_layers = 12 <span class="hljs-comment"># BERT base encoder has 12 layers</span>
	attention_layers = 6 <span class="hljs-comment"># Encoder in Attention is All You Need has 6 layers</span>
	layer_diff = bert_layers - attention_layers
	<span class="hljs-built_in">print</span>(<span class="hljs-string">"The difference in layers between BERT base encoder and Attention is All You Need is"</span>, layer_diff)
	====
	Print outputs:
	The difference <span class="hljs-keyword">in</span> layers between BERT base encoder and Attention is All You Need is 6

	==== Agent is executing the code below:
	final_answer(<span class="hljs-string">"BERT base encoder has {} more layers than the encoder from Attention is All You Need."</span>.format(layer_diff))
	====
	Print outputs:

	>>> Final answer:
	BERT base encoder has 6 more layers than the encoder from Attention is All You Need.<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-slp997">This guide will walk you through in more detail how to initialize an agent.</p> <h2 class="relative group"><a id="llm" 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="#llm"><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>LLM</span></h2> <p data-svelte-h="svelte-kwq5sb">An agent uses a LLM to plan and execute a task; it is the engine that powers the agent. To choose and build your own LLM engine, you need a method that:</p> <ol data-svelte-h="svelte-djsytv"><li>the input uses the <a href="./chat_templating">chat template</a> format, <code>List[Dict[str, str]]</code>, and it returns a string</li> <li>the LLM stops generating outputs when it encounters the sequences in <code>stop_sequences</code></li></ol> <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">def</span> <span class="hljs-title function_">llm_engine</span>(<span class="hljs-params">messages, stop_sequences=[<span class="hljs-string">"Task"</span>]</span>) -> <span class="hljs-built_in">str</span>:
	response = client.chat_completion(messages, stop=stop_sequences, max_tokens=<span class="hljs-number">1000</span>)
	answer = response.choices[<span class="hljs-number">0</span>].message.content
	<span class="hljs-keyword">return</span> answer<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1xlre0h">Next, initialize an engine to load a model. To run an agent locally, create a <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.TransformersEngine">TransformersEngine</a> to load a preinitialized <a href="/docs/transformers/pr_36839/en/main_classes/pipelines#transformers.Pipeline">Pipeline</a>.</p> <p data-svelte-h="svelte-1nqjhd9">However, you could also leverage Hugging Face’s powerful inference infrastructure, <a href="https://hf.co/docs/api-inference/index" rel="nofollow">Inference API</a> or <a href="https://hf.co/docs/inference-endpoints/index" rel="nofollow">Inference Endpoints</a>, to run your model. This is useful for loading larger models that are typically required for agentic behavior. In this case, load the <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.HfApiEngine">HfApiEngine</a> to run the agent.</p> <p data-svelte-h="svelte-1ro6pd">The agent requires a list of tools it can use to complete a task. If you aren’t using any additional tools, pass an empty list. The default tools provided by Transformers are loaded automatically, but you can optionally set <code>add_base_tools=True</code> to explicitly enable them.</p> <div class="flex space-x-2 items-center my-1.5 mr-8 h-7 !pl-0 -mx-3 md:mx-0"><div class="flex items-center border rounded-lg px-1.5 py-1 leading-none select-none text-smd border-gray-800 bg-black dark:bg-gray-700 text-white">TransformersEngine </div><div class="flex items-center border rounded-lg px-1.5 py-1 leading-none select-none text-smd text-gray-500 cursor-pointer opacity-90 hover:text-gray-700 dark:hover:text-gray-200 hover:shadow-sm">HfApiEngine </div></div> <div class="language-select"><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> transformers <span class="hljs-keyword">import</span> AutoModelForCausalLM, AutoTokenizer, pipeline, TransformersEngine, CodeAgent

	tokenizer = AutoTokenizer.from_pretrained(<span class="hljs-string">"meta-llama/Llama-3.1-8B-Instruct"</span>)
	model = AutoModelForCausalLM.from_pretrained(<span class="hljs-string">"meta-llama/Llama-3.1-8B-Instruct"</span>).to(<span class="hljs-string">"cuda"</span>)
	pipeline = pipeline(<span class="hljs-string">"text-generation"</span>, model=model, tokenizer=tokenizer)
	llm_engine = TransformersEngine(pipeline)
	agent = CodeAgent(tools=[], llm_engine=llm_engine)
	agent.run(
	<span class="hljs-string">"What causes bread to rise?"</span>,
	)<!-- HTML_TAG_END --></pre></div> </div> <p data-svelte-h="svelte-vls8ox">The agent supports <a href="https://hf.co/docs/text-generation-inference/conceptual/guidance" rel="nofollow">constrained generation</a> for generating outputs according to a specific structure with the <code>grammar</code> parameter. The <code>grammar</code> parameter should be specified in the <code>llm_engine</code> method or you can set it when initializing an agent.</p> <p data-svelte-h="svelte-1ie71q1">Lastly, an agent accepts additional inputs such as text and audio. In the <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.HfApiEngine">HfApiEngine</a> example above, the agent accepted a sentence to translate. But you could also pass a path to a local or remote file for the agent to access. The example below demonstrates how to pass a path to an audio file.</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> transformers <span class="hljs-keyword">import</span> ReactCodeAgent

	agent = ReactCodeAgent(tools=[], llm_engine=llm_engine)
	agent.run(<span class="hljs-string">"Why doesn't he know many people in New York?"</span>, audio=<span class="hljs-string">"https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/transformers/recording.mp3"</span>)<!-- HTML_TAG_END --></pre></div> <h2 class="relative group"><a id="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="#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>System prompt</span></h2> <p data-svelte-h="svelte-mxj1mp">A system prompt describes how an agent should behave, a description of the available tools, and the expected output format.</p> <p data-svelte-h="svelte-olex0k">Tools are defined by the <code><<tool_descriptions>></code> token which is dynamically replaced during runtime with the actual tool. The tool description is derived from the tool name, description, inputs, output type, and a Jinja2 template. Refer to the <a href="./tools">Tools</a> guide for more information about how to describe tools.</p> <p data-svelte-h="svelte-1jbydvo">The example below is the system prompt for <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.ReactCodeAgent">ReactCodeAgent</a>.</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 -->You will be given a task to solve <span class="hljs-keyword">as</span> best you can.
	You have access to the following tools:
	<<tool_descriptions>>

	To solve the task, you must plan forward to proceed <span class="hljs-keyword">in</span> a series of steps, <span class="hljs-keyword">in</span> a cycle of <span class="hljs-string">'Thought:'</span>, <span class="hljs-string">'Code:'</span>, <span class="hljs-keyword">and</span> <span class="hljs-string">'Observation:'</span> sequences.

	At each step, <span class="hljs-keyword">in</span> the <span class="hljs-string">'Thought:'</span> sequence, you should first explain your reasoning towards solving the task, then the tools that you want to use.
	Then <span class="hljs-keyword">in</span> the <span class="hljs-string">'Code:'</span> sequence, you should write the code <span class="hljs-keyword">in</span> simple Python. The code sequence must end <span class="hljs-keyword">with</span> <span class="hljs-string">'/End code'</span> sequence.
	During each intermediate step, you can use <span class="hljs-string">'print()'</span> to save whatever important information you will then need.
	These <span class="hljs-built_in">print</span> outputs will then be available <span class="hljs-keyword">in</span> the <span class="hljs-string">'Observation:'</span> field, <span class="hljs-keyword">for</span> using this information <span class="hljs-keyword">as</span> <span class="hljs-built_in">input</span> <span class="hljs-keyword">for</span> the <span class="hljs-built_in">next</span> step.

	In the end you have to <span class="hljs-keyword">return</span> a final answer using the `final_answer` tool.

	Here are a few examples using notional tools:
	---
	{examples}

	Above example were using notional tools that might <span class="hljs-keyword">not</span> exist <span class="hljs-keyword">for</span> you. You only have access to those tools:
	<<tool_names>>
	You also can perform computations <span class="hljs-keyword">in</span> the python code you generate.

	Always provide a <span class="hljs-string">'Thought:'</span> <span class="hljs-keyword">and</span> a <span class="hljs-string">'Code:\n```py'</span> sequence ending <span class="hljs-keyword">with</span> <span class="hljs-string">'```<end_code>'</span> sequence. You MUST provide at least the <span class="hljs-string">'Code:'</span> sequence to move forward.

	Remember to <span class="hljs-keyword">not</span> perform too many operations <span class="hljs-keyword">in</span> a single code block! You should split the task into intermediate code blocks.
	Print results at the end of each step to save the intermediate results. Then use final_answer() to <span class="hljs-keyword">return</span> the final result.

	Remember to make sure that variables you use are <span class="hljs-built_in">all</span> defined.

	Now Begin!<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-4jh3w4">The system prompt can be tailored to the intended task. For example, you can add a better explanation of the output format or you can overwrite the system prompt template entirely with your own custom system prompt as shown below.</p> <div class="course-tip course-tip-orange bg-gradient-to-br dark:bg-gradient-to-r before:border-orange-500 dark:before:border-orange-800 from-orange-50 dark:from-gray-900 to-white dark:to-gray-950 border border-orange-50 text-orange-700 dark:text-gray-400"><p data-svelte-h="svelte-l0xtfu">If you’re writing a custom system prompt, make sure to include <code><<tool_descriptions>></code> in the template so the agent is aware of the available tools.</p></div> <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> transformers <span class="hljs-keyword">import</span> ReactJsonAgent
	<span class="hljs-keyword">from</span> transformers.agents <span class="hljs-keyword">import</span> PythonInterpreterTool

	agent = ReactJsonAgent(tools=[PythonInterpreterTool()], system_prompt=<span class="hljs-string">"{your_custom_prompt}"</span>)<!-- HTML_TAG_END --></pre></div> <h2 class="relative group"><a id="code-execution" 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="#code-execution"><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>Code execution</span></h2> <p data-svelte-h="svelte-1dtk242">For safety, only the tools you provide (and the default Transformers tools) and the <code>print</code> function are executed. The interpreter doesn’t allow importing modules that aren’t on a safe list.</p> <p data-svelte-h="svelte-1c01mws">To import modules that aren’t on the list, add them as a list to the <code>additional_authorized_imports</code> parameter when initializing an agent.</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> transformers <span class="hljs-keyword">import</span> ReactCodeAgent

	agent = ReactCodeAgent(tools=[], additional_authorized_imports=[<span class="hljs-string">'requests'</span>, <span class="hljs-string">'bs4'</span>])
	agent.run(<span class="hljs-string">"Could you get me the title of the page at url 'https://huggingface.co/blog'?"</span>)<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-kagpuv">Code execution stops if a tool isn’t on the safe list, it isn’t authorized, or if the code generated by the agent returns a Python error.</p> <div class="course-tip course-tip-orange bg-gradient-to-br dark:bg-gradient-to-r before:border-orange-500 dark:before:border-orange-800 from-orange-50 dark:from-gray-900 to-white dark:to-gray-950 border border-orange-50 text-orange-700 dark:text-gray-400"><p data-svelte-h="svelte-ug0oul">A LLM can generate any arbitrary code that can be executed, so don’t add any unsafe imports!</p></div> <h2 class="relative group"><a id="multi-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="#multi-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>Multi-agent</span></h2> <p data-svelte-h="svelte-1ot2sat"><a href="https://hf.co/papers/2308.08155" rel="nofollow">Multi-agent</a> refers to multiple agents working together to solve a task. Performance is typically better because each agent is specialized for a particular subtask.</p> <p data-svelte-h="svelte-1usd7qa">Multi-agents are created through a <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.ManagedAgent">ManagedAgent</a> class, where a <em>manager agent</em> oversees how other agents work together. The manager agent requires an agent and their name and description. These are added to the manager agents system prompt which lets it know how to call and use them.</p> <p data-svelte-h="svelte-17tjv9j">The multi-agent example below creates a web search agent that is managed by another <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.ReactCodeAgent">ReactCodeAgent</a>.</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> transformers.agents <span class="hljs-keyword">import</span> ReactCodeAgent, HfApiEngine, DuckDuckGoSearchTool, ManagedAgent

	llm_engine = HfApiEngine()
	web_agent = ReactCodeAgent(tools=[DuckDuckGoSearchTool()], llm_engine=llm_engine)
	managed_web_agent = ManagedAgent(
	agent=web_agent,
	name=<span class="hljs-string">"web_search"</span>,
	description=<span class="hljs-string">"Runs web searches for you. Give it your query as an argument."</span>
	)
	manager_agent = ReactCodeAgent(
	tools=[], llm_engine=llm_engine, managed_agents=[managed_web_agent]
	)
	manager_agent.run(<span class="hljs-string">"Who is the CEO of Hugging Face?"</span>)<!-- HTML_TAG_END --></pre></div> <h2 class="relative group"><a id="gradio-integration" 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="#gradio-integration"><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>Gradio integration</span></h2> <p data-svelte-h="svelte-ara28r"><a href="https://www.gradio.app/" rel="nofollow">Gradio</a> is a library for quickly creating and sharing machine learning apps. The <a href="https://www.gradio.app/docs/gradio/chatbot" rel="nofollow">gradio.Chatbot</a> supports chatting with a Transformers agent with the <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.stream_to_gradio">stream_to_gradio()</a> function.</p> <p data-svelte-h="svelte-ch0496">Load a tool and LLM with an agent, and then create a Gradio app. The key is to use <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.stream_to_gradio">stream_to_gradio()</a> to stream the agents messages and display how it’s reasoning through a task.</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">import</span> gradio <span class="hljs-keyword">as</span> gr
	<span class="hljs-keyword">from</span> transformers <span class="hljs-keyword">import</span> (
	load_tool,
	ReactCodeAgent,
	HfApiEngine,
	stream_to_gradio,
	)

	<span class="hljs-comment"># Import tool from Hub</span>
	image_generation_tool = load_tool(<span class="hljs-string">"m-ric/text-to-image"</span>)
	llm_engine = HfApiEngine(<span class="hljs-string">"meta-llama/Meta-Llama-3-70B-Instruct"</span>)

	<span class="hljs-comment"># Initialize the agent with the image generation tool</span>
	agent = ReactCodeAgent(tools=[image_generation_tool], llm_engine=llm_engine)

	<span class="hljs-keyword">def</span> <span class="hljs-title function_">interact_with_agent</span>(<span class="hljs-params">task</span>):
	messages = []
	messages.append(gr.ChatMessage(role=<span class="hljs-string">"user"</span>, content=task))
	<span class="hljs-keyword">yield</span> messages
	<span class="hljs-keyword">for</span> msg <span class="hljs-keyword">in</span> stream_to_gradio(agent, task):
	messages.append(msg)
	<span class="hljs-keyword">yield</span> messages + [
	gr.ChatMessage(role=<span class="hljs-string">"assistant"</span>, content=<span class="hljs-string">"⏳ Task not finished yet!"</span>)
	]
	<span class="hljs-keyword">yield</span> messages

	<span class="hljs-keyword">with</span> gr.Blocks() <span class="hljs-keyword">as</span> demo:
	text_input = gr.Textbox(lines=<span class="hljs-number">1</span>, label=<span class="hljs-string">"Chat Message"</span>, value=<span class="hljs-string">"Make me a picture of the Statue of Liberty."</span>)
	submit = gr.Button(<span class="hljs-string">"Run illustrator agent!"</span>)
	chatbot = gr.Chatbot(
	label=<span class="hljs-string">"Agent"</span>,
	<span class="hljs-built_in">type</span>=<span class="hljs-string">"messages"</span>,
	avatar_images=(
	<span class="hljs-literal">None</span>,
	<span class="hljs-string">"https://em-content.zobj.net/source/twitter/53/robot-face_1f916.png"</span>,
	),
	)
	submit.click(interact_with_agent, [text_input], [chatbot])

	<span class="hljs-keyword">if</span> __name__ == <span class="hljs-string">"__main__"</span>:
	demo.launch()<!-- HTML_TAG_END --></pre></div> <h2 class="relative group"><a id="troubleshoot" 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="#troubleshoot"><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>Troubleshoot</span></h2> <p data-svelte-h="svelte-1lec8j9">For a better idea of what is happening when you call an agent, it is always a good idea to check the system prompt template first.</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-built_in">print</span>(agent.system_prompt_template)<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1uczg7d">If the agent is behaving unexpectedly, remember to explain the task you want to perform as clearly as possible. Every <a href="/docs/transformers/pr_36839/en/main_classes/agent#transformers.Agent.run">run()</a> is different and minor variations in your system prompt may yield completely different results.</p> <p data-svelte-h="svelte-13gjoub">To find out what happened after a run, check the following agent attributes.</p> <ul data-svelte-h="svelte-1mtavqt"><li><code>agent.logs</code> stores the finegrained agent logs. At every step of the agents run, everything is stored in a dictionary and appended to <code>agent.logs</code>.</li> <li><code>agent.write_inner_memory_from_logs</code> only stores a high-level overview of the agents run. For example, at each step, it stores the LLM output as a message and the tool call output as a separate message. Not every detail from a step is transcripted by <code>write_inner_memory_from_logs</code>.</li></ul> <h2 class="relative group"><a id="resources" 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="#resources"><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>Resources</span></h2> <p data-svelte-h="svelte-f9abqj">Learn more about ReAct agents in the <a href="https://hf.co/blog/open-source-llms-as-agents" rel="nofollow">Open-source LLMs as LangChain Agents</a> blog post.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/transformers/blob/main/docs/source/en/agents.md" 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_1bm5psi = {
	assets: "/docs/transformers/pr_36839/en",
	base: "/docs/transformers/pr_36839/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/transformers/pr_36839/en/_app/immutable/entry/start.6be8d590.js"),
	import("/docs/transformers/pr_36839/en/_app/immutable/entry/app.09748b4b.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 5],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 50.4 kB
Xet hash:: 275cae9bf05ac6986084b51621bbfe1e59a8f1f4921d131a5a30a6327f82e205

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