← Back to API reference

neuralfetch.download.Huggingface

pydantic model neuralfetch.download.Huggingface[source][source]

Download a dataset repository from Hugging Face Hub.

Uses huggingface_hub.snapshot_download() for a full repository snapshot. Set the HUGGING_FACE_HUB_TOKEN environment variable for private or gated repositories.

Parameters:

  • study (str) – Dataset repository name (e.g. "allen-bold"). The full repo ID used will be org/study.

  • org (str) – Hugging Face organisation or user that owns the dataset (e.g. "BrainAI" or "openai"). Combined with study to form repo_id.

  • include (list of str) – Dataset-relative globs, forwarded natively to snapshot_download as allow_patterns/ignore_patterns. See BaseDownload.

  • exclude (list of str) – Dataset-relative globs, forwarded natively to snapshot_download as allow_patterns/ignore_patterns. See BaseDownload.

Fields:
requirements: ClassVar[tuple[str, ...]] = ('huggingface_hub',)[source]
field org: str [Required][source]

← Back to API reference