Skip to content

Releases: huggingface/huggingface_hub

[v0.24.6]: Fix [DONE] handling for `AsyncInferenceClient` on TGI 2.2.0+

19 Aug 15:17
23bab6a
Compare
Choose a tag to compare

[v0.24.5] Fix download process on S3 mount (v2)

31 Jul 09:03
f2fbf5b
Compare
Choose a tag to compare

Follow-up after #2433 and v0.24.4 patch release. This release will definitely fix things.

Full Changelog: v0.24.4...v0.24.5

[v0.24.4] Fix download process on S3 mount

31 Jul 08:41
e63f31f
Compare
Choose a tag to compare

When downloading a file, the process was failing if the filesystem did not support either chmod or shutils.copy2 when moving a file from the tmp folder to the cache. This patch release fixes this. More details in #2429.

Full Changelog: v0.24.3...v0.24.4

[v0.24.3] Fix InferenceClient base_url for OpenAI compatibility

29 Jul 12:58
071503f
Compare
Choose a tag to compare

Fixing a bug in the chat completion URL to follow OpenAI standard #2418. InferenceClient now works with urls ending with /, /v1 and /v1/chat/completions.

Full Changelog: v0.24.2...v0.24.3

[v0.24.2] Fix create empty commit PR should not fail

24 Jul 14:23
09fc1d4
Compare
Choose a tag to compare

See #2413 for more details.
Creating an empty commit on a PR was failing due to a revision parameter been quoted twice. This patch release fixes it.

Full Changelog: v0.24.1...v0.24.2

[v0.24.1] Handle [DONE] signal from TGI + remove logic for "non-TGI servers"

23 Jul 14:44
1dd68a9
Compare
Choose a tag to compare

