Spaces:

Wauplin

/

huggingface_hub

like 15

Runtime error

🔐 Authentication

Authentication has been greatly improved in Google Colab. The best way to authenticate in a Colab notebook is to define a HF_TOKEN secret in your personal secrets. When a notebook tries to reach the Hub, a pop-up will ask you if you want to share the HF_TOKEN secret with this notebook -as an opt-in mechanism. This way, no need to call huggingface_hub.login and copy-paste your token anymore! 🔥🔥🔥

In addition to the Google Colab integration, the login guide has been revisited to focus on security. It is recommended to authenticate either using huggingface_hub.login or the HF_TOKEN environment variable, rather than passing a hardcoded token in your scripts. Check out the new guide here.

• Login/authentication enhancements by @Wauplin in #1895
• Catch SecretNotFoundError in google colab login by @Wauplin in #1912

🏎️ Faster HfFileSystem

HfFileSystem is a pythonic fsspec-compatible file interface to the Hugging Face Hub. Implementation has been greatly improved to optimize fs.find performances.

Here is a quick benchmark with the bigcode/the-stack-dedup dataset:

• Faster HfFileSystem.find by @mariosasko in #1809
• Faster HfFileSystem.glob by @lhoestq in #1815
• Fix common path in _ ls_tree by @lhoestq in #1850
• Remove maxdepth param from HfFileSystem.glob by @mariosasko in #1875
• [HfFileSystem] Support quoted revisions in path by @lhoestq in #1888
• Deprecate HfApi.list_files_info by @mariosasko in #1910

🚪 Access requests API (gated repos)

Models and datasets can be gated to monitor who's accessing the data you are sharing. You can also filter access with a manual approval of the requests. Access requests can now be managed programmatically using HfApi. This can be useful for example if you have advanced user request screening requirements (for advanced compliance requirements, etc) or if you want to condition access to a model based on completing a payment flow.

Check out this guide to learn more about gated repos.

>>> from huggingface_hub import list_pending_access_requests, accept_access_request

# List pending requests
>>> requests = list_pending_access_requests("meta-llama/Llama-2-7b")
>>> requests[0]
[
    AccessRequest(
        username='clem',
        fullname='Clem 🤗',
        email='***',
        timestamp=datetime.datetime(2023, 11, 23, 18, 4, 53, 828000, tzinfo=datetime.timezone.utc),
        status='pending',
        fields=None,
    ),
    ...
]

# Accept Clem's request
>>> accept_access_request("meta-llama/Llama-2-7b", "clem")

• Manage access requests programmatically by @Wauplin in #1905

🔍 Parse Safetensors metadata

Safetensors is a simple, fast and secured format to save tensors in a file. Its advantages makes it the preferred format to host weights on the Hub. Thanks to its specification, it is possible to parse the file metadata on-the-fly. HfApi now provides get_safetensors_metadata, an helper to get safetensors metadata from a repo.

# Parse repo with single weights file
>>> metadata = get_safetensors_metadata("bigscience/bloomz-560m")
>>> metadata
SafetensorsRepoMetadata(
    metadata=None,
    sharded=False,
    weight_map={'h.0.input_layernorm.bias': 'model.safetensors', ...},
    files_metadata={'model.safetensors': SafetensorsFileMetadata(...)}
)
>>> metadata.files_metadata["model.safetensors"].metadata
{'format': 'pt'}

• Parse safetensors metadata by @Wauplin in #1855

Other improvements

List and filter collections

You can now list collections on the Hub. You can filter them to return only collection containing a given item, or created by a given author.

>>> collections = list_collections(item="models/TheBloke/OpenHermes-2.5-Mistral-7B-GGUF", sort="trending", limit=5):
>>> for collection in collections:
...   print(collection.slug)
teknium/quantized-models-6544690bb978e0b0f7328748
AmeerH/function-calling-65560a2565d7a6ef568527af
PostArchitekt/7bz-65479bb8c194936469697d8c
gnomealone/need-to-test-652007226c6ce4cdacf9c233
Crataco/favorite-7b-models-651944072b4fffcb41f8b568

• add list_collections endpoint, solves #1835 by @ceferisbarov in #1856
• fix list collections sort values by @Wauplin in #1867
• Warn about truncation when listing collections by @Wauplin in #1873

Respect .gitignore

upload_folder now respect gitignore files!

