Markdown Editor

Model Card Template (Mitchell et al. 2019)

Model details, intended and out-of-scope uses, factors, metrics, data, disaggregated results, ethics, caveats

IA y datosCompletaModel Cards for Model Reporting (Mitchell et al., 2019)modelcard

Cómo usar: Use when releasing or handing over a trained model. Fill intended use and factors first, because the factors decide how results are disaggregated. The main pitfall is a single headline metric with no per-group results or confidence intervals.

Vista previa

Model Card: [Model name] [version]

Complete model card for a trained machine learning model: what it is, what it is for and not for, how it was trained and evaluated, how it performs across groups of people and conditions, and what users must know before relying on it. The section structure follows the model card framework of Mitchell et al. (2019), Model Cards for Model Reporting. Replace every [bracketed] value and every row marked Example.

Document control

FieldValue
Document ID[MC-MODEL-001]
Model name[Model name]
Model version[1.2.0]
Card version[0.1]
Status[Draft / In review / Approved / Published / Retired]
Owner[@model-owner]
Classification[Internal / Confidential / Public]
Last updatedYYYY-MM-DD
Related documents[Datasheet for training data], [ML system design], [AI risk assessment], [Evaluation report]

Approvals

RoleNameDecisionDate
Model owner[@name][Approved / Changes requested]YYYY-MM-DD
Responsible AI / ethics reviewer[@name][Decision]YYYY-MM-DD
Product owner[@name][Decision]YYYY-MM-DD
Privacy or legal reviewer[@name][Decision]YYYY-MM-DD

Revision history

VersionDateAuthorChange summary
0.1YYYY-MM-DD[@name]First draft for review
0.2YYYY-MM-DD[@name]Example: Added results for speakers over 65 after fairness review
1.0YYYY-MM-DD[@name]Example: Published with model 1.2.0

Contents

1. Model details

1.1 Summary

[Two or three sentences in plain language. Example: "A gradient-boosted classifier that estimates the probability that an incoming support ticket is urgent, so that agents can sort their queue. It reads the ticket text and metadata only; it does not read customer account data."]

1.2 Identification and provenance

AttributeValue
Developer / organisation[Team, organisation]
Model dateYYYY-MM-DD
Model version[1.2.0]
Artefact location and hash[Registry URI], sha256:[hash]
Model typeExample: Gradient-boosted decision trees over TF-IDF and metadata features
Architecture detailsExample: 600 trees, max depth 8, learning rate 0.05
Base or foundation model[None / Name and version of the pre-trained model it was fine-tuned from]
InputExample: Ticket subject and body (English, up to 4 000 characters), channel, product area
OutputExample: Probability of "urgent" in [0, 1] and a binary label at threshold 0.62
Training framework[Framework and version]
Licence[Internal use only / Open licence name]
Citation[How to cite this model, if published]

1.3 Training approach

[Describe the algorithm, objective, important hyperparameters, fairness constraints or interventions, and how the decision threshold was chosen. Example: "Trained with log loss on 18 months of labelled tickets; class weights balance the 9% urgent rate; threshold chosen to give 90% recall on the validation set."]

2. Intended use

2.1 Primary intended uses

IDUseDecision supportedHuman in the loop
IU-01Example: Rank the open ticket queue by urgency for support agentsOrder in which agents read ticketsYes, agent decides what to work on
IU-02Example: Trigger a page to the on-call lead when 5 or more urgent tickets arrive in 10 minutesWhether to escalateYes, lead confirms incident
[IU-nn][Use][Decision][Yes / No, describe]

2.2 Primary intended users

[Who operates the model output, with what training. Example: "Tier-1 and tier-2 support agents trained on the triage runbook; support leads."]

2.3 Out-of-scope uses

IDUse that is out of scopeWhy
OOS-01Example: Deciding refunds, credits or account closureNot trained or evaluated for these outcomes
OOS-02Example: Tickets in languages other than EnglishPerformance drops sharply (see 7.3)
OOS-03Example: Evaluating agent performanceScores reflect ticket text, not agent behaviour
[OOS-nn][Use][Reason]

