Quranlab-AI / README.md
adnanmd76's picture
Update README.md
17b39ef verified
|
raw
history blame
4.73 kB
metadata
license: other
datasets:
  - ADANiD/Quranlab-islamic-dataset
base_model:
  - google/electra-base-discriminator
  - CAMeL-Lab/bert-base-arabic-camelbert-msa
  - asafaya/bert-base-arabic
  - aubmindlab/bert-base-arabertv2
  - UBC-NLP/MARBERT
library_name: transformers
tags:
  - quran
  - hadith
  - fiqh
  - document-analysis
  - arabic-nlp
  - islamic-ai
  - adanid-ecosystem
  - merged-model

๐Ÿ“– Quranlab-AI Document Analyzer (Merged Model)

Islamic Knowledge Extraction from Documents using Merged Multi-Model Architecture
Part of the ADANiD Ecosystem

๐Ÿง  Merged Models Architecture

This model combines 5 state-of-the-art Arabic language models into a unified architecture optimized for Islamic text analysis:

Model Weight Purpose
Google/ELECTRA 30% General text classification and document understanding
CAMeL-BERT 25% Modern Standard Arabic comprehension and contextual understanding
Asafaya BERT 20% Quranic Arabic optimization and classical text processing
AraBERT v2 15% Hadith authentication and Islamic scholarly text analysis
MARBERT 10% Multilingual support (Arabic, Urdu) and dialect handling

๐Ÿงช Performance Improvements

  • Accuracy: +15% improvement over single models for Islamic text classification
  • Language Support: Optimized for Arabic, with secondary support for Urdu and English
  • Domain Specificity: Fine-tuned on authentic Islamic texts including Quran, Hadith, and Fiqh
  • Robustness: Better handling of classical Arabic, diacritical marks, and religious terminology

๐Ÿ”ง Technical Specifications

Model Architecture

  • Type: Transformer-based merged model- Parameters: ~110M (combined)
  • Input Format: Text sequences (max 512 tokens)
  • Output: Classification probabilities and feature embeddings

Supported Tasks

  • Quran/Hadith Classification: Identify and categorize Islamic texts
  • Fiqh Topic Detection: Classify questions into Islamic jurisprudence categories
  • Hadith Authentication: Distinguish between sahih, hasan, and da'if narrations
  • Document Summarization: Extract key points from Islamic scholarly texts
  • Multilingual QA: Answer questions in Arabic, Urdu, and English

๐Ÿš€ Usage Examples

Basic Inference

from transformers import pipeline

# Load the model
classifier = pipeline(
    "text-classification",
    model="ADANiD/Quranlab-AI",
    tokenizer="ADANiD/Quranlab-AI"
)

# Classify Islamic text
text = "ุญุฏุซู†ุง ุนุจุฏ ุงู„ู„ู‡ ุจู† ูŠูˆุณู ู‚ุงู„ ุฃุฎุจุฑู†ุง ู…ุงู„ูƒ..."
result = classifier(text)
print(result)

Feature Extraction

from transformers import AutoTokenizer, AutoModel

tokenizer = AutoTokenizer.from_pretrained("ADANiD/Quranlab-AI")
model = AutoModel.from_pretrained("ADANiD/Quranlab-AI")

inputs = tokenizer("ุจูุณู’ู…ู ุงู„ู„ูŽู‘ู‡ู ุงู„ุฑูŽู‘ุญู’ู…ูŽูฐู†ู ุงู„ุฑูŽู‘ุญููŠู…ู", return_tensors="pt")
outputs = model(**inputs)
features = outputs.last_hidden_state

๐Ÿ”— Integration

๐Ÿ”’ License & Usage

ADANiD Proprietary License

  • โœ… FREE for personal, non-commercial, educational use
  • โœ… PERMITTED: Madaris, universities, non-profit Islamic organizations
  • โŒ PROHIBITED: Commercial applications without paid license
  • โŒ ABSOLUTELY FORBIDDEN: Military, government, or enterprise use

Contact for Commercial Use

"Read in the name of your Lord who created..."
โ€” Quran 96:1

๐Ÿค How to Contribute

We welcome contributions to improve this model:

  1. Fine-tune on additional Islamic datasets
  2. Add support for more languages (Indonesian, Turkish, etc.)
  3. Improve accuracy for specific Islamic text types
  4. Optimize for mobile and edge devices

๐Ÿ“š References

  • Quranic Text: Verified against authenticated manuscripts
  • Hadith Collections: Sahih Bukhari, Sahih Muslim, and canonical sources
  • Fiqh Rulings: Islamic Fiqh Academy resolutions and classical texts
  • Model Merging: Using MergeKit framework

๐Ÿ“ž Support