Model Card Writer
When to activate
When documenting a machine learning model for production use, sharing with stakeholders, or publishing research. Triggers: "generate a model card", "document this model", "create model documentation", "write model card for X".
When NOT to use
When only technical implementation details are needed (use code documentation instead). Not for general project documentation or architecture guides.
Instructions
- Gather model metadata: name, version, training data, performance metrics, intended use
- Structure the card following the Model Card for Model Reporting framework
- Document model details, intended use, performance characteristics, ethical considerations
- Include limitations, biases, and uncertainty quantification
- Format as Markdown or JSON depending on deployment context
Example
[To be completed with concrete model card example]
1---2name: model-card-writer3description: Model Card Writer4---5# Model Card Writer67## When to activate8When documenting a machine learning model for production use, sharing with stakeholders, or publishing research. Triggers: "generate a model card", "document this model", "create model documentation", "write model card for X".910## When NOT to use11When only technical implementation details are needed (use code documentation instead). Not for general project documentation or architecture guides.1213## Instructions141. Gather model metadata: name, version, training data, performance metrics, intended use152. Structure the card following the Model Card for Model Reporting framework163. Document model details, intended use, performance characteristics, ethical considerations174. Include limitations, biases, and uncertainty quantification185. Format as Markdown or JSON depending on deployment context1920## Example21[To be completed with concrete model card example]
UitbreidenOS