Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,39 @@
|
|
| 1 |
-
---
|
| 2 |
-
license: bigcode-openrail-m
|
| 3 |
-
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: bigcode-openrail-m
|
| 3 |
+
---
|
| 4 |
+
---
|
| 5 |
+
license: bigcode-openrail-m
|
| 6 |
+
tags:
|
| 7 |
+
- islam
|
| 8 |
+
- chatbot
|
| 9 |
+
- quran
|
| 10 |
+
- muslim-ai
|
| 11 |
+
- agent
|
| 12 |
+
---
|
| 13 |
+
|
| 14 |
+
# 🕌 AgentMusim
|
| 15 |
+
|
| 16 |
+
**AgentMusim** is an AI agent designed for the global Muslim community. It provides answers to faith-based questions, helps with prayer timings, and integrates culturally relevant knowledge using modern language models.
|
| 17 |
+
|
| 18 |
+
## ✨ Features
|
| 19 |
+
- Quranic Q&A
|
| 20 |
+
- Hadith reference support
|
| 21 |
+
- Prayer times (based on location)
|
| 22 |
+
- Fasting calendar
|
| 23 |
+
- General Islamic assistant
|
| 24 |
+
|
| 25 |
+
## 🧠 Model Details
|
| 26 |
+
- Base model: `Mistral` / `LLaMA2` / `Phi-2` (specify)
|
| 27 |
+
- Fine-tuned on Islamic QA datasets and trusted sources.
|
| 28 |
+
- Trained using the `bigcode-openrail-m` license guidelines.
|
| 29 |
+
|
| 30 |
+
## 🤖 Usage
|
| 31 |
+
```python
|
| 32 |
+
from transformers import AutoModelForCausalLM, AutoTokenizer
|
| 33 |
+
|
| 34 |
+
tokenizer = AutoTokenizer.from_pretrained("likhonsheikh/AgentMusim")
|
| 35 |
+
model = AutoModelForCausalLM.from_pretrained("likhonsheikh/AgentMusim")
|
| 36 |
+
|
| 37 |
+
inputs = tokenizer("Who was the first Prophet in Islam?", return_tensors="pt")
|
| 38 |
+
outputs = model.generate(**inputs)
|
| 39 |
+
print(tokenizer.decode(outputs[0]))
|