docs: add hf-mount as an access method to download docs#2406
Merged
davanstrien merged 2 commits intomainfrom Apr 27, 2026
Merged
docs: add hf-mount as an access method to download docs#2406davanstrien merged 2 commits intomainfrom
davanstrien merged 2 commits intomainfrom
Conversation
Adds a "Using hf-mount" section to datasets-downloading.md and models-downloading.md, describing mounting a repo as a local filesystem as an alternative to downloading. Examples verified locally with hf-mount v0.3.1. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
pcuenca
reviewed
Apr 17, 2026
Address @pcuenca's comment on #2406: first mention of hf-mount now links to the GitHub repo (product home), and the "see also" link at the bottom points to the internal setup section in storage-buckets-access.md. Same change applied symmetrically to both files. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
julien-c
reviewed
Apr 21, 2026
| For large models, you can mount a repo as a local filesystem with [hf-mount](https://github.com/huggingface/hf-mount) instead of downloading the full repo. Files are fetched lazily — only the bytes your code reads hit the network. | ||
|
|
||
| ```bash | ||
| curl -fsSL https://raw.githubusercontent.com/huggingface/hf-mount/main/install.sh | sh |
Member
There was a problem hiding this comment.
remember to mention brew after it's in brew
2 tasks
davanstrien
added a commit
that referenced
this pull request
Apr 28, 2026
* docs: promote brew install for hf-mount hf-mount is now in homebrew-core (brew install hf-mount). Lead with brew across the three install snippets and keep the install.sh one-liner as an alternative on the main hf-mount section in storage-buckets-access.md. Follow-up to #2406 (julien-c review note). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: keep install.sh as alt in compact hf-mount snippets Users on Linux/servers without Homebrew can still use the install.sh one-liner. Added as an inline `# or:` comment in the two compact examples. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: split hf-mount install/mount into separate blocks Match house style (xet, hf CLI, llama.cpp): brew block, "Or using an installation script:" prose, curl block, then the mount command. Cleaner for human readers and more reliably parseable for agents extracting install commands from code blocks. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs: drop install.sh refs for hf-mount (per XciD review) The hf-mount install.sh script no longer exists (404). Brew is the only install path now — drop curl alternative across all three pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
## Using hf-mountsection todocs/hub/datasets-downloading.mdanddocs/hub/models-downloading.mdstorage-buckets-access.md); these cross-refs promote it as a peer access method alongsidehf download, the client library, and git clonePlacement
models-downloading.md, placed after## Faster downloadsso Xet-based downloads (the recommended default) stay more prominentdatasets-downloading.md, at the end (page has no Faster downloads section)Verified locally
Tested both examples with hf-mount v0.3.1 (NFS backend):
The
datasets/prefix on dataset repo IDs is the canonical form perhf-mount-nfs repo --help.🤖 Generated with Claude Code
Note
Low Risk
Low risk doc-only change that adds a new recommended access option; main risk is user confusion if
hf-mountbehavior/commands change or platform support differs.Overview
Adds a new "Using hf-mount" section to the model and dataset download guides, presenting
hf-mountas an alternative to fully downloading repos by mounting them as a local, read-only filesystem with lazy fetching.Includes install + example
hf-mount start repo ...commands for a model and a dataset, and links back tostorage-buckets-accessfor full setup, backend options, and caching details.Reviewed by Cursor Bugbot for commit a1adf93. Bugbot is set up for automated code reviews on this repo. Configure here.