Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / trackio /pr_669 /en /sweeps.html

qgallouedec

12 days ago

download

raw

44.7 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Hyperparameter Sweeps","local":"hyperparameter-sweeps","sections":[{"title":"Quickstart","local":"quickstart","sections":[],"depth":2},{"title":"Sweep configuration","local":"sweep-configuration","sections":[{"title":"Parameter specifications","local":"parameter-specifications","sections":[],"depth":3}],"depth":2},{"title":"Bayesian optimization","local":"bayesian-optimization","sections":[],"depth":2},{"title":"Command-based sweeps and the CLI agent","local":"command-based-sweeps-and-the-cli-agent","sections":[],"depth":2},{"title":"Parallel agents","local":"parallel-agents","sections":[],"depth":2},{"title":"Managing sweeps from the CLI","local":"managing-sweeps-from-the-cli","sections":[],"depth":2},{"title":"Inspecting sweeps from Python","local":"inspecting-sweeps-from-python","sections":[],"depth":2},{"title":"Differences from wandb (current limitations)","local":"differences-from-wandb-current-limitations","sections":[],"depth":2}],"depth":1}"/>
	<link href="/docs/trackio/pr_669/en/_app/immutable/entry/start.B3tM5Kf8.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/chunks/C0oxOte6.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/chunks/BA8oMRef.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/entry/app.0X2VWKHT.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/chunks/7mH5W6P6.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/chunks/WYhG-p4K.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/chunks/DsnmJJEf.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/chunks/C5PX9Fte.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/nodes/0.D7KOxa0H.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/chunks/BoBcZwWf.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/nodes/5.BvMvw6zX.js" rel="modulepreload">
	<link href="/docs/trackio/pr_669/en/_app/immutable/chunks/DGYuDBkl.js" rel="modulepreload">
	<!--bc3lsu--><meta name="hf:doc:metadata" content="{"title":"Hyperparameter Sweeps","local":"hyperparameter-sweeps","sections":[{"title":"Quickstart","local":"quickstart","sections":[],"depth":2},{"title":"Sweep configuration","local":"sweep-configuration","sections":[{"title":"Parameter specifications","local":"parameter-specifications","sections":[],"depth":3}],"depth":2},{"title":"Bayesian optimization","local":"bayesian-optimization","sections":[],"depth":2},{"title":"Command-based sweeps and the CLI agent","local":"command-based-sweeps-and-the-cli-agent","sections":[],"depth":2},{"title":"Parallel agents","local":"parallel-agents","sections":[],"depth":2},{"title":"Managing sweeps from the CLI","local":"managing-sweeps-from-the-cli","sections":[],"depth":2},{"title":"Inspecting sweeps from Python","local":"inspecting-sweeps-from-python","sections":[],"depth":2},{"title":"Differences from wandb (current limitations)","local":"differences-from-wandb-current-limitations","sections":[],"depth":2}],"depth":1}"/><!---->
	<link href="/docs/trackio/pr_669/en/_app/immutable/assets/0.tn0RQdqM.css" rel="modulepreload"> <!--[--><!--[0--><!--[--><!--[0--><!--[--><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> <!--[-1--><!--]--></div><!----> <!--[0--><h1 class="relative group"><a id="hyperparameter-sweeps" 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="#hyperparameter-sweeps"><span><svg 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>Hyperparameter Sweeps</span></h1><!--]--><!----> <p>Trackio can run hyperparameter sweeps: define a search space once, then run one or more agents that execute your training function with different hyperparameter combinations. The API is compatible with <code>wandb.sweep()</code> / <code>wandb.agent()</code>, so existing wandb sweep configs work unchanged.</p> <!--[1--><h2 class="relative group"><a id="quickstart" 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"><span><svg 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</span></h2><!--]--><!----> <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 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="language-python "><!----><span class="hljs-keyword">import</span> trackio

	sweep_config = {
	<span class="hljs-string">"method"</span>: <span class="hljs-string">"grid"</span>,
	<span class="hljs-string">"metric"</span>: {<span class="hljs-string">"name"</span>: <span class="hljs-string">"loss"</span>, <span class="hljs-string">"goal"</span>: <span class="hljs-string">"minimize"</span>},
	<span class="hljs-string">"parameters"</span>: {
	<span class="hljs-string">"lr"</span>: {<span class="hljs-string">"values"</span>: [<span class="hljs-number">0.1</span>, <span class="hljs-number">0.01</span>, <span class="hljs-number">0.001</span>]},
	<span class="hljs-string">"batch_size"</span>: {<span class="hljs-string">"values"</span>: [<span class="hljs-number">16</span>, <span class="hljs-number">32</span>]},
	},
	}

	sweep_id = trackio.sweep(sweep_config, project=<span class="hljs-string">"my-project"</span>)

	<span class="hljs-keyword">def</span> <span class="hljs-title function_">train</span>():
	run = trackio.init(project=<span class="hljs-string">"my-project"</span>)
	lr = run.config[<span class="hljs-string">"lr"</span>]
	batch_size = run.config[<span class="hljs-string">"batch_size"</span>]
	<span class="hljs-keyword">for</span> step <span class="hljs-keyword">in</span> <span class="hljs-built_in">range</span>(<span class="hljs-number">100</span>):
	loss = train_step(lr, batch_size)
	trackio.log({<span class="hljs-string">"loss"</span>: loss})
	trackio.finish()

	trackio.agent(sweep_id, function=train)<!----></pre></div><!----> <p>The agent asks the sweep for the next hyperparameter combination, calls <code>function()</code>, and repeats until the sweep is exhausted, capped, or stopped. Inside <code>function</code>, <code>trackio.init()</code> automatically attaches the run to the sweep and merges the trial’s hyperparameters into <code>run.config</code> (sweep values override any defaults passed via <code>init(config=...)</code>).</p> <p>Results appear in the <strong>Sweeps</strong> tab of the dashboard (<code>trackio show</code>): each sweep shows its state, trial leaderboard, and best run, with pause/resume/stop/cancel controls. In the sidebar, you can also group runs by sweep.</p> <!--[1--><h2 class="relative group"><a id="sweep-configuration" 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="#sweep-configuration"><span><svg 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>Sweep configuration</span></h2><!--]--><!----> <p>The config schema follows wandb’s:</p> <table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody><tr><td><code>method</code></td><td>Search strategy: <code>"grid"</code>, <code>"random"</code>, or <code>"bayes"</code> (required).</td></tr><tr><td><code>parameters</code></td><td>The search space (required).</td></tr><tr><td><code>metric</code></td><td><code>{"name": ..., "goal": "minimize"\\|"maximize", "target": ...}</code> — the metric to optimize. Must be logged as a top-level key via <code>trackio.log()</code>. When <code>target</code> is set, the sweep finishes as soon as a trial reaches it. Required for <code>method: "bayes"</code>.</td></tr><tr><td><code>run_cap</code></td><td>Maximum total number of trials in the sweep.</td></tr><tr><td><code>name</code></td><td>Display name for the sweep.</td></tr><tr><td><code>program</code> / <code>command</code></td><td>Command-based sweeps: the training script and optional command template (see below).</td></tr></tbody></table> <!--[2--><h3 class="relative group"><a id="parameter-specifications" 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="#parameter-specifications"><span><svg 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>Parameter specifications</span></h3><!--]--><!----> <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 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="language-python "><!----><span class="hljs-string">"parameters"</span>: {
	<span class="hljs-string">"constant_param"</span>: {<span class="hljs-string">"value"</span>: <span class="hljs-number">42</span>},
	<span class="hljs-string">"choice_param"</span>: {<span class="hljs-string">"values"</span>: [<span class="hljs-string">"adam"</span>, <span class="hljs-string">"sgd"</span>]},
	<span class="hljs-string">"weighted_choice"</span>: {<span class="hljs-string">"values"</span>: [<span class="hljs-string">"a"</span>, <span class="hljs-string">"b"</span>], <span class="hljs-string">"probabilities"</span>: [<span class="hljs-number">0.7</span>, <span class="hljs-number">0.3</span>]},
	<span class="hljs-string">"int_param"</span>: {<span class="hljs-string">"min"</span>: <span class="hljs-number">1</span>, <span class="hljs-string">"max"</span>: <span class="hljs-number">10</span>},
	<span class="hljs-string">"float_param"</span>: {<span class="hljs-string">"min"</span>: <span class="hljs-number">0.0</span>, <span class="hljs-string">"max"</span>: <span class="hljs-number">1.0</span>},
	<span class="hljs-string">"log_param"</span>: {<span class="hljs-string">"distribution"</span>: <span class="hljs-string">"log_uniform_values"</span>, <span class="hljs-string">"min"</span>: <span class="hljs-number">1e-5</span>, <span class="hljs-string">"max"</span>: <span class="hljs-number">1e-1</span>},
	<span class="hljs-string">"nested"</span>: {
	<span class="hljs-string">"parameters"</span>: {
	<span class="hljs-string">"sub_param"</span>: {<span class="hljs-string">"values"</span>: [<span class="hljs-number">1</span>, <span class="hljs-number">2</span>]},
	}
	},
	}<!----></pre></div><!----> <p>When <code>distribution</code> is omitted, it is inferred: <code>values</code> becomes <code>categorical</code>, <code>value</code> becomes <code>constant</code>, integer <code>min</code>/<code>max</code> becomes <code>int_uniform</code>, and float bounds become <code>uniform</code>. Explicit distributions include <code>uniform</code>, <code>int_uniform</code>, <code>log_uniform_values</code>, <code>q_uniform</code>, <code>normal</code>, <code>log_normal</code>, <code>beta</code>, and their <code>q_</code>-quantized variants — the same set wandb supports.</p> <p>Grid search requires discrete parameters (<code>value</code>, <code>values</code>, <code>int_uniform</code>, or <code>q_uniform</code>); continuous distributions raise an error. Set <code>randomize_order: true</code> at the top level of the config to visit grid combinations in random order. Random search never terminates on its own — bound it with <code>run_cap</code>, <code>metric.target</code>, or the agent’s <code>count</code>.</p> <!--[1--><h2 class="relative group"><a id="bayesian-optimization" 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="#bayesian-optimization"><span><svg 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>Bayesian optimization</span></h2><!--]--><!----> <p><code>method: "bayes"</code> suggests trials with a Gaussian-process surrogate (Matern kernel) and Expected Improvement, comparable to wandb’s bayes engine and implemented with numpy only — no extra dependencies. It requires <code>metric.name</code> so trial results can guide the search:</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 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="language-python "><!---->sweep_config = {
	<span class="hljs-string">"method"</span>: <span class="hljs-string">"bayes"</span>,
	<span class="hljs-string">"metric"</span>: {<span class="hljs-string">"name"</span>: <span class="hljs-string">"loss"</span>, <span class="hljs-string">"goal"</span>: <span class="hljs-string">"minimize"</span>},
	<span class="hljs-string">"run_cap"</span>: <span class="hljs-number">40</span>,
	<span class="hljs-string">"parameters"</span>: {
	<span class="hljs-string">"lr"</span>: {<span class="hljs-string">"distribution"</span>: <span class="hljs-string">"log_uniform_values"</span>, <span class="hljs-string">"min"</span>: <span class="hljs-number">1e-5</span>, <span class="hljs-string">"max"</span>: <span class="hljs-number">1e-1</span>},
	<span class="hljs-string">"optimizer"</span>: {<span class="hljs-string">"values"</span>: [<span class="hljs-string">"adam"</span>, <span class="hljs-string">"sgd"</span>]},
	},
	}<!----></pre></div><!----> <p>The first two trials are sampled randomly; after that, each suggestion maximizes Expected Improvement over candidates drawn from the parameter priors. Failed trials are treated as worst-case observations so the search steers away from crashing regions, and in-flight trials from parallel agents are accounted for so agents don’t receive near-duplicate suggestions. Like random search, bayes never exhausts the space — bound it with <code>run_cap</code> or <code>metric.target</code>.</p> <!--[1--><h2 class="relative group"><a id="command-based-sweeps-and-the-cli-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="#command-based-sweeps-and-the-cli-agent"><span><svg 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>Command-based sweeps and the CLI agent</span></h2><!--]--><!----> <p>Instead of a Python <code>function</code>, a sweep can launch your training script as a subprocess — set <code>program</code> (and optionally <code>command</code>) in the config, wandb-style:</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 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="language-yaml "><!----><span class="hljs-attr">method:</span> <span class="hljs-string">bayes</span>
	<span class="hljs-attr">metric:</span>
	<span class="hljs-attr">name:</span> <span class="hljs-string">loss</span>
	<span class="hljs-attr">goal:</span> <span class="hljs-string">minimize</span>
	<span class="hljs-attr">program:</span> <span class="hljs-string">train.py</span>
	<span class="hljs-attr">parameters:</span>
	<span class="hljs-attr">lr:</span>
	<span class="hljs-attr">min:</span> <span class="hljs-number">0.0001</span>
	<span class="hljs-attr">max:</span> <span class="hljs-number">0.1</span><!----></pre></div><!----> <p>Then run agents from the CLI:</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 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="language-bash "><!---->trackio sweep new sweep.yaml --project my-project
	trackio agent my-project/abcd1234 --count 10<!----></pre></div><!----> <p>Each trial runs <code>program</code> with the hyperparameters passed as <code>--key=value</code> arguments (nested parameters become dotted flags like <code>--optimizer.lr=0.001</code>). Inside the script, call <code>trackio.init()</code> as usual — the agent passes the trial context through environment variables, so the run attaches to the sweep and <code>run.config</code> contains the trial’s hyperparameters automatically.</p> <p>The default command is <code>${env} ${interpreter} ${program} ${args}</code>. Set <code>command</code> to customize it, using wandb’s macros:</p> <table><thead><tr><th>Macro</th><th>Expands to</th></tr></thead><tbody><tr><td><code>${env}</code></td><td><code>/usr/bin/env</code> (omitted on Windows)</td></tr><tr><td><code>${interpreter}</code></td><td>The agent’s Python interpreter (<code>sys.executable</code>)</td></tr><tr><td><code>${program}</code></td><td>The <code>program</code> value</td></tr><tr><td><code>${args}</code></td><td><code>--key=value</code> for every hyperparameter</td></tr><tr><td><code>${args_no_boolean_flags}</code></td><td>Like <code>${args}</code>, but <code>True</code> becomes a bare <code>--key</code> and <code>False</code> is omitted</td></tr><tr><td><code>${args_no_hyphens}</code></td><td><code>key=value</code> pairs</td></tr><tr><td><code>${args_json}</code></td><td>All hyperparameters as one JSON string</td></tr><tr><td><code>${envvar:NAME}</code></td><td>The value of environment variable <code>NAME</code></td></tr></tbody></table> <p>For example, to run training through a shell wrapper:</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 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="language-yaml "><!----><span class="hljs-attr">program:</span> <span class="hljs-string">train.py</span>
	<span class="hljs-attr">command:</span>
	<span class="hljs-bullet">-</span> <span class="hljs-string">${env}</span>
	<span class="hljs-bullet">-</span> <span class="hljs-string">bash</span>
	<span class="hljs-bullet">-</span> <span class="hljs-string">wrapper.sh</span>
	<span class="hljs-bullet">-</span> <span class="hljs-string">${program}</span>
	<span class="hljs-bullet">-</span> <span class="hljs-string">${args_no_hyphens}</span><!----></pre></div><!----> <p><code>trackio.agent(sweep_id)</code> (without <code>function=</code>) also runs command-based sweeps from Python. Command-based agents work against remote sweeps too: <code>trackio agent --space ...</code> or <code>--server-url ...</code> forwards the connection to the subprocess so its run logs to the same server.</p> <!--[1--><h2 class="relative group"><a id="parallel-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="#parallel-agents"><span><svg 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>Parallel agents</span></h2><!--]--><!----> <p>Multiple agents can share one sweep — trial assignment is atomic, so two agents never receive the same grid cell:</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 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="language-python "><!---->trackio.agent(sweep_id, function=train, count=<span class="hljs-number">10</span>)<!----></pre></div><!----> <p>Each agent runs at most <code>count</code> trials (unlimited if omitted). Agents on different machines coordinate through a shared trackio server: pass <code>space_id=</code> or <code>server_url=</code> to both <code>trackio.sweep()</code> and <code>trackio.agent()</code> to coordinate via a Hugging Face Space or a self-hosted server (requires a write token).</p> <!--[1--><h2 class="relative group"><a id="managing-sweeps-from-the-cli" 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="#managing-sweeps-from-the-cli"><span><svg 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>Managing sweeps from the CLI</span></h2><!--]--><!----> <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 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="language-bash "><!---->trackio sweep new sweep.yaml --project my-project <span class="hljs-comment"># also accepts .json / .toml</span>
	trackio sweep list --project my-project
	trackio sweep status my-project/abcd1234 --trials
	trackio sweep pause my-project/abcd1234
	trackio sweep resume my-project/abcd1234
	trackio sweep stop my-project/abcd1234
	trackio sweep cancel my-project/abcd1234<!----></pre></div><!----> <p>YAML configs require <code>pyyaml</code> (<code>pip install pyyaml</code>); JSON and TOML work without extra dependencies. Paused sweeps make agents wait; stopped/cancelled sweeps make agents exit.</p> <!--[1--><h2 class="relative group"><a id="inspecting-sweeps-from-python" 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="#inspecting-sweeps-from-python"><span><svg 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>Inspecting sweeps from Python</span></h2><!--]--><!----> <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 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="language-python "><!----><span class="hljs-keyword">from</span> trackio <span class="hljs-keyword">import</span> Api

	api = Api()
	<span class="hljs-keyword">for</span> sweep <span class="hljs-keyword">in</span> api.sweeps(<span class="hljs-string">"my-project"</span>):
	<span class="hljs-built_in">print</span>(sweep.sweep_id, sweep.state)
	<span class="hljs-built_in">print</span>(sweep.trials)
	best = sweep.best_run()
	<span class="hljs-keyword">if</span> best <span class="hljs-keyword">is</span> <span class="hljs-keyword">not</span> <span class="hljs-literal">None</span>:
	<span class="hljs-built_in">print</span>(best.name, best.config)<!----></pre></div><!----> <!--[1--><h2 class="relative group"><a id="differences-from-wandb-current-limitations" 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="#differences-from-wandb-current-limitations"><span><svg 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>Differences from wandb (current limitations)</span></h2><!--]--><!----> <ul><li><strong><code>early_terminate</code> (hyperband) is not supported yet</strong> — it is accepted but ignored, with a warning.</li> <li><strong>Bayesian optimization is wandb-comparable, not identical</strong> — trackio’s numpy GP uses the same kernel family and acquisition strategy as wandb’s engine but is not a bit-for-bit port, so the exact suggestion sequence differs.</li> <li><code>${interpreter}</code> expands to the agent’s own Python interpreter (<code>sys.executable</code>) rather than wandb’s bare <code>python</code>, so command-based sweeps respect virtual environments. The <code>${args_json_file}</code> macro is not supported.</li> <li><code>entity</code> and <code>prior_runs</code> are accepted for wandb compatibility but ignored.</li> <li>Sweeps are scoped to a single project.</li></ul> <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/sweeps.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><span class="underline">Update</span> on GitHub</span></a><!----> <p></p><!--]--><!----><!--]--><!--]--><!--]--> <!--[-1--><!--]--><!--]-->

	<script>
	{
	__sveltekit_lyrqfm = {
	base: "/docs/trackio/pr_669/en",
	assets: "/docs/trackio/pr_669/en"
	};

	const element = document.currentScript.parentElement;

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

Xet Storage Details

Size:: 44.7 kB
Xet hash:: 4db344989acf2b2363a0be1cf0ecfe16ec204f5dc0ee8b9a0f892324c094f25d

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