simulate/v0.0.2/en/api_overview.html

<meta charset="utf-8" /><meta http-equiv="content-security-policy" content=""><meta name="hf:doc:metadata" content="{&quot;local&quot;:&quot;overview&quot;,&quot;title&quot;:&quot;Overview&quot;}" data-svelte="svelte-1phssyn">
	<link rel="modulepreload" href="/docs/simulate/v0.0.2/en/_app/assets/pages/__layout.svelte-hf-doc-builder.css">
	<link rel="modulepreload" href="/docs/simulate/v0.0.2/en/_app/start-hf-doc-builder.js">
	<link rel="modulepreload" href="/docs/simulate/v0.0.2/en/_app/chunks/vendor-hf-doc-builder.js">
	<link rel="modulepreload" href="/docs/simulate/v0.0.2/en/_app/chunks/paths-hf-doc-builder.js">
	<link rel="modulepreload" href="/docs/simulate/v0.0.2/en/_app/pages/__layout.svelte-hf-doc-builder.js">
	<link rel="modulepreload" href="/docs/simulate/v0.0.2/en/_app/pages/api_overview.mdx-hf-doc-builder.js">
	<link rel="modulepreload" href="/docs/simulate/v0.0.2/en/_app/chunks/Tip-hf-doc-builder.js">
	<link rel="modulepreload" href="/docs/simulate/v0.0.2/en/_app/chunks/IconCopyLink-hf-doc-builder.js"> 





<h1 class="relative group"><a id="overview" 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="#overview"><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>Overview
	</span></h1>

<p>The how-to guides offer a more comprehensive overview of all the tools 🤗 Simulate offers and how to use them. This will help you build 3D environments, define an Actors with Sensors, Actuators and Reward Functions.</p>
<p>The guides assume you are familiar and comfortable with the 🤗 Simulate basics. We recommend newer users check out our <a href="tutorial">tutorials</a> first.</p>


<div class="course-tip  bg-gradient-to-br dark:bg-gradient-to-r before:border-green-500 dark:before:border-green-800 from-green-50 dark:from-gray-900 to-white dark:to-gray-950 border border-green-50 text-green-700 dark:text-gray-400"><p>Interested in learning more about Deep RL? Check of the 🤗 <a href="https://github.com/huggingface/deep-rl-class#the-hugging-face-deep-reinforcement-learning-class-" rel="nofollow">Deep RL course</a>.</p></div>
<p>The guides are organized into five sections:</p>
<ul><li><span class="underline decoration-sky-400 decoration-2 font-semibold">General usage</span>: How to define the walls, objects and lighting of an environment.</li>
<li><span class="underline decoration-indigo-400 decoration-2 font-semibold">Under the hood</span>: The core classes that enable Simulate to work as it does with Python.</li>
<li><span class="underline decoration-pink-400 decoration-2 font-semibold">Reinforcement learning</span>: How to create you Actors, Sensors, Actuators and Reward Functions.</li>
<li><span class="underline decoration-yellow-400 decoration-2 font-semibold">Synthetic data generation</span>: How to use the Simulate library to create synthetic datasets.</li>
<li><span class="underline decoration-green-400 decoration-2 font-semibold">Articulation bodies</span>: How to set up robotic limbs, with hinges, joints and sliders.</li></ul>
<p>If you have any questions about 🤗 Simulate, feel free to join and ask the community on our <a href="https://discuss.huggingface.co/c/simulate" rel="nofollow">forum</a>.</p>


		<script type="module" data-hydrate="sn50dp">
		import { start } from "/docs/simulate/v0.0.2/en/_app/start-hf-doc-builder.js";
		start({
			target: document.querySelector('[data-hydrate="sn50dp"]').parentNode,
			paths: {"base":"/docs/simulate/v0.0.2/en","assets":"/docs/simulate/v0.0.2/en"},
			session: {},
			route: false,
			spa: false,
			trailing_slash: "never",
			hydrate: {
				status: 200,
				error: null,
				nodes: [
					import("/docs/simulate/v0.0.2/en/_app/pages/__layout.svelte-hf-doc-builder.js"),
						import("/docs/simulate/v0.0.2/en/_app/pages/api_overview.mdx-hf-doc-builder.js")
				],
				params: {}
			}
		});
	</script>