Skip to main content

Client library to download and publish models, datasets and other repos on the huggingface.co hub

Project description

huggingface_hub library logo

The official CLI and Python client for the Hugging Face Hub.
About · Documentation · Install · CLI Guide · Contributing

Documentation GitHub release PyPi version PyPI - Downloads Code coverage

English | Deutsch | Français | हिंदी | 한국어 | 中文 (简体) | ಕನ್ನಡ

Quick start

Install the hf CLI with the standalone installer:

# On macOS and Linux.
curl -LsSf https://hf.co/cli/install.sh | bash
# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://hf.co/cli/install.ps1 | iex"

Log in, then start working with the Hub:

# Log in (use --token $HF_TOKEN in non-interactive environments)
hf auth login

# Find models served by Inference Providers
hf models ls --warm

# Download a model
hf download Qwen/Qwen3-0.6B

# Upload files to your own repo
hf upload username/my-cool-model ./model.safetensors

# Sync a local folder to a storage bucket
hf buckets sync ./checkpoints hf://buckets/username/my-bucket

# Run a job on Hugging Face infrastructure
hf jobs run python:3.12 python -c "print('Hello from the cloud!')"

# Discover everything else
hf --help

The Hub uses tokens to authenticate applications (see docs). Check out the CLI guide for a tour of the main features.

What is huggingface_hub?

The huggingface_hub library allows you to interact with the Hugging Face Hub, a platform democratizing open-source Machine Learning for creators and collaborators. Discover pre-trained models and datasets for your projects, play with the thousands of machine learning apps hosted on the Hub, or create and share your own models, datasets and demos with the community. Everything ships in one package with two interfaces: the hf CLI for your terminal and the huggingface_hub library for Python — both designed to work well for humans and AI agents. Use them to:

Built for humans and AI agents

The hf CLI is designed for people and coding agents alike: the same commands adapt their output when run by an agent. If you use Claude Code, Codex, Cursor, or another coding agent, install the hf CLI Skill — a command reference generated from your installed CLI:

# for Codex, Cursor, OpenCode, Pi and other agents that load skills from `.agents/skills`
hf skills add
# includes the above + Claude Code
hf skills add --claude

Learn more in the Hugging Face CLI for AI agents guide and the announcement blog post.

Use the Python library

Install the huggingface_hub package with pip (this also installs the hf CLI):

pip install huggingface_hub

We recommend using uv for a fast and reliable install:

uv pip install huggingface_hub

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 to use the MCP module, run:

pip install "huggingface_hub[mcp]"

To learn more about installation and optional dependencies, check out the installation guide.

Download files

Download a single file

from huggingface_hub import hf_hub_download

hf_hub_download(repo_id="zai-org/GLM-5.2", filename="config.json")

Or an entire repository

from huggingface_hub import snapshot_download

snapshot_download("sentence-transformers/all-MiniLM-L6-v2")

Files will be downloaded in a local cache folder. More details in this guide.

Create a repository

from huggingface_hub import create_repo

create_repo(repo_id="super-cool-model")

Upload files

Upload a single file

from huggingface_hub import upload_file

upload_file(
    path_or_fileobj="/home/lysandre/dummy-test/README.md",
    path_in_repo="README.md",
    repo_id="lysandre/test-model",
)

Or an entire folder

from huggingface_hub import upload_folder

upload_folder(
    folder_path="/path/to/local/space",
    repo_id="username/my-cool-space",
    repo_type="space",
)

More details in the upload guide.

Integrating with 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.

The advantages are:

  • Free model or dataset hosting for libraries and their users.
  • Built-in file versioning, even with very large files, made possible by Xet, the Hub's chunk-deduplicated storage backend.
  • 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 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 to summarize how to get started to contribute to this repository.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

huggingface_hub-1.24.0rc1.tar.gz (922.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

huggingface_hub-1.24.0rc1-py3-none-any.whl (772.0 kB view details)

Uploaded Python 3

File details

Details for the file huggingface_hub-1.24.0rc1.tar.gz.

File metadata

  • Download URL: huggingface_hub-1.24.0rc1.tar.gz
  • Upload date:
  • Size: 922.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for huggingface_hub-1.24.0rc1.tar.gz
Algorithm Hash digest
SHA256 9252078e1d715accf6bf7d37b129219ae518bbcbbc5fe05a48365389ea6b89c2
MD5 9af84ccfc241a503f1488f3f6fc88608
BLAKE2b-256 8a5eec607afc0712a2cc7b38e901b847f2b896b42c2c1d7aaf5967d0cef019bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for huggingface_hub-1.24.0rc1.tar.gz:

Publisher: release.yml on huggingface/huggingface_hub

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file huggingface_hub-1.24.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for huggingface_hub-1.24.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 f71eed76edf2d6474ede480f23e2f279b46e9a9ce9bf7400fba3da05b3cf8f19
MD5 9cf1aaaaa859497e7e03f41780511c80
BLAKE2b-256 eb9b51fc709d84099f9e3fc501e4150cda01c4c7b93922644695a4fd8c40f3e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for huggingface_hub-1.24.0rc1-py3-none-any.whl:

Publisher: release.yml on huggingface/huggingface_hub

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page