Skip to content

docs: add "Access Buckets from Code" page#2363

Open
davanstrien wants to merge 3 commits intomainfrom
docs/buckets-access-patterns
Open

docs: add "Access Buckets from Code" page#2363
davanstrien wants to merge 3 commits intomainfrom
docs/buckets-access-patterns

Conversation

@davanstrien
Copy link
Copy Markdown
Member

@davanstrien davanstrien commented Apr 7, 2026

Summary

New subpage under Storage Buckets covering the main access patterns for using bucket data from code:

  • hf-mount: mount buckets as local filesystem (NFS/FUSE)
  • HfFileSystem (fsspec): hf://buckets/ paths with pandas, DuckDB Python client
  • Volume mounts: cross-link to Jobs/Spaces volume docs
  • CLI sync: cross-link to existing sync docs

Also adds a tip callout on the main storage-buckets.md page linking to the new page.

Notes

The page is intentionally high-level for now — buckets is evolving fast, so it links out
to detailed docs (hf-mount repo, huggingface_hub guides) rather than duplicating content.
Happy to flesh out with more detailed examples and additional tool integrations in future PRs.

Related: #2362 (adds bucket tip boxes to pandas/DuckDB pages)

Test plan

  • Page renders in sidebar under Storage Buckets → Access from Code
  • Cross-links resolve (storage-buckets, jobs-configuration, HfFileSystem guide, buckets guide)
  • pandas and DuckDB Python examples verified working against a real bucket

Note

Low Risk
Low risk documentation-only change that adds a new page and sidebar entry plus a cross-link; no runtime or API behavior is affected.

Overview
Adds a new Storage Buckets → Access Patterns doc page describing common ways to use bucket data from existing workflows (mount via hf-mount, Python hf://buckets/ access with HfFileSystem/fsspec, Jobs/Spaces volume mounts, and CLI sync).

Updates the Hub docs sidebar (_toctree.yml) to include the new page and adds a tip callout on storage-buckets.md linking readers to it.

Reviewed by Cursor Bugbot for commit f63cfcf. Bugbot is set up for automated code reviews on this repo. Configure here.

New subpage under Storage Buckets covering access patterns: hf-mount
(filesystem), HfFileSystem/fsspec (pandas, DuckDB), volume mounts in
Jobs/Spaces, and CLI sync. Keeps content high-level with cross-links
to detailed docs.
@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

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.

|--------|----------|---------|
| **hf-mount** | Mount as local filesystem — any tool works | [See below](#mount-as-a-local-filesystem) |
| **hf:// paths** (fsspec) | Python data tools (pandas, DuckDB) | [See below](#python-data-tools) |
| **Volume mounts** | HF Jobs & Spaces | [See below](#volume-mounts-in-jobs-and-spaces) |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i would move those one level closer to hf-mount given they're really the same thing

Install:

```bash
curl -fsSL https://raw.githubusercontent.com/huggingface/hf-mount/main/install.sh | sh
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

really need to submit it to brew

Copy link
Copy Markdown
Member

@julien-c julien-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wait for other reviewers, but nice 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants