Skip to content

Releases: huggingface/huggingface_hub

v0.0.11: Improved documentation, `hf_hub_download` and `Repository` power-up

23 Jun 11:01
Compare
Choose a tag to compare

v0.0.11: Improved documentation, hf_hub_download and Repository power-up

Improved documentation

The huggingface_hub documentation is now available on hf.co/docs! Additionally, a new step-by-step guide to adding libraries is available.

New method: hf_hub_download

A new method is introduced: hf_hub_download. It is the equivalent of doing cached_download(hf_hub_url()), in a single method.

Repository power-up

The Repository class is updated to behave more similarly to git. It is now impossible to clone a repository in a folder that already contains files.

The PyTorch Mixin contributed by @vasudevgupta7 is slightly updated to have the push_to_hub method manage a repository as one would from the command line.

Improvement & Fixes

v0.0.10: Merging `huggingface_hub` with `api-inference-community` and hub interfaces

08 Jun 13:43
Compare
Choose a tag to compare

v0.0.10: Merging huggingface_hub with api-inference-community and hub interfaces

v0.0.10 Signs the merging of three components of the HuggingFace stack: the huggingface_hub repository is now the central platform to contribute new libraries to be supported on the hub.

It regroups three previously separated components:

  • The huggingface_hub Python library, as the Python library to download, upload, and retrieve information from the hub.
  • The api-inference-community, as the platform where libraries wishing for hub support may be added.
  • The interfaces, as the definition for pipeline types as well as default widget inputs and definitions/UI elements for third-party libraries.

Future efforts will be focused on further easing contributing third-party libraries to the Hugging Face Hub

Improvement & Fixes

v0.0.9: HTTP File uploads, multiple filter model selection

20 May 15:19
Compare
Choose a tag to compare

v0.0.9: HTTP file uploads, multiple filter model selection

Support for large file uploads

Implementation of an endpoint to programmatically upload (large) files to any repo on the hub, without the need for git, using HTTP POST requests.

The HfApi.model_list method now allows multiple filters

Models may now be filtered using several filters:

                Example usage:

                    >>> from huggingface_hub import HfApi
                    >>> api = HfApi()

                    >>> # List all models
                    >>> api.list_models()

                    >>> # List only the text classification models
                    >>> api.list_models(filter="text-classification")

                    >>> # List only the russian models compatible with pytorch
                    >>> api.list_models(filter=("ru", "pytorch"))

                    >>> # List only the models trained on the "common_voice" dataset
                    >>> api.list_models(filter="dataset:common_voice")

                    >>> # List only the models from the AllenNLP library
                    >>> api.list_models(filter="allennlp")

ModelInfo now has a readable representation

Improvement of the ModelInfo class so that it displays information about the object.

Improvements and bugfixes

v0.0.8: Model Info, Snapshot download

07 Apr 23:57
Compare
Choose a tag to compare
  • Addition of the HfApi.model_info method to retrieve information about a repo given a revision.
  • The accompanying snapshot_download utility to download to cache all files stored in that repo at that given revision.

Example usage of HfApi.model_info:

from huggingface_hub import HfApi

hf_api = HfApi()
model_info = hf_api.model_info("lysandre/dummy-hf-hub")

print("Model ID:", model_info.modelId)

for file in model_info.siblings:
    print("file:", file.rfilename)

outputs:

Model ID: lysandre/dummy-hf-hub
file: .gitattributes
file: README.md

Example usage of snapshot_download:

from huggingface_hub import snapshot_download
import os

repo_path = snapshot_download("lysandre/dummy-hf-hub")
print(os.listdir(repo_path))

outputs:

['.gitattributes', 'README.md']

v0.0.7: Networking improvements + PyTorch mixin

18 Mar 17:54
Compare
Choose a tag to compare
  • Networking improvements by @Pierrci and @lhoestq (#21 and #22)

  • Adding mixin class for ease saving, uploading, downloading a PyTorch model. See PR #11 by @vasudevgupta7

Example usage:

from huggingface_hub import ModelHubMixin

class MyModel(nn.Module, ModelHubMixin):
   def __init__(self, **kwargs):
      super().__init__()
      self.config = kwargs.pop("config", None)
      self.layer = ...
   def forward(self, ...):
      return ...

model = MyModel()

# saving model to local directory & pushing to hub
model.save_pretrained("mymodel", push_to_hub=True, config={"act": "gelu"})

# initiatizing model & loading it from trained-weights
model = MyModel.from_pretrained("username/mymodel@main")

Thanks a ton for your contributions ♥️

v0.0.6

02 Mar 15:03
Compare
Choose a tag to compare
[Repository] Strip basic auth info

Repository class + other tweaks

02 Mar 14:41
Compare
Choose a tag to compare

Repository class

02 Mar 14:31
35418de
Compare
Choose a tag to compare

Repository helper class to interact with git/git-lfs programmatically

02 Mar 14:29
35418de
Compare
Choose a tag to compare
  • [Repository] more forgiving lfs_track

  • added stderr and exceptions (#19)

    • added stderr and exceptions

    • added log to push and check for commit error

    • fixed quality

    • doc improvements + small tweaks

    • [git_add] actually take input pattern

    • less brittle test if local_dir is an actual git repo

    Co-authored-by: Julien Chaumond julien@huggingface.co

  • v0.0.3

Repository helper class to interact with git/git-lfs programmatically

23 Feb 19:43
Compare
Choose a tag to compare
v0.0.3rc2

v0.0.3rc2