3. Factors

3.1 Relevant factors

Factor typeFactorWhy it may affect performanceEvaluated
GroupExample: Customer writing in a second languagePhrasing and vocabulary differ from training majorityYes
GroupExample: Customer age band (self-declared, sample only)Writing style; accessibility needsPartly, sample of 2 000
InstrumentationExample: Channel: email, web form, chat transcriptLength and structure of text differYes
EnvironmentExample: Incident days versus normal daysTicket mix shifts, many near-duplicatesYes
[Group / Instrumentation / Environment][Factor][Reason][Yes / No / Partly]

3.2 Evaluation factors

[Which factors section 7 reports on and why these were chosen. Explain any relevant factor that was not evaluated, for example because labels for that group are not lawfully collectable, and what that means for users.]

4. Metrics

4.1 Performance measures

MetricDefinitionWhy it matters here
Recall (urgent)TPTP+FN\frac{TP}{TP + FN}A missed urgent ticket delays a customer in trouble
Precision (urgent)TPTP+FP\frac{TP}{TP + FP}False alarms waste agent attention and erode trust
False negative rateFNTP+FN\frac{FN}{TP + FN}Compared across groups to detect unequal harm
AUROCArea under the ROC curveThreshold-free ranking quality
Calibration errorExpected calibration error over 10 binsScores are shown to agents as probabilities
[Metric][Definition][Reason]

4.2 Decision threshold

[Threshold value, how it was chosen, and the trade-off it represents. Example: "0.62, chosen on validation data to reach recall of at least 0.90 while keeping precision above 0.55."]

4.3 Variation approaches

[How uncertainty is shown. Example: "95% bootstrap confidence intervals from 1 000 resamples of the test set, stratified by channel. Group gaps are reported with their own intervals."]

5. Evaluation data

AttributeValue
Dataset(s)Example: Held-out tickets from YYYY-MM-DD to YYYY-MM-DD, never used in training
SizeExample: 24 000 tickets, 2 180 labelled urgent
MotivationExample: Most recent period, closest to production mix
LabellingExample: Two agents labelled independently; disagreements resolved by a lead; Cohen's kappa 0.81
PreprocessingExample: Same pipeline as training: lower-casing, signature removal, PII masking
Known gapsExample: Only 3% of tickets from chat; no tickets from the new Japanese site
Datasheet[Link to datasheet for this dataset]

6. Training data

AttributeValue
SourceExample: Support tickets from all public channels, YYYY-MM to YYYY-MM
SizeExample: 310 000 tickets, 9% urgent
Collection and consent basis[Legal basis or consent mechanism; reference to privacy notice]
Personal data handlingExample: Names, emails and phone numbers masked before training
Distribution over factorsExample: Email 61%, web form 33%, chat 6%; second-language writers estimated 14%
ExclusionsExample: Tickets under 10 words; spam; internal test tickets
Datasheet[Link to datasheet for this dataset]

7. Quantitative analyses

7.1 Overall results

MetricValue95% CITargetMet
Recall (urgent)Example: 0.910.89 to 0.92at least 0.90Yes
Precision (urgent)Example: 0.580.56 to 0.60at least 0.55Yes
AUROCExample: 0.940.93 to 0.95at least 0.92Yes
Expected calibration errorExample: 0.0310.025 to 0.037at most 0.05Yes

7.2 Disaggregated results by single factor

FactorGroupnRecallPrecisionFNRGap vs overall FNR
ChannelEmailExample: 14 6000.920.600.08-0.01
ChannelWeb formExample: 8 0000.910.570.090.00
ChannelChatExample: 1 4000.820.490.18+0.09 (above tolerance)
WriterSecond languageExample: 3 3000.860.550.14+0.05
Day typeIncident dayExample: 2 1000.950.710.05-0.04
[Factor][Group][n][value][value][value][value]

