Edraky commited on
Commit
c2b8fdf
ยท
verified ยท
1 Parent(s): 6559454

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +124 -1
README.md CHANGED
@@ -23,4 +23,127 @@ tags:
23
  - qwen
24
  - educational
25
  - fine-tuned
26
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
23
  - qwen
24
  - educational
25
  - fine-tuned
26
+ ---
27
+
28
+ <style>
29
+ body {
30
+ font-family: 'Segoe UI', sans-serif;
31
+ line-height: 1.7;
32
+ color: #1e1e1e;
33
+ background: #ffffff;
34
+ padding: 1.5em;
35
+ }
36
+
37
+ h1, h2, h3 {
38
+ color: #2c3e50;
39
+ border-bottom: 2px solid #eee;
40
+ padding-bottom: 5px;
41
+ }
42
+
43
+ img {
44
+ display: block;
45
+ margin: 1em auto;
46
+ max-width: 200px;
47
+ }
48
+
49
+ code, pre {
50
+ background-color: #f5f5f5;
51
+ padding: 0.5em;
52
+ border-radius: 5px;
53
+ font-family: 'Courier New', monospace;
54
+ display: block;
55
+ white-space: pre-wrap;
56
+ }
57
+
58
+ blockquote {
59
+ border-left: 4px solid #3498db;
60
+ background: #ecf6fd;
61
+ padding: 0.8em;
62
+ color: #333;
63
+ margin: 1.5em 0;
64
+ }
65
+ </style>
66
+
67
+ # ๐Ÿค– ุฅุฏุฑุงูƒูŠ (Edraky) - Multilingual Educational AI Model
68
+
69
+ ![Edraky Logo](https://cdn-uploads.huggingface.co/production/uploads/686e726239f003427404a1be/uuB7LFKDX1C5B28DGJyZN.png)
70
+
71
+ > A fine-tuned AI assistant that helps Egyptian students โ€” specially 3rd preparatory โ€” with Arabic, English, Hebrew content, and educational support.
72
+
73
+ ---
74
+
75
+ ## ๐Ÿง  Model Details
76
+
77
+ - **Base Model:** Qwen/Qwen2-1.5B-Instruct
78
+ - **Languages:** Arabic, English, Hebrew
79
+ - **Trained on:** Educational, Q&A, mathematical, and multilingual prompts
80
+ - **License:** Apache-2.0
81
+ - **Tags:** multilingual, Arabic, Hebrew, educational, fine-tuned, transformers
82
+
83
+ ---
84
+
85
+ ## ๐Ÿš€ How to Use
86
+
87
+ ```python
88
+ from transformers import AutoModelForCausalLM, AutoTokenizer
89
+
90
+ model = AutoModelForCausalLM.from_pretrained("Edraky/Edraky")
91
+ tokenizer = AutoTokenizer.from_pretrained("Edraky/Edraky")
92
+
93
+ input_text = "ุงุดุฑุญ ุงู„ุซูˆุฑุฉ ุงู„ุนุฑุงุจูŠุฉ"
94
+ inputs = tokenizer(input_text, return_tensors="pt")
95
+ outputs = model.generate(**inputs, max_new_tokens=100)
96
+ print(tokenizer.decode(outputs[0]))
97
+ โœ… Intended Uses
98
+ ๐Ÿง‘โ€๐Ÿซ Educational chatbot for classroom topics
99
+
100
+ ๐Ÿ“š Answering curriculum-based questions
101
+
102
+ โœ๏ธ Writing, completion, and explanation for Arabic texts
103
+
104
+ ๐Ÿซ Perfect fit for 3rd preparatory grade in Egypt
105
+
106
+ ๐Ÿšซ Limitations / Out-of-Scope
107
+ โŒ Not designed for real-time tutoring
108
+
109
+ โŒ No legal, political, or medical advice
110
+
111
+ โŒ Not for biased, violent, or harmful use
112
+
113
+ ๐Ÿ“Š Evaluation & Training
114
+ Datasets:
115
+
116
+ fka/awesome-chatgpt-prompts
117
+
118
+ microsoft/rStar-Coder
119
+
120
+ gsm8k-rerun/Qwen_Qwen2.5-1.5B-Instruct
121
+
122
+ Metrics Used:
123
+
124
+ Accuracy
125
+
126
+ Perplexity
127
+
128
+ Word Error Rate (WER)
129
+
130
+ ๐ŸŒ Environment Impact (Optional)
131
+ Trained on GPU (details coming soon). Expected carbon footprint is low due to small model size (1.5B).
132
+
133
+ ๐Ÿ‘จโ€๐Ÿ’ป Maintainers & Contact
134
+ Created by: Edraky Team
135
+
136
+ Contact: edraky.edu@gmail.com
137
+
138
+ License: Apache 2.0
139
+
140
+ ๐Ÿ“œ Citation (if needed)
141
+ bibtex
142
+ Copy
143
+ Edit
144
+ @misc{edraky2025,
145
+ title={Edraky: Multilingual Educational AI Model},
146
+ author={Edraky Team},
147
+ year={2025},
148
+ howpublished={\\url{https://huggingface.co/Edraky/Edraky}}
149
+ }