autotrain/pr_749/en/quickstart_spaces.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Quickstart Guide to AutoTrain on Hugging Face Spaces&quot;,&quot;local&quot;:&quot;quickstart-guide-to-autotrain-on-hugging-face-spaces&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Creating a New AutoTrain Space&quot;,&quot;local&quot;:&quot;creating-a-new-autotrain-space&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Ensuring Your AutoTrain is Up-to-Date&quot;,&quot;local&quot;:&quot;ensuring-your-autotrain-is-up-to-date&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}">
		<link href="/docs/autotrain/pr_749/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/entry/start.b4f8a0ef.js">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/scheduler.0219f8bd.js">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/singletons.74a96c49.js">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/paths.5815e531.js">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/entry/app.4f18d4a0.js">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/index.f61edf3b.js">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/nodes/0.3ba41ccf.js">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/nodes/21.8ae4399d.js">
		<link rel="modulepreload" href="/docs/autotrain/pr_749/en/_app/immutable/chunks/EditOnGithub.48fa589f.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Quickstart Guide to AutoTrain on Hugging Face Spaces&quot;,&quot;local&quot;:&quot;quickstart-guide-to-autotrain-on-hugging-face-spaces&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Creating a New AutoTrain Space&quot;,&quot;local&quot;:&quot;creating-a-new-autotrain-space&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Ensuring Your AutoTrain is Up-to-Date&quot;,&quot;local&quot;:&quot;ensuring-your-autotrain-is-up-to-date&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>  <h1 class="relative group"><a id="quickstart-guide-to-autotrain-on-hugging-face-spaces" 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="#quickstart-guide-to-autotrain-on-hugging-face-spaces"><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>Quickstart Guide to AutoTrain on Hugging Face Spaces</span></h1> <p data-svelte-h="svelte-yoa7jd">AutoTrain on Hugging Face Spaces is the preferred choice for a streamlined experience in
