( repo_id: str filename: str subfolder: typing.Optional[str] = None repo_type: typing.Optional[str] = None revision: typing.Optional[str] = None library_name: typing.Optional[str] = None library_version: typing.Optional[str] = None cache_dir: typing.Union[str, pathlib.Path, NoneType] = None user_agent: typing.Union[typing.Dict, str, NoneType] = None force_download: bool = False force_filename: typing.Optional[str] = None proxies: typing.Optional[typing.Dict] = None etag_timeout: float = 10 resume_download: bool = False token: typing.Union[bool, str, NoneType] = None local_files_only: bool = False legacy_cache_layout: bool = False )
Parameters
str
) —
A user or an organization name and a repo name separated by a /
.
str
) —
The name of the file in the repo.
str
, optional) —
An optional value corresponding to a folder inside the model repo.
str
, optional) —
Set to "dataset"
or "space"
if uploading to a dataset or space,
None
or "model"
if uploading to a model. Default is None
.
str
, optional) —
An optional Git revision id which can be a branch name, a tag, or a
commit hash.
str
, optional) —
The name of the library to which the object corresponds.
str
, optional) —
The version of the library.
str
, Path
, optional) —
Path to the folder where cached files are stored.
dict
, str
, optional) —
The user-agent info in the form of a dictionary or a string.
bool
, optional, defaults to False
) —
Whether the file should be downloaded even if it already exists in
the local cache.
dict
, optional) —
Dictionary mapping protocol to the URL of the proxy passed to
requests.request
.
float
, optional, defaults to 10
) —
When fetching ETag, how many seconds to wait for the server to send
data before giving up which is passed to requests.request
.
bool
, optional, defaults to False
) —
If True
, resume a previously interrupted download.
str
, bool
, optional) —
A token to be used for the download.True
, the token is read from the HuggingFace config
folder.bool
, optional, defaults to False
) —
If True
, avoid downloading the file and return the path to the
local cached file if it exists.
bool
, optional, defaults to False
) —
If True
, uses the legacy file cache layout i.e. just call hf_hub_url()
then cached_download
. This is deprecated as the new cache layout is
more powerful.
Download a given file if it’s not already present in the local cache.
The new cache file layout looks like this:
[ 96] .
└── [ 160] models--julien-c--EsperBERTo-small
├── [ 160] blobs
│ ├── [321M] 403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
│ ├── [ 398] 7cb18dc9bafbfcf74629a4b760af1b160957a83e
│ └── [1.4K] d7edf6bd2a681fb0175f7735299831ee1b22b812
├── [ 96] refs
│ └── [ 40] main
└── [ 128] snapshots
├── [ 128] 2439f60ef33a0d46d85da5001d52aeda5b00ce9f
│ ├── [ 52] README.md -> ../../blobs/d7edf6bd2a681fb0175f7735299831ee1b22b812
│ └── [ 76] pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
└── [ 128] bbc77c8132af1cc5cf678da3f1ddf2de43606d48
├── [ 52] README.md -> ../../blobs/7cb18dc9bafbfcf74629a4b760af1b160957a83e
└── [ 76] pytorch_model.bin -> ../../blobs/403450e234d65943a7dcf7e05a771ce3c92faa84dd07db4ac20f592037a1e4bd
Raises the following errors:
EnvironmentError
if token=True
and the token cannot be found.OSError
if ETag cannot be determined.ValueError
if some parameter value is invalidprivate
and you do not have access.( repo_id: str filename: str subfolder: typing.Optional[str] = None repo_type: typing.Optional[str] = None revision: typing.Optional[str] = None )
Parameters
str
) —
A namespace (user or an organization) name and a repo name separated
by a /
.
str
) —
The name of the file in the repo.
str
, optional) —
An optional value corresponding to a folder inside the repo.
str
, optional) —
Set to "dataset"
or "space"
if uploading to a dataset or space,
None
or "model"
if uploading to a model. Default is None
.
str
, optional) —
An optional Git revision id which can be a branch name, a tag, or a
commit hash.
Construct the URL of a file from the given information.
The resolved address can either be a huggingface.co-hosted url, or a link to Cloudfront (a Content Delivery Network, or CDN) for large files which are more than a few MBs.
Example:
>>> from huggingface_hub import hf_hub_url
>>> hf_hub_url(
... repo_id="julien-c/EsperBERTo-small", filename="pytorch_model.bin"
... )
'https://huggingface.co/julien-c/EsperBERTo-small/resolve/main/pytorch_model.bin'
Notes:
Cloudfront is replicated over the globe so downloads are way faster for the end user (and it also lowers our bandwidth costs).
Cloudfront aggressively caches files by default (default TTL is 24 hours), however this is not an issue here because we implement a git-based versioning system on huggingface.co, which means that we store the files on S3/Cloudfront in a content-addressable way (i.e., the file name is its hash). Using content-addressable filenames means cache can’t ever be stale.
In terms of client-side caching from this library, we base our caching
on the objects’ entity tag (ETag
), which is an identifier of a
specific version of a resource [1]_. An object’s ETag is: its git-sha1
if stored in git, or its sha256 if stored in git-lfs.
References:
( repo_id: str revision: typing.Optional[str] = None repo_type: typing.Optional[str] = None cache_dir: typing.Union[str, pathlib.Path, NoneType] = None library_name: typing.Optional[str] = None library_version: typing.Optional[str] = None user_agent: typing.Union[typing.Dict, str, NoneType] = None proxies: typing.Optional[typing.Dict] = None etag_timeout: float = 10 resume_download: bool = False token: typing.Union[bool, str, NoneType] = None local_files_only: bool = False allow_regex: typing.Union[typing.List[str], str, NoneType] = None ignore_regex: typing.Union[typing.List[str], str, NoneType] = None allow_patterns: typing.Union[typing.List[str], str, NoneType] = None ignore_patterns: typing.Union[typing.List[str], str, NoneType] = None max_workers: int = 8 tqdm_class: typing.Optional[tqdm.asyncio.tqdm_asyncio] = None )
Parameters
str
) —
A user or an organization name and a repo name separated by a /
.
str
, optional) —
An optional Git revision id which can be a branch name, a tag, or a
commit hash.
str
, optional) —
Set to "dataset"
or "space"
if uploading to a dataset or space,
None
or "model"
if uploading to a model. Default is None
.
str
, Path
, optional) —
Path to the folder where cached files are stored.
str
, optional) —
The name of the library to which the object corresponds.
str
, optional) —
The version of the library.
str
, dict
, optional) —
The user-agent info in the form of a dictionary or a string.
dict
, optional) —
Dictionary mapping protocol to the URL of the proxy passed to
requests.request
.
float
, optional, defaults to 10
) —
When fetching ETag, how many seconds to wait for the server to send
data before giving up which is passed to requests.request
.
bool
, optional, defaults to False) -- If
True`, resume a previously interrupted download.
str
, bool
, optional) —
A token to be used for the download.True
, the token is read from the HuggingFace config
folder.bool
, optional, defaults to False
) —
If True
, avoid downloading the file and return the path to the
local cached file if it exists.
List[str]
or str
, optional) —
If provided, only files matching at least one pattern are downloaded.
List[str]
or str
, optional) —
If provided, files matching any of the patterns are not downloaded.
int
, optional) —
Number of concurrent threads to download files (1 thread = 1 file download).
Defaults to 8.
tqdm
, optional) —
If provided, overwrites the default behavior for the progress bar. Passed
argument must inherit from tqdm.auto.tqdm
or at least mimic its behavior.
Note that the tqdm_class
is not passed to each individual download.
Defaults to the custom HF progress bar that can be disabled by setting
HF_HUB_DISABLE_PROGRESS_BARS
environment variable.
Download all files of a repo.
Downloads a whole snapshot of a repo’s files at the specified revision. This is useful when you want all files from a repo, because you don’t know which ones you will need a priori. All files are nested inside a folder in order to keep their actual filename relative to that folder.
An alternative would be to just clone a repo but this would require that the user always has git and git-lfs installed, and properly configured.
Raises the following errors:
EnvironmentError
if token=True
and the token cannot be found.OSError
if
ETag cannot be determined.ValueError
if some parameter value is invalid( url: str token: typing.Union[bool, str, NoneType] = None proxies: typing.Optional[typing.Dict] = None timeout: float = 10 )
Parameters
str
) —
File url, for example returned by hf_hub_url().
str
or bool
, optional) —
A token to be used for the download.True
, the token is read from the HuggingFace config
folder.False
or None
, no token is provided.dict
, optional) —
Dictionary mapping protocol to the URL of the proxy passed to
requests.request
.
float
, optional, defaults to 10) —
How many seconds to wait for the server to send metadata before giving up.
Fetch metadata of a file versioned on the Hub for a given url.
( commit_hash: typing.Optional[str] etag: typing.Optional[str] location: str size: typing.Optional[int] )
Parameters
str
, optional) —
The commit_hash related to the file.
str
, optional) —
Etag of the file on the server.
str
) —
Location where to download the file. Can be a Hub url or not (CDN).
size
) —
Size of the file. In case of an LFS file, contains the size of the actual
LFS file, not the pointer.
Data structure containing information about a file versioned on the Hub.
Returned by get_hf_file_metadata() based on a URL.
The methods displayed above are designed to work with a caching system that prevents re-downloading files. The caching system was updated in v0.8.0 to become the central cache-system shared across libraries that depend on the Hub.
Read the cache-system guide for a detailed presentation of caching at at HF.