Skip to content

docs: eval-path as badge row (Hub renders blockquotes gray-italic) #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeqcho merged 1 commit into from
Jul 8, 2026
Merged

docs: eval-path as badge row (Hub renders blockquotes gray-italic) #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/model-card-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,9 @@ inference: false

# <Model name — robot + method in plain words>

> **Evaluate this checkpoint** with [Inspect Robots](https://github.com/robocurve/inspect-robots) —
> the Inspect-AI-style eval framework for physical AI — using the
> [<embodiment> adapters](https://github.com/robocurve/inspect-robots-<embodiment>); benchmarks
> are catalogued in [WorldEvals](https://github.com/robocurve/worldevals).
[![Evaluate with Inspect Robots](https://img.shields.io/badge/evaluate%20with-Inspect%20Robots-indigo)](https://github.com/robocurve/inspect-robots)
[![Adapters: <embodiment>](https://img.shields.io/badge/adapters-inspect--robots--<embodiment>-blue)](https://github.com/robocurve/inspect-robots-<embodiment>)
[![Benchmarks: WorldEvals](https://img.shields.io/badge/benchmarks-WorldEvals-2ea44f)](https://worldevals.org)

<≤3 sentences: [base model](link) + method (LoRA/full FT; what's frozen) + robot +
[dataset](link). Adapter/merge status and where raw adapters live.>
Expand Down
10 changes: 5 additions & 5 deletions docs/model-cards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,10 @@ model-index:

At most three sentences: base model + method (LoRA/full FT; what's frozen) + robot/embodiment
+ dataset. State whether adapters are merged and where raw adapters live if published.
**Immediately after the H1**, add an eval-path blockquote linking
[Inspect Robots](https://github.com/robocurve/inspect-robots), the embodiment's adapter repo
(e.g. inspect-robots-so101 / inspect-robots-yam), and
[WorldEvals](https://github.com/robocurve/worldevals) — see the template.
**Immediately after the H1**, add an eval-path badge row (shields.io — blockquotes render
as gray italics on the Hub) linking [Inspect Robots](https://github.com/robocurve/inspect-robots),
the embodiment's adapter repo (e.g. inspect-robots-so101 / inspect-robots-yam), and
[WorldEvals](https://worldevals.org) — copy the exact badges from the template.
Link every **named artifact**: base model, each dataset, training-code repo, method libraries,
papers. (Ordinary nouns like "camera" need no link.)

Expand Down Expand Up @@ -205,7 +205,7 @@ Frontmatter

Body
- [ ] Header ≤3 sentences; every named artifact linked; adapter/merge status stated
- [ ] Eval-path blockquote right after the H1 (Inspect Robots + embodiment adapters + WorldEvals)
- [ ] Eval-path badge row right after the H1 (Inspect Robots + embodiment adapters + WorldEvals)
- [ ] Intended use + out-of-scope + validation status (with e-stop/supervision language)
- [ ] Training table: data counts + filter/split rule (level, %, seed)
- [ ] Training table: embodiment config + state/action key layout
Expand Down
Loading