kernels/pr_607/en/builder/design-overview.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Design overview&quot;,&quot;local&quot;:&quot;design-overview&quot;,&quot;sections&quot;:[],&quot;depth&quot;:1}">
		<link href="/docs/kernels/pr_607/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/entry/start.783410d4.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/chunks/scheduler.f3b1e791.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/chunks/singletons.1e1d6fe7.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/chunks/paths.dc7f083c.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/entry/app.d93c6142.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/chunks/preload-helper.b9f0e7b7.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/chunks/index.023a9934.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/nodes/0.1d24170c.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/nodes/9.fb449f15.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/chunks/CopyLLMTxtMenu.c780467c.js">
		<link rel="modulepreload" href="/docs/kernels/pr_607/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.fb377ec3.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Design overview&quot;,&quot;local&quot;:&quot;design-overview&quot;,&quot;sections&quot;:[],&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="design-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="#design-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>Design overview</span></h1> <p data-svelte-h="svelte-1w9yse9">The Kernel Builder is a Nix flake that combines two components:</p> <p data-svelte-h="svelte-1dqbs7"><img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/kernels/kernel_design_overview.jpg" alt="Kernel Builder architecture"></p> <ul data-svelte-h="svelte-1fh1iln"><li><code>kernel-builder/</code>: a Rust-based CLI
that parses and validates <code>build.toml</code>, scaffolds new kernel projects, and drives the
build. It does not compile kernels itself: every build subcommand executes
<code>nix build</code>/<code>nix run</code>/<code>nix develop</code> against the kernel project’s <code>flake.nix</code>.</li> <li><code>nix-builder</code>: the Nix builder drives the build itself. It generates a build matrix using the supported build configurations
(see <code>nix-builder/versions.nix</code>) and the kernel’s <code>build.toml</code>. The build matrix is the cartesian product of
the backend (one or more of CPU/CUDA/Metal/ROCm/XPU), backend versions, and framework versions.
Nix builder uses <code>kernel-builder</code> to generate the CMake files that drive the build. To do so,
<code>kernel-builder</code> itself is packaged in <code>nix-builder/pkgs</code>.</li></ul> <p data-svelte-h="svelte-w9m9o3">A kernel author uses the Nix builder through the <code>lib.genKernelFlakeOutputs</code> that is exposed through the top-level <code>flake.nix</code>. This generates the Nix flake outputs for building and developing kernels, such as <code>bundle</code> for bundle builds and <code>devShells</code> for development shells.</p> <p data-svelte-h="svelte-aeqsvr">For a deeper look at the design of the Nix builder, see
<a href="./design-nix-builder">Nix Builder design</a>.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/kernels/blob/main/docs/source/builder/design-overview.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_13ecnld = {
						assets: "/docs/kernels/pr_607/en",
						base: "/docs/kernels/pr_607/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/kernels/pr_607/en/_app/immutable/entry/start.783410d4.js"),
						import("/docs/kernels/pr_607/en/_app/immutable/entry/app.d93c6142.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 9],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>