Skip to content

Commit d1bf4c0

Browse files
authored
Revisit "search the hub" page (+HfApi reference page) (#1303)
* Condense more the HfApi reference page * revisit 'searching the hub' page * titles
1 parent 39a1d55 commit d1bf4c0

File tree

2 files changed

+105
-232
lines changed

2 files changed

+105
-232
lines changed

docs/source/package_reference/hf_api.mdx

Lines changed: 32 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,79 @@
1-
# Hugging Face Hub API
1+
# HfApi Client
22

3-
Below is the documentation for the `HfApi` class, which serves as a Python wrapper for the Hugging Face
4-
Hub's API.
3+
Below is the documentation for the `HfApi` class, which serves as a Python wrapper for the Hugging Face Hub's API.
54

6-
All methods from the `HfApi` are also accessible from the package's root directly, both approaches are detailed
7-
below.
5+
All methods from the `HfApi` are also accessible from the package's root directly. Both approaches are detailed below.
86

9-
The following approach uses the method from the root of the package:
7+
Using the root method is more straightforward but the [`HfApi`] class gives you more flexibility.
8+
In particular, you can pass a token that will be reused in all HTTP calls. This is different
9+
than `huggingface-cli login` or [`login`] as the token is not persisted on the machine.
10+
It is also possible to provide a different endpoint or configure a custom user-agent.
1011

1112
```python
12-
from huggingface_hub import list_models
13+
from huggingface_hub import HfApi, list_models
1314

15+
# Use root method
1416
models = list_models()
15-
```
16-
17-
The following approach uses the `HfApi` class:
18-
19-
```python
20-
from huggingface_hub import HfApi
21-
22-
hf_api = HfApi()
23-
models = hf_api.list_models()
24-
```
25-
26-
Using the [`HfApi`] class directly enables you to configure the client. In particular, a
27-
token can be passed to be authenticated in all API calls. This is different than
28-
`huggingface-cli login` or [`login`] as the token is not persisted on the machine. One
29-
can also specify a different endpoint than the Hugging Face's Hub (for example to interact
30-
with a Private Hub).
31-
32-
```py
33-
from huggingface_hub import HfApi
3417

18+
# Or configure a HfApi client
3519
hf_api = HfApi(
3620
endpoint="https://huggingface.co", # Can be a Private Hub endpoint.
3721
token="hf_xxx", # Token is not persisted on the machine.
3822
)
23+
models = hf_api.list_models()
3924
```
4025

41-
### HfApi
26+
## HfApi
4227

4328
[[autodoc]] HfApi
4429

45-
### RepoUrl
30+
## API Dataclasses
4631

47-
[[autodoc]] huggingface_hub.hf_api.RepoUrl
48-
49-
### ModelInfo
32+
### CommitInfo
5033

51-
[[autodoc]] huggingface_hub.hf_api.ModelInfo
34+
[[autodoc]] huggingface_hub.hf_api.CommitInfo
5235

5336
### DatasetInfo
5437

5538
[[autodoc]] huggingface_hub.hf_api.DatasetInfo
5639

57-
### SpaceInfo
58-
59-
[[autodoc]] huggingface_hub.hf_api.SpaceInfo
60-
61-
### RepoFile
40+
### GitRefInfo
6241

63-
[[autodoc]] huggingface_hub.hf_api.RepoFile
42+
[[autodoc]] huggingface_hub.hf_api.GitRefInfo
6443

6544
### GitRefs
6645

6746
[[autodoc]] huggingface_hub.hf_api.GitRefs
6847

69-
### GitRefInfo
48+
### ModelInfo
7049

71-
[[autodoc]] huggingface_hub.hf_api.GitRefInfo
50+
[[autodoc]] huggingface_hub.hf_api.ModelInfo
7251

73-
### CommitInfo
52+
### RepoFile
7453

75-
[[autodoc]] huggingface_hub.hf_api.CommitInfo
54+
[[autodoc]] huggingface_hub.hf_api.RepoFile
55+
56+
### RepoUrl
57+
58+
[[autodoc]] huggingface_hub.hf_api.RepoUrl
59+
60+
### SpaceInfo
61+
62+
[[autodoc]] huggingface_hub.hf_api.SpaceInfo
7663

7764
### UserLikes
7865

7966
[[autodoc]] huggingface_hub.hf_api.UserLikes
8067

81-
## `create_commit` API
68+
## CommitOperation
8269

8370
Below are the supported values for [`CommitOperation`]:
8471

8572
[[autodoc]] CommitOperationAdd
8673

8774
[[autodoc]] CommitOperationDelete
8875

89-
## Hugging Face local storage
76+
## Token helper
9077

9178
`huggingface_hub` stores the authentication information locally so that it may be re-used in subsequent
9279
methods.
@@ -95,7 +82,7 @@ It does this using the [`HfFolder`] utility, which saves data at the root of the
9582

9683
[[autodoc]] HfFolder
9784

98-
## Filtering helpers
85+
## Search helpers
9986

10087
Some helpers to filter repositories on the Hub are available in the `huggingface_hub` package.
10188

0 commit comments

Comments
 (0)