Text Generation
Transformers
Safetensors
English
t5
text2text-generation
english
quran
islamic
religious-texts
question-answering
text-generation-inference
Instructions to use justdeen/QuranPlus with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use justdeen/QuranPlus with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="justdeen/QuranPlus")# Load model directly from transformers import AutoTokenizer, AutoModelForSeq2SeqLM tokenizer = AutoTokenizer.from_pretrained("justdeen/QuranPlus") model = AutoModelForSeq2SeqLM.from_pretrained("justdeen/QuranPlus") - Notebooks
- Google Colab
- Kaggle
- Local Apps
- vLLM
How to use justdeen/QuranPlus with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "justdeen/QuranPlus" # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:8000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "justdeen/QuranPlus", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker
docker model run hf.co/justdeen/QuranPlus
- SGLang
How to use justdeen/QuranPlus with SGLang:
Install from pip and serve model
# Install SGLang from pip: pip install sglang # Start the SGLang server: python3 -m sglang.launch_server \ --model-path "justdeen/QuranPlus" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "justdeen/QuranPlus", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }'Use Docker images
docker run --gpus all \ --shm-size 32g \ -p 30000:30000 \ -v ~/.cache/huggingface:/root/.cache/huggingface \ --env "HF_TOKEN=<secret>" \ --ipc=host \ lmsysorg/sglang:latest \ python3 -m sglang.launch_server \ --model-path "justdeen/QuranPlus" \ --host 0.0.0.0 \ --port 30000 # Call the server using curl (OpenAI-compatible API): curl -X POST "http://localhost:30000/v1/completions" \ -H "Content-Type: application/json" \ --data '{ "model": "justdeen/QuranPlus", "prompt": "Once upon a time,", "max_tokens": 512, "temperature": 0.5 }' - Docker Model Runner
How to use justdeen/QuranPlus with Docker Model Runner:
docker model run hf.co/justdeen/QuranPlus
# Load model directly
from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
tokenizer = AutoTokenizer.from_pretrained("justdeen/QuranPlus")
model = AutoModelForSeq2SeqLM.from_pretrained("justdeen/QuranPlus")Quick Links
QuranPlus - English Language Islamic Q&A Model
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 Details
- 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
You can ask questions in English and receive answers in English:
from transformers import T5ForConditionalGeneration, T5Tokenizer
model = T5ForConditionalGeneration.from_pretrained("justdeen/QuranPlus")
tokenizer = T5Tokenizer.from_pretrained("justdeen/QuranPlus")
# 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)
Example Questions
- "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?"
Note
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
The model has been trained to make Islamic knowledge accessible to English speakers.
- Downloads last month
- 14
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="justdeen/QuranPlus")