HF-Mirror is a mirror portal for Hugging Face, positioned as a public-benefit project, with the main goal of providing stable and fast mirror services to help domestic users access Hugging Face resources without barriers.
[Purpose] Accelerate access to Hugging Face and solve network problems that may be encountered when accessing Hugging Face resources domestically.
[Main Capabilities]
- Provide a mirror access entry point for Hugging Face resources.
- Support searching on this site and downloading files from Files and Version on the model homepage.
- Support downloading through the huggingface-cli command-line tool, which comes with complete download functionality.
- Provide hfd, a dedicated Hugging Face download tool developed by this site, based on aria2, which can download stably and at high speed without disconnecting.
- Support a non-intrusive method by setting the HF_ENDPOINT environment variable to solve download problems in most cases. The huggingface toolchain will obtain the HF_ENDPOINT environment variable to determine the URL used to download files. For example: HF_ENDPOINT=https://hf-mirror.com python your_script.py.
- For download scripts built into some datasets, the address in the script needs to be manually modified.
[Usage Methods]
- Web download: Search on this site and download files from Files and Version on the model homepage.
- Command-line download: Use huggingface-cli.
- Dedicated tool download: Use hfd developed by this site, based on aria2.
- Environment variable method: Set HF_ENDPOINT=https://hf-mirror.com and then run the script.
[Applicable Scenarios] Suitable for domestic users who need to obtain models or datasets from Hugging Face but are limited by network conditions.
[Limitations]
- Some Gated Repos require login and application for permission. To ensure account security, this site does not support login. You need to first go to the Hugging Face official website to log in and apply for permission, obtain an Access Token on the official website, then return to the mirror site to download via the command line.
- Some datasets have built-in download scripts, and the address in the script needs to be manually changed.
- Other functions, charges, prices, platforms, or effects not explained in the materials are not provided for now.
