Update language to English - model accepts English input and provides English output

README.md

@@ -4,73 +4,68 @@ pipeline_tag: text-generation
 tags:
 - transformers
 - text-generation
-- arabic
+- english
 - quran
 - islamic
+- religious-texts
+- question-answering
 - safetensors
+- t5
 language:
-- ar
+- en
 library_name: transformers
+widget:
+- text: "What is Islam?"
+  example_title: "Basic Question"
+- text: "Tell me about the five pillars of Islam"
+  example_title: "Islamic Concepts"
+- text: "Explain the significance of prayer in Islam"
+  example_title: "Religious Practice"
 ---
 
-# QuranPlus
+# QuranPlus - English Language Islamic Q&A Model
 
-QuranPlus is a language model trained for Islamic and Quranic text generation.
+This model is fine-tuned to answer questions about Islam and the Quran in **English**. While it has knowledge of Arabic religious texts and can reference them, it primarily operates in English for both input and output.
 
-## Model Description
+## Model Details
 
-This model is designed to generate text related to Islamic teachings and Quranic content in Arabic.
+- **Primary Language**: English
+- **Model Type**: T5 (Text-to-Text Transfer Transformer)
+- **Task**: Question Answering about Islamic topics
+- **Input**: English questions about Islam, Quran, and Islamic teachings
+- **Output**: English responses with references to Islamic texts
 
 ## Usage
 
-```python
-from transformers import AutoTokenizer, AutoModelForCausalLM
-
-# Load model and tokenizer
-tokenizer = AutoTokenizer.from_pretrained("justdeen/QuranPlus")
-model = AutoModelForCausalLM.from_pretrained("justdeen/QuranPlus")
-
-# Generate text
-input_text = "ما هو الإسلام؟"
-inputs = tokenizer(input_text, return_tensors="pt")
-
-with torch.no_grad():
-    outputs = model.generate(**inputs, max_length=100, do_sample=True)
-
-generated_text = tokenizer.decode(outputs[0], skip_special_tokens=True)
-print(generated_text)
-```
-
-## Inference API
-
-You can also use this model via the Hugging Face Inference API:
+You can ask questions in English and receive answers in English:
 
 ```python
-import requests
+from transformers import T5ForConditionalGeneration, T5Tokenizer
 
-API_URL = "https://api-inference.huggingface.co/models/justdeen/QuranPlus"
-headers = {"Authorization": f"Bearer {YOUR_HF_TOKEN}"}
+model = T5ForConditionalGeneration.from_pretrained("justdeen/QuranPlus")
+tokenizer = T5Tokenizer.from_pretrained("justdeen/QuranPlus")
 
-def query(payload):
-    response = requests.post(API_URL, headers=headers, json=payload)
-    return response.json()
-
-output = query({
-    "inputs": "ما هو الإسلام؟",
-})
+# Ask questions in English
+question = "What is the importance of charity in Islam?"
+inputs = tokenizer(question, return_tensors="pt", max_length=512, truncation=True)
+outputs = model.generate(**inputs, max_length=150)
+answer = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(answer)
 ```
 
-## Training Details
-
-This model was trained on Islamic and Quranic texts to provide accurate and contextually appropriate responses about Islamic teachings.
+## Example Questions
 
-## Limitations
+- "What is Islam?"
+- "Tell me about the five pillars of Islam"
+- "What does the Quran say about kindness?"
+- "Explain the concept of Tawheed"
+- "What is the significance of Ramadan?"
 
-- The model is specifically trained for Islamic content
-- Responses should be verified by Islamic scholars for religious accuracy
-- May not perform well on non-Islamic topics
+## Note
 
-## License
+While this model may reference Arabic terms and texts, it is designed to:
+- Accept questions in English
+- Provide responses in English
+- Explain Islamic concepts in English
 
-Apache 2.0
-<!-- Last updated: 2025-08-03T10:43:18.421892 -->
+The model has been trained to make Islamic knowledge accessible to English speakers.