Hub Client Library documentation

Join the Hugging Face community

to get started

< >

( 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: typing.Optional[bool] = False force_filename: typing.Optional[str] = None proxies: typing.Optional[typing.Dict] = None etag_timeout: typing.Optional[float] = 10 resume_download: typing.Optional[bool] = False use_auth_token: typing.Union[bool, str, NoneType] = None local_files_only: typing.Optional[bool] = False legacy_cache_layout: typing.Optional[bool] = False )

Parameters

• repo_id (str) — A user or an organization name and a repo name separated by a /.
• filename (str) — The name of the file in the repo.
• subfolder (str, optional) — An optional value corresponding to a folder inside the model repo.
• repo_type (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.
• revision (str, optional) — An optional Git revision id which can be a branch name, a tag, or a commit hash.
• library_name (str, optional) — The name of the library to which the object corresponds.
• library_version (str, optional) — The version of the library.
• cache_dir (str, Path, optional) — Path to the folder where cached files are stored.
• user_agent (dict, str, optional) — The user-agent info in the form of a dictionary or a string.
• force_download (bool, optional, defaults to False) — Whether the file should be downloaded even if it already exists in the local cache.
• proxies (dict, optional) — Dictionary mapping protocol to the URL of the proxy passed to requests.request.
• etag_timeout (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.
• resume_download (bool, optional, defaults to False) — If True, resume a previously interrupted download.
• use_auth_token (str, bool, optional) — A token to be used for the download.
• If True, the token is read from the HuggingFace config folder.
• If a string, it’s used as the authentication token.
• local_files_only (bool, optional, defaults to False) — If True, avoid downloading the file and return the path to the local cached file if it exists.
• legacy_cache_layout (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.

The new cache file layout looks like this:

• The cache directory contains one subfolder per repo_id (namespaced by repo type)
• inside each repo folder:
• refs is a list of the latest known revision => commit_hash pairs
• blobs contains the actual file blobs (identified by their git-sha or sha256, depending on whether they’re LFS files or not)
• snapshots contains one subfolder per commit, each “commit” contains the subset of the files that have been resolved at that particular commit. Each filename is a symlink to the blob at that particular commit.

[ 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:

< >

( 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: typing.Optional[float] = 10 resume_download: typing.Optional[bool] = False use_auth_token: typing.Union[bool, str, NoneType] = None local_files_only: typing.Optional[bool] = False allow_regex: typing.Union[typing.List[str], str, NoneType] = None ignore_regex: typing.Union[typing.List[str], str, NoneType] = None )

Parameters

• repo_id (str) — A user or an organization name and a repo name separated by a /.
• revision (str, optional) — An optional Git revision id which can be a branch name, a tag, or a commit hash.
• repo_type (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.
• cache_dir (str, Path, optional) — Path to the folder where cached files are stored.
• library_name (str, optional) — The name of the library to which the object corresponds.
• library_version (str, optional) — The version of the library.
• user_agent (str, dict, optional) — The user-agent info in the form of a dictionary or a string.
• proxies (dict, optional) — Dictionary mapping protocol to the URL of the proxy passed to requests.request.
• etag_timeout (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.
• resume_download (bool, optional, defaults to False) -- If True, resume a previously interrupted download.
• use_auth_token (str, bool, optional) — A token to be used for the download.
• If True, the token is read from the HuggingFace config folder.
• If a string, it’s used as the authentication token.
• local_files_only (bool, optional, defaults to False) — If True, avoid downloading the file and return the path to the local cached file if it exists.
• allow_regex (list of str, str, optional) — If provided, only files matching this regex are downloaded.
• ignore_regex (list of str, str, optional) — If provided, files matching this regex are not downloaded.

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:

< >

( url: str 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: typing.Optional[bool] = False force_filename: typing.Optional[str] = None proxies: typing.Optional[typing.Dict] = None etag_timeout: typing.Optional[float] = 10 resume_download: typing.Optional[bool] = False use_auth_token: typing.Union[bool, str, NoneType] = None local_files_only: typing.Optional[bool] = False legacy_cache_layout: typing.Optional[bool] = False )

Parameters

• url (str) — The path to the file to be downloaded.
• library_name (str, optional) — The name of the library to which the object corresponds.
• library_version (str, optional) — The version of the library.
• cache_dir (str, Path, optional) — Path to the folder where cached files are stored.
• user_agent (dict, str, optional) — The user-agent info in the form of a dictionary or a string.
• force_download (bool, optional, defaults to False) — Whether the file should be downloaded even if it already exists in the local cache.
• force_filename (str, optional) — Use this name instead of a generated file name.
• proxies (dict, optional) — Dictionary mapping protocol to the URL of the proxy passed to requests.request.
• etag_timeout (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.
• resume_download (bool, optional, defaults to False) — If True, resume a previously interrupted download.
• use_auth_token (bool, str, optional) — A token to be used for the download.
• If True, the token is read from the HuggingFace config folder.
• If a string, it’s used as the authentication token.
• local_files_only (bool, optional, defaults to False) — If True, avoid downloading the file and return the path to the local cached file if it exists.
• legacy_cache_layout (bool, optional, defaults to False) — Set this parameter to True to mention that you’d like to continue the old cache layout. Putting this to True manually will not raise any warning when using cached_download. We recommend using hf_hub_download to take advantage of the new cache.

Download from a given URL and cache it if it’s not already present in the local cache.

Given a URL, this function looks for the corresponding file in the local cache. If it’s not there, download it. Then return the path to the cached file.

Will raise errors tailored to the Hugging Face Hub.

Raises the following errors:

#### huggingface_hub.hf_hub_url

< >

( repo_id: str filename: str subfolder: typing.Optional[str] = None repo_type: typing.Optional[str] = None revision: typing.Optional[str] = None )

Parameters

• repo_id (str) — A namespace (user or an organization) name and a repo name separated by a /.
• filename (str) — The name of the file in the repo.
• subfolder (str, optional) — An optional value corresponding to a folder inside the repo.
• repo_type (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.
• revision (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:

## Caching

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 allow directory structure and file sharing across libraries that depend on the hub.

The caching system is designed as follows:

<CACHE_DIR>
├─ <MODELS>
├─ <DATASETS>
├─ <SPACES>

The <CACHE_DIR> is usually your user’s home directory. However, it is customizable with the cache_dir argument on all methods, or by specifying the HF_HOME environment variable.

Models, datasets and spaces share a common root. Each of these repositories contains the namespace (organization, username) if it exists, alongside the repository name:

<CACHE_DIR>
├─ models--julien-c--EsperBERTo-small
├─ models--lysandrejik--arxiv-nlp
├─ models--bert-base-cased
├─ datasets--glue
├─ datasets--huggingface--DataMeasurementsFiles
├─ spaces--dalle-mini--dalle-mini

It is within these folders that all files will now be downloaded from the hub. Caching ensures that a file isn’t downloaded twice if it already exists and wasn’t updated; but if it was updated, and you’re asking for the latest file, then it will download the latest file (while keeping the previous file intact in case you need it again).

In order to achieve this, all folders contain the same skeleton:

<CACHE_DIR>
├─ datasets--glue
│  ├─ refs
│  ├─ blobs
│  ├─ snapshots
...

Each folder is designed to contain the following:

### Refs

The refs folder contains files which indicates the latest revision of the given reference. For example, if we have previously fetched a file from the main branch of a repository, the refs folder will contain a file named main, which will itself contain the commit identifier of the current head.

If the latest commit of main has aaaaaa as identifier, then it will contain aaaaaa.

If that same branch gets updated with a new commit, that has bbbbbb as an identifier, then redownloading a file from that reference will update the refs/main file to contain bbbbbb.

### Blobs

The blobs folder contains the actual files that we have downloaded. The name of each file is their hash.

### Snapshots

The snapshots folder contains symlinks to the blobs mentioned above. It is itself made up of several folders: one per known revision!

In the explanation above, we had initially fetched a file from the aaaaaa revision, before fetching a file from the bbbbbb revision. In this situation, we would now have two folders in the snapshots folder: aaaaaa and bbbbbb.

In each of these folders, live symlinks that have the names of the files that we have downloaded. For example, if we had downloaded the READMD.md file at revision aaaaaa, we would have the following path:

<CACHE_DIR>/<REPO_NAME>/snapshots/aaaaaa/README.md

That README.md file is actually a symlink linking to the blob that has the hash of the file.

Creating the skeleton this way means opens up the mechanism to file sharing: if the same file was fetched in revision bbbbbb, it would have the same hash and the file would not need to be redownloaded.

### In practice

In practice, it should look like the following tree in your cache:

    [  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`