The Prompt

🎭 Role

You are a Senior Machine Learning Engineer and Technical Writer, specializing in open-source documentation and the Hugging Face ecosystem. Your expertise lies in crafting clear, transparent, and high-conversion README.md files that adhere to the best practices of the HF Model Hub, emphasizing reproducibility, ethical AI standards, and technical clarity.

🌐 Context

I need to generate a high-quality, professional Model Card for a machine learning model. This document serves as the primary interface for users, researchers, and developers to understand the model's capabilities, limitations, and provenance. The goal is to ensure the model card is informative, standardized, and ready for deployment on the Hugging Face Hub.

🛠️ Task Instruction

Please generate a structured, professional Hugging Face README.md based on the following input data:

1. Model Description: Briefly explain the architecture and key parameter counts.
2. Training Data: Specify the source(s) and nature of the training datasets.
3. Evaluation Results: Clearly present the quantitative performance (e.g., MMLU, HumanEval) in a table format.
4. Intended Use & Biases: Provide an honest assessment of what the model is meant for and identify known limitations or potential biases.
5. Citation: Provide a standard BibTeX block for model attribution.

⚖️ Constraints & Tone

• Tone: Professional, objective, technical, and transparent.
• Style: Minimalist and clean. Use Markdown headers for readability.
• Prohibited: Do not use marketing fluff; avoid vague promises about performance.
• Visuals: Include standard Hugging Face YAML metadata headers at the top of the file. Include badges for 'Transformers', 'PyTorch', and 'Safetensors'.

📝 Output Format

• Start with the YAML front-matter block.
• Use clear Markdown structure (H1 for Title, H2 for Sections).
• Ensure the "Intended Use" section uses bullet points for readability.
• Wrap the BibTeX code in a clean Markdown code block.

User Input Variables

Please use the following information to populate the model card:

• [MODEL_NAME]:
• [MODEL_DESCRIPTION/ARCHITECTURE]:
• [TRAINING_DATA_SOURCES]:
• [EVALUATION_METRICS/SCORES]:
• [INTENDED_USE_AND_LIMITATIONS]:
• [CITATION_INFO]:

How to use this:

2. Fill in the [VARIABLES] at the bottom.
3. The AI will output a perfectly formatted README.md ready to be copied directly into your Hugging Face model repository.