Previously it was possible to filter which files should be uploaded from a folder using the allow_patterns and ignore_patterns parameters. This can now automatically be done by simply creating a .gitignore file in your repo.

• Respect .gitignore file in commits by @Wauplin in #1868
• Remove respect_gitignore parameter by @Wauplin in #1876

Robust uploads

Uploading LFS files has also gotten more robust with a retry mechanism if a transient error happen while uploading to S3.

• More robust uploads by @Wauplin in #1827

Target language in InferenceClient.translation

InferenceClient.translation now supports src_lang/tgt_lang for applicable models.

>>> from huggingface_hub import InferenceClient
>>> client = InferenceClient()
>>> client.translation("My name is Sarah Jessica Parker but you can call me Jessica", model="facebook/mbart-large-50-many-to-many-mmt", src_lang="en_XX", tgt_lang="fr_XX")
"Mon nom est Sarah Jessica Parker mais vous pouvez m'appeler Jessica"
>>> client.translation("My name is Sarah Jessica Parker but you can call me Jessica", model="facebook/mbart-large-50-many-to-many-mmt", src_lang="en_XX", tgt_lang="es_XX")
'Mi nombre es Sarah Jessica Parker pero puedes llamarme Jessica'

• add language support to translation client, solves #1763 by @ceferisbarov in #1869

Support source in reported EvalResult

EvalResult now support source_name and source_link to provide a custom source for a reported result.

• Support source in EvalResult for model cards by @Wauplin in #1874

🛠️ Misc

Fetch all pull requests refs with list_repo_refs.

• Add include_pull_requests to list_repo_refs by @Wauplin in #1822

Filter discussion when listing them with get_repo_discussions.

# List opened PR from "sanchit-gandhi" on model repo "openai/whisper-large-v3"
>>> from huggingface_hub import get_repo_discussions
>>> discussions = get_repo_discussions(
...     repo_id="openai/whisper-large-v3",
...     author="sanchit-gandhi",
...     discussion_type="pull_request",
...     discussion_status="open",
... )

• ✨ Add filters to HfApi.get_repo_discussions by @SBrandeis in #1845

New field createdAt for ModelInfo, DatasetInfo and SpaceInfo.

• Add support for createdAt field by @Wauplin in #1816

It's now possible to create an inference endpoint running on a custom docker image (typically: a TGI container).

# Start an Inference Endpoint running Zephyr-7b-beta on TGI
>>> from huggingface_hub import create_inference_endpoint
>>> endpoint = create_inference_endpoint(
...     "aws-zephyr-7b-beta-0486",
...     repository="HuggingFaceH4/zephyr-7b-beta",
...     framework="pytorch",
...     task="text-generation",
...     accelerator="gpu",
...     vendor="aws",
...     region="us-east-1",
...     type="protected",
...     instance_size="medium",
...     instance_type="g5.2xlarge",
...     custom_image={
...         "health_route": "/health",
...         "env": {
...             "MAX_BATCH_PREFILL_TOKENS": "2048",
...             "MAX_INPUT_LENGTH": "1024",
...             "MAX_TOTAL_TOKENS": "1512",
...             "MODEL_ID": "/repository"
...         },
...         "url": "ghcr.io/huggingface/text-generation-inference:1.1.0",
...     },
... )

• Allow create inference endpoint from docker image by @Wauplin in #1861

Upload CLI: create branch when revision does not exist

• Create branch if missing in hugginface-cli upload by @Wauplin in #1857

🖥️ Environment variables

huggingface_hub.constants.HF_HOME has been made a public constant (see reference).

• Expose HF_HOME in constants by @Wauplin in #1825

Offline mode has gotten more consistent. If HF_HUB_OFFLINE is set, any http call to the Hub will fail. The fallback mechanism is snapshot_download has been refactored to be aligned with the hf_hub_download workflow. If offline mode is activated (or a connection error happens) and the files are already in the cache, snapshot_download returns the corresponding snapshot directory.

• Respect HF_HUB_OFFLINE for every http call by @Wauplin in #1899
• Improve snapshot_download offline mode by @Wauplin in #1913

DO_NOT_TRACK environment variable is now respected to deactivate telemetry calls. This is similar to HF_HUB_DISABLE_TELEMETRY but not specific to Hugging Face.

• Support DO_NOT_TRACK env variable by @Wauplin in #1920

📚 Documentation

