Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / huggingface_hub /pr_4113 /en /package_reference /environment_variables.html

HuggingFaceDocBuilder

about 1 month ago

download

raw

68.7 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Environment variables","local":"environment-variables","sections":[{"title":"Generic","local":"generic","sections":[{"title":"HF_INFERENCE_ENDPOINT","local":"hfinferenceendpoint","sections":[],"depth":3},{"title":"HF_HOME","local":"hfhome","sections":[],"depth":3},{"title":"HF_HUB_CACHE","local":"hfhubcache","sections":[],"depth":3},{"title":"HF_XET_CACHE","local":"hfxetcache","sections":[],"depth":3},{"title":"HF_ASSETS_CACHE","local":"hfassetscache","sections":[],"depth":3},{"title":"HF_TOKEN","local":"hftoken","sections":[],"depth":3},{"title":"HF_TOKEN_PATH","local":"hftokenpath","sections":[],"depth":3},{"title":"HF_HUB_VERBOSITY","local":"hfhubverbosity","sections":[],"depth":3},{"title":"HF_HUB_ETAG_TIMEOUT","local":"hfhubetagtimeout","sections":[],"depth":3},{"title":"HF_HUB_DOWNLOAD_TIMEOUT","local":"hfhubdownloadtimeout","sections":[],"depth":3}],"depth":2},{"title":"Xet","local":"xet","sections":[{"title":"Other Xet environment variables","local":"other-xet-environment-variables","sections":[],"depth":3},{"title":"HF_XET_CHUNK_CACHE_SIZE_BYTES","local":"hfxetchunkcachesizebytes","sections":[],"depth":3},{"title":"HF_XET_SHARD_CACHE_SIZE_LIMIT","local":"hfxetshardcachesizelimit","sections":[],"depth":3},{"title":"HF_XET_NUM_CONCURRENT_RANGE_GETS","local":"hfxetnumconcurrentrangegets","sections":[],"depth":3}],"depth":2},{"title":"Boolean values","local":"boolean-values","sections":[{"title":"HF_DEBUG","local":"hfdebug","sections":[],"depth":3},{"title":"HF_HUB_OFFLINE","local":"hfhuboffline","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_IMPLICIT_TOKEN","local":"hfhubdisableimplicittoken","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_PROGRESS_BARS","local":"hfhubdisableprogressbars","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_SYMLINKS","local":"hfhubdisablesymlinks","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_SYMLINKS_WARNING","local":"hfhubdisablesymlinkswarning","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_EXPERIMENTAL_WARNING","local":"hfhubdisableexperimentalwarning","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_TELEMETRY","local":"hfhubdisabletelemetry","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_XET","local":"hfhubdisablexet","sections":[],"depth":3},{"title":"HF_HUB_ENABLE_HF_TRANSFER","local":"hfhubenablehftransfer","sections":[],"depth":3},{"title":"HF_XET_HIGH_PERFORMANCE","local":"hfxethighperformance","sections":[],"depth":3},{"title":"HF_XET_RECONSTRUCT_WRITE_SEQUENTIALLY","local":"hfxetreconstructwritesequentially","sections":[],"depth":3}],"depth":2},{"title":"Deprecated environment variables","local":"deprecated-environment-variables","sections":[],"depth":2},{"title":"From external tools","local":"from-external-tools","sections":[{"title":"DO_NOT_TRACK","local":"donottrack","sections":[],"depth":3},{"title":"NO_COLOR","local":"nocolor","sections":[],"depth":3},{"title":"XDG_CACHE_HOME","local":"xdgcachehome","sections":[],"depth":3}],"depth":2}],"depth":1}">
	<link href="/docs/huggingface_hub/pr_4113/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/entry/start.cad533c1.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/chunks/scheduler.0cf4ef2e.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/chunks/singletons.2cc47ca0.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/chunks/paths.69a55a12.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/entry/app.b1cfe321.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/chunks/preload-helper.d23a64db.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/chunks/index.abc433bf.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/nodes/0.3b235bd8.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/chunks/each.e59479a4.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/nodes/32.24536c29.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/chunks/CopyLLMTxtMenu.f735f320.js">
	<link rel="modulepreload" href="/docs/huggingface_hub/pr_4113/en/_app/immutable/chunks/MermaidChart.svelte_svelte_type_style_lang.f083e07d.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{"title":"Environment variables","local":"environment-variables","sections":[{"title":"Generic","local":"generic","sections":[{"title":"HF_INFERENCE_ENDPOINT","local":"hfinferenceendpoint","sections":[],"depth":3},{"title":"HF_HOME","local":"hfhome","sections":[],"depth":3},{"title":"HF_HUB_CACHE","local":"hfhubcache","sections":[],"depth":3},{"title":"HF_XET_CACHE","local":"hfxetcache","sections":[],"depth":3},{"title":"HF_ASSETS_CACHE","local":"hfassetscache","sections":[],"depth":3},{"title":"HF_TOKEN","local":"hftoken","sections":[],"depth":3},{"title":"HF_TOKEN_PATH","local":"hftokenpath","sections":[],"depth":3},{"title":"HF_HUB_VERBOSITY","local":"hfhubverbosity","sections":[],"depth":3},{"title":"HF_HUB_ETAG_TIMEOUT","local":"hfhubetagtimeout","sections":[],"depth":3},{"title":"HF_HUB_DOWNLOAD_TIMEOUT","local":"hfhubdownloadtimeout","sections":[],"depth":3}],"depth":2},{"title":"Xet","local":"xet","sections":[{"title":"Other Xet environment variables","local":"other-xet-environment-variables","sections":[],"depth":3},{"title":"HF_XET_CHUNK_CACHE_SIZE_BYTES","local":"hfxetchunkcachesizebytes","sections":[],"depth":3},{"title":"HF_XET_SHARD_CACHE_SIZE_LIMIT","local":"hfxetshardcachesizelimit","sections":[],"depth":3},{"title":"HF_XET_NUM_CONCURRENT_RANGE_GETS","local":"hfxetnumconcurrentrangegets","sections":[],"depth":3}],"depth":2},{"title":"Boolean values","local":"boolean-values","sections":[{"title":"HF_DEBUG","local":"hfdebug","sections":[],"depth":3},{"title":"HF_HUB_OFFLINE","local":"hfhuboffline","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_IMPLICIT_TOKEN","local":"hfhubdisableimplicittoken","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_PROGRESS_BARS","local":"hfhubdisableprogressbars","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_SYMLINKS","local":"hfhubdisablesymlinks","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_SYMLINKS_WARNING","local":"hfhubdisablesymlinkswarning","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_EXPERIMENTAL_WARNING","local":"hfhubdisableexperimentalwarning","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_TELEMETRY","local":"hfhubdisabletelemetry","sections":[],"depth":3},{"title":"HF_HUB_DISABLE_XET","local":"hfhubdisablexet","sections":[],"depth":3},{"title":"HF_HUB_ENABLE_HF_TRANSFER","local":"hfhubenablehftransfer","sections":[],"depth":3},{"title":"HF_XET_HIGH_PERFORMANCE","local":"hfxethighperformance","sections":[],"depth":3},{"title":"HF_XET_RECONSTRUCT_WRITE_SEQUENTIALLY","local":"hfxetreconstructwritesequentially","sections":[],"depth":3}],"depth":2},{"title":"Deprecated environment variables","local":"deprecated-environment-variables","sections":[],"depth":2},{"title":"From external tools","local":"from-external-tools","sections":[{"title":"DO_NOT_TRACK","local":"donottrack","sections":[],"depth":3},{"title":"NO_COLOR","local":"nocolor","sections":[],"depth":3},{"title":"XDG_CACHE_HOME","local":"xdgcachehome","sections":[],"depth":3}],"depth":2}],"depth":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="environment-variables" 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="#environment-variables"><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>Environment variables</span></h1> <p data-svelte-h="svelte-1xuew16"><code>huggingface_hub</code> can be configured using environment variables.</p> <p data-svelte-h="svelte-1by1ave">If you are unfamiliar with environment variable, here are generic articles about them
	<a href="https://linuxize.com/post/how-to-set-and-list-environment-variables-in-linux/" rel="nofollow">on macOS and Linux</a>
	and on <a href="https://phoenixnap.com/kb/windows-set-environment-variable" rel="nofollow">Windows</a>.</p> <p data-svelte-h="svelte-5z5k2g">This page will guide you through all environment variables specific to <code>huggingface_hub</code>
	and their meaning.</p> <blockquote class="tip" data-svelte-h="svelte-1t5awzb"><p>All environment variables are read at import time of <code>huggingface_hub</code>. Any modification
	made afterwards will not be taken into account. Make sure to set your environment variables
	before importing <code>huggingface_hub</code>.</p></blockquote> <h2 class="relative group"><a id="generic" 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="#generic"><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>Generic</span></h2> <h3 class="relative group"><a id="hfinferenceendpoint" 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="#hfinferenceendpoint"><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>HF_INFERENCE_ENDPOINT</span></h3> <p data-svelte-h="svelte-178hqev">To configure the inference api base url. You might want to set this variable if your organization
	is pointing at an API Gateway rather than directly at the inference api.</p> <p data-svelte-h="svelte-3un1ol">Defaults to <code>"https://api-inference.huggingface.co"</code>.</p> <h3 class="relative group"><a id="hfhome" 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="#hfhome"><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>HF_HOME</span></h3> <p data-svelte-h="svelte-uz9mxv">To configure where <code>huggingface_hub</code> will locally store data. In particular, your token
	and the cache will be stored in this folder.</p> <p data-svelte-h="svelte-1x0d3ca">Defaults to <code>"~/.cache/huggingface"</code> unless <a href="#xdgcachehome">XDG_CACHE_HOME</a> is set.</p> <h3 class="relative group"><a id="hfhubcache" 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="#hfhubcache"><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>HF_HUB_CACHE</span></h3> <p data-svelte-h="svelte-lfw4ab">To configure where repositories from the Hub will be cached locally (models, datasets and
	spaces).</p> <p data-svelte-h="svelte-a5p60a">Defaults to <code>"$HF_HOME/hub"</code> (e.g. <code>"~/.cache/huggingface/hub"</code> by default).</p> <h3 class="relative group"><a id="hfxetcache" 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="#hfxetcache"><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>HF_XET_CACHE</span></h3> <p data-svelte-h="svelte-1actej4">To configure where Xet chunks (byte ranges from files managed by Xet backend) are cached locally.</p> <p data-svelte-h="svelte-15fupku">Defaults to <code>"$HF_HOME/xet"</code> (e.g. <code>"~/.cache/huggingface/xet"</code> by default).</p> <h3 class="relative group"><a id="hfassetscache" 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="#hfassetscache"><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>HF_ASSETS_CACHE</span></h3> <p data-svelte-h="svelte-ksjawo">To configure where <a href="../guides/manage-cache#caching-assets">assets</a> created by downstream libraries
	will be cached locally. Those assets can be preprocessed data, files downloaded from GitHub,
	logs,…</p> <p data-svelte-h="svelte-3wzlwo">Defaults to <code>"$HF_HOME/assets"</code> (e.g. <code>"~/.cache/huggingface/assets"</code> by default).</p> <h3 class="relative group"><a id="hftoken" 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="#hftoken"><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>HF_TOKEN</span></h3> <p data-svelte-h="svelte-81jzle">To configure the User Access Token to authenticate to the Hub. If set, this value will
	overwrite the token stored on the machine (in either <code>$HF_TOKEN_PATH</code> or <code>"$HF_HOME/token"</code> if the former is not set).</p> <p data-svelte-h="svelte-pa4dpn">For more details about authentication, check out <a href="../quick-start#authentication">this section</a>.</p> <h3 class="relative group"><a id="hftokenpath" 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="#hftokenpath"><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>HF_TOKEN_PATH</span></h3> <p data-svelte-h="svelte-ks6kva">To configure where <code>huggingface_hub</code> should store the User Access Token. Defaults to <code>"$HF_HOME/token"</code> (e.g. <code>~/.cache/huggingface/token</code> by default).</p> <h3 class="relative group"><a id="hfhubverbosity" 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="#hfhubverbosity"><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>HF_HUB_VERBOSITY</span></h3> <p data-svelte-h="svelte-t9rwl1">Set the verbosity level of the <code>huggingface_hub</code>’s logger. Must be one of
	<code>{"debug", "info", "warning", "error", "critical"}</code>.</p> <p data-svelte-h="svelte-4zt9wc">Defaults to <code>"warning"</code>.</p> <p data-svelte-h="svelte-5rzz4d">For more details, see <a href="../package_reference/utilities#huggingface_hub.utils.logging.get_verbosity">logging reference</a>.</p> <h3 class="relative group"><a id="hfhubetagtimeout" 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="#hfhubetagtimeout"><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>HF_HUB_ETAG_TIMEOUT</span></h3> <p data-svelte-h="svelte-14q9j1n">Integer value to define the number of seconds to wait for server response when fetching the latest metadata from a repo before downloading a file. If the request times out, <code>huggingface_hub</code> will default to the locally cached files. Setting a lower value speeds up the workflow for machines with a slow connection that have already cached files. A higher value guarantees the metadata call to succeed in more cases. Default to 10s.</p> <h3 class="relative group"><a id="hfhubdownloadtimeout" 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="#hfhubdownloadtimeout"><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>HF_HUB_DOWNLOAD_TIMEOUT</span></h3> <p data-svelte-h="svelte-8qjsc">Integer value to define the number of seconds to wait for server response when downloading a file. If the request times out, a TimeoutError is raised. Setting a higher value is beneficial on machine with a slow connection. A smaller value makes the process fail quicker in case of complete network outage. Default to 10s.</p> <h2 class="relative group"><a id="xet" 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="#xet"><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>Xet</span></h2> <h3 class="relative group"><a id="other-xet-environment-variables" 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="#other-xet-environment-variables"><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>Other Xet environment variables</span></h3> <ul data-svelte-h="svelte-egfzye"><li><a href="../package_reference/environment_variables#hfhubdisablexet"><code>HF_HUB_DISABLE_XET</code></a></li> <li><a href="../package_reference/environment_variables#hfxetcache"><code>HF_XET_CACHE</code></a></li> <li><a href="../package_reference/environment_variables#hfxethighperformance"><code>HF_XET_HIGH_PERFORMANCE</code></a></li> <li><a href="../package_reference/environment_variables#hfxetreconstructwritesequentially"><code>HF_XET_RECONSTRUCT_WRITE_SEQUENTIALLY</code></a></li></ul> <h3 class="relative group"><a id="hfxetchunkcachesizebytes" 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="#hfxetchunkcachesizebytes"><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>HF_XET_CHUNK_CACHE_SIZE_BYTES</span></h3> <p data-svelte-h="svelte-1h7t06r">To set the size of the Xet chunk cache locally. By default, the chunk cache is disabled. The chunk cache can be beneficial if you are generating new revisions to existing models or datasets as this is used to cache terms/chunks that are fetched from S3. A larger cache can better take advantage of deduplication across repos & files. To enable the chunk cache set the environment variable to a large number (10GB) or greater. However, in most cases when downloading or uploading new data, disabling the chunk cache will have better performance, which is why it is disabled by default.</p> <p data-svelte-h="svelte-1saw02r">Defaults to <code>0</code> (0 bytes, means chunk cache is disabled).</p> <h3 class="relative group"><a id="hfxetshardcachesizelimit" 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="#hfxetshardcachesizelimit"><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>HF_XET_SHARD_CACHE_SIZE_LIMIT</span></h3> <p data-svelte-h="svelte-10qddk9">To set the size of the Xet shard cache locally. Increasing this will improve upload efficiency as chunks referenced in cached shard files are not re-uploaded. Note that the default soft limit is likely sufficient for most workloads.</p> <p data-svelte-h="svelte-11kq16s">Defaults to <code>4000000000</code> (4GB).</p> <h3 class="relative group"><a id="hfxetnumconcurrentrangegets" 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="#hfxetnumconcurrentrangegets"><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>HF_XET_NUM_CONCURRENT_RANGE_GETS</span></h3> <p data-svelte-h="svelte-131g5cp">To set the number of concurrent terms (range of bytes from within a xorb, often called a chunk) downloaded from S3 per file. Increasing this will help with the speed of downloading a file if there is network bandwidth available.</p> <p data-svelte-h="svelte-13faio5">Defaults to <code>16</code>.</p> <h2 class="relative group"><a id="boolean-values" 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="#boolean-values"><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>Boolean values</span></h2> <p data-svelte-h="svelte-1enkv8e">The following environment variables expect a boolean value. The variable will be considered
	as <code>True</code> if its value is one of <code>{"1", "ON", "YES", "TRUE"}</code> (case-insensitive). Any other value
	(or undefined) will be considered as <code>False</code>.</p> <h3 class="relative group"><a id="hfdebug" 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="#hfdebug"><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>HF_DEBUG</span></h3> <p data-svelte-h="svelte-1ir96u3">If set, the log level for the <code>huggingface_hub</code> logger is set to DEBUG. Additionally, all requests made by HF libraries will be logged as equivalent cURL commands for easier debugging and reproducibility.</p> <h3 class="relative group"><a id="hfhuboffline" 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="#hfhuboffline"><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>HF_HUB_OFFLINE</span></h3> <p data-svelte-h="svelte-1uojfms">If set, no HTTP calls will be made to the Hugging Face Hub. If you try to download files, only the cached files will be accessed. If no cache file is detected, an error is raised This is useful in case your network is slow and you don’t care about having the latest version of a file.</p> <p data-svelte-h="svelte-erwo8k">If <code>HF_HUB_OFFLINE=1</code> is set as environment variable and you call any method of <a href="/docs/huggingface_hub/pr_4113/en/package_reference/hf_api#huggingface_hub.HfApi">HfApi</a>, an <a href="/docs/huggingface_hub/pr_4113/en/package_reference/utilities#huggingface_hub.errors.OfflineModeIsEnabled">OfflineModeIsEnabled</a> exception will be raised.</p> <p data-svelte-h="svelte-p6ydxq"><strong>Note:</strong> even if the latest version of a file is cached, calling <code>hf_hub_download</code> still triggers a HTTP request to check that a new version is not available. Setting <code>HF_HUB_OFFLINE=1</code> will skip this call which speeds up your loading time.</p> <p data-svelte-h="svelte-1wyde1z">If you want to check if offline mode is enabled or not, you can use the <a href="/docs/huggingface_hub/pr_4113/en/package_reference/utilities#huggingface_hub.is_offline_mode">is_offline_mode()</a> helper.</p> <h3 class="relative group"><a id="hfhubdisableimplicittoken" 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="#hfhubdisableimplicittoken"><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>HF_HUB_DISABLE_IMPLICIT_TOKEN</span></h3> <p data-svelte-h="svelte-dak2q4">Authentication is not mandatory for every request to the Hub. For instance, requesting
	details about <code>"gpt2"</code> model does not require to be authenticated. However, if a user is
	<a href="../package_reference/login">logged in</a>, the default behavior will be to always send the token
	in order to ease user experience (never get a HTTP 401 Unauthorized) when accessing private or gated repositories. For privacy, you can
	disable this behavior by setting <code>HF_HUB_DISABLE_IMPLICIT_TOKEN=1</code>. In this case,
	the token will be sent only for “write-access” calls (example: create a commit).</p> <p data-svelte-h="svelte-d0rh1g"><strong>Note:</strong> disabling implicit sending of token can have weird side effects. For example,
	if you want to list all models on the Hub, your private models will not be listed. You
	would need to explicitly pass <code>token=True</code> argument in your script.</p> <h3 class="relative group"><a id="hfhubdisableprogressbars" 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="#hfhubdisableprogressbars"><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>HF_HUB_DISABLE_PROGRESS_BARS</span></h3> <p data-svelte-h="svelte-j4bdq6">For time-consuming tasks, <code>huggingface_hub</code> displays a progress bar by default (using tqdm).
	You can disable all the progress bars at once by setting <code>HF_HUB_DISABLE_PROGRESS_BARS=1</code>.</p> <h3 class="relative group"><a id="hfhubdisablesymlinks" 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="#hfhubdisablesymlinks"><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>HF_HUB_DISABLE_SYMLINKS</span></h3> <p data-svelte-h="svelte-1h6cflp">If set, <code>huggingface_hub</code> will never create symlinks in the cache. Instead, files will be duplicated or moved directly into snapshot directories. This is a power-user feature making the cache directory run in a degraded mode where huge files ends-up duplicated on your hard-drive.</p> <p data-svelte-h="svelte-1vd25uv">An example use case is when a shared network drive (e.g. NAS) is used as <code>HF_HUB_CACHE</code> across machines running different operating
	systems. Symlinks created on Linux are not always traversable on Windows, leading to errors. Setting <code>HF_HUB_DISABLE_SYMLINKS=1</code> avoids this problem at the cost of disk-space deduplication.</p> <h3 class="relative group"><a id="hfhubdisablesymlinkswarning" 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="#hfhubdisablesymlinkswarning"><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>HF_HUB_DISABLE_SYMLINKS_WARNING</span></h3> <p data-svelte-h="svelte-1a5ggf9">If you are on a Windows machine, it is recommended to enable the developer mode or to run
	<code>huggingface_hub</code> in admin mode. If not, <code>huggingface_hub</code> will not be able to create
	symlinks in your cache system. You will be able to execute any script but your user experience
	will be degraded as some huge files might end-up duplicated on your hard-drive. A warning
	message is triggered to warn you about this behavior. Set <code>HF_HUB_DISABLE_SYMLINKS_WARNING=1</code>,
	to disable this warning.</p> <p data-svelte-h="svelte-1wsb5xe">For more details, see <a href="../guides/manage-cache#limitations">cache limitations</a>.</p> <h3 class="relative group"><a id="hfhubdisableexperimentalwarning" 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="#hfhubdisableexperimentalwarning"><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>HF_HUB_DISABLE_EXPERIMENTAL_WARNING</span></h3> <p data-svelte-h="svelte-16gkjc3">Some features of <code>huggingface_hub</code> are experimental. This means you can use them but we do not guarantee they will be
	maintained in the future. In particular, we might update the API or behavior of such features without any deprecation
	cycle. A warning message is triggered when using an experimental feature to warn you about it. If you’re comfortable debugging any potential issues using an experimental feature, you can set <code>HF_HUB_DISABLE_EXPERIMENTAL_WARNING=1</code> to disable the warning.</p> <p data-svelte-h="svelte-140g1ix">If you are using an experimental feature, please let us know! Your feedback can help us design and improve it.</p> <h3 class="relative group"><a id="hfhubdisabletelemetry" 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="#hfhubdisabletelemetry"><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>HF_HUB_DISABLE_TELEMETRY</span></h3> <p data-svelte-h="svelte-yphpce">By default, some data is collected by HF libraries (<code>transformers</code>, <code>datasets</code>, <code>gradio</code>,..) to monitor usage, debug issues and help prioritize features.
	Each library defines its own policy (i.e. which usage to monitor) but the core implementation happens in <code>huggingface_hub</code> (see <code>send_telemetry</code>).</p> <p data-svelte-h="svelte-h3tzls">You can set <code>HF_HUB_DISABLE_TELEMETRY=1</code> as environment variable to globally disable telemetry.</p> <h3 class="relative group"><a id="hfhubdisablexet" 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="#hfhubdisablexet"><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>HF_HUB_DISABLE_XET</span></h3> <p data-svelte-h="svelte-17qd2nm">Set to disable using <code>hf-xet</code>, even if it is available in your Python environment. This is since <code>hf-xet</code> will be used automatically if it is found, this allows explicitly disabling its usage. If you are disabling Xet, please consider <a href="https://github.com/huggingface/xet-core?tab=readme-ov-file#issues-diagnostics--debugging" rel="nofollow">filing an issue and including the diagnostics</a> information to help us understand why Xet is not working for you.</p> <h3 class="relative group"><a id="hfhubenablehftransfer" 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="#hfhubenablehftransfer"><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>HF_HUB_ENABLE_HF_TRANSFER</span></h3> <blockquote class="warning" data-svelte-h="svelte-1078dku"><p>This is a deprecated environment variable.
	Now that the Hugging Face Hub is fully powered by the Xet storage backend, all file transfers go through the <code>hf-xet</code> binary package. It provides efficient transfers using a chunk-based deduplication strategy and integrates seamlessly with <code>huggingface_hub</code>.
	This means <code>hf_transfer</code> can’t be used anymore. If you are interested in higher performance, check out the <a href="#hf_xet_high_performance"><code>HF_XET_HIGH_PERFORMANCE</code> section</a></p></blockquote> <h3 class="relative group"><a id="hfxethighperformance" 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="#hfxethighperformance"><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>HF_XET_HIGH_PERFORMANCE</span></h3> <p data-svelte-h="svelte-qpyuw9">Set <code>hf-xet</code> to operate with increased settings to maximize network and disk resources on the machine. Enabling high performance mode will try to saturate the network bandwidth of this machine and utilize all CPU cores for parallel upload/download activity.</p> <p data-svelte-h="svelte-1j2757w">Consider this analogous to the legacy <code>HF_HUB_ENABLE_HF_TRANSFER=1</code> environment variable but applied to <code>hf-xet</code>.</p> <p data-svelte-h="svelte-18myguy">To learn more about the benefits of Xet storage and <code>hf_xet</code>, refer to this <a href="https://huggingface.co/docs/hub/xet/index" rel="nofollow">section</a>.</p> <h3 class="relative group"><a id="hfxetreconstructwritesequentially" 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="#hfxetreconstructwritesequentially"><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>HF_XET_RECONSTRUCT_WRITE_SEQUENTIALLY</span></h3> <p data-svelte-h="svelte-werts4">To have <code>hf-xet</code> write sequentially to local disk, instead of in parallel. <code>hf-xet</code> is designed for SSD/NVMe disks (using parallel writes with direct addressing). If you are using an HDD (spinning hard disk), setting this will change disk writes to be sequential instead of parallel. For slower hard disks, this can improve overall write performance, as the disk is not spinning to seek for parallel writes.</p> <h2 class="relative group"><a id="deprecated-environment-variables" 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="#deprecated-environment-variables"><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>Deprecated environment variables</span></h2> <p data-svelte-h="svelte-1xlsmjd">In order to standardize all environment variables within the Hugging Face ecosystem, some variables have been marked as deprecated. Although they remain functional, they no longer take precedence over their replacements. The following table outlines the deprecated variables and their corresponding alternatives:</p> <table data-svelte-h="svelte-1i64e1s"><thead><tr><th>Deprecated Variable</th> <th>Replacement</th></tr></thead> <tbody><tr><td><code>HUGGINGFACE_HUB_CACHE</code></td> <td><code>HF_HUB_CACHE</code></td></tr> <tr><td><code>HUGGINGFACE_ASSETS_CACHE</code></td> <td><code>HF_ASSETS_CACHE</code></td></tr> <tr><td><code>HUGGING_FACE_HUB_TOKEN</code></td> <td><code>HF_TOKEN</code></td></tr></tbody></table> <h2 class="relative group"><a id="from-external-tools" 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="#from-external-tools"><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>From external tools</span></h2> <p data-svelte-h="svelte-6ntlb2">Some environment variables are not specific to <code>huggingface_hub</code> but are still taken into account when they are set.</p> <h3 class="relative group"><a id="donottrack" 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="#donottrack"><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>DO_NOT_TRACK</span></h3> <p data-svelte-h="svelte-yngnil">Boolean value. Equivalent to <code>HF_HUB_DISABLE_TELEMETRY</code>. When set to true, telemetry is globally disabled in the Hugging Face Python ecosystem (<code>transformers</code>, <code>diffusers</code>, <code>gradio</code>, etc.). See <a href="https://consoledonottrack.com/" rel="nofollow">https://consoledonottrack.com/</a> for more details.</p> <h3 class="relative group"><a id="nocolor" 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="#nocolor"><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>NO_COLOR</span></h3> <p data-svelte-h="svelte-hj4q1w">Boolean value. When set, <code>hf</code> CLI will not print any ANSI color.
	See <a href="https://no-color.org/" rel="nofollow">no-color.org</a>.</p> <h3 class="relative group"><a id="xdgcachehome" 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="#xdgcachehome"><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>XDG_CACHE_HOME</span></h3> <p data-svelte-h="svelte-38e7oi">Used only when <code>HF_HOME</code> is not set!</p> <p data-svelte-h="svelte-khdsxn">This is the default way to configure where <a href="https://wiki.archlinux.org/title/XDG_Base_Directory" rel="nofollow">user-specific non-essential (cached) data should be written</a>
	on linux machines.</p> <p data-svelte-h="svelte-hhj9xt">If <code>HF_HOME</code> is not set, the default home will be <code>"$XDG_CACHE_HOME/huggingface"</code> instead
	of <code>"~/.cache/huggingface"</code>.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/huggingface_hub/blob/main/docs/source/en/package_reference/environment_variables.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_1c3kngw = {
	assets: "/docs/huggingface_hub/pr_4113/en",
	base: "/docs/huggingface_hub/pr_4113/en",
	env: {}
	};

	const element = document.currentScript.parentElement;

	const data = [null,null];

	Promise.all([
	import("/docs/huggingface_hub/pr_4113/en/_app/immutable/entry/start.cad533c1.js"),
	import("/docs/huggingface_hub/pr_4113/en/_app/immutable/entry/app.b1cfe321.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 32],
	data,
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 68.7 kB
Xet hash:: eb77442bcdcef501c64ad43a7b9f845ab1afca22f0831539d2d64310d8f12eca

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