Skip to content

Commit fac8997

Browse files
Pierrciclaude
andcommitted
docs: document new buckets model card metadata field
Adds documentation for the new `buckets` metadata field that links models to storage buckets (moon-landing#17491). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent c2bb932 commit fac8997

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

docs/hub/model-cards.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ license: "any valid license identifier"
7272
datasets:
7373
- dataset1
7474
- dataset2
75+
buckets:
76+
- bucket1
77+
- bucket2
7578
base_model: "base model Hub identifier"
7679
---
7780
```
@@ -182,6 +185,16 @@ datasets:
182185
- HuggingFaceFW/fineweb
183186
```
184187

188+
### Specifying a bucket
189+
190+
You can specify the [storage buckets](./storage-buckets) linked to your model in the model card metadata section. The buckets will be shown as tags on the model page and the linked bucket pages will show the model in return. You should use the Hub bucket identifier, which is the same as the bucket's repo name:
191+
192+
```yaml
193+
buckets:
194+
- my-org/my-bucket
195+
- my-org/another-bucket
196+
```
197+
185198
### Specifying a task (`pipeline_tag`)
186199

187200
You can specify the `pipeline_tag` in the model card metadata. The `pipeline_tag` indicates the type of task the model is intended for. This tag will be displayed on the model page and users can filter models on the Hub by task. This tag is also used to determine which [widget](./models-widgets#enabling-a-widget) to use for the model and which APIs to use under the hood.

docs/hub/storage-buckets.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,6 +314,18 @@ Buckets are well-suited for maintaining rolling backups. With a Git-based [Datas
314314
hf sync ./daily-backup hf://buckets/my-user/backups/latest --delete
315315
```
316316

317+
### Linking models to buckets
318+
319+
You can create a two-way link between a model and a bucket by adding the `buckets` field to the model card metadata. The linked models will then appear on the bucket page, and the bucket will appear as a tag on the model page.
320+
321+
```yaml
322+
# In the model card YAML frontmatter
323+
buckets:
324+
- my-org/my-bucket
325+
```
326+
327+
See [Specifying a bucket](./model-cards#specifying-a-bucket) in the model cards documentation for more details.
328+
317329
## Pricing
318330
319331
Storage Buckets are billed based on the amount of data stored, with simple per-TB pricing. Enterprise plans benefit from dedup-based billing, where shared chunks across files directly reduce the billed footprint.

0 commit comments

Comments
 (0)