• Document more list repos behavior by @Wauplin in #1823
• [i18n-KO] 🌐 Translated git_vs_http.md to Korean by @heuristicwave in #1862

Doc fixes

• Fixing gated attribute type in docs by @ademait in #1848
• Update modelcard_template.md by @EziOzoani in #1859
• fix typo by @pkking in #1864
• Update references to hub-docs by @mishig25 in #1866
• Docs: _from_pretrained -> push_to_hub by @tomaarsen in #1871
• type of conflicting_files of DiscussionWDetails by @ademait in #1847

💔 Breaking change

timeout parameter has been removed from list_repo_files, as part of a planned deprecation cycle.

• Prepare for v0.20.0 by @Wauplin in #1807

Otherwise, breaking changes should not be expected in this release. We can mention the fact that upload_file and upload_folder are now returning a CommitInfo dataclass instead of a str. Those two methods were previously returning the url of the uploaded file or folder on the Hub as a string. However, some information is lost compared to CommitInfo: commit id, commit title, description, author, etc. In order to make it backward compatible, the return type CommitInfo inherit from both dataclass and str. The plan is to switch to dataclass-only in release v1.0 (not planned yet).

• Harmonize commit return type by @Wauplin in #1921

Finally, HfFolder is now deprecated in favor of get_token, login and logout. The goal is to force users and integrations to use login/logout (instead of HfFolder.save_token/HfFolder.delete_token) which contain more checks and warning messages. The plan is to get rid of HfFolder in release v1.0 (not planned yet).

• Login/authentication enhancements by @Wauplin in #1895

Small fixes and maintenance

⚙️ fixes

• [FIX] Catch TypeError when parsing card data from ModelInfo by @Wauplin in #1821
• Limit to pydantic<2.x on python3.8 by @Wauplin in #1828
• Send user_agent in HEAD calls by @Wauplin in #1854
• Fix pydantic deprecation warning by @Wauplin in #1837
• Call are_symlink_supported on commonpath by @Wauplin in #1852
• Fix IndexError when empty string for credential.helper by @SID262000 in #1860
• fix credentials by @Wauplin (direct commit on main)
• Fix git credential parsing regex by @Wauplin in #1870
• Fix Repository is not a class by @Wauplin in #1879
• Fix WebhookPayload schema + add WebhooksServer.launch by @Wauplin in #1884
• Fix PermissionError between volumes by @Wauplin in #1886
• Fix error handling on HTTP 401 by @Wauplin in #1904
• Send bearer auth in LFS upload by @Wauplin in #1906
• Fix to_local_dir on hf_hub_download edge case by @Wauplin in #1919

⚙️ internal

• Prepare for v0.20.0 by @Wauplin in #1807
• (nit) fix fsspec default mode by @Wauplin (direct commit on main)
• Use ruff formatter in check_static_imports.py by @Wauplin in #1824
• ruff formatte by @Wauplin (direct commit on main)
• Check pydantic correct installation by @Wauplin in #1829
• FIX ?? send ref in LFS endpoint by @Wauplin in #1838
• Install doc-builder from source by @Wauplin in #1849
• robustness by @Wauplin (direct commit on main)
• style by @Wauplin (direct commit on main)
• fix list_space_author test by @Wauplin (direct commit on main)
• finally fix robustness? by @Wauplin (direct commit on main)
• 4 parallel tests in repo CI instead of 8 to improve stability by @Wauplin (direct commit on main)
• Remove delete_doc_comment.yaml and delete_doc_comment_trigger.yaml from CI by @Wauplin in #1887
• skip flaky test by @Wauplin (direct commit on main)
• Rerun flaky tests in CI by @Wauplin in #1914
• Sentence Transformers test (soon) no longer expected to fail by @tomaarsen in #1918
• flakyness by @Wauplin (direct commit on main)

Significant community contributions

The following contributors have made significant changes to the library over the last release:

• @ademait
  • Fixing gated attribute type in docs (#1848)
  • type of conflicting_files of DiscussionWDetails (#1847)
• @ceferisbarov
  • add list_collections endpoint, solves #1835 (#1856)
  • add language support to translation client, solves #1763 (#1869)
• @SID262000
  • Fix IndexError when empty string for credential.helper (#1860)
• @heuristicwave
  • 🌐 [i18n-KO] Translated git_vs_http.md to Korean (#1862)