model training. This platform is optimized for ease of use, with pre-installed dependencies
and managed hardware resources. AutoTrain on Hugging Face Spaces can be used both by
no-code users and developers, making it versatile for various levels of expertise.</p>  <h2 class="relative group"><a id="creating-a-new-autotrain-space" 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="#creating-a-new-autotrain-space"><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>Creating a New AutoTrain Space</span></h2> <p data-svelte-h="svelte-6mu5px">Getting started with AutoTrain is straightforward. Here’s how you can create your new space:</p> <ol data-svelte-h="svelte-tbklvx"><li><p><strong>Visit the AutoTrain Page</strong>: To create a new space with AutoTrain Docker image, all you need to do is go
to <a href="https://hf.co/autotrain" rel="nofollow">AutoTrain Homepage</a> and click on “Create new project”.</p></li> <li><p><strong>Log In or View the Setup Screen</strong>: If not logged in, you’ll be prompted to do so. Then, you’ll see a screen similar to this:</p></li></ol> <p data-svelte-h="svelte-170r39o"><img src="https://raw.githubusercontent.com/huggingface/autotrain-advanced/main/static/duplicate_space.png" alt="autotrain-duplicate-space"></p> <ol start="3" data-svelte-h="svelte-1kzvq72"><li><strong>Set Up Your Space</strong>:</li></ol> <ul data-svelte-h="svelte-me8mn0"><li><p><strong>Choose a Space Name</strong>: Name your space something relevant to your project.</p></li> <li><p><strong>Allocate Hardware Resources</strong>: Select the necessary computational resources based on your project needs.</p></li> <li><p><strong>Duplicate Space</strong>: Click on “Duplicate Space” to initiate your AutoTrain space with the Docker image.</p></li></ul> <ol start="4" data-svelte-h="svelte-pyqbsl"><li><strong>Configuration Options</strong>:</li></ol> <ul data-svelte-h="svelte-rqvo"><li>PAUSE_ON_FAILURE: Set this to 0 if you prefer the space not to pause on training failures, useful for running continuous experiments. This option can also be used if you continuously want to perfom many experiments in the same space.</li></ul> <ol start="5" data-svelte-h="svelte-162o80o"><li><strong>Launch and Train</strong>:</li></ol> <ul data-svelte-h="svelte-1n9nw3m"><li>Once done, in a few seconds, the AutoTrain Space will be up and running and you will be presented with the following screen:</li></ul> <p data-svelte-h="svelte-ex5u22"><img src="https://raw.githubusercontent.com/huggingface/autotrain-advanced/main/static/autotrain_space.png" alt="autotrain-space"></p> <ul data-svelte-h="svelte-1ras086"><li><p>From here, you can select tasks, upload datasets, choose models, adjust hyperparameters (if needed),
and start the training process directly within the space.</p></li> <li><p>The space will manage its own activity, shutting down post-training unless configured
otherwise based on the <code>PAUSE_ON_FAILURE</code> setting.</p></li></ul> <ol start="6" data-svelte-h="svelte-7g1eo2"><li><strong>Monitoring Progress</strong>:</li></ol> <ul data-svelte-h="svelte-1lhdc0b"><li><p>All training logs and progress can be monitored via TensorBoard, accessible under
<code>username/project_name</code> on the Hugging Face Hub.</p></li> <li><p>Once training concludes successfully, you’ll find the model files in the same repository.</p></li></ul> <ol start="7" data-svelte-h="svelte-vkd4ir"><li><strong>Navigating the UI</strong>:</li></ol> <ul data-svelte-h="svelte-1c1z6b6"><li>If you need help understanding any UI elements, click on the small (i) information icons for detailed descriptions.</li></ul> <p data-svelte-h="svelte-khj2is">If you are confused about the UI elements, click on the small (i) information icon to get more information about the UI element.</p> <p data-svelte-h="svelte-1xlcyug">For data formats and detailed parameter information, please see the Data Formats and Parameters section where we provide
example datasets and detailed information about the parameters for each task supported by AutoTrain.</p>  <h2 class="relative group"><a id="ensuring-your-autotrain-is-up-to-date" 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="#ensuring-your-autotrain-is-up-to-date"><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>Ensuring Your AutoTrain is Up-to-Date</span></h2> <p data-svelte-h="svelte-8tht4d">We are constantly adding new features and tasks to AutoTrain Advanced. To benefit from the latest features, tasks, and bug fixes, update your AutoTrain space regularly:</p> <ul data-svelte-h="svelte-1miam7u"><li><em>Factory Reboot</em>: Navigate to the settings page of your space and click on “Factory reboot” to upgrade to the latest version of AutoTrain Advanced.</li></ul> <p data-svelte-h="svelte-117xos0"><img src="https://raw.githubusercontent.com/huggingface/autotrain-advanced/main/static/space_template_5.png" alt="autotrain-space-template"></p> <ul data-svelte-h="svelte-17czs0t"><li><em>Note</em>: Simply “restarting” the space does not update it; a factory reboot is necessary for a complete update.</li></ul> <p data-svelte-h="svelte-1k0e6jk">For additional details on data formats and specific parameters, refer to the
‘Data Formats and Parameters’ section where we provide example datasets and extensive
parameter information for each supported task by AutoTrain.</p> <p data-svelte-h="svelte-1cwuhdo">With these steps, you can effortlessly initiate and manage your AutoTrain projects on
Hugging Face Spaces, leveraging the platform’s robust capabilities for your machine learning and AI
needs.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/autotrain-advanced/blob/main/docs/source/quickstart_spaces.mdx" target="_blank"><span data-svelte-h="svelte-1kd6by1">&lt;</span> <span data-svelte-h="svelte-x0xyl0">&gt;</span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a>  <p></p> 
			
			<script>
				{
					__sveltekit_ewvlbq = {
						assets: "/docs/autotrain/pr_749/en",
						base: "/docs/autotrain/pr_749/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/autotrain/pr_749/en/_app/immutable/entry/start.b4f8a0ef.js"),
						import("/docs/autotrain/pr_749/en/_app/immutable/entry/app.4f18d4a0.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 21],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>