transformers/pr_35010/en/gguf.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;GGUF&quot;,&quot;local&quot;:&quot;gguf&quot;,&quot;sections&quot;:[],&quot;depth&quot;:1}">
		<link href="/docs/transformers/pr_35010/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/entry/start.80f0bf24.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/scheduler.01eeda35.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/singletons.2f9d3ffa.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/index.4862150a.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/paths.5ba5a4a8.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/entry/app.746bb5e5.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/index.6dd51b66.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/nodes/0.507a43fb.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/nodes/25.90d88134.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/Tip.de9bae2b.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/CodeBlock.864da1b0.js">
		<link rel="modulepreload" href="/docs/transformers/pr_35010/en/_app/immutable/chunks/EditOnGithub.7faefd25.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;GGUF&quot;,&quot;local&quot;:&quot;gguf&quot;,&quot;sections&quot;:[],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>   <h1 class="relative group"><a id="gguf" 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="#gguf"><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>GGUF</span></h1> <p data-svelte-h="svelte-1j8wxcx"><a href="https://github.com/ggerganov/ggml/blob/master/docs/gguf.md" rel="nofollow">GGUF</a> is a file format used to store models for inference with <a href="https://github.com/ggerganov/ggml" rel="nofollow">GGML</a>, a fast and lightweight inference framework written in C and C++. GGUF is a single-file format containing the model metadata and tensors.</p> <div class="flex justify-center" data-svelte-h="svelte-1kvm71c"><img src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/gguf-spec.png"></div> <p data-svelte-h="svelte-ddcg59">The GGUF format also supports many quantized data types (refer to <a href="https://hf.co/docs/hub/en/gguf#quantization-types" rel="nofollow">quantization type table</a> for a complete list of supported quantization types) which saves a significant amount of memory, making inference with large models like Whisper and Llama feasible on local and edge devices.</p> <p data-svelte-h="svelte-1m2p8bz">Transformers supports loading models stored in the GGUF format for further training or finetuning. The GGUF format is dequantized to fp32 where the full model weights are available and compatible with PyTorch.</p>  <div class="course-tip  bg-gradient-to-br dark:bg-gradient-to-r before:border-green-500 dark:before:border-green-800 from-green-50 dark:from-gray-900 to-white dark:to-gray-950 border border-green-50 text-green-700 dark:text-gray-400"><p data-svelte-h="svelte-2lajtu">Models that support GGUF include Llama, Mistral, Qwen2, Qwen2Moe, Phi3, Bloom, Falcon, StableLM, GPT2, and Starcoder2.</p></div> <p data-svelte-h="svelte-o3hdx9">Add the <code>gguf_file</code> parameter to <a href="/docs/transformers/pr_35010/en/main_classes/model#transformers.PreTrainedModel.from_pretrained">from_pretrained()</a> to specify the GGUF file to load.</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-keyword">from</span> transformers <span class="hljs-keyword">import</span> AutoTokenizer, AutoModelForCausalLM

model_id = <span class="hljs-string">&quot;TheBloke/TinyLlama-1.1B-Chat-v1.0-GGUF&quot;</span>
filename = <span class="hljs-string">&quot;tinyllama-1.1b-chat-v1.0.Q6_K.gguf&quot;</span>

tokenizer = AutoTokenizer.from_pretrained(model_id, gguf_file=filename)
model = AutoModelForCausalLM.from_pretrained(model_id, gguf_file=filename)<!-- HTML_TAG_END --></pre></div> <p data-svelte-h="svelte-hgylw2">Once you’re done tinkering with the model, save and convert it back to the GGUF format with the <a href="https://github.com/ggerganov/llama.cpp/blob/master/convert_hf_to_gguf.py" rel="nofollow">convert-hf-to-gguf.py</a> script.</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 -->tokenizer.save_pretrained(<span class="hljs-string">&quot;directory&quot;</span>)
model.save_pretrained(<span class="hljs-string">&quot;directory&quot;</span>)

!python ${path_to_llama_cpp}/convert-hf-to-gguf.py ${directory}<!-- HTML_TAG_END --></pre></div> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/transformers/blob/main/docs/source/en/gguf.md" 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_14c1y9j = {
						assets: "/docs/transformers/pr_35010/en",
						base: "/docs/transformers/pr_35010/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/transformers/pr_35010/en/_app/immutable/entry/start.80f0bf24.js"),
						import("/docs/transformers/pr_35010/en/_app/immutable/entry/app.746bb5e5.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 25],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>