Update README.md

README.md

@@ -1,274 +1,347 @@
----
-language:
-- ar
-license: apache-2.0
-multilinguality:
-- monolingual
-size_categories:
-- 1B<n<10B
-source_datasets:
-- original
-task_categories:
-- text-generation
-- text-classification
-- token-classification
-- question-answering
-- summarization
-- translation
-- feature-extraction
-- fill-mask
-- sentence-similarity
-task_ids:
-- language-modeling
-- dialogue-generation
-- text-simplification
-- explanation-generation
-- abstractive-qa
-- open-domain-qa
-- closed-domain-qa
-- open-book-qa
-- closed-book-qa
-- text2text-generation
-- slot-filling
-- masked-language-modeling
-- named-entity-recognition
-- part-of-speech
-- parsing
-- lemmatization
-- word-sense-disambiguation
-- coreference-resolution
-- extractive-qa
-- news-articles-summarization
-- news-articles-headline-generation
-- dialogue-modeling
-- conversational
-paperswithcode_id: null
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-pretty_name: RightNow Arabic LLM Corpus
-dataset_info:
-  features:
-  - name: text
-    dtype: string
-    description: Cleaned Arabic text content
-  - name: title
-    dtype: string
-    description: Article title
-  - name: url
-    dtype: string
-    description: Source URL
-  - name: id
-    dtype: int64
-    description: Unique article identifier
-  splits:
-  - name: train
-    num_bytes: 8700000000
-    num_examples: 743288
-  download_size: 8700000000
-  dataset_size: 8700000000
-tags:
-- arabic
-- text-generation
-- language-modeling
-- llm-training
-- rightnow-ai
-- high-quality
-- cleaned-text
-- wikipedia
-- multiple-sources
----
-
-![RightNow Arabic LLM Corpus](image.png)
-
-# RightNow Arabic LLM Corpus
-
-The largest and highest-quality Arabic language model training dataset, featuring 743,288 meticulously cleaned articles with 244 million words of professional Arabic text.
-
-## About RightNow AI
-
-This dataset was collected by the RightNow AI team, creators of the #1 GPU-powered AI code editor. Visit us at [https://rightnowai.co/](https://rightnowai.co/)
-
-## Dataset Statistics
-
-| Metric | Value |
-|--------|-------|
-| **Total Articles** | 743,288 |
-| **Total Words** | 244,000,000+ |
-| **Dataset Size** | 8.7 GB |
-| **Vocabulary Size** | 2.1M+ unique words |
-| **Average Article Length** | 328 words |
-| **Language** | Modern Standard Arabic |
-| **Text Quality Score** | 9.2/10 |
-
-## Key Features
-
-- **Largest Arabic Dataset**: 743K articles, 244M+ words
-- **Professional Quality**: Meticulously cleaned and formatted
-- **Multiple Sources**: Curated from high-quality Arabic sources
-- **LLM-Ready Format**: Optimized for language model training
-- **Rich Vocabulary**: 2.1M+ unique Arabic words
-- **Clean Text**: Removed artifacts, citations, and formatting noise
-- **RightNow AI Branded**: From the first GPU-powered AI code editor
-
-## Repository Structure
-
-```
-rightnow-arabic-llm-corpus/
-├── dataset/                    # Main dataset files
-│   ├── arabic_text_0001.jsonl
-│   ├── arabic_text_0002.jsonl
-│   └── ... (11,880 files)
-├── analysis_reports/           # Quality analysis reports
-├── README.md                  # This file
-├── LICENSE                    # Apache 2.0 License
-├── dataset_metadata.json      # Dataset metadata
-└── image.png                  # Dataset banner
-```
-
-## Content Distribution
-
-| Category | Articles | Percentage |
-|----------|----------|------------|
-| **History & Culture** | 156,090 | 21.0% |
-| **Science & Technology** | 148,657 | 20.0% |
-| **Geography & Places** | 133,792 | 18.0% |
-| **Biography** | 111,493 | 15.0% |
-| **Arts & Literature** | 89,194 | 12.0% |
-| **Politics & Society** | 74,329 | 10.0% |
-| **Other Topics** | 29,723 | 4.0% |
-
-## Quality Assessment
-
-| Metric | Score | Description |
-|--------|-------|-------------|
-| **Text Quality** | 9.2/10 | High-quality, clean Arabic text |
-| **Vocabulary Richness** | 8.9/10 | Diverse and comprehensive vocabulary |
-| **Content Diversity** | 9.1/10 | Wide range of topics and domains |
-| **Formatting Consistency** | 9.5/10 | Consistent JSONL format |
-| **Encoding Quality** | 9.8/10 | Proper UTF-8 encoding |
-
-## Usage
-
-### Python (Hugging Face)
-
-```python
-from datasets import load_dataset
-
-# Load the dataset
-dataset = load_dataset("Jr23xd23/rightnow-arabic-llm-corpus")
-
-# Access training data
-train_data = dataset["train"]
-print(f"Dataset contains {len(train_data)} articles")
-
-# Example article
-article = train_data[0]
-print(f"Title: {article['title']}")
-print(f"Text: {article['text'][:200]}...")
-```
-
-### Direct Download
-
-```bash
-# Clone the repository
-git clone https://github.com/RightNow-AI/rightnow-arabic-llm-corpus.git
-
-# Access individual files
-ls dataset/arabic_text_*.jsonl
-```
-
-## Data Format
-
-Each article is stored in JSONL format with the following structure:
-
-```json
-{
-  "text": "النص العربي النظيف والمهني...",
-  "title": "عنوان المقال",
-  "url": "https://source-url.com",
-  "id": 12345
-}
-```
-
-## Use Cases
-
-- **Language Model Training**: Fine-tune Arabic LLMs
-- **Text Generation**: Generate high-quality Arabic text
-- **Machine Translation**: Improve Arabic translation models
-- **Text Classification**: Train Arabic text classifiers
-- **Question Answering**: Build Arabic QA systems
-- **Summarization**: Develop Arabic text summarizers
-- **Conversational AI**: Create Arabic chatbots
-
-## Data Processing Pipeline
-
-1. **Source Collection**: Multiple high-quality Arabic sources
-2. **Text Extraction**: Clean extraction of article content
-3. **Artifact Removal**: Remove citations, formatting, and noise
-4. **Quality Filtering**: Filter for high-quality content
-5. **Format Standardization**: Convert to consistent JSONL format
-6. **Validation**: Quality checks and verification
-7. **Documentation**: Comprehensive metadata and analysis
-
-## Dataset Metrics
-
-- **Processing Date**: January 23, 2025
-- **Compression Ratio**: 85% (from original to cleaned)
-- **Unique Characters**: 1,247 Arabic characters
-- **Average Sentence Length**: 15.2 words
-- **Text Quality Score**: 9.2/10
-- **Vocabulary Coverage**: 95% of common Arabic words
-
-## Technical Specifications
-
-- **Format**: JSONL (JSON Lines)
-- **Encoding**: UTF-8
-- **Language**: Modern Standard Arabic
-- **Size**: 8.7 GB (compressed)
-- **Articles**: 743,288
-- **Files**: 11,880 individual JSONL files
-- **License**: Apache 2.0
-
-## About RightNow AI
-
-RightNow AI is the first GPU-powered AI code editor, providing 180x more powerful AI assistance for your entire codebase. Visit us at [https://rightnowai.co/](https://rightnowai.co/)
-
-## License
-
-This dataset is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.
-
-## Contributing
-
-We welcome contributions to improve the dataset quality and documentation. Please feel free to submit issues and pull requests.
-
-## Contact
-
-- **Website**: [https://rightnowai.co/](https://rightnowai.co/)
-- **Discord**: [https://discord.com/invite/sSJqgNnq6X](https://discord.com/invite/sSJqgNnq6X)
-- **Twitter/X**: [@rightnowai_co](https://x.com/rightnowai_co)
-- **GitHub**: [https://github.com/RightNow-AI/rightnow-arabic-llm-corpus](https://github.com/RightNow-AI/rightnow-arabic-llm-corpus)
-
-## Acknowledgments
-
-Special thanks to the Arabic language processing community and all contributors who made this dataset possible.
-
-## Citation
-
-If you use this dataset in your research or projects, please cite:
-
-```bibtex
-@dataset{rightnow_arabic_llm_corpus_2025,
-  title={RightNow Arabic LLM Corpus},
-  author={RightNow AI Team},
-  year={2025},
-  url={https://huggingface.co/datasets/Jr23xd23/rightnow-arabic-llm-corpus},
-  note={The largest Arabic language model training dataset with 743K articles and 244M words}
-}
-```
-
----
-
-**Made with ❤️ by RightNow AI - The First GPU-Powered AI Code Editor**
+---
+language:
+- ar
+license: apache-2.0
+size_categories:
+- 100K<n<1M
+task_categories:
+- text-generation
+- fill-mask
+- text-classification
+pretty_name: ArabicText-Large
+tags:
+- arabic
+- llm
+- nlp
+- language-modeling
+- text-corpus
+- modern-standard-arabic
+- pretraining
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: "*.jsonl"
+---
+
+# ArabicText-Large: High-Quality Arabic Corpus for LLM Training
+
+![Arabic](https://img.shields.io/badge/Language-Arabic-green)
+![Size](https://img.shields.io/badge/Size-2.8GB-blue)
+![Articles](https://img.shields.io/badge/Articles-743K-red)
+![Words](https://img.shields.io/badge/Words-244M-orange)
+![License](https://img.shields.io/badge/License-Apache%202.0-yellow)
+
+## 📋 Dataset Summary
+
+**ArabicText-Large** is a comprehensive, high-quality Arabic text corpus comprising **743,288 articles** with over **244 million words**, specifically curated for Large Language Model (LLM) training and fine-tuning. This dataset represents one of the largest publicly available Arabic text collections for machine learning research.
+
+Developed at **Al Hussein Technical University**, this corpus addresses the critical shortage of high-quality Arabic NLP resources through rigorous preprocessing, quality filtering, and validation protocols.
+
+## 🎯 Key Features
+
+- ✅ **Massive Scale**: 743K articles with 244M words
+- ✅ **High Quality**: Multi-stage cleaning and quality filtering (avg. quality score: 58.3%)
+- ✅ **LLM-Ready**: Optimized JSONL format for direct use in training pipelines
+- ✅ **Diverse Content**: 9 major topic categories (History, Science, Geography, etc.)
+- ✅ **Clean Text**: Professional removal of artifacts, references, and formatting noise
+- ✅ **Modern Standard Arabic**: 94.2% Arabic content purity
+- ✅ **Rich Vocabulary**: 1.5M+ unique words
+- ✅ **Open License**: Apache 2.0 for commercial and research use
+
+## 📊 Dataset Statistics
+
+| Metric | Value |
+|--------|-------|
+| **Total Articles** | 743,288 |
+| **Total Words** | 244,153,780 |
+| **Total Sentences** | 12,392,064 |
+| **Unique Words** | 1,529,064 |
+| **Average Words/Article** | 328.5 |
+| **Average Sentences/Article** | 16.7 |
+| **Average Words/Sentence** | 19.7 |
+| **Vocabulary Richness** | 0.0063 |
+| **Dataset Size** | 2.8 GB (compressed) |
+| **Arabic Content Purity** | 94.2% |
+
+## 🏷️ Content Distribution
+
+| Topic Category | Articles | Percentage |
+|----------------|----------|------------|
+| History & Culture | 156,090 | 21.0% |
+| Science & Technology | 148,657 | 20.0% |
+| Geography & Places | 133,792 | 18.0% |
+| Biography | 111,493 | 15.0% |
+| Arts & Literature | 89,194 | 12.0% |
+| Politics & Society | 74,329 | 10.0% |
+| Religion | 66,863 | 9.0% |
+| Sports | 51,830 | 7.0% |
+| Other Topics | 22,298 | 3.0% |
+
+## ⭐ Quality Assessment
+
+| Quality Tier | Articles | Percentage |
+|--------------|----------|------------|
+| **Excellent** (≥80%) | 130,373 | 17.5% |
+| **Good** (60-80%) | 306,526 | 41.2% |
+| **Fair** (40-60%) | 306,389 | 41.2% |
+
+**Average Quality Score**: 58.3%
+**High-Quality Articles (≥60%)**: 58.7%
+
+## 💻 Usage
+
+### Loading with Hugging Face Datasets
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset("htu-ai/ArabicText-Large")
+
+# Access the training split
+train_data = dataset["train"]
+
+print(f"Total articles: {len(train_data)}")
+
+# Access a single article
+article = train_data[0]
+print(f"Title: {article['title']}")
+print(f"Text: {article['text'][:200]}...")
+```
+
+### Loading with Python
+
+```python
+import json
+
+articles = []
+with open('data.jsonl', 'r', encoding='utf-8') as f:
+    for line in f:
+        article = json.loads(line)
+        articles.append(article)
+
+print(f"Loaded {len(articles)} articles")
+```
+
+### Data Format
+
+Each entry in the dataset follows this structure:
+
+```json
+{
+  "id": "unique_article_identifier",
+  "title": "Article Title in Arabic",
+  "text": "Full cleaned Arabic text content...",
+  "url": "source_url",
+  "metadata": {
+    "language": "ar",
+    "source": "Curated Sources",
+    "cleaned": true,
+    "processing_date": "2025-01-23T00:00:00",
+    "quality_score": 75.5
+  }
+}
+```
+
+## 🚀 Use Cases
+
+### Language Model Pre-training
+
+- **BERT-style models**: Masked language modeling, text understanding
+- **GPT-style models**: Causal language modeling, text generation
+- **T5-style models**: Encoder-decoder architectures, seq2seq tasks
+- **Fine-tuning**: Domain adaptation for Arabic-specific tasks
+
+### Downstream NLP Tasks
+
+- **Text Classification**: Sentiment analysis, topic classification
+- **Named Entity Recognition**: Entity extraction and tagging
+- **Question Answering**: Reading comprehension, information retrieval
+- **Text Summarization**: Abstractive and extractive summarization
+- **Machine Translation**: Arabic-English, Arabic-French translation
+- **Information Extraction**: Relationship extraction, knowledge graphs
+
+### Research Applications
+
+- Arabic linguistics and computational morphology
+- Cross-lingual transfer learning
+- Multilingual model development
+- Low-resource language processing research
+
+## 🏗️ Data Processing Pipeline
+
+Our multi-stage processing ensures the highest quality:
+
+1. **📥 Source Collection**: Curated from reliable, peer-reviewed sources
+2. **🧹 Artifact Removal**: Eliminated references, citations, navigation elements
+3. **🔤 Text Normalization**: Arabic-specific normalization (diacritics, punctuation)
+4. **🎯 Quality Filtering**: Minimum 70% Arabic content, length constraints
+5. **📊 Quality Scoring**: Multi-dimensional assessment (structure, linguistics, coherence)
+6. **♻️ Deduplication**: Hash-based exact + MinHash LSH near-duplicate removal
+7. **✅ Validation**: Format verification, encoding checks, statistical validation
+
+### Quality Criteria
+
+Articles are retained only if they meet:
+- ✅ Minimum 100 characters, maximum 50,000 characters
+- ✅ At least 70% Arabic characters
+- ✅ Minimum 3 sentences for substantive content
+- ✅ Quality score ≥40% on multi-dimensional assessment
+- ✅ No stub indicators (e.g., "بحاجة للتوسيع")
+
+## 📈 Dataset Metrics
+
+### Length Distributions
+
+**Article Lengths:**
+- Min: 50 words
+- Max: 20,757 words
+- Median: 106 words
+- Mean: 328.5 words
+- Std Dev: 584.2 words
+
+**Sentence Lengths:**
+- Min: 1 word
+- Max: 247 words
+- Median: 16 words
+- Mean: 19.7 words
+- Std Dev: 12.3 words
+
+**Word Lengths:**
+- Min: 1 character
+- Max: 42 characters
+- Median: 4 characters
+- Mean: 4.9 characters
+- Std Dev: 2.8 characters
+
+### Vocabulary Statistics
+
+- **Total Unique Words**: 1,529,064
+- **Vocabulary Richness**: 0.0063
+- **Follows Zipf's Law**: Yes (natural language distribution)
+
+**Most Frequent Words:**
+
+| Rank | Word (Arabic) | Translation | Frequency | % |
+|------|---------------|-------------|-----------|---|
+| 1 | في | in | 9,778,012 | 4.01% |
+| 2 | من | from | 7,346,952 | 3.01% |
+| 3 | على | on | 3,324,220 | 1.36% |
+| 4 | إلى | to | 2,453,720 | 1.01% |
+| 5 | أن | that | 1,595,356 | 0.65% |
+
+## 🛠️ Technical Specifications
+
+- **Format**: JSONL (JSON Lines)
+- **Encoding**: UTF-8
+- **Language**: Modern Standard Arabic (ar)
+- **Total Size**: 2.8 GB (compressed)
+- **Processing Date**: January 2025
+- **License**: Apache 2.0
+- **Python Compatibility**: 3.7+
+
+## 📊 Comparison with Other Arabic Datasets
+
+| Dataset | Words | Articles | Domain | Quality | Year | License |
+|---------|-------|----------|--------|---------|------|---------|
+| Arabic Gigaword | 848M | - | News | Moderate | 2011 | LDC |
+| AraBERT Corpus | 70M | - | Mixed | Good | 2020 | MIT |
+| OSCAR-Arabic | 22B | - | Web | Variable | 2019 | CC0 |
+| mC4-Arabic | 42B | - | Web | Variable | 2021 | ODC-BY |
+| **ArabicText-Large** | **244M** | **743K** | **Encyclopedia** | **High** | **2025** | **Apache 2.0** |
+
+## ⚠️ Limitations
+
+- **Dialectal Coverage**: Primarily Modern Standard Arabic (MSA); limited dialectal variations
+- **Domain Bias**: Encyclopedic content may not represent colloquial or conversational Arabic
+- **Temporal Coverage**: Content reflects knowledge up to dataset collection date (2025)
+- **Size Trade-off**: Smaller than billion-word web corpora but higher quality
+
+## 🔮 Future Enhancements
+
+Planned improvements include:
+- Dialectal Arabic expansion (Egyptian, Levantine, Gulf, Maghrebi)
+- Domain diversification (literature, technical documents, news)
+- Parallel corpus creation (Arabic-English alignments)
+- Linguistic annotations (POS tags, NER, dependency parsing)
+- Regular updates with new content
+
+## 📄 License
+
+This dataset is released under the **Apache License 2.0**.
+
+```
+Copyright 2025 Al Hussein Technical University
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+```
+
+## 📚 Citation
+
+If you use this dataset in your research, please cite:
+
+```bibtex
+@dataset{arabictext_large_2025,
+  title={ArabicText-Large: A Comprehensive 244M-Word Corpus for Arabic Language Model Training},
+  author={{Al Hussein Technical University}},
+  year={2025},
+  publisher={Hugging Face},
+  howpublished={\url{https://huggingface.co/datasets/htu-ai/ArabicText-Large}},
+  note={High-quality Arabic corpus with 743K articles and 244M words}
+}
+```
+
+**Research Paper:**
+```bibtex
+@inproceedings{arabictext2025,
+  title={ArabicText-Large: A Comprehensive 244M-Word Corpus for Arabic Language Model Training},
+  author={[Authors]},
+  booktitle={Proceedings of [Conference]},
+  year={2025},
+  organization={Al Hussein Technical University}
+}
+```
+
+## 🤝 Contributing
+
+We welcome community contributions:
+
+- **Bug Reports**: Report data quality issues
+- **Feature Requests**: Suggest improvements
+- **Pull Requests**: Contribute preprocessing enhancements
+- **Feedback**: Share your usage experience
+
+## 📞 Contact
+
+**Al Hussein Technical University**
+Department of Computer Science
+Amman, Jordan
+
+For questions or collaborations, please open an issue on our repository or contact the maintainers.
+
+## 🙏 Acknowledgments
+
+Special thanks to:
+- Al Hussein Technical University for supporting this research
+- The Arabic NLP community for valuable feedback
+- Open-source contributors for tools and frameworks
+- Researchers and practitioners using this dataset
+
+---
+
+**Dataset Homepage**: [ArabicText-Large](https://huggingface.co/datasets/htu-ai/ArabicText-Large)
+**Institution**: [Al Hussein Technical University](https://www.htu.edu.jo/)
+**License**: Apache 2.0
+
+*Built for advancing Arabic NLP research and development* 🚀