Quranlab-AI / README.md
adnanmd76's picture
Update README.md
da074eb verified
---
license: other
datasets:
- ADANiD/Quranlab-islamic-dataset
base_model: aubmindlab/bert-base-arabertv2
library_name: transformers
tags:
- quran
- hadith
- fiqh
- document-analysis
- arabic-nlp
- islamic-ai
- adanid-ecosystem
- tajweed-analysis
- abjad-validation
- jannah-points
---
# πŸŒ™ Allah QuranLab-AI: Islamic Knowledge Extraction System
> **World's first AI system for comprehensive Islamic knowledge extraction with Tajweed analysis and Abjad validation**
## 🧠 Enhanced Capabilities
- **Quranic Analysis**: Recitation, Tajweed correction, Abjad validation with Jannah Points
- **Hadith Processing**: Authentication, classification, isnad analysis with Sahih collections
- **Fiqh Understanding**: Multi-madhhab rulings (Hanafi, Shafi'i) with contemporary issues
- **Multilingual Support**: Arabic, Urdu, English with proper diacritics handling
- **Ethical Compliance**: Quranic principles built-in with ADANiD proprietary license
- **7 Qira'at Support**: All major recitation styles with real-time feedback
## πŸ”§ Technical Integration
### As Base Model
```python
from transformers import AutoModelForSequenceClassification, AutoTokenizer
model = AutoModelForSequenceClassification.from_pretrained("ADANiD/Quranlab-AI")
tokenizer = AutoTokenizer.from_pretrained("ADANiD/Quranlab-AI")
```
### For Fine-tuning
```python
from datasets import load_dataset
dataset = load_dataset("ADANiD/Quranlab-islamic-dataset")
# Your fine-tuning code here
```
### API Integration
```python
from fastapi import FastAPI
app = FastAPI()
@app.post("/analyze-quran")
async def analyze_quran(text: str):
inputs = tokenizer(text, return_tensors="pt")
outputs = model(**inputs)
return {
"classification": outputs.logits.argmax().item(),
"jannah_points": calculate_jannah_points(outputs.logits)
}
```
## πŸ”— Ecosystem Integration
- **GitHub Repository**: [ADANiD-AI/adan-id-opencloud](https://github.com/ADANiD-AI/adan-id-opencloud)
- **Hugging Face Dataset**: [ADANiD/Quranlab-islamic-dataset](https://huggingface.co/datasets/ADANiD/Quranlab-islamic-dataset)
- **Live Demo**: [Quranlab Demo Space](https://huggingface.co/spaces/ADANiD/quranlab-demo)
- **Kaggle Dataset**: [nooreabjad-dataset](https://www.kaggle.com/datasets/adnanmd76/nooreabjad-dataset)
## πŸ”’ ADANiD Proprietary License
- βœ… **FREE** for educational, non-commercial use
- βœ… **PERMITTED**: Madaris, universities, non-profit Islamic organizations
- βœ… **ALLOWED**: Personal spiritual development and Quranic recitation practice
- ❌ **PROHIBITED**: Commercial applications without paid license
- ❌ **ABSOLUTELY FORBIDDEN**: Military, government, or enterprise use
> **"And We have certainly made the Qur'an easy for remembrance..." β€” Quran 54:17**
> **"Read in the name of your Lord who created..." β€” Quran 96:1**
**Built by Muhammad Adnan Ul Mustafa**