Skip to content

docs(hf): document bucket support and update service table#7387

Open
kszucs wants to merge 1 commit intoapache:mainfrom
kszucs:hf-docs
Open

docs(hf): document bucket support and update service table#7387
kszucs wants to merge 1 commit intoapache:mainfrom
kszucs:hf-docs

Conversation

@kszucs
Copy link
Copy Markdown
Member

@kszucs kszucs commented Apr 14, 2026

Which issue does this PR close?

Closes #.

Rationale for this change

The HuggingFace service now supports two distinct storage backends — git-based repositories (model, dataset, space) and object store buckets — but the documentation only described the git-based backend.

What changes are included in this PR?

  • Add a Storage Backends section to docs.md explaining the difference between git-based repos and object store buckets, with links to the Xet documentation
  • Update the Capabilities list to match the actual implementation: add copy, rename, presign as unchecked, remove entries that were never part of the capability set
  • Update Configurations to include bucket as a valid repo_type, clarify that revision is git-only, and document the HF_ENDPOINT environment variable
  • Add example code for bucket access via builder and URI
  • Add huggingface to the Object Storage Services row in core/README.md (it was only listed under Git Based Storage Services)

Are there any user-facing changes?

Yes — the docs now accurately reflect that repo_type = "bucket" is supported for object store access, and document the HF_ENDPOINT env var that was previously undocumented.

AI Usage Statement

This PR was written with the assistance of Claude Code (claude-sonnet-4-6).

@kszucs kszucs requested a review from Xuanwo as a code owner April 14, 2026 15:48
@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. releases-note/docs The PR modifies docs related content or has a title that begins with "docs" labels Apr 14, 2026
- Add Storage Backends section describing git repos vs object store buckets
- Update capabilities list to match implementation (add copy/rename/presign,
  remove unimplemented entries)
- Add bucket repo_type and HF_ENDPOINT env var to Configurations
- Add bucket builder and URI examples
- Link to Xet documentation
- Add huggingface to Object Storage Services in README (alongside existing
  Git Based Storage Services entry)
@kszucs
Copy link
Copy Markdown
Member Author

kszucs commented Apr 14, 2026

cc @lhoestq

Copy link
Copy Markdown
Member

@Xuanwo Xuanwo left a comment

Choose a reason for hiding this comment

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

Nice!

@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Apr 14, 2026
}
```

### Via URI
Copy link
Copy Markdown

@su77ungr su77ungr Apr 15, 2026

Choose a reason for hiding this comment

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

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

Labels

lgtm This PR has been approved by a maintainer releases-note/docs The PR modifies docs related content or has a title that begins with "docs" size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants