- <p align="center">
- <picture>
- <source media="(prefers-color-scheme: dark)" srcset="https://huggingface.co/datasets/huggingface/documentation-images/raw/main/huggingface_hub-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="https://huggingface.co/datasets/huggingface/documentation-images/raw/main/huggingface_hub.svg">
<img alt="huggingface_hub library logo" src="https://huggingface.co/datasets/huggingface/documentation-images/raw/main/huggingface_hub.svg" width="352" height="59" style="max-width: 100%;">
System Message: WARNING/2 (<string>, line 6)
Definition list ends without a blank line; unexpected unindent.
</picture>
<br/>
<br/>
System Message: WARNING/2 (<string>, line 9)
Definition list ends without a blank line; unexpected unindent.
</p>
- <p align="center">
- <i>The official Python client for the Huggingface Hub.</i>
System Message: WARNING/2 (<string>, line 13)
Definition list ends without a blank line; unexpected unindent.
</p>
- <p align="center">
- <a href="https://huggingface.co/docs/huggingface_hub/en/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>
<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="PyPi version" src="https://img.shields.io/pypi/pyversions/huggingface_hub.svg"></a>
<a href="https://pypi.org/project/huggingface-hub"><img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/huggingface_hub"></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>
System Message: WARNING/2 (<string>, line 21)
Definition list ends without a blank line; unexpected unindent.
</p>
- <h4 align="center">
- <p>
- <b>English</b> |
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_de.md">Deutsch</a> |
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_hi.md">हिंदी</a> |
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_ko.md">한국어</a> |
<a href="https://github.com/huggingface/huggingface_hub/blob/main/i18n/README_cn.md">中文（简体）</a>
System Message: WARNING/2 (<string>, line 30)
Definition list ends without a blank line; unexpected unindent.
<p>
System Message: WARNING/2 (<string>, line 31)
Definition list ends without a blank line; unexpected unindent.
</h4>
---
Documentation: <a href="https://hf.co/docs/huggingface_hub" target="_blank">https://hf.co/docs/huggingface_hub</a>
Source Code: <a href="https://github.com/huggingface/huggingface_hub" target="_blank">https://github.com/huggingface/huggingface_hub</a>
---
## Welcome to the huggingface_hub library
The huggingface_hub library allows you to interact with the [Hugging Face Hub](https://huggingface.co/), a platform democratizing open-source Machine Learning for creators and collaborators. Discover pre-trained models and datasets for your projects or play with the thousands of machine learning apps hosted on the Hub. You can also create and share your own models, datasets and demos with the community. The huggingface_hub library provides a simple way to do all these things with Python.
## Key features
## Installation
Install the huggingface_hub package with [pip](https://pypi.org/project/huggingface-hub/):
`bash
pip install huggingface_hub
`
If you prefer, you can also install it with [conda](https://huggingface.co/docs/huggingface_hub/en/installation#install-with-conda).
In order to keep the package minimal by default, huggingface_hub comes with optional dependencies useful for some use cases. For example, if you want have a complete experience for Inference, run:
`bash
pip install huggingface_hub[inference]
`
To learn more installation and optional dependencies, check out the [installation guide](https://huggingface.co/docs/huggingface_hub/en/installation).
## Quick start
### Download files
Download a single file
```py
from huggingface_hub import hf_hub_download
System Message: WARNING/2 (<string>, line 79); backlink
Inline literal start-string without end-string.
System Message: WARNING/2 (<string>, line 79); backlink
Inline interpreted text or phrase reference start-string without end-string.
hf_hub_download(repo_id="tiiuae/falcon-7b-instruct", filename="config.json")
```
System Message: WARNING/2 (<string>, line 82); backlink
Inline literal start-string without end-string.
System Message: WARNING/2 (<string>, line 82); backlink
Inline interpreted text or phrase reference start-string without end-string.
Or an entire repository
```py
from huggingface_hub import snapshot_download
System Message: WARNING/2 (<string>, line 87); backlink
Inline literal start-string without end-string.
System Message: WARNING/2 (<string>, line 87); backlink
Inline interpreted text or phrase reference start-string without end-string.
snapshot_download("stabilityai/stable-diffusion-2-1")
```
System Message: WARNING/2 (<string>, line 90); backlink
Inline literal start-string without end-string.
System Message: WARNING/2 (<string>, line 90); backlink
Inline interpreted text or phrase reference start-string without end-string.
Files will be downloaded in a local cache folder. More details in [this guide](https://huggingface.co/docs/huggingface_hub/en/guides/manage-cache).
### Login
The Hugging Face Hub uses tokens to authenticate applications (see [docs](https://huggingface.co/docs/hub/security-tokens)). To log in your machine, run the following CLI:
`bash
huggingface-cli login
# or using an environment variable
huggingface-cli login --token $HUGGINGFACE_TOKEN
`
### Create a repository
```py
from huggingface_hub import create_repo
System Message: WARNING/2 (<string>, line 107); backlink
Inline literal start-string without end-string.
System Message: WARNING/2 (<string>, line 107); backlink
Inline interpreted text or phrase reference start-string without end-string.
create_repo(repo_id="super-cool-model")
```
System Message: WARNING/2 (<string>, line 110); backlink
Inline literal start-string without end-string.
System Message: WARNING/2 (<string>, line 110); backlink
Inline interpreted text or phrase reference start-string without end-string.
### Upload files
Upload a single file
```py
from huggingface_hub import upload_file
System Message: WARNING/2 (<string>, line 117); backlink
Inline literal start-string without end-string.
System Message: WARNING/2 (<string>, line 117); backlink
Inline interpreted text or phrase reference start-string without end-string.
- upload_file(
- path_or_fileobj="/home/lysandre/dummy-test/README.md",
path_in_repo="README.md",
repo_id="lysandre/test-model",
System Message: WARNING/2 (<string>, line 124)
Definition list ends without a blank line; unexpected unindent.
)
Or an entire folder
```py
from huggingface_hub import upload_folder
System Message: WARNING/2 (<string>, line 129); backlink
Inline literal start-string without end-string.
System Message: WARNING/2 (<string>, line 129); backlink
Inline interpreted text or phrase reference start-string without end-string.
- upload_folder(
- folder_path="/path/to/local/space",
repo_id="username/my-cool-space",
repo_type="space",
System Message: WARNING/2 (<string>, line 136)
Definition list ends without a blank line; unexpected unindent.
)
For details in the [upload guide](https://huggingface.co/docs/huggingface_hub/en/guides/upload).
## 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.
- Serverless 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.
## Contributions (feature requests, bugs, etc.) are super welcome 💙💚💛💜🧡❤️
Everyone is welcome to contribute, and we value everybody's contribution. Code is not the only way to help the community.
Answering questions, helping others, reaching out and improving the documentations are immensely valuable to the community.
We wrote a [contribution guide](https://github.com/huggingface/huggingface_hub/blob/main/CONTRIBUTING.md) to summarize
how to get started to contribute to this repository.
