Edraky-AI / README.md
Edraky's picture
Update README.md
0bbe7b5 verified
---
title: ๐Ÿค– ุฅุฏุฑุงูƒูŠ (Edraky) - Multilingual Educational AI Model ๐Ÿ‡ช๐Ÿ‡ฌ
emoji: ๐Ÿง 
colorFrom: indigo
colorTo: emerald
sdk: gradio
sdk_version: 4.25.0
app_file: app.py
pinned: false
license: apache-2.0
datasets:
- deepseek-ai/DeepSeek-ProverBench
- open-llm-leaderboard/Qwen__Qwen2-1.5B-Instruct-details
- Salama1429/tarteel-ai-everyayah-Quran
language:
- ar
- en
- he
metrics:
- accuracy
- perplexity
- wer
base_model: Qwen/Qwen2-1.5B-Instruct
pipeline_tag: text-generation
library_name: transformers
tags:
- multilingual
- arabic
- hebrew
- qwen
- educational
- fine-tuned
- open-source
- egyptian-curriculum
---
<style>
body {
font-family: 'Cairo', sans-serif;
background: linear-gradient(to left, #f9f9f9, #e0ecf7);
color: #222;
padding: 2em;
line-height: 1.8;
}
h1, h2, h3, h4 {
color: #003366;
border-bottom: 2px solid #eee;
padding-bottom: 0.3em;
}
code {
background-color: #f4f4f4;
padding: 0.2em 0.4em;
border-radius: 4px;
font-family: Consolas, monospace;
color: #c7254e;
}
pre {
background-color: #f0f0f0;
padding: 1em;
border-radius: 8px;
overflow-x: auto;
}
ul {
padding-left: 1.5em;
}
blockquote {
background: #f9f9f9;
border-left: 5px solid #ccc;
padding: 1em;
font-style: italic;
color: #666;
}
</style>
# ๐Ÿค– ุฅุฏุฑุงูƒูŠ (Edraky) - Multilingual Educational AI Model ๐Ÿ‡ช๐Ÿ‡ฌ
**Edraky** is a fine-tuned multilingual model built on `Qwen2-1.5B-Instruct`, designed to provide educational support for Arabic-speaking students, especially targeting Egypt's 3rd preparatory curriculum. It supports Arabic, English, and Hebrew to ensure flexible, broad usage in multilingual environments.
## ๐Ÿง  About Edraky
Edraky is part of the **"ุฅุฏุฑุงูƒูŠ"** educational initiative to democratize access to AI-powered tools for students in Egypt and the broader Arab world. By fine-tuning the powerful Qwen2 base model, Edraky delivers context-aware, curriculum-aligned, and interactive responses that help learners understand core subjects such as:
- ุงู„ู„ุบุฉ ุงู„ุนุฑุจูŠุฉ (Arabic Language)
- ุงู„ุฏุฑุงุณุงุช ุงู„ุงุฌุชู…ุงุนูŠุฉ (Social Studies)
- ุงู„ุนู„ูˆู… (Science)
- ุงู„ุฑูŠุงุถูŠุงุช (Math)
- ุญุงุณุจ ุขู„ูŠ (Computer)
- ุงู„ู„ุบุฉ ุงู„ุฅู†ุฌู„ูŠุฒูŠุฉ (English)
## ๐Ÿš€ Key Features
- ๐Ÿค– **Text Generation & Q&A**: Answer student questions in an educational and child-safe manner.
- ๐Ÿ“– **Curriculum Support**: Focused especially on 3rd preparatory grade in Egypt.
- ๐ŸŒ **Multilingual Input**: Supports Arabic, English, and Hebrew.
- ๐Ÿ”€ **Open-Source**: Available for research, personal, or educational use.
- ๐Ÿ“š **Trained on curated educational prompts** for logic, language understanding, and curriculum-based queries.
## ๐Ÿงช Training & Fine-Tuning
**Base model:** `Qwen/Qwen2-1.5B-Instruct`
**Training Data Sources:**
- fka/awesome-chatgpt-prompts
- gsm8k-rerun/Qwen_Qwen2.5-1.5B-Instruct
- Additional data created from Arabic curriculum-style questions and student textbooks
**Training Methodology:**
- Supervised fine-tuning
- Prompt-optimized inputs
- Tokenized using Hugging Faceโ€™s tokenizer compatible with Qwen2 models
## ๐Ÿ” Evaluation
Model was evaluated on:
- โœ”๏ธ Accuracy for subject-specific answers
- โœ”๏ธ Perplexity for fluency and coherence
- โœ”๏ธ WER (Word Error Rate) for language understanding
> Evaluation still in progress for full benchmarks โ€” to be published soon.
## ๐Ÿง‘โ€๐Ÿ’ป Example Usage
```python
from transformers import AutoModelForCausalLM, AutoTokenizer
model = AutoModelForCausalLM.from_pretrained("Edraky/Edraky-AI")
tokenizer = AutoTokenizer.from_pretrained("Edraky/Edraky-AI")
prompt = "ุงุดุฑุญ ุงู„ุซูˆุฑุฉ ุงู„ุนุฑุงุจูŠุฉ ุจุฅูŠุฌุงุฒ"
inputs = tokenizer(prompt, return_tensors="pt")
output = model.generate(**inputs, max_new_tokens=150)
print(tokenizer.decode(output[0], skip_special_tokens=True))
```
## ๐Ÿง‘โ€๐Ÿ““ Intended Use
- ๐Ÿ’ฌ Classroom support AI assistant
- โœ๏ธ Writing and summarization in Arabic
- โ“ Question answering for exam preparation
- ๐Ÿ” Fact recall for historical, literary, and social studies content
### โŒ Not Intended For:
- โŒ Political or religious fatwa content
- โŒ Personal decision-making
- โŒ Generating offensive or misleading answers
## ๐ŸŒฑ Future Plans
- โœ… Add voice input/output via Whisper integration
- โœ… Online quiz companion
- โœ… Add visual aids (diagrams, maps)
- โœ… Full web platform integration (see [edraky.rf.gd](https://edraky.rf.gd))
## ๐Ÿ“ข Maintainers
**Developed by:** Edraky AI Team
๐ŸŒ Website: [https://edraky.rf.gd](https://edraky.rf.gd)
๐Ÿ“ง Contact: edraky.help@gmail.com
## ๐Ÿ“œ Citation
```bibtex
@misc{edraky2025,
title={Edraky: Multilingual Educational AI Model},
author={Edraky Team},
year={2025},
howpublished={\url{https://huggingface.co/Edraky/Edraky}}
}
```
> ู‡ุฐุง ุงู„ู…ุดุฑูˆุน ู…ู† ุฃุฌู„ ุฏุนู… ุงู„ุชุนู„ูŠู… ููŠ ู…ุตุฑ ุจุงุณุชุฎุฏุงู… ุงู„ุฐูƒุงุก ุงู„ุงุตุทู†ุงุนูŠ. ู†ุฑุฌูˆ ุฃู† ูŠูƒูˆู† ู…ููŠุฏู‹ุง ู„ุฌู…ูŠุน ุงู„ุทู„ุงุจ ูˆุงู„ู…ุนู„ู…ูŠู† ๐ŸŒŸ