Skip to main content

Client library to download and publish models on the huggingface.co hub

Project description

huggingface_hub

Welcome to the Hub repo! Here you can find all the open source things related to the Hugging Face Hub.

Build GitHub GitHub release

What can you find in this repo?

  • huggingface_hub, a client library to download and publish on the Hugging Face Hub as well as extracting useful information from there.
  • api-inference-community, the Inference API for open source machine learning libraries.
  • widgets, the open-sourced widgets that allow people to try out the models in the browser.
  • interfaces, Typescript definition files for the Hugging Face Hub.
  • docs, containing the official Hugging Face Hub documentation.

The huggingface_hub client library

This library allows anyone to work with the Hub repositories: you can clone them, create them and upload your models to them. On top of this, the library also offers methods to access information from the Hub. For example, listing all models that meet specific criteria or get all the files from a specific repo. You can find the library implementation here.


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.

The advantages are:

  • Free model 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 with ❤️ showing how to do this integration.


Inference API integration into the Hugging Face Hub

In order to get a functional Inference API on the Hub for your models (and thus, cool working widgets!) check out this doc. There is a docker image for each library. Within the image, you can find the implementation for supported pipelines for the given library.


Widgets

All our widgets are open-sourced. Feel free to propose and implement widgets. You can try all of them out here.


Code Snippets

We'll implement a few tweaks to improve the UX for your models on the website – let's use Asteroid as an example.

Model authors add an asteroid tag to their model card and they get the advantages of model versioning built-in

asteroid-model

We add a custom "Use in Asteroid" button. When clicked, you get a library-specific code sample that you'll be able to specify. 🔥

asteroid-code-sample


Feedback (feature requests, bugs, etc.) is super welcome 💙💚💛💜♥️🧡

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-0.0.12.tar.gz (34.0 kB view details)

Uploaded Source

Built Distribution

huggingface_hub-0.0.12-py3-none-any.whl (37.9 kB view details)

Uploaded Python 3

File details

Details for the file huggingface_hub-0.0.12.tar.gz.

File metadata

  • Download URL: huggingface_hub-0.0.12.tar.gz
  • Upload date:
  • Size: 34.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for huggingface_hub-0.0.12.tar.gz
Algorithm Hash digest
SHA256 661b17fab0c475276fd71603ee7e16c3b3d1d6e812e1b29f40144f64d361e59d
MD5 eab25a57ebb8fd6b79ae4cbd4521211c
BLAKE2b-256 6ebbec72847c404c2240a80835a6e23a542c5206ae2e9c539118d7d497aae2b4

See more details on using hashes here.

File details

Details for the file huggingface_hub-0.0.12-py3-none-any.whl.

File metadata

  • Download URL: huggingface_hub-0.0.12-py3-none-any.whl
  • Upload date:
  • Size: 37.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5

File hashes

Hashes for huggingface_hub-0.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 5c82ff96897a72e1ed48a94c1796686f120dea05888200522f3994f130c12e6a
MD5 ae59a6d7fc7ff2890ce52b71942335ee
BLAKE2b-256 2fee97e253668fda9b17e968b3f97b2f8e53aa0127e8807d24a547687423fe0b

See more details on using hashes here.

Supported by

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