Update README.md

README.md

@@ -10,4 +10,87 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+---
+title: Akin Yurt with RAG
+emoji: 🤖
+colorFrom: blue
+colorTo: purple
+sdk: gradio
+sdk_version: 4.0.0
+app_file: app.py
+pinned: false
+license: apache-2.0
+---
+
+# Akin Yurt Model with RAG 🤖
+
+هذا المشروع يستخدم نموذج **Akin Yurt** مع نظام **Retrieval-Augmented Generation (RAG)** للإجابة على الأسئلة باستخدام قاعدة بيانات شهداء تركمان.
+
+## 🌟 المميزات
+
+- ✅ **RAG System**: استرجاع ذكي للمعلومات من قاعدة البيانات
+- ✅ **محادثة تفاعلية**: واجهة Gradio سهلة الاستخدام
+- ✅ **إعدادات قابلة للتخصيص**: تحكم في Temperature و Max Tokens
+- ✅ **مقارنة النتائج**: تفعيل/تعطيل RAG لرؤية الفرق
+- ✅ **دعم اللغة العربية**: واجهة وتفاعل باللغة العربية
+
+## 📊 النماذج والبيانات
+
+- **النموذج**: [aab20abdullah/akin-yurt-finely](https://huggingface.co/aab20abdullah/akin-yurt-finely)
+- **Dataset**: [aab20abdullah/turkmen-martyrs-dataset](https://huggingface.co/datasets/aab20abdullah/turkmen-martyrs-dataset)
+- **Embedding Model**: sentence-transformers/paraphrase-multilingual-MiniLM-L12-v2
+
+## 🚀 كيفية الاستخدام
+
+1. اكتب سؤالك في صندوق النص
+2. اضغط "إرسال" أو Enter
+3. شاهد الإجابة مع المعلومات المسترجعة من قاعدة البيانات
+
+### إعدادات متقدمة
+
+- **استخدام RAG**: تفعيل/تعطيل استرجاع المعلومات
+- **Temperature** (0.1 - 2.0): 
+  - قيم منخفضة (0.1-0.5): إجابات دقيقة ومباشرة
+  - قيم متوسطة (0.6-1.0): توازن بين الدقة والإبداع
+  - قيم عالية (1.1-2.0): إجابات أكثر إبداعية وتنوعاً
+- **Max Tokens** (128 - 2048): الحد الأقصى لطول الإجابة
+
+## 🛠️ التقنيات المستخدمة
+
+- **Gradio**: واجهة المستخدم
+- **Transformers**: تحميل وتشغيل النموذج
+- **Sentence Transformers**: إنشاء embeddings للنصوص
+- **FAISS**: بحث سريع عن أقرب الجيران (nearest neighbors)
+- **Datasets**: تحميل البيانات من Hugging Face
+
+## 📝 كيف يعمل RAG
+
+1. **الاسترجاع**: عند إرسال سؤال، يتم البحث عن أقرب 3 نصوص ذات صلة من قاعدة البيانات
+2. **الإضافة**: يتم إضافة هذه النصوص كسياق للنموذج
+3. **التوليد**: يستخدم النموذج هذا السياق لتوليد إجابة دقيقة ومبنية على البيانات
+
+## 🔧 التثبيت المحلي
+
+```bash
+# استنساخ المشروع
+git clone https://huggingface.co/spaces/aab20abdullah/akin-yurt-rag
+cd akin-yurt-rag
+
+# تثبيت المتطلبات
+pip install -r requirements.txt
+
+# تشغيل التطبيق
+python app.py
+```
+
+## 📄 الترخيص
+
+Apache 2.0
+
+## 👤 المطور
+
+**Abdullah** ([@aab20abdullah](https://huggingface.co/aab20abdullah))
+
+---
+
+⭐ إذا أعجبك هذا المشروع، لا تنسى إعطاءه نجمة!