1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<!--⚠️ 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.
-->
# HfApi Client
Below is the documentation for the `HfApi` class, which serves as a Python wrapper for the Hugging Face Hub's API.
All methods from the `HfApi` are also accessible from the package's root directly. Both approaches are detailed below.
Using the root method is more straightforward but the [`HfApi`] class gives you more flexibility.
In particular, you can pass a token that will be reused in all HTTP calls. This is different
from `hf auth login` or [`login`] as the token is not persisted on the machine.
It is also possible to provide a different endpoint or configure a custom user-agent.
```python
from huggingface_hub import HfApi, list_models
# Use root method
models = list_models()
# Or configure a HfApi client
hf_api = HfApi(
endpoint="https://huggingface.co", # Can be a Private Hub endpoint.
token="hf_xxx", # Token is not persisted on the machine.
)
models = hf_api.list_models()
```
## HfApi
[[autodoc]] HfApi
## API Dataclasses
### AccessRequest
[[autodoc]] huggingface_hub.hf_api.AccessRequest
### CommitInfo
[[autodoc]] huggingface_hub.hf_api.CommitInfo
### DatasetInfo
[[autodoc]] huggingface_hub.hf_api.DatasetInfo
### DryRunFileInfo
[[autodoc]] huggingface_hub.hf_api.DryRunFileInfo
### GitRefInfo
[[autodoc]] huggingface_hub.hf_api.GitRefInfo
### GitCommitInfo
[[autodoc]] huggingface_hub.hf_api.GitCommitInfo
### GitRefs
[[autodoc]] huggingface_hub.hf_api.GitRefs
### InferenceProviderMapping
[[autodoc]] huggingface_hub.hf_api.InferenceProviderMapping
### LFSFileInfo
[[autodoc]] huggingface_hub.hf_api.LFSFileInfo
### ModelInfo
[[autodoc]] huggingface_hub.hf_api.ModelInfo
### RepoSibling
[[autodoc]] huggingface_hub.hf_api.RepoSibling
### RepoFile
[[autodoc]] huggingface_hub.hf_api.RepoFile
### RepoUrl
[[autodoc]] huggingface_hub.hf_api.RepoUrl
### SafetensorsRepoMetadata
[[autodoc]] huggingface_hub.utils.SafetensorsRepoMetadata
### SafetensorsFileMetadata
[[autodoc]] huggingface_hub.utils.SafetensorsFileMetadata
### SpaceInfo
[[autodoc]] huggingface_hub.hf_api.SpaceInfo
### TensorInfo
[[autodoc]] huggingface_hub.utils.TensorInfo
### User
[[autodoc]] huggingface_hub.hf_api.User
### UserLikes
[[autodoc]] huggingface_hub.hf_api.UserLikes
### WebhookInfo
[[autodoc]] huggingface_hub.hf_api.WebhookInfo
### WebhookWatchedItem
[[autodoc]] huggingface_hub.hf_api.WebhookWatchedItem
## CommitOperation
Below are the supported values for [`CommitOperation`]:
[[autodoc]] CommitOperationAdd
[[autodoc]] CommitOperationDelete
[[autodoc]] CommitOperationCopy
## CommitScheduler
[[autodoc]] CommitScheduler
|
