model-readme

A set of rules for documenting machine-learning models in README.md files, including their source, license, paper, task, and available recipes.

In plain words
What is it for?
Use it when creating or editing a model README. It also covers the model manifest, recipe links, folder-name mappings, and validated hardware notes.
Why use it?
It makes model folders easier to understand and helps readers find the correct weights, code, documentation, and tested AMD or ROCm setup.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/amdresearch/ai4science-studio/model-readme
Clone the repo
git clone --depth 1 https://github.com/AMDResearch/ai4science-studio

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 364 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00364
Opus 5 $0.00000 $0.00182
Sonnet 5 $0.00000 $0.00073
Haiku 4.5 $0.00000 $0.00036

Measured 2d ago against content hash 760ac974de99, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

model-readme scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/model-readme.mdc · 41 lines

What it actually says

Model README conventions

When creating or editing a README.md at <domain>/models/<slug>/README.md:

Required fields

Every model README must include these fields near the top, either as bold-label lines or a YAML-style table:

  1. Hugging Face model id — The canonical HF id (e.g. nvidia/stormcast-v1-era5-hrrr) or N/A with an "Obtaining model weights" section
  2. License — SPDX identifier or link to the license
  3. Upstream code — Link to the GitHub repository
  4. Paper — Link to the paper (arXiv, journal, etc.) or "N/A"
  5. Task description — What the model does, in 1-2 sentences

Required sections

  1. Recipes table — List all available recipes with links:

    ## Recipes
    | Recipe | Summary |
    |--------|---------|
    | [`recipes/inference/`](recipes/inference/) | ... |
    
  2. AMD / ROCm notes — Only what has actually been validated. Include container image, hardware tested, and any ROCm-specific findings.

  3. On-disk folder name — If the folder name differs from the HF slug, document the mapping.

Companion files

Every model folder should also have:

  • model.yaml — Machine-readable manifest with the same metadata
  • recipes/ — At least one recipe subfolder
  • examples/ — Ready-to-run scripts with README.md
Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 41 lines · 0 tokens per session scan A 760ac974de99

Subscribe to this mod's changes

model-readme is a cursor rule published in the GitHub repository AMDResearch/ai4science-studio (4 stars, last pushed 1mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 364 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.