Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document HF_TRANSFER #1330

Merged
merged 3 commits into from
Jul 9, 2024
Merged

Document HF_TRANSFER #1330

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1bcae5
Document HF_TRANSFER
muellerzr Jul 9, 2024
563a584
Update docs/hub/models-downloading.md
muellerzr Jul 9, 2024
76f603d
Update docs/hub/models-downloading.md
muellerzr Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/hub/models-downloading.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,25 @@ git clone [email protected]:<MODEL ID> # example: git clone [email protected]:bigscience/bloom
If you have write-access to the particular model repo, you'll also have the ability to commit and push revisions to the model.

Add your SSH public key to [your user settings](https://huggingface.co/settings/keys) to push changes and/or access private repos.

## Faster downloads

If you are running on a machine with high bandwidth,
you can increase your download speed with [`hf_transfer`](https://github.com/huggingface/hf_transfer),
a Rust-based library developed to speed up file transfers with the Hub.

```bash
pip install huggingface_hub[hf_transfer]
HF_HUB_ENABLE_HF_TRANSFER=1 huggingface-cli download ...
```

<Tip warning={true}>

`hf_transfer` is a power user tool!
It is tested and production-ready,
but it lacks user-friendly features like advanced error handling or proxies.
For more details, please take a look at this [guide](https://huggingface.co/docs/huggingface_hub/hf_transfer).

</Tip>


Loading