trackio/pr_320/en/deploy_embed.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Deploying and Embedding Dashboards&quot;,&quot;local&quot;:&quot;deploying-and-embedding-dashboards&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Deploying to Hugging Face Spaces&quot;,&quot;local&quot;:&quot;deploying-to-hugging-face-spaces&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Embedding a Trackio Dashboard&quot;,&quot;local&quot;:&quot;embedding-a-trackio-dashboard&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2}],&quot;depth&quot;:1}">
		<link href="/docs/trackio/pr_320/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/entry/start.e438b774.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/chunks/scheduler.cfabe6e6.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/chunks/singletons.d68e5a39.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/chunks/index.9f0f4ad4.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/chunks/paths.63d94957.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/entry/app.da21f547.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/chunks/preload-helper.802ec759.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/chunks/index.2eae04e0.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/nodes/0.8f9e9ec0.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/nodes/4.2fa80927.js">
		<link rel="modulepreload" href="/docs/trackio/pr_320/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.e552d4e7.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Deploying and Embedding Dashboards&quot;,&quot;local&quot;:&quot;deploying-and-embedding-dashboards&quot;,&quot;sections&quot;:[{&quot;title&quot;:&quot;Deploying to Hugging Face Spaces&quot;,&quot;local&quot;:&quot;deploying-to-hugging-face-spaces&quot;,&quot;sections&quot;:[],&quot;depth&quot;:2},{&quot;title&quot;:&quot;Embedding a Trackio Dashboard&quot;,&quot;local&quot;:&quot;embedding-a-trackio-dashboard&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 max-sm:gap-0.5 h-6 max-sm:h-5 px-2 max-sm:px-1.5 text-[11px] max-sm:text-[9px] 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"><svg class="w-3 h-3 max-sm:w-2.5 max-sm:h-2.5" 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-6 max-sm:h-5 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 w-3 h-3 max-sm:w-2.5 max-sm:h-2.5 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="deploying-and-embedding-dashboards" 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="#deploying-and-embedding-dashboards"><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>Deploying and Embedding Dashboards</span></h1>  <h2 class="relative group"><a id="deploying-to-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="#deploying-to-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>Deploying to Hugging Face Spaces</span></h2> <p data-svelte-h="svelte-39faps">When calling <a href="/docs/trackio/pr_320/en/api#trackio.init">init()</a>, by default the service will run locally and store project data on the local machine.</p> <p data-svelte-h="svelte-1jdlpm8">But if you pass a <code>space_id</code> to <a href="/docs/trackio/pr_320/en/api#trackio.init">init()</a>, like:</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 -->trackio.init(project=<span class="hljs-string">&quot;my-project&quot;</span>, space_id=<span class="hljs-string">&quot;orgname/space_id&quot;</span>)<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-93sdsf">or</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 -->trackio.init(project=<span class="hljs-string">&quot;my-project&quot;</span>, space_id=<span class="hljs-string">&quot;username/space_id&quot;</span>)<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-q9r9dd">it will use an existing or automatically deploy a new Hugging Face Space as needed. You should be logged in with the <code>huggingface-cli</code> locally and your token should have write permissions to create the Space.</p>  <h2 class="relative group"><a id="embedding-a-trackio-dashboard" 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="#embedding-a-trackio-dashboard"><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>Embedding a Trackio Dashboard</span></h2> <p data-svelte-h="svelte-bar35u">One of the reasons we created <code>trackio</code> was to make it easy to embed live dashboards on websites, blog posts, or anywhere else you can embed a website.</p> <p data-svelte-h="svelte-1lnedmc"><img src="https://github.com/user-attachments/assets/77f1424b-737b-4f04-b828-a12b2c1af4ef" alt="image"></p> <p data-svelte-h="svelte-12lrtsj">If your Trackio dashboard is hosted on Spaces, you can embed it anywhere using an <code>&lt;iframe&gt;</code>:</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-tag">&lt;<span class="hljs-name">iframe</span> <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://username-space_id.hf.space&quot;</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">iframe</span>&gt;</span><!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-15pvsve">You can also filter the dashboard to display only specific projects or metrics using query parameters. Supported parameters include:</p> <ul data-svelte-h="svelte-178sgr3"><li><p><code>project</code> (string): Show only a specific project.</p></li> <li><p><code>metrics</code> (comma-separated list): Show only specific metrics, e.g., <code>train_loss,train_accuracy</code>.</p></li> <li><p><code>sidebar</code> (string, <code>&quot;hidden&quot;</code> or <code>&quot;collapsed&quot;</code>):</p> <ul><li><code>&quot;hidden&quot;</code> hides the sidebar completely.</li> <li><code>&quot;collapsed&quot;</code> keeps the sidebar initially collapsed, but the user can expand it. By default, the sidebar is visible and open.</li></ul></li> <li><p><code>xmin</code> (number): Set the initial minimum value for the x-axis limits across all metrics plots.</p></li> <li><p><code>xmax</code> (number): Set the initial maximum value for the x-axis limits across all metrics plots.</p></li> <li><p><code>smoothing</code> (number): Set the initial value of the smoothing slider (0-20, where 0 = no smoothing).</p></li></ul> <p data-svelte-h="svelte-fafxx9">You can customize your <code>&lt;iframe&gt;</code> using standard attributes such as <code>width</code>, <code>height</code>, and <code>style</code>. For more details, see <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/iframe" rel="nofollow">MDN Web Docs: <code>&lt;iframe&gt;</code></a>. For example:</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-tag">&lt;<span class="hljs-name">iframe</span> 
    <span class="hljs-attr">src</span>=<span class="hljs-string">&quot;https://trackio-documentation.hf.space/?project=my-project&amp;metrics=train_loss,train_accuracy&amp;sidebar=hidden&quot;</span> 
    <span class="hljs-attr">width</span>=<span class="hljs-string">&quot;600&quot;</span> 
    <span class="hljs-attr">height</span>=<span class="hljs-string">&quot;630&quot;</span> 
    <span class="hljs-attr">style</span>=<span class="hljs-string">&quot;border:0;&quot;</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">iframe</span>&gt;</span><!-- HTML_TAG_END --></pre></div> <iframe src="https://trackio-documentation.hf.space/?project=my-project&metrics=train_loss,train_accuracy&sidebar=hidden" width="600" height="630" style="border:0;" data-svelte-h="svelte-1mm7d2a"></iframe> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/gradio-app/trackio/blob/main/docs/source/deploy_embed.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_1q08kwj = {
						assets: "/docs/trackio/pr_320/en",
						base: "/docs/trackio/pr_320/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

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