source
stringclasses 40
values | url
stringlengths 53
184
| file_type
stringclasses 1
value | chunk
stringlengths 3
512
| chunk_id
stringlengths 5
8
|
|---|---|---|---|---|
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvisualquestionansweringoutputelement | .md | ```python
Outputs of inference for the Visual Question Answering task
``` | 19_121_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubvisualquestionansweringparameters | .md | ```python
Additional inference parameters for Visual Question Answering
``` | 19_122_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotclassificationinput | .md | ```python
Inputs for Zero Shot Classification inference
``` | 19_123_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotclassificationoutputelement | .md | ```python
Outputs of inference for the Zero Shot Classification task
``` | 19_124_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotclassificationparameters | .md | ```python
Additional inference parameters for Zero Shot Classification
``` | 19_125_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotimageclassificationinput | .md | ```python
Inputs for Zero Shot Image Classification inference
``` | 19_126_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotimageclassificationoutputelement | .md | ```python
Outputs of inference for the Zero Shot Image Classification task
``` | 19_127_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotimageclassificationparameters | .md | ```python
Additional inference parameters for Zero Shot Image Classification
``` | 19_128_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotobjectdetectionboundingbox | .md | ```python
The predicted bounding box. Coordinates are relative to the top left corner of the input
image.
``` | 19_129_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotobjectdetectioninput | .md | ```python
Inputs for Zero Shot Object Detection inference
``` | 19_130_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotobjectdetectionoutputelement | .md | ```python
Outputs of inference for the Zero Shot Object Detection task
``` | 19_131_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/inference_types.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/inference_types/#huggingfacehubzeroshotobjectdetectionparameters | .md | ```python
Additional inference parameters for Zero Shot Object Detection
``` | 19_132_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/ | .md | <!--⚠️ Note that this file is in Markdown but contains specific syntax for our doc-builder (similar to MDX) that may not be
rendered properly in your Markdown viewer.
--> | 20_0_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#cache-system-reference | .md | 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](../guides/manage-cache)
for a detailed presentation of caching at HF. | 20_1_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubtrytoloadfromcache | .md | ```python
Explores the cache to return the latest cached file for a given revision if found.
This function will not raise any exception if the file in not cached. | 20_2_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubtrytoloadfromcache | .md | This function will not raise any exception if the file in not cached.
Args:
cache_dir (`str` or `os.PathLike`):
The folder where the cached files lie.
repo_id (`str`):
The ID of the repo on huggingface.co.
filename (`str`):
The filename to look for inside `repo_id`.
revision (`str`, *optional*):
The specific model version to use. Will default to `"main"` if it's not provided and no `commit_hash` is
provided either.
repo_type (`str`, *optional*):
The type of the repository. Will default to `"model"`. | 20_2_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubtrytoloadfromcache | .md | Returns:
`Optional[str]` or `_CACHED_NO_EXIST`:
Will return `None` if the file was not cached. Otherwise:
- The exact path to the cached file if it's found in the cache
- A special value `_CACHED_NO_EXIST` if the file does not exist at the given commit hash and this fact was
cached.
Example:
```python
from huggingface_hub import try_to_load_from_cache, _CACHED_NO_EXIST
filepath = try_to_load_from_cache()
if isinstance(filepath, str): | 20_2_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#file-exists-and-is-cached | .md | ...
elif filepath is _CACHED_NO_EXIST: | 20_3_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#non-existence-of-file-is-cached | .md | ...
else: | 20_4_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#file-is-not-cached | .md | ...
```
``` | 20_5_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | ```python
Return a folder path to cache arbitrary files.
`huggingface_hub` provides a canonical folder path to store assets. This is the
recommended way to integrate cache in a downstream library as it will benefit from
the builtins tools to scan and delete the cache properly. | 20_6_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | The distinction is made between files cached from the Hub and assets. Files from the
Hub are cached in a git-aware manner and entirely managed by `huggingface_hub`. See
[related documentation](https://huggingface.co/docs/huggingface_hub/how-to-cache).
All other files that a downstream library caches are considered to be "assets"
(files downloaded from external sources, extracted from a .tar archive, preprocessed
for training,...). | 20_6_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | Once the folder path is generated, it is guaranteed to exist and to be a directory.
The path is based on 3 levels of depth: the library name, a namespace and a
subfolder. Those 3 levels grants flexibility while allowing `huggingface_hub` to
expect folders when scanning/deleting parts of the assets cache. Within a library,
it is expected that all namespaces share the same subset of subfolder names but this
is not a mandatory rule. The downstream library has then full control on which file | 20_6_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | is not a mandatory rule. The downstream library has then full control on which file
structure to adopt within its cache. Namespace and subfolder are optional (would
default to a `"default/"` subfolder) but library name is mandatory as we want every
downstream library to manage its own cache. | 20_6_3 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | Expected tree:
```text
assets/
└── datasets/
│ ├── SQuAD/
│ │ ├── downloaded/
│ │ ├── extracted/
│ │ └── processed/
│ ├── Helsinki-NLP--tatoeba_mt/
│ ├── downloaded/
│ ├── extracted/
│ └── processed/
└── transformers/
├── default/
│ ├── something/
├── bert-base-cased/
│ ├── default/
│ └── training/
hub/
└── models--julien-c--EsperBERTo-small/
├── blobs/
│ ├── (...)
│ ├── (...)
├── refs/
│ └── (...)
└── [ 128] snapshots/ | 20_6_4 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | └── models--julien-c--EsperBERTo-small/
├── blobs/
│ ├── (...)
│ ├── (...)
├── refs/
│ └── (...)
└── [ 128] snapshots/
├── 2439f60ef33a0d46d85da5001d52aeda5b00ce9f/
│ ├── (...)
└── bbc77c8132af1cc5cf678da3f1ddf2de43606d48/
└── (...)
``` | 20_6_5 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | Args:
library_name (`str`):
Name of the library that will manage the cache folder. Example: `"dataset"`.
namespace (`str`, *optional*, defaults to "default"):
Namespace to which the data belongs. Example: `"SQuAD"`.
subfolder (`str`, *optional*, defaults to "default"):
Subfolder in which the data will be stored. Example: `extracted`.
assets_dir (`str`, `Path`, *optional*):
Path to the folder where assets are cached. This must not be the same folder | 20_6_6 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | assets_dir (`str`, `Path`, *optional*):
Path to the folder where assets are cached. This must not be the same folder
where Hub files are cached. Defaults to `HF_HOME / "assets"` if not provided.
Can also be set with `HF_ASSETS_CACHE` environment variable. | 20_6_7 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | Returns:
Path to the cache folder (`Path`). | 20_6_8 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | Example:
```py
>>> from huggingface_hub import cached_assets_path
>>> cached_assets_path(library_name="datasets", namespace="SQuAD", subfolder="download")
PosixPath('/home/wauplin/.cache/huggingface/extra/datasets/SQuAD/download')
>>> cached_assets_path(library_name="datasets", namespace="SQuAD", subfolder="extracted")
PosixPath('/home/wauplin/.cache/huggingface/extra/datasets/SQuAD/extracted')
>>> cached_assets_path(library_name="datasets", namespace="Helsinki-NLP/tatoeba_mt") | 20_6_9 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedassetspath | .md | >>> cached_assets_path(library_name="datasets", namespace="Helsinki-NLP/tatoeba_mt")
PosixPath('/home/wauplin/.cache/huggingface/extra/datasets/Helsinki-NLP--tatoeba_mt/default')
>>> cached_assets_path(library_name="datasets", assets_dir="/tmp/tmp123456")
PosixPath('/tmp/tmp123456/datasets/default/default')
```
``` | 20_6_10 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubscancachedir | .md | ```python
Scan the entire HF cache-system and return a [`~HFCacheInfo`] structure.
Use `scan_cache_dir` in order to programmatically scan your cache-system. The cache
will be scanned repo by repo. If a repo is corrupted, a [`~CorruptedCacheException`]
will be thrown internally but captured and returned in the [`~HFCacheInfo`]
structure. Only valid repos get a proper report. | 20_7_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubscancachedir | .md | ```py
>>> from huggingface_hub import scan_cache_dir
>>> hf_cache_info = scan_cache_dir()
HFCacheInfo(
size_on_disk=3398085269,
repos=frozenset({
CachedRepoInfo(
repo_id='t5-small',
repo_type='model',
repo_path=PosixPath(...),
size_on_disk=970726914,
nb_files=11,
revisions=frozenset({
CachedRevisionInfo(
commit_hash='d78aea13fa7ecd06c29e3e46195d6341255065d5',
size_on_disk=970726339,
snapshot_path=PosixPath(...),
files=frozenset({
CachedFileInfo(
file_name='config.json',
size_on_disk=1197 | 20_7_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubscancachedir | .md | snapshot_path=PosixPath(...),
files=frozenset({
CachedFileInfo(
file_name='config.json',
size_on_disk=1197
file_path=PosixPath(...),
blob_path=PosixPath(...),
),
CachedFileInfo(...),
...
}),
),
CachedRevisionInfo(...),
...
}),
),
CachedRepoInfo(...),
...
}),
warnings=[
CorruptedCacheException("Snapshots dir doesn't exist in cached repo: ..."),
CorruptedCacheException(...),
...
],
)
``` | 20_7_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubscancachedir | .md | You can also print a detailed report directly from the `huggingface-cli` using:
```text
> huggingface-cli scan-cache
REPO ID REPO TYPE SIZE ON DISK NB FILES REFS LOCAL PATH
--------------------------- --------- ------------ -------- ------------------- -------------------------------------------------------------------------
glue dataset 116.3K 15 1.17.0, main, 2.4.0 /Users/lucain/.cache/huggingface/hub/datasets--glue | 20_7_3 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubscancachedir | .md | google/fleurs dataset 64.9M 6 main, refs/pr/1 /Users/lucain/.cache/huggingface/hub/datasets--google--fleurs
Jean-Baptiste/camembert-ner model 441.0M 7 main /Users/lucain/.cache/huggingface/hub/models--Jean-Baptiste--camembert-ner
bert-base-cased model 1.9G 13 main /Users/lucain/.cache/huggingface/hub/models--bert-base-cased | 20_7_4 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubscancachedir | .md | t5-base model 10.1K 3 main /Users/lucain/.cache/huggingface/hub/models--t5-base
t5-small model 970.7M 11 refs/pr/1, main /Users/lucain/.cache/huggingface/hub/models--t5-small
Done in 0.0s. Scanned 6 repo(s) for a total of 3.4G.
Got 1 warning(s) while scanning. Use -vvv to print details.
``` | 20_7_5 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubscancachedir | .md | Args:
cache_dir (`str` or `Path`, `optional`):
Cache directory to cache. Defaults to the default HF cache directory.
<Tip warning={true}>
Raises:
`CacheNotFound`
If the cache directory does not exist.
[`ValueError`](https://docs.python.org/3/library/exceptions.html#ValueError)
If the cache directory is a file, instead of a directory.
</Tip>
Returns: a [`~HFCacheInfo`] object.
``` | 20_7_6 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#data-structures | .md | All structures are built and returned by [`scan_cache_dir`] and are immutable. | 20_8_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubhfcacheinfo | .md | ```python
Frozen data structure holding information about the entire cache-system.
This data structure is returned by [`scan_cache_dir`] and is immutable. | 20_9_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubhfcacheinfo | .md | Args:
size_on_disk (`int`):
Sum of all valid repo sizes in the cache-system.
repos (`FrozenSet[CachedRepoInfo]`):
Set of [`~CachedRepoInfo`] describing all valid cached repos found on the
cache-system while scanning.
warnings (`List[CorruptedCacheException]`):
List of [`~CorruptedCacheException`] that occurred while scanning the cache.
Those exceptions are captured so that the scan can continue. Corrupted repos
are skipped from the scan.
<Tip warning={true}> | 20_9_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubhfcacheinfo | .md | <Tip warning={true}>
Here `size_on_disk` is equal to the sum of all repo sizes (only blobs). However if
some cached repos are corrupted, their sizes are not taken into account.
</Tip>
``` | 20_9_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedrepoinfo | .md | ```python
Frozen data structure holding information about a cached repository. | 20_10_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedrepoinfo | .md | Args:
repo_id (`str`):
Repo id of the repo on the Hub. Example: `"google/fleurs"`.
repo_type (`Literal["dataset", "model", "space"]`):
Type of the cached repo.
repo_path (`Path`):
Local path to the cached repo.
size_on_disk (`int`):
Sum of the blob file sizes in the cached repo.
nb_files (`int`):
Total number of blob files in the cached repo.
revisions (`FrozenSet[CachedRevisionInfo]`):
Set of [`~CachedRevisionInfo`] describing all revisions cached in the repo.
last_accessed (`float`): | 20_10_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedrepoinfo | .md | Set of [`~CachedRevisionInfo`] describing all revisions cached in the repo.
last_accessed (`float`):
Timestamp of the last time a blob file of the repo has been accessed.
last_modified (`float`):
Timestamp of the last time a blob file of the repo has been modified/created. | 20_10_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedrepoinfo | .md | <Tip warning={true}>
`size_on_disk` is not necessarily the sum of all revisions sizes because of
duplicated files. Besides, only blobs are taken into account, not the (negligible)
size of folders and symlinks.
</Tip>
<Tip warning={true}>
`last_accessed` and `last_modified` reliability can depend on the OS you are using.
See [python documentation](https://docs.python.org/3/library/os.html#os.stat_result)
for more details.
</Tip>
```
- size_on_disk_str
- refs | 20_10_3 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedrevisioninfo | .md | ```python
Frozen data structure holding information about a revision.
A revision correspond to a folder in the `snapshots` folder and is populated with
the exact tree structure as the repo on the Hub but contains only symlinks. A
revision can be either referenced by 1 or more `refs` or be "detached" (no refs). | 20_11_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedrevisioninfo | .md | Args:
commit_hash (`str`):
Hash of the revision (unique).
Example: `"9338f7b671827df886678df2bdd7cc7b4f36dffd"`.
snapshot_path (`Path`):
Path to the revision directory in the `snapshots` folder. It contains the
exact tree structure as the repo on the Hub.
files: (`FrozenSet[CachedFileInfo]`):
Set of [`~CachedFileInfo`] describing all files contained in the snapshot.
refs (`FrozenSet[str]`):
Set of `refs` pointing to this revision. If the revision has no `refs`, it
is considered detached. | 20_11_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedrevisioninfo | .md | refs (`FrozenSet[str]`):
Set of `refs` pointing to this revision. If the revision has no `refs`, it
is considered detached.
Example: `{"main", "2.4.0"}` or `{"refs/pr/1"}`.
size_on_disk (`int`):
Sum of the blob file sizes that are symlink-ed by the revision.
last_modified (`float`):
Timestamp of the last time the revision has been created/modified. | 20_11_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedrevisioninfo | .md | <Tip warning={true}>
`last_accessed` cannot be determined correctly on a single revision as blob files
are shared across revisions.
</Tip>
<Tip warning={true}>
`size_on_disk` is not necessarily the sum of all file sizes because of possible
duplicated files. Besides, only blobs are taken into account, not the (negligible)
size of folders and symlinks.
</Tip>
```
- size_on_disk_str
- nb_files | 20_11_3 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedfileinfo | .md | ```python
Frozen data structure holding information about a single cached file. | 20_12_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedfileinfo | .md | Args:
file_name (`str`):
Name of the file. Example: `config.json`.
file_path (`Path`):
Path of the file in the `snapshots` directory. The file path is a symlink
referring to a blob in the `blobs` folder.
blob_path (`Path`):
Path of the blob file. This is equivalent to `file_path.resolve()`.
size_on_disk (`int`):
Size of the blob file in bytes.
blob_last_accessed (`float`):
Timestamp of the last time the blob file has been accessed (from any
revision).
blob_last_modified (`float`): | 20_12_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedfileinfo | .md | Timestamp of the last time the blob file has been accessed (from any
revision).
blob_last_modified (`float`):
Timestamp of the last time the blob file has been modified/created. | 20_12_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcachedfileinfo | .md | <Tip warning={true}>
`blob_last_accessed` and `blob_last_modified` reliability can depend on the OS you
are using. See [python documentation](https://docs.python.org/3/library/os.html#os.stat_result)
for more details.
</Tip>
```
- size_on_disk_str | 20_12_3 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubdeletecachestrategy | .md | ```python
Frozen data structure holding the strategy to delete cached revisions.
This object is not meant to be instantiated programmatically but to be returned by
[`~utils.HFCacheInfo.delete_revisions`]. See documentation for usage example. | 20_13_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubdeletecachestrategy | .md | Args:
expected_freed_size (`float`):
Expected freed size once strategy is executed.
blobs (`FrozenSet[Path]`):
Set of blob file paths to be deleted.
refs (`FrozenSet[Path]`):
Set of reference file paths to be deleted.
repos (`FrozenSet[Path]`):
Set of entire repo paths to be deleted.
snapshots (`FrozenSet[Path]`):
Set of snapshots to be deleted (directory of symlinks).
```
- expected_freed_size_str | 20_13_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cache.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cache/#huggingfacehubcorruptedcacheexception | .md | ```python
Exception for any unexpected structure in the Huggingface cache-system.
``` | 20_14_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/ | .md | <!--⚠️ Note that this file is in Markdown but contains specific syntax for our doc-builder (similar to MDX) that may not be
rendered properly in your Markdown viewer.
--> | 21_0_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#environment-variables | .md | `huggingface_hub` can be configured using environment variables.
If you are unfamiliar with environment variable, here are generic articles about them
[on macOS and Linux](https://linuxize.com/post/how-to-set-and-list-environment-variables-in-linux/)
and on [Windows](https://phoenixnap.com/kb/windows-set-environment-variable).
This page will guide you through all environment variables specific to `huggingface_hub`
and their meaning. | 21_1_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfinferenceendpoint | .md | 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.
Defaults to `"https://api-inference.huggingface.co"`. | 21_2_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhome | .md | 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](#xdgcachehome) is set. | 21_3_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubcache | .md | 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). | 21_4_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfassetscache | .md | To configure where [assets](../guides/manage-cache#caching-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). | 21_5_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hftoken | .md | 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](../quick-start#authentication). | 21_6_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hftokenpath | .md | To configure where `huggingface_hub` should store the User Access Token. Defaults to `"$HF_HOME/token"` (e.g. `~/.cache/huggingface/token` by default). | 21_7_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubverbosity | .md | 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](../package_reference/utilities#huggingface_hub.utils.logging.get_verbosity). | 21_8_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhublocaldirautosymlinkthreshold | .md | This environment variable has been deprecated and is now ignored by `huggingface_hub`. Downloading files to the local dir does not rely on symlinks anymore. | 21_9_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubetagtimeout | .md | 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. | 21_10_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdownloadtimeout | .md | 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. | 21_11_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#boolean-values | .md | 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`. | 21_12_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhuboffline | .md | 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 [`~huggingface_hub.utils.OfflineModeIsEnabled`] exception will be raised. | 21_13_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhuboffline | .md | **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. | 21_13_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdisableimplicittoken | .md | 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](../package_reference/login), 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, | 21_14_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdisableimplicittoken | .md | 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. | 21_14_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdisableprogressbars | .md | 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`. | 21_15_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdisablesymlinkswarning | .md | 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. | 21_16_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdisablesymlinkswarning | .md | 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](../guides/manage-cache#limitations). | 21_16_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdisableexperimentalwarning | .md | 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. | 21_17_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdisableexperimentalwarning | .md | If you are using an experimental feature, please let us know! Your feedback can help us design and improve it. | 21_17_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubdisabletelemetry | .md | 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. | 21_18_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubenablehftransfer | .md | Set to `True` for faster uploads and downloads from the Hub using `hf_transfer`.
By default, `huggingface_hub` uses the Python-based `requests.get` and `requests.post` functions.
Although these are reliable and versatile,
they may not be the most efficient choice for machines with high bandwidth.
[`hf_transfer`](https://github.com/huggingface/hf_transfer) is a Rust-based package developed to
maximize the bandwidth used by dividing large files into smaller parts | 21_19_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubenablehftransfer | .md | maximize the bandwidth used by dividing large files into smaller parts
and transferring them simultaneously using multiple threads.
This approach can potentially double the transfer speed.
To use `hf_transfer`:
1. Specify the `hf_transfer` extra when installing `huggingface_hub`
(e.g. `pip install huggingface_hub[hf_transfer]`).
2. Set `HF_HUB_ENABLE_HF_TRANSFER=1` as an environment variable. | 21_19_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#hfhubenablehftransfer | .md | 2. Set `HF_HUB_ENABLE_HF_TRANSFER=1` as an environment variable.
Please note that using `hf_transfer` comes with certain limitations. Since it is not purely Python-based, debugging errors may be challenging. Additionally, `hf_transfer` lacks several user-friendly features such as resumable downloads and proxies. These omissions are intentional to maintain the simplicity and speed of the Rust logic. Consequently, `hf_transfer` is not enabled by default in `huggingface_hub`. | 21_19_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#deprecated-environment-variables | .md | 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:
| Deprecated Variable | Replacement |
| --- | --- |
| `HUGGINGFACE_HUB_CACHE` | `HF_HUB_CACHE` |
| `HUGGINGFACE_ASSETS_CACHE` | `HF_ASSETS_CACHE` |
| `HUGGING_FACE_HUB_TOKEN` | `HF_TOKEN` | | 21_20_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#deprecated-environment-variables | .md | | `HUGGINGFACE_ASSETS_CACHE` | `HF_ASSETS_CACHE` |
| `HUGGING_FACE_HUB_TOKEN` | `HF_TOKEN` |
| `HUGGINGFACE_HUB_VERBOSITY` | `HF_HUB_VERBOSITY` | | 21_20_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#from-external-tools | .md | Some environment variables are not specific to `huggingface_hub` but are still taken into account when they are set. | 21_21_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#donottrack | .md | 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. | 21_22_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#nocolor | .md | Boolean value. When set, `huggingface-cli` tool will not print any ANSI color.
See [no-color.org](https://no-color.org/). | 21_23_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/environment_variables.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/environment_variables/#xdgcachehome | .md | 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](https://wiki.archlinux.org/title/XDG_Base_Directory)
on linux machines.
If `HF_HOME` is not set, the default home will be `"$XDG_CACHE_HOME/huggingface"` instead
of `"~/.cache/huggingface"`. | 21_24_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/ | .md | <!--⚠️ Note that this file is in Markdown but contains specific syntax for our doc-builder (similar to MDX) that may not be
rendered properly in your Markdown viewer.
--> | 22_0_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#repository-cards | .md | The huggingface_hub library provides a Python interface to create, share, and update Model/Dataset Cards.
Visit the [dedicated documentation page](https://huggingface.co/docs/hub/models-cards) for a deeper view of what
Model Cards on the Hub are, and how they work under the hood. You can also check out our [Model Cards guide](../how-to-model-cards) to
get a feel for how you would use these utilities in your own projects. | 22_1_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#repo-card | .md | The `RepoCard` object is the parent class of [`ModelCard`], [`DatasetCard`] and `SpaceCard`. | 22_2_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#huggingfacehubrepocardrepocard | .md | No docstring found for huggingface_hub.repocard.RepoCard
- __init__
- all | 22_3_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#card-data | .md | The [`CardData`] object is the parent class of [`ModelCardData`] and [`DatasetCardData`]. | 22_4_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#huggingfacehubrepocarddatacarddata | .md | ```python
Structure containing metadata from a RepoCard.
[`CardData`] is the parent class of [`ModelCardData`] and [`DatasetCardData`].
Metadata can be exported as a dictionary or YAML. Export can be customized to alter the representation of the data
(example: flatten evaluation results). `CardData` behaves as a dictionary (can get, pop, set values) but do not
inherit from `dict` to allow this export step.
``` | 22_5_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#modelcard | .md | No docstring found for huggingface_hub.ModelCard | 22_6_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#modelcarddata | .md | ```python
Model Card Metadata that is used by Hugging Face Hub when included at the top of your README.md | 22_7_0 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#modelcarddata | .md | Args:
base_model (`str` or `List[str]`, *optional*):
The identifier of the base model from which the model derives. This is applicable for example if your model is a
fine-tune or adapter of an existing model. The value must be the ID of a model on the Hub (or a list of IDs
if your model derives from multiple models). Defaults to None.
datasets (`Union[str, List[str]]`, *optional*):
Dataset or list of datasets that were used to train this model. Should be a dataset ID | 22_7_1 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#modelcarddata | .md | Dataset or list of datasets that were used to train this model. Should be a dataset ID
found on https://hf.co/datasets. Defaults to None.
eval_results (`Union[List[EvalResult], EvalResult]`, *optional*):
List of `huggingface_hub.EvalResult` that define evaluation results of the model. If provided,
`model_name` is used to as a name on PapersWithCode's leaderboards. Defaults to `None`.
language (`Union[str, List[str]]`, *optional*): | 22_7_2 |
/Users/nielsrogge/Documents/python_projecten/huggingface_hub/docs/source/en/package_reference/cards.md | https://huggingface.co/docs/huggingface_hub/en/package_reference/cards/#modelcarddata | .md | language (`Union[str, List[str]]`, *optional*):
Language of model's training data or metadata. It must be an ISO 639-1, 639-2 or
639-3 code (two/three letters), or a special value like "code", "multilingual". Defaults to `None`.
library_name (`str`, *optional*):
Name of library used by this model. Example: keras or any library from
https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries.ts.
Defaults to None.
license (`str`, *optional*): | 22_7_3 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.