环境变量
huggingface_hub
可以使用环境变量进行配置。
如果您不熟悉环境变量,这里有一些关于它们的通用文章 关于 macOS 和 Linux 以及关于 Windows 的。
此页面将指导您了解所有特定于 huggingface_hub
的环境变量及其含义。
通用
HF_INFERENCE_ENDPOINT
配置推理 API 基本 URL。如果您的组织指向 API 网关而不是直接指向推理 API,您可能需要设置此变量。
默认为 "https://api-inference.huggingface.co"
。
HF_HOME
配置 huggingface_hub
在本地存储数据的位置。特别是,您的令牌和缓存将存储在此文件夹中。
默认为 "~/.cache/huggingface"
,除非设置了 XDG_CACHE_HOME。
HF_HUB_CACHE
配置从 Hub 本地缓存存储库(模型、数据集和空间)的位置。
默认为 "$HF_HOME/hub"
(例如,默认情况下为 "~/.cache/huggingface/hub"
)。
HF_ASSETS_CACHE
配置下游库创建的 资产 在本地缓存的位置。这些资产可以是预处理的数据、从 GitHub 下载的文件、日志等。
默认为 "$HF_HOME/assets"
(例如,默认情况下为 "~/.cache/huggingface/assets"
)。
HF_TOKEN
配置用户访问令牌以对 Hub 进行身份验证。如果设置,此值将覆盖机器上存储的令牌(在 $HF_TOKEN_PATH
或 "$HF_HOME/token"
中,如果前者未设置)。
有关身份验证的更多详细信息,请查看 此部分。
HF_TOKEN_PATH
配置 huggingface_hub
应在何处存储用户访问令牌。默认为 "$HF_HOME/token"
(例如,默认情况下为 ~/.cache/huggingface/token
)。
HF_HUB_VERBOSITY
设置 huggingface_hub
日志记录器的详细程度级别。必须是 {"debug", "info", "warning", "error", "critical"}
中的一个。
默认为 "warning"
。
有关更多详细信息,请参阅 日志记录参考。
HF_HUB_LOCAL_DIR_AUTO_SYMLINK_THRESHOLD
此环境变量已弃用,现在被 huggingface_hub
忽略。下载到本地目录的文件不再依赖于符号链接。
HF_HUB_ETAG_TIMEOUT
整数类型值,用于定义在下载文件之前获取存储库最新元数据时等待服务器响应的秒数。如果请求超时,huggingface_hub
将默认为本地缓存文件。设置较低的值可以加快具有缓慢连接且已缓存文件的机器的工作流程。较高的值可确保在更多情况下元数据调用成功。默认为 10 秒。
HF_HUB_DOWNLOAD_TIMEOUT
整数类型值,用于定义下载文件时等待服务器响应的秒数。如果请求超时,则会引发 TimeoutError。在连接速度较慢的机器上设置较高的值是有益的。如果网络完全中断,较小的值会使进程更快失败。默认为 10 秒。
布尔值
以下环境变量期望布尔值。如果变量的值是 {"1", "ON", "YES", "TRUE"}
中的一个(不区分大小写),则该变量将被视为 True
。任何其他值(或未定义)将被视为 False
。
HF_HUB_OFFLINE
如果设置,则不会向 Hugging Face Hub 发出任何 HTTP 调用。如果您尝试下载文件,则只会访问缓存的文件。如果未检测到缓存文件,则会引发错误。这在您的网络速度缓慢并且您不关心文件是否为最新版本时非常有用。
如果将 HF_HUB_OFFLINE=1
设置为环境变量,并且您调用了 HfApi 的任何方法,则会引发 OfflineModeIsEnabled 异常。
注意:即使文件的最新版本已缓存,调用 hf_hub_download
仍会触发 HTTP 请求以检查是否有新版本可用。设置 HF_HUB_OFFLINE=1
将跳过此调用,从而加快您的加载时间。