The fairness tolerance used in this card is: [Example: no group's false negative rate may exceed the overall rate by more than 0.05 absolute].

7.3 Intersectional results

Group combinationnRecallFNRNote
Example: Chat and second language2600.740.26Wide interval (0.66 to 0.81); treat with caution
Example: Non-English tickets (out of scope)4100.520.48Confirms OOS-02
[Combination][n][value][value][Note]

7.4 Interpretation

[What the numbers mean for users. Example: "The model misses roughly one in five urgent chat tickets. Chat tickets must not rely on the urgency score alone until the chat-specific model in roadmap item RM-14 ships."]

8. Ethical considerations

TopicConsiderationMitigationResidual concern
Sensitive dataExample: Tickets may mention health or financial hardshipPII masking; no sensitive attributes as featuresFree text can still reveal sensitive facts
Human life and safetyExample: Urgent tickets may involve service outages for hospitalsHospital accounts always routed to priority queue regardless of scoreNone known
Unequal performanceExample: Higher miss rate for chat and second-language writersGroup-specific monitoring; agent guidance in 9Gap remains until RM-14
Automation biasExample: Agents may skip low-score ticketsQueue shows age as well as score; maximum wait ruleMonitored monthly
[Topic][Consideration][Mitigation][Residual]

9. Caveats and recommendations

9.1 Caveats

  • [Example: Not evaluated on tickets longer than 4 000 characters; text is truncated.]
  • [Example: Performance after major product launches is unknown until labels arrive, usually 14 days.]
  • [Example: Age band results come from a self-declared sample and may not represent all customers.]

9.2 Recommendations for users

  • [Example: Read every chat ticket older than 15 minutes regardless of score.]
  • [Example: Report misclassified tickets with the "wrong urgency" button; reports feed the next retraining.]
  • [Example: Do not display the raw probability to customers.]

10. Versioning, maintenance and contact

10.1 Version lineage

Model versionDateChangeCard version
Example: 1.0.0YYYY-MM-DDFirst production model1.0
Example: 1.2.0YYYY-MM-DDRetrained on 6 more months; chat features added2.0
[Version]YYYY-MM-DD[Change][Card version]

10.2 Monitoring and retraining

[What is monitored in production, thresholds that trigger review, and the retraining cadence. Example: "Weekly recall per channel from agent feedback; retrain quarterly or when recall drops below 0.87 for two consecutive weeks."]

10.3 Contact

PurposeContact
Questions about the model[@model-owner], [team channel]
Report a harmful or incorrect output[Issue tracker or form]
Responsible AI review[@reviewer]

11. References and glossary

11.1 References

ReferenceUse
Mitchell, M., Wu, S., Zaldivar, A., Barnes, P., Vasserman, L., Hutchinson, B., Spitzer, E., Raji, I. D., Gebru, T. (2019). Model Cards for Model Reporting. Proceedings of the Conference on Fairness, Accountability, and Transparency (FAT* '19).Card structure
Gebru, T. et al. (2021). Datasheets for Datasets. Communications of the ACM 64(12).Data documentation linked from 5 and 6
[Internal evaluation report]Source of section 7 numbers

11.2 Glossary

TermMeaning
TP, FP, FNTrue positives, false positives, false negatives for the positive class
FNRFalse negative rate: share of real positives the model missed
Disaggregated resultA metric computed separately for one group or condition
Intersectional resultA metric for a combination of groups, such as channel and language
CalibrationHow closely predicted probabilities match observed frequencies

Standard and licence note

Structure aligned with the model card framework described in Mitchell et al. (2019), Model Cards for Model Reporting (FAT* '19), covering its sections on model details, intended use, factors, metrics, evaluation and training data, quantitative analyses, ethical considerations, and caveats and recommendations. This template is original text written for this collection and reproduces no text from the paper; read the paper for the authors' full guidance. Template licence: MIT.

Plantillas relacionadas