From 23c8c24ed2f46e0114f786297caba746cfc72c36 Mon Sep 17 00:00:00 2001 From: jeqcho Date: Tue, 7 Jul 2026 20:51:26 -0700 Subject: [PATCH] docs: interlink WorldPolicies (catalog registration is now a publish requirement) Co-Authored-By: Claude Fable 5 --- README.md | 4 ++++ docs/model-card-template.md | 1 + docs/model-cards.md | 11 ++++++++++- 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f21f009..2167f51 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,10 @@ checkpoint behind it is documented. Every model checkpoint published to the **[model-card standard](docs/model-cards.md)** (start from the [template](docs/model-card-template.md); the standard includes a gating checklist). +Published checkpoints are catalogued in **[WorldPolicies](https://github.com/robocurve/worldpolicies)** +(CI-validated registry + [🤗 Collection](https://huggingface.co/collections/robocurve/worldpolicies-6a4dc8fd556a82aeea0fca37)) — +WorldEvals benchmarks them; WorldPolicies is where they live. + ## Development > **Dependency changes:** after editing dependencies in `pyproject.toml`, run diff --git a/docs/model-card-template.md b/docs/model-card-template.md index 4b87bf6..5fc4a5e 100644 --- a/docs/model-card-template.md +++ b/docs/model-card-template.md @@ -35,6 +35,7 @@ inference: false [![Evaluate with Inspect Robots](https://img.shields.io/badge/evaluate%20with-Inspect%20Robots-indigo)](https://github.com/robocurve/inspect-robots) [![Adapters: ](https://img.shields.io/badge/adapters-inspect--robots---blue)](https://github.com/robocurve/inspect-robots-) [![Benchmarks: WorldEvals](https://img.shields.io/badge/benchmarks-WorldEvals-2ea44f)](https://worldevals.org) +[![Catalog: WorldPolicies](https://img.shields.io/badge/catalog-WorldPolicies-yellow)](https://huggingface.co/collections/robocurve/worldpolicies-6a4dc8fd556a82aeea0fca37) <≤3 sentences: [base model](link) + method (LoRA/full FT; what's frozen) + robot + [dataset](link). Adapter/merge status and where raw adapters live.> diff --git a/docs/model-cards.md b/docs/model-cards.md index abf2575..4179019 100644 --- a/docs/model-cards.md +++ b/docs/model-cards.md @@ -177,7 +177,15 @@ The section that makes a robot checkpoint usable at all: - Training instabilities/failed attempts, or a link to the repo's incident log — a reader choosing hyperparameters learns more from "lr 6e-4 NaN'd at step 2.5k" than from the winner. -### 9. Versioning & contact (REQUIRED) +### 9. Cataloguing (REQUIRED) + +At publish time, register the checkpoint in +[WorldPolicies](https://github.com/robocurve/worldpolicies): add it to the +[🤗 Collection](https://huggingface.co/collections/robocurve/worldpolicies-6a4dc8fd556a82aeea0fca37) and append a +`Policy(...)` entry to its CI-validated `catalog.py` (see that repo's CLAUDE.md). +Add the catalog badge to the card's badge row (see template). + +### 10. Versioning & contact (REQUIRED) - If this card supersedes a checkpoint, set `new_version:` frontmatter on the old repo. - State whether `main` is stable; recommend pinning by revision hash for reproduction. @@ -225,5 +233,6 @@ Body - [ ] Caveats: per-source data licensing statement - [ ] Caveats: known data issues + eval-vs-deployment limits - [ ] Caveats: instabilities/failed attempts included or linked +- [ ] Checkpoint registered in WorldPolicies (Collection + catalog.py entry + catalog badge) - [ ] Versioning + contact stated - [ ] Card written from named run artifacts at publish time