optimum/pr_2398/en/installation.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Installation&quot;,&quot;local&quot;:&quot;installation&quot;,&quot;sections&quot;:[],&quot;depth&quot;:1}">
		<link href="/docs/optimum/pr_2398/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/entry/start.d29628ca.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/chunks/scheduler.0cf4ef2e.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/chunks/singletons.33568f82.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/chunks/paths.e973c34f.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/entry/app.fc7b8179.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/chunks/preload-helper.b91a9496.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/chunks/index.abc433bf.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/nodes/0.c38eab5a.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/nodes/7.95b40890.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.dec0daab.js">
		<link rel="modulepreload" href="/docs/optimum/pr_2398/en/_app/immutable/chunks/CodeBlock.557012be.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Installation&quot;,&quot;local&quot;:&quot;installation&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 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="installation" 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="#installation"><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>Installation</span></h1> <p data-svelte-h="svelte-wergr7">🤗 Optimum can be installed using <code>pip</code> as follows:</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 -->python -m pip install optimum<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1az9spn">If you’d like to use the accelerator-specific features of 🤗 Optimum, you can install the required dependencies according to the table below:</p> <table data-svelte-h="svelte-15niwzs"><thead><tr><th align="left">Accelerator</th> <th align="left">Installation</th></tr></thead> <tbody><tr><td align="left"><a href="https://huggingface.co/docs/optimum/onnxruntime/overview" rel="nofollow">ONNX Runtime</a></td> <td align="left"><code>pip install --upgrade --upgrade-strategy eager optimum[onnxruntime]</code></td></tr> <tr><td align="left"><a href="https://huggingface.co/docs/optimum/intel/index" rel="nofollow">OpenVINO</a></td> <td align="left"><code>pip install --upgrade --upgrade-strategy eager optimum[openvino]</code></td></tr> <tr><td align="left"><a href="https://huggingface.co/docs/optimum/main/en/nvidia_overview" rel="nofollow">NVIDIA TensorRT-LLM</a></td> <td align="left"><code>docker run -it --gpus all --ipc host huggingface/optimum-nvidia</code></td></tr> <tr><td align="left"><a href="https://huggingface.co/docs/optimum/amd/index" rel="nofollow">AMD Instinct GPUs and Ryzen AI NPU</a></td> <td align="left"><code>pip install --upgrade --upgrade-strategy eager optimum[amd]</code></td></tr> <tr><td align="left"><a href="https://huggingface.co/docs/optimum-neuron/index" rel="nofollow">AWS Trainum &amp; Inferentia</a></td> <td align="left"><code>pip install --upgrade --upgrade-strategy eager optimum[neuronx]</code></td></tr> <tr><td align="left"><a href="https://huggingface.co/docs/optimum/habana/index" rel="nofollow">Habana Gaudi Processor (HPU)</a></td> <td align="left"><code>pip install --upgrade --upgrade-strategy eager optimum[habana]</code></td></tr> <tr><td align="left"><a href="https://huggingface.co/docs/optimum/furiosa/index" rel="nofollow">FuriosaAI</a></td> <td align="left"><code>pip install --upgrade --upgrade-strategy eager optimum[furiosa]</code></td></tr></tbody></table> <p data-svelte-h="svelte-q5ptbo">The <code>--upgrade --upgrade-strategy eager</code> option is needed to ensure the different packages are upgraded to the latest possible version.</p> <p data-svelte-h="svelte-1vwn6yx">If you’d like to play with the examples or need the bleeding edge of the code and can’t wait for a new release, you can install the base library from source as follows:</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 -->python -m pip install git+https://github.com/huggingface/optimum.git<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-1k9gtp3">For the accelerator-specific features, you can install them by appending <code>optimum[accelerator_type]</code> to the <code>pip</code> command, e.g.</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 -->python -m pip install optimum[onnxruntime]@git+https://github.com/huggingface/optimum.git<!-- HTML_TAG_END --></pre></div>  <p></p> 
			
			<script>
				{
					__sveltekit_zufkep = {
						assets: "/docs/optimum/pr_2398/en",
						base: "/docs/optimum/pr_2398/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/optimum/pr_2398/en/_app/immutable/entry/start.d29628ca.js"),
						import("/docs/optimum/pr_2398/en/_app/immutable/entry/app.fc7b8179.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 7],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>