Upload README.md with huggingface_hub

README.md

@@ -1,3 +1,88 @@
----
-license: mit
----
+---
+language:
+- en
+license: apache-2.0
+tags:
+- prompt-optimization
+- british-english
+- education
+- gpt-oss
+- ollama
+datasets:
+- roneymatusp/british-educational-prompts
+widget:
+- text: "como fazer uma aula boa?"
+  example_title: "Portuguese Input"
+- text: "teach math to kids"
+  example_title: "American English Input"
+- text: "avaliação para matemática"
+  example_title: "Mixed Language Input"
+---
+
+# PauleanPrompt - British Educational Prompt Optimizer
+
+## Model Description
+
+PauleanPrompt is a specialized prompt optimization model that converts any input (Portuguese, American English, etc.) into optimized British English educational prompts.
+
+## Features
+
+- ✅ Accepts input in ANY language
+- ✅ Always outputs British English prompts
+- ✅ Focuses on British educational levels (Pre-Prep, Prep, Junior, IGCSE, IBDP)
+- ✅ Uses British spelling and terminology
+- ✅ Aligned with National Curriculum
+
+## Usage
+
+### Using with Ollama Turbo
+
+```python
+from ollama import Client
+
+client = Client(
+    host="https://ollama.com",
+    headers={'Authorization': 'YOUR_API_KEY'}
+)
+
+response = client.chat(
+    model="gpt-oss:20b",
+    messages=[
+        {'role': 'system', 'content': SYSTEM_PROMPT},
+        {'role': 'user', 'content': "como fazer uma aula boa?"}
+    ]
+)
+```
+
+### Example Outputs
+
+| Input | Output |
+|-------|--------|
+| "como fazer uma aula boa?" | "Create a comprehensive lesson plan for a Year 6 class..." |
+| "teach math to kids" | "Design a Year 2 mathematics lesson plan..." |
+| "avaliação para matemática" | "Develop a formative assessment for Year 8 pupils..." |
+
+## Training Details
+
+- **Base Model**: GPT-OSS:20b
+- **Training Method**: LoRA fine-tuning
+- **Dataset**: 8,086 British educational examples
+- **Training Date**: August 2025
+
+## Limitations
+
+- This is a prompt optimizer, NOT a chatbot
+- Always outputs prompts, not answers
+- Optimized for educational context only
+
+## Citation
+
+```bibtex
+@misc{pauleanprompt2025,
+  author = {Roney Matus},
+  title = {PauleanPrompt: British Educational Prompt Optimizer},
+  year = {2025},
+  publisher = {HuggingFace},
+  url = {https://huggingface.co/roneymatusp/PauleanPrompt}
+}
+```