To configure where huggingface_hub will locally store data. In particular, your token and the cache will be stored in this folder.

Defaults to "~/.cache/huggingface" unless XDG_CACHE_HOME is set.

HF_HUB_CACHE

To configure where repositories from the Hub will be cached locally (models, datasets and spaces).

Defaults to "$HF_HOME/hub" (e.g. "~/.cache/huggingface/hub" by default).

HF_XET_CACHE

To configure where Xet chunks (byte ranges from files managed by Xet backend) are cached locally.

Defaults to "$HF_HOME/xet" (e.g. "~/.cache/huggingface/xet" by default).

HF_ASSETS_CACHE

To configure where assets created by downstream libraries will be cached locally. Those assets can be preprocessed data, files downloaded from GitHub, logs,…

Defaults to "$HF_HOME/assets" (e.g. "~/.cache/huggingface/assets" by default).

HF_TOKEN

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 $HF_TOKEN_PATH or "$HF_HOME/token" if the former is not set).

For more details about authentication, check out this section.

HF_TOKEN_PATH

To configure where huggingface_hub should store the User Access Token. Defaults to "$HF_HOME/token" (e.g. ~/.cache/huggingface/token by default).

HF_HUB_VERBOSITY

Set the verbosity level of the huggingface_hub’s logger. Must be one of {"debug", "info", "warning", "error", "critical"}.

Defaults to "warning".

For more details, see logging reference.

HF_HUB_ETAG_TIMEOUT

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, huggingface_hub 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.

HF_HUB_DOWNLOAD_TIMEOUT

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.

Xet

Other Xet environment variables

• HF_HUB_DISABLE_XET
• HF_XET_CACHE
• HF_XET_HIGH_PERFORMANCE
• HF_XET_RECONSTRUCT_WRITE_SEQUENTIALLY

HF_XET_CHUNK_CACHE_SIZE_BYTES

To set the size of the Xet chunk cache locally. Increasing this will give more space for caching terms/chunks fetched from S3. A larger cache can better take advantage of deduplication across repos & files. If your network speed is much greater than your local disk speed (ex 10Gbps vs SSD or worse) then consider disabling the Xet cache for increased performance. To disable the Xet cache, set HF_XET_CHUNK_CACHE_SIZE_BYTES=0.

Defaults to 10000000000 (10GB).

HF_XET_SHARD_CACHE_SIZE_LIMIT

To set the size of the Xet shard cache locally. Increasing this will improve upload effeciency as chunks referenced in cached shard files are not re-uploaded. Note that the default soft limit is likely sufficient for most workloads.

Defaults to 4000000000 (4GB).

HF_XET_NUM_CONCURRENT_RANGE_GETS

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.

Defaults to 16.

Boolean values

The following environment variables expect a boolean value. The variable will be considered as True if its value is one of {"1", "ON", "YES", "TRUE"} (case-insensitive). Any other value (or undefined) will be considered as False.

HF_DEBUG

If set, the log level for the huggingface_hub logger is set to DEBUG. Additionally, all requests made by HF libraries will be logged as equivalent cURL commands for easier debugging and reproducibility.

HF_HUB_OFFLINE

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.

If HF_HUB_OFFLINE=1 is set as environment variable and you call any method of HfApi, an OfflineModeIsEnabled exception will be raised.

Note: even if the latest version of a file is cached, calling hf_hub_download still triggers a HTTP request to check that a new version is not available. Setting HF_HUB_OFFLINE=1 will skip this call which speeds up your loading time.

HF_HUB_DISABLE_IMPLICIT_TOKEN

Authentication is not mandatory for every requests to the Hub. For instance, requesting details about "gpt2" model does not require to be authenticated. However, if a user is logged in, 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 HF_HUB_DISABLE_IMPLICIT_TOKEN=1. In this case, the token will be sent only for “write-access” calls (example: create a commit).

Note: 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 token=True argument in your script.

HF_HUB_DISABLE_PROGRESS_BARS

For time consuming tasks, huggingface_hub displays a progress bar by default (using tqdm). You can disable all the progress bars at once by setting HF_HUB_DISABLE_PROGRESS_BARS=1.

HF_HUB_DISABLE_SYMLINKS_WARNING

If you are on a Windows machine, it is recommended to enable the developer mode or to run huggingface_hub in admin mode. If not, huggingface_hub 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 HF_HUB_DISABLE_SYMLINKS_WARNING=1, to disable this warning.

For more details, see cache limitations.

HF_HUB_DISABLE_EXPERIMENTAL_WARNING

Some features of huggingface_hub 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 HF_HUB_DISABLE_EXPERIMENTAL_WARNING=1 to disable the warning.

If you are using an experimental feature, please let us know! Your feedback can help us design and improve it.

HF_HUB_DISABLE_TELEMETRY

By default, some data is collected by HF libraries (transformers, datasets, gradio,..) 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 huggingface_hub (see send_telemetry).

You can set HF_HUB_DISABLE_TELEMETRY=1 as environment variable to globally disable telemetry.

HF_HUB_DISABLE_XET

Set to disable using hf-xet, even if it is available in your Python environment. This is since hf-xet will be used automatically if it is found, this allows explicitly disabling its usage.

HF_HUB_ENABLE_HF_TRANSFER

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 hf-xet binary package. It provides efficient transfers using a chunk-based deduplication strategy and integrates seamlessly with huggingface_hub. This means hf_transfer can’t be used anymore. If you are interested in higher performance, check out the HF_XET_HIGH_PERFORMANCE section

HF_XET_HIGH_PERFORMANCE

Set hf-xet 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.

Consider this analogous to the legacy HF_HUB_ENABLE_HF_TRANSFER=1 environment variable but applied to hf-xet.

To learn more about the benefits of Xet storage and hf_xet, refer to this section.

HF_XET_RECONSTRUCT_WRITE_SEQUENTIALLY

To have hf-xet write sequentially to local disk, instead of in parallel. hf-xet 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.

Deprecated environment variables

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:

From external tools

Some environment variables are not specific to huggingface_hub but are still taken into account when they are set.

DO_NOT_TRACK

Boolean value. Equivalent to HF_HUB_DISABLE_TELEMETRY. When set to true, telemetry is globally disabled in the Hugging Face Python ecosystem (transformers, diffusers, gradio, etc.). See https://consoledonottrack.com/ for more details.

NO_COLOR

Boolean value. When set, hf CLI will not print any ANSI color. See no-color.org.

XDG_CACHE_HOME

Used only when HF_HOME is not set!

This is the default way to configure where user-specific non-essential (cached) data should be written on linux machines.

If HF_HOME is not set, the default home will be "$XDG_CACHE_HOME/huggingface" instead of "~/.cache/huggingface".