This release fixes 2 things:

  • handle "[DONE]" message in chat stream (related to TGI update huggingface/text-generation-inference#2221)
  • remove the "non-TGI" logic in chat completion since all models support server-side rendering now that even transformers-backed models are TGI-server.

See #2410 for more details.

Full Changelog: v0.24.0...v0.24.1

v0.24.0: Inference, serialization and optimizations

17 Jul 13:41
44b6e0f
Compare
Choose a tag to compare

⚡️ OpenAI-compatible inference client!

The InferenceClient's chat completion API is now fully compliant with OpenAI client. This means it's a drop-in replacement in your script:

- from openai import OpenAI
+ from huggingface_hub import InferenceClient

- client = OpenAI(
+ client = InferenceClient(
    base_url=...,
    api_key=...,
)


output = client.chat.completions.create(
    model="meta-llama/Meta-Llama-3-8B-Instruct",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Count to 10"},
    ],
    stream=True,
    max_tokens=1024,
)

for chunk in output:
    print(chunk.choices[0].delta.content)

Why switching to InferenceClient if you already use OpenAI then? Because it's better integrated with HF services, such as the Serverless Inference API and Dedicated Endpoints. Check out the more detailed answer in this HF Post.

For more details about OpenAI compatibility, check out this guide's section.

  • True OpenAI drop-in replacement by InferenceClient by @Wauplin in #2384
  • Promote chat_completion in inference guide by @Wauplin in #2366

(other) InferenceClient improvements

Some new parameters have been added to the InferenceClient, following the latest changes in our Inference API:

  • prompt_name, truncate and normalize in feature_extraction
  • model_id and response_format, in chat_completion
  • adapter_id in text_generation
  • hypothesis_template and multi_labels in zero_shot_classification

Of course, all of those changes are also available in the AsyncInferenceClient async equivalent 🤗

  • Support truncate and normalize in InferenceClient by @Wauplin in #2270
  • Add prompt_name to feature-extraction + update types by @Wauplin in #2363
  • Send model_id in ChatCompletion request by @Wauplin in #2302
  • improve client.zero_shot_classification() by @MoritzLaurer in #2340
  • [InferenceClient] Add support for adapter_id (text-generation) and response_format (chat-completion) by @Wauplin in #2383

Added helpers for TGI servers:

  • get_endpoint_info to get information about an endpoint (running model, framework, etc.). Only available on TGI/TEI-powered models.
  • health_check to check health status of the server. Only available on TGI/TEI-powered models and only for InferenceEndpoint or local deployment. For serverless InferenceAPI, it's better to use get_model_status.

Other fixes:

  • image_to_text output type has been fixed
  • use wait-for-model to avoid been rate limited while model is not loaded
  • add proxies support
  • Fix InferenceClient.image_to_text output value by @Wauplin in #2285
  • Fix always None in text_generation output by @Wauplin in #2316
  • Add wait-for-model header when sending request to Inference API by @Wauplin in #2318
  • Add proxy support on async client by @noech373 in #2350
  • Remove jinja tips + fix typo in chat completion docstring by @Wauplin in #2368

💾 Serialization

The serialization module introduced in v0.22.x has been improved to become the preferred way to serialize a torch model to disk. It handles how of the box sharding and safe serialization (using safetensors) with subtleties to work with shared layers. This logic was previously scattered in libraries like transformers, diffusers, accelerate and safetensors. The goal of centralizing it in huggingface_hub is to allow any external library to safely benefit from the same naming convention, making it easier to manage for end users.

>>> from huggingface_hub import save_torch_model
>>> model = ... # A PyTorch model

# Save state dict to "path/to/folder". The model will be split into shards of 5GB each and saved as safetensors.
>>> save_torch_model(model, "path/to/folder")

# Or save the state dict manually
>>> from huggingface_hub import save_torch_state_dict
>>> save_torch_state_dict(model.state_dict(), "path/to/folder") 

More details in the serialization package reference.

  • Serialization: support saving torch state dict to disk by @Wauplin in #2314
  • Handle shared layers in save_torch_state_dict + add save_torch_model by @Wauplin in #2373

Some helpers related to serialization have been made public for reuse in external libraries:

  • get_torch_storage_id
  • get_torch_storage_size
  • Support max_shard_size as string in split_state_dict_into_shards_factory by @SunMarc in #2286
  • Make get_torch_storage_id public by @Wauplin in #2304

📁 HfFileSystem

The HfFileSystem has been improved to optimize calls, especially when listing files from a repo. This is especially useful for large datasets like HuggingFaceFW/fineweb for faster processing and reducing risk of being rate limited.

  • [HfFileSystem] Less /paths-info calls by @lhoestq in #2271
  • Update token type definition and arg description in hf_file_system.py by @lappemic in #2278
  • [HfFileSystem] Faster fs.walk() by @lhoestq in #2346

Thanks to @lappemic, HfFileSystem methods are now properly documented. Check it out here!

✨ HfApi & CLI improvements

Commit API

A new mechanism has been introduced to prevent empty commits if no changes have been detected. Enabled by default in upload_file, upload_folder, create_commit and the huggingface-cli upload command. There is no way to force an empty commit.

  • Prevent empty commits if files did not change by @Wauplin in #2389

Resource groups

Resource Groups allow organizations administrators to group related repositories together, and manage access to those repos. It is now possible to specify a resource group ID when creating a repo:

from huggingface_hub import create_repo

create_repo("my-secret-repo", private=True, resource_group_id="66670e5163145ca562cb1988")

Webhooks API

Webhooks allow you to listen for new changes on specific repos or to all repos belonging to particular set of users/organizations (not just your repos, but any repo). With the Webhooks API you can create, enable, disable, delete, update, and list webhooks from a script!

from huggingface_hub import create_webhook

# Example: Creating a webhook
webhook = create_webhook(
    url="https://webhook.site/your-custom-url",
    watched=[{"type": "user", "name": "your-username"}, {"type": "org", "name": "your-org-name"}],
    domains=["repo", "discussion"],
    secret="your-secret"
)

Search API

The search API has been slightly improved. It is now possible to:

  • filter datasets by tags
  • filter which attributes should be returned in model_info/list_models (and similarly for datasets/Spaces). For example, you can ask the server to return downloadsAllTime for all models.
>>> from huggingface_hub import list_models

>>> for model in list_models(library="transformers", expand="downloadsAllTime", sort="downloads", limit=5):
...     print(model.id, model.downloads_all_time)
MIT/ast-finetuned-audioset-10-10-0.4593 1676502301
sentence-transformers/all-MiniLM-L12-v2 115588145
sentence-transformers/all-MiniLM-L6-v2 250790748
google-bert/bert-base-uncased 1476913254
openai/clip-vit-large-patch14 590557280
  • Support filtering datasets by tags by @Wauplin in #2266
  • Support expand parameter in xxx_info and list_xxxs (model/dataset/Space) by @Wauplin in #2333
  • Add InferenceStatus to ExpandModelProperty_T by @Wauplin in #2388
  • Do not mention gitalyUid in expand parameter by @Wauplin in #2395

CLI

It is now possible to delete files from a repo using the command line:

Delete a folder:

>>> huggingface-cli repo-files Wauplin/my-cool-model delete folder/  
Files correctly deleted from repo. Commit: https://huggingface.co/Wauplin/my-cool-mo...

Use Unix-style wildcards to delete sets of files:

>>> huggingface-cli repo-files Wauplin/my-cool-model delete *.txt folder/*.bin 
Files correctly deleted from repo. Commit: https://huggingface.co/Wauplin/my-cool-mo...

ModelHubMixin

The ModelHubMixin, allowing for quick integration of external libraries with the Hub have been updated to fix some existing bugs and ease its use. Learn how to integrate your library from this guide.

  • Don't override 'config' in model_kwargs by @alexander-soare in #2274
  • Support custom kwargs for model card in save_pretrained by @qubvel in #2310
  • ModelHubMixin: Fix attributes lost in inheritance by @Wauplin in #2305
  • Fix ModelHubMixin coders by @gorold in #2291
  • Hot-fix: do not share tags between ModelHubMixin siblings by @Wauplin in #2394
  • Fix: correctly encode/decode config in ModelHubMixin if custom coders by @Wauplin in #2337

🌐 📚 Documentation

Efforts from the Korean-speaking community continued to translate guides and package references to KO! Check out the result here.

  • 🌐 [i18n-KO] Trans...
Read more

[v0.23.5] Hot-fix: do not share tags between ModelHubMixin siblings

16 Jul 12:13
ac90bd4
Compare
Choose a tag to compare

[v0.23.4] Patch: fix encoders issues in ModelHubMixin

14 Jun 14:19
4c7aa33
Compare
Choose a tag to compare

Includes:

  • 🌐 [i18n-KO] Translated guides/integrations.md to Korean #2256 #2256
  • Don't override 'config' in model_kwargs #2274
  • Fix ModelHubMixin coders #2291
  • ModelHubMixin: Fix attributes lost in inheritance #2305
  • Support custom kwargs for model card in save_pretrained #2310

Full Changelog: v0.23.3...v0.23.4

[v0.23.3] Patch: fix details not returned in `InferenceClient.text_generation`

05 Jun 12:48
83efe51
Compare
Choose a tag to compare

Release 0.23.0 introduced a breaking change in InferenceClient.text_generation. When details=True is passed, the details attribute in the output is always None. The patch release fixes this. See #2316 for more details.

Full Changelog: v0.23.2...v0.23.3