Skills

Authoring Model Cards

Generate a model card for an OpenMed clinical NER or de-identification model...

Install

npx skills add maziyarpanahi/openmed --skill authoring-model-cards -g -a claude-code -y
Repository
maziyarpanahi/openmed5.8k
Category
Writing
Updated
4d ago
License
Apache-2.0
Context cost
Mediumabout 1,619 tokens
Runs scripts
No, instructions only

What it does

Generate a model card for an OpenMed clinical NER or de-identification model documenting intended use, quantitative metrics, subgroup performance, limitations, and a medical-device disclaimer for clinical AI governance. Use when the user wants to write or update a model card, a README model section, or governance documentation, or to turn OpenMed eval outputs (release gate report, fairness_report, error_report) into the card's metrics and limitations sections. Trigger on \"model card\", \"intended use\", \"model documentation\", \"governance\", \"limitations section\", \"datasheet\", or \"FDA/ONC transparency\" for an OpenMed model.

Authoring Model Cards

A model card is the honest spec sheet for a model: what it's for, how well it works, where it breaks, and who it might fail. For clinical models this is governance-critical, an undocumented de-id model is one nobody can sign off on. This skill fills a model card directly from OpenMed eval outputs so the numbers are reproducible, not aspirational.

When to use this skill

  • You're publishing or updating an OpenMed model and need its card.
  • You have eval artifacts (GateReport, fairness_report, error_report) and need to turn them into intended-use, metrics, and limitations sections.
  • A clinical AI governance / model-risk review needs a transparency document.

Run the evals first (see evaluating-with-leakage-gates, benchmarking-clinical-ner, auditing-subgroup-fairness); this skill documents their results, it does not generate the numbers.

Card sections (Mitchell et al., + clinical extensions)

See references/model-card-sections.md for the full section-to-source map. The load-bearing sections for an OpenMed model:

  • Model details, repo id, family, tier, format, params, milestone, license (Apache-2.0). Pull from the GateReport identity fields.
  • Intended use, the clinical task and the deployment envelope.
  • Out-of-scope / misuse, explicitly: not a medical device; not for autonomous clinical decisions; de-id is verified, not assumed.
  • Metrics, entity-level P/R/F1 and, for de-id, residual leakage + per-label recall floors and the gate decision.
  • Quantitative analysis (subgroups), per-group leakage/recall from fairness_report, including which groups lack data.
  • Limitations, error patterns from error_report; calibration assumptions.
  • Caveats & disclaimer, the medical-device disclaimer.

Quick start, fill the card from eval outputs

from openmed.eval import (
    run_suite, ReleaseGate, fairness_report, error_report,
)
Read the whole SKILL.md on GitHub

More in Writing