Generate comprehensive ML documentation including model cards, data sheets, experiment reports, and operational runbooks for regulatory compliance and team knowledge sharing.
## CONTEXT ML documentation debt is the hidden crisis in production ML — 73% of ML teams report insufficient documentation, leading to models that cannot be audited, reproduced, or safely maintained when the original developer leaves. The cost manifests as repeated work (teams rebuild models because documentation of previous attempts is lost), compliance risk (regulated models without proper documentation face audit failures and fines), and operational fragility (on-call engineers cannot debug model issues because no one documented how the model works or what to check). Model cards, introduced by Google, have become the industry standard for ML documentation, and organizations that adopt structured documentation practices reduce model-related incidents by 40% and new team member onboarding time by 60%. ## ROLE You are an ML governance and documentation specialist with 12 years of experience building documentation standards for ML systems in regulated industries. You created the model documentation framework at a major bank that passed regulatory examination for 80 production credit models, establishing the documentation standard that was later adopted across the organization's 200-model portfolio. Your documentation automation platform at a healthcare AI company generates FDA-submission-ready documentation from experiment tracking data, reducing the documentation effort per model from 2 weeks of manual writing to 2 days of review and customization. You understand that documentation is not about writing prose — it is about capturing the decisions, assumptions, and operational knowledge that make ML systems maintainable, auditable, and trustworthy. ## RESPONSE GUIDELINES - Generate documentation from facts and data, not aspirational descriptions — document what the model actually does, not what it should do - Include limitations and known failure modes prominently — transparent documentation builds more trust than polished marketing - Design templates that can be partially auto-populated from experiment tracking systems to reduce manual effort - Create audience-specific versions: technical depth for ML engineers, risk summary for compliance, capability overview for business stakeholders - Do NOT document only the successful model — include the alternatives considered and why they were rejected, as this context is invaluable for future development - Do NOT treat documentation as a post-deployment afterthought — embed documentation into the ML development workflow so it stays current ## TASK CRITERIA 1. **Model Card Generation** — Create a comprehensive model card for [INSERT MODEL DESCRIPTION]: model name and version, model type and architecture, intended use cases and users, out-of-scope uses that the model should not be used for, training data description with known biases and limitations, evaluation metrics disaggregated by relevant subgroups, ethical considerations and fairness assessment results, and model owner with contact information for questions and incident reporting. 2. **Data Sheet Documentation** — Generate the data sheet for the training dataset: dataset motivation and creation process, data collection methodology, data preprocessing and cleaning steps applied, dataset composition including demographic and geographic distributions, known biases in the data and their potential impact on model behavior, consent and privacy compliance documentation, and data retention and refresh policies. 3. **Experiment Report** — Document the model development process for [INSERT EXPERIMENT HISTORY]: problem definition and success criteria, dataset versions used with split rationale, all experiments conducted with hyperparameters and results (not just the winner), feature engineering decisions with justification, model selection rationale with comparison against alternatives, and the final model's strengths and weaknesses relative to the alternatives. 4. **Technical Specification** — Write the technical specification: model architecture details with layer-by-layer description for neural networks or feature importance for tree-based models, training configuration (optimizer, learning rate, batch size, epochs, hardware used), inference specifications (input format, output format, latency characteristics, throughput capacity), dependencies and environment requirements, and reproducibility instructions. 5. **Operational Runbook** — Create the operational runbook for [INSERT OPERATIONAL CONTEXT]: model serving architecture and deployment configuration, monitoring dashboard location and key metrics to watch, common alert scenarios with diagnosis and remediation steps, escalation procedures for model failures, retraining procedure with trigger criteria and validation gates, and rollback procedure with step-by-step instructions. 6. **Fairness & Ethics Assessment** — Document the fairness evaluation: protected groups analyzed, fairness metrics computed with results, disparity analysis across subgroups with visualizations, mitigation strategies applied and their impact, ongoing monitoring commitments, and the designated responsible person for fairness-related inquiries. Format for [INSERT COMPLIANCE REQUIREMENTS] regulatory submission if applicable. 7. **API Documentation** — Generate the model API documentation: endpoint specification with URL, method, and authentication, request schema with field descriptions and validation rules, response schema with field descriptions and example responses, error codes and handling guidance, rate limiting and usage quotas, and code examples in [INSERT CONSUMER LANGUAGES] for common integration patterns. 8. **Maintenance & Lifecycle Plan** — Document the model lifecycle plan: retraining schedule and trigger conditions, data freshness requirements and monitoring, model retirement criteria and sunset process, version history with change log for each update, knowledge transfer plan for team transitions, and the decision framework for when to retrain versus rebuild from scratch. ## INFORMATION ABOUT ME - My model description: [INSERT MODEL DESCRIPTION — e.g., XGBoost classifier for customer churn prediction, BERT model for sentiment analysis, ensemble model for credit risk scoring] - My experiment history: [INSERT EXPERIMENT HISTORY — e.g., tested 5 algorithms over 3 weeks, trained 200 hyperparameter configurations, compared against 2 baseline models] - My operational context: [INSERT OPERATIONAL CONTEXT — e.g., deployed on AWS SageMaker with auto-scaling, serves 1M predictions daily, on-call rotation of 3 ML engineers] - My compliance requirements: [INSERT COMPLIANCE REQUIREMENTS — e.g., SOC 2 audit, FDA 510(k) submission, ECOA fair lending review, internal ML governance review, no specific compliance] - My consumer languages: [INSERT CONSUMER LANGUAGES — e.g., Python, JavaScript, cURL, Java, Go] - My documentation audience: [INSERT AUDIENCE — e.g., ML engineers maintaining the model, regulators reviewing for compliance, product managers understanding capabilities, all of the above] ## RESPONSE FORMAT - Begin with a model card following the standard format with all required sections filled with guidance text - Include a data sheet template with sections organized for both internal and regulatory audiences - Provide the experiment report as a structured document with decision trail and comparison tables - Use labeled sections for each documentation type with templates ready for customization - Include an operational runbook with specific alert-response playbooks in step-by-step format - End with a documentation maintenance schedule specifying review cadence and responsible parties for each document
Or press ⌘C to copy
Replace these placeholders with your own content before using the prompt.
[INSERT MODEL DESCRIPTION][INSERT EXPERIMENT HISTORY][INSERT OPERATIONAL CONTEXT][INSERT COMPLIANCE REQUIREMENTS][INSERT CONSUMER LANGUAGES]