File size: 7,548 Bytes
439aaa0
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
Metadata-Version: 2.1
Name: huggingface-hub
Version: 0.11.1
Summary: Client library to download and publish models, datasets and other repos on the huggingface.co hub
Home-page: https://github.com/huggingface/huggingface_hub
Author: Hugging Face, Inc.
Author-email: [email protected]
License: Apache
Keywords: model-hub machine-learning models natural-language-processing deep-learning pytorch pretrained-models
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: filelock
Requires-Dist: requests
Requires-Dist: tqdm
Requires-Dist: pyyaml (>=5.1)
Requires-Dist: typing-extensions (>=3.7.4.3)
Requires-Dist: packaging (>=20.9)
Requires-Dist: importlib-metadata ; python_version < "3.8"
Provides-Extra: all
Requires-Dist: InquirerPy (==0.3.4) ; extra == 'all'
Requires-Dist: isort (>=5.5.4) ; extra == 'all'
Requires-Dist: jedi ; extra == 'all'
Requires-Dist: Jinja2 ; extra == 'all'
Requires-Dist: pytest ; extra == 'all'
Requires-Dist: pytest-cov ; extra == 'all'
Requires-Dist: pytest-env ; extra == 'all'
Requires-Dist: soundfile ; extra == 'all'
Requires-Dist: black (==22.3) ; extra == 'all'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'all'
Requires-Dist: flake8-bugbear ; extra == 'all'
Requires-Dist: mypy (==0.982) ; extra == 'all'
Requires-Dist: types-PyYAML ; extra == 'all'
Requires-Dist: types-requests ; extra == 'all'
Requires-Dist: types-simplejson ; extra == 'all'
Requires-Dist: types-toml ; extra == 'all'
Requires-Dist: types-tqdm ; extra == 'all'
Requires-Dist: types-urllib3 ; extra == 'all'
Provides-Extra: cli
Requires-Dist: InquirerPy (==0.3.4) ; extra == 'cli'
Provides-Extra: dev
Requires-Dist: InquirerPy (==0.3.4) ; extra == 'dev'
Requires-Dist: isort (>=5.5.4) ; extra == 'dev'
Requires-Dist: jedi ; extra == 'dev'
Requires-Dist: Jinja2 ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-env ; extra == 'dev'
Requires-Dist: soundfile ; extra == 'dev'
Requires-Dist: black (==22.3) ; extra == 'dev'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'dev'
Requires-Dist: flake8-bugbear ; extra == 'dev'
Requires-Dist: mypy (==0.982) ; extra == 'dev'
Requires-Dist: types-PyYAML ; extra == 'dev'
Requires-Dist: types-requests ; extra == 'dev'
Requires-Dist: types-simplejson ; extra == 'dev'
Requires-Dist: types-toml ; extra == 'dev'
Requires-Dist: types-tqdm ; extra == 'dev'
Requires-Dist: types-urllib3 ; extra == 'dev'
Provides-Extra: fastai
Requires-Dist: toml ; extra == 'fastai'
Requires-Dist: fastai (>=2.4) ; extra == 'fastai'
Requires-Dist: fastcore (>=1.3.27) ; extra == 'fastai'
Provides-Extra: quality
Requires-Dist: black (==22.3) ; extra == 'quality'
Requires-Dist: flake8 (>=3.8.3) ; extra == 'quality'
Requires-Dist: flake8-bugbear ; extra == 'quality'
Requires-Dist: isort (>=5.5.4) ; extra == 'quality'
Requires-Dist: mypy (==0.982) ; extra == 'quality'
Provides-Extra: tensorflow
Requires-Dist: tensorflow ; extra == 'tensorflow'
Requires-Dist: pydot ; extra == 'tensorflow'
Requires-Dist: graphviz ; extra == 'tensorflow'
Provides-Extra: testing
Requires-Dist: InquirerPy (==0.3.4) ; extra == 'testing'
Requires-Dist: isort (>=5.5.4) ; extra == 'testing'
Requires-Dist: jedi ; extra == 'testing'
Requires-Dist: Jinja2 ; extra == 'testing'
Requires-Dist: pytest ; extra == 'testing'
Requires-Dist: pytest-cov ; extra == 'testing'
Requires-Dist: pytest-env ; extra == 'testing'
Requires-Dist: soundfile ; extra == 'testing'
Provides-Extra: torch
Requires-Dist: torch ; extra == 'torch'
Provides-Extra: typing
Requires-Dist: types-PyYAML ; extra == 'typing'
Requires-Dist: types-requests ; extra == 'typing'
Requires-Dist: types-simplejson ; extra == 'typing'
Requires-Dist: types-toml ; extra == 'typing'
Requires-Dist: types-tqdm ; extra == 'typing'
Requires-Dist: types-urllib3 ; extra == 'typing'

# `huggingface_hub`

<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
<a href="https://codecov.io/gh/huggingface/huggingface_hub"><img alt="Code coverage" src="https://codecov.io/gh/huggingface/huggingface_hub/branch/main/graph/badge.svg?token=RXP95LE2XL"></a>
<a href="https://github.com/huggingface/huggingface_hub/releases"><img alt="GitHub release" src="https://img.shields.io/github/release/huggingface/huggingface_hub.svg"></a>
<a href="https://github.com/huggingface/huggingface_hub"><img alt="Documentation" src="https://img.shields.io/pypi/pyversions/huggingface_hub.svg"></a>
<a href="https://huggingface.co/docs/huggingface_hub/index"><img alt="Documentation" src="https://img.shields.io/website/http/huggingface.co/docs/huggingface_hub/index.svg?down_color=red&down_message=offline&up_message=online&label=doc"></a>

## Welcome to the huggingface_hub library


The `huggingface_hub` is a client library to interact with the Hugging Face Hub. The Hugging Face Hub is a platform with over 35K models, 4K datasets, and 2K demos in which people can easily collaborate in their ML workflows. The Hub works as a central place where anyone can share, explore, discover, and experiment with open-source Machine Learning.

With `huggingface_hub`, you can easily download and upload models, datasets, and Spaces. You can extract useful information from the Hub, and do much more. Some example use cases:
* Downloading and caching files from a Hub repository.
* Creating repositories and uploading an updated model every few epochs.
* Extract metadata from all models that match certain criteria (e.g. models for `text-classification`).
* List all files from a specific repository.

Read all about it in [the library documentation](https://huggingface.co/docs/huggingface_hub).

<br>

## Integrating to the Hub.

We're partnering with cool open source ML libraries to provide free model hosting and versioning. You can find the existing integrations [here](https://huggingface.co/docs/hub/libraries).

The advantages are:

- Free model or dataset hosting for libraries and their users.
- Built-in file versioning, even with very large files, thanks to a git-based approach.
- Hosted inference API for all models publicly available.
- In-browser widgets to play with the uploaded models.
- Anyone can upload a new model for your library, they just need to add the corresponding tag for the model to be discoverable.
- Fast downloads! We use Cloudfront (a CDN) to geo-replicate downloads so they're blazing fast from anywhere on the globe.
- Usage stats and more features to come.

If you would like to integrate your library, feel free to open an issue to begin the discussion. We wrote a [step-by-step guide](https://huggingface.co/docs/hub/adding-a-library) with ❀️ showing how to do this integration.

<br>

## Feedback (feature requests, bugs, etc.) is super welcome πŸ’™πŸ’šπŸ’›πŸ’œβ™₯️🧑