openenv/pr_739/en/guides/index.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Guides&quot;,&quot;local&quot;:&quot;guides&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Using Environments&quot;,&quot;local&quot;:&quot;using-environments&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Building Environments&quot;,&quot;local&quot;:&quot;building-environments&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Training&quot;,&quot;local&quot;:&quot;training&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}">
		<link href="/docs/openenv/pr_739/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/entry/start.4afebbde.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/chunks/scheduler.2b22cead.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/chunks/singletons.94248ff9.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/chunks/paths.ebd69244.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/entry/app.55ca0ce1.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/chunks/preload-helper.841f9d18.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/chunks/index.1a0e8013.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/nodes/0.dbf60284.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/nodes/49.5e9f59fc.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/chunks/Heading.8250c9c7.js">
		<link rel="modulepreload" href="/docs/openenv/pr_739/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.5df0e759.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Guides&quot;,&quot;local&quot;:&quot;guides&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Using Environments&quot;,&quot;local&quot;:&quot;using-environments&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Building Environments&quot;,&quot;local&quot;:&quot;building-environments&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Training&quot;,&quot;local&quot;:&quot;training&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>  <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" 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></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg></button></div> </div>  <h1 class="relative group"><a id="guides" 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="#guides"><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>Guides</span></h1> <p data-svelte-h="svelte-1otajy7">Practical how-to guides for working with OpenEnv. These guides are task-oriented and help you accomplish specific goals.</p> <div class="mt-6" data-svelte-h="svelte-1cj8hpw"><div class="w-full flex flex-col space-y-4 md:space-y-0 md:grid md:grid-cols-3 md:gap-4"><a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-md" href="concepts"><div class="font-bold mb-2">🔌 Using Environments</div> <p>Learn how to connect to and interact with OpenEnv environments.</p> <p class="text-sm font-medium">Concepts →</p></a> <a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-md" href="first-environment"><div class="font-bold mb-2">🛠️ Building Environments</div> <p>Create your own custom environments for agentic training.</p> <p class="text-sm font-medium">Your First Environment →</p></a> <a class="!no-underline border dark:border-gray-700 p-5 rounded-lg shadow hover:shadow-md" href="rl-integration"><div class="font-bold mb-2">🧠 Training</div> <p>Integrate OpenEnv with RL frameworks for agent training.</p> <p class="text-sm font-medium">RL Integration →</p></a></div></div>  <h2 class="relative group"><a id="using-environments" 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="#using-environments"><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>Using Environments</span></h2> <ul data-svelte-h="svelte-922zo1"><li><a href="concepts"><strong>Concepts</strong></a> - Understand the core environment, action, observation, and reward abstractions</li> <li><a href="auto-discovery"><strong>Auto-Discovery (AutoEnv)</strong></a> - Automatically discover and load environments</li> <li><a href="connecting"><strong>Connecting to Servers</strong></a> - Connect via HTTP, Docker, or Hugging Face Spaces</li> <li><a href="async-sync"><strong>Async vs Sync Usage</strong></a> - When and how to use async vs sync clients</li></ul>  <h2 class="relative group"><a id="building-environments" 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="#building-environments"><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>Building Environments</span></h2> <ul data-svelte-h="svelte-1fp77dr"><li><a href="first-environment"><strong>Your First Environment</strong></a> - Build a simple environment from scratch</li> <li><a href="environment-anatomy"><strong>Environment Anatomy</strong></a> - Deep dive into environment structure</li> <li><a href="deployment"><strong>Deployment</strong></a> - Deploy to Docker, Hugging Face Spaces, and registries</li> <li><a href="customizing-web-ui"><strong>Customizing the Web UI</strong></a> - Customize your environment’s built-in web interface</li></ul>  <h2 class="relative group"><a id="training" 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="#training"><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>Training</span></h2> <ul data-svelte-h="svelte-f5o2rz"><li><a href="rl-integration"><strong>RL Framework Integration</strong></a> - Use OpenEnv with TRL, torchforge, and more</li> <li><a href="rewards"><strong>Reward Design</strong></a> - Design effective reward functions for your agents</li> <li><a href="simulation-vs-production"><strong>Simulation vs Production Mode</strong></a> - When to use the training loop vs direct MCP access</li> <li><a href="mcp-environment-lifecycle"><strong>MCP Environment Lifecycle</strong></a> - How MCP tools fit into the step loop</li></ul> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/openenv/blob/main/docs/source/guides/index.md" target="_blank"><svg class="mr-1" 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="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg> <span data-svelte-h="svelte-zjs2n5"><span class="underline">Update</span> on GitHub</span></a>  <p></p> 
			
			<script>
				{
					__sveltekit_1xo0pas = {
						assets: "/docs/openenv/pr_739/en",
						base: "/docs/openenv/pr_739/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/openenv/pr_739/en/_app/immutable/entry/start.4afebbde.js"),
						import("/docs/openenv/pr_739/en/_app/immutable/entry/app.55ca0ce1.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 49],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>