HuggingFaceDownloader
Python template · sinapsis_huggingface_hub.templates.huggingface_downloader
Overview
A Sinapsis Template that downloads a repository snapshot from the Hugging Face Hub.
Capabilities
Capabilities: not setInstallation
Install the published package using pip or uv.
pip install sinapsis-huggingface-hub==1.0.0uv pip install sinapsis-huggingface-hub==1.0.0uv add sinapsis-huggingface-hub==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
A dictionary of proxy servers to use for the download.
Optional
Default: null
The repository ID from the Hub (e.g., "stabilityai/stable-diffusion-2-1").
Required
Default: null
Optional
Default: null
The specific model version to use (e.g., a branch name, tag, or commit hash).
Optional
Default: null
The directory where downloaded files will be cached.
Optional
Default: "/home/ariel/.cache/sinapsis"
The type of the repository.
Optional
Default: "model"
The maximum number of threads to use for parallel downloads.
Optional
Default: 8
The timeout in seconds for checking the ETag of the files.
Optional
Default: 10
A pattern or list of patterns to specify which files to download.
Optional
Default: null
If True, forces the repository to be re-downloaded even if it's already cached.
Optional
Default: false
A pattern or list of patterns to specify which files to ignore.
Optional
Default: null
If True, resumes an interrupted download.
Optional
Default: false
If True, the function will only look for the files in the cache and will not access the network.
Optional
Default: false
Configuration example
Generated from documented defaults. Replace any placeholders and complete required nested settings before running.
templates:
- template_name: "HuggingFaceDownloader"
class_name: "HuggingFaceDownloader"
attributes:
proxies: {}
repo_id: "<required>"
revision: null
cache_dir: "/home/ariel/.cache/sinapsis"
repo_type: "model"
max_workers: 8
etag_timeout: 10
allow_patterns: null
force_download: false
ignore_patterns: null
resume_download: false
local_files_only: false
Inheritance
sinapsis_core.template_base.template.TemplateEnvironment variables
Environment definitions belong to their canonical Python modules.