Update README.md

README.md

@@ -1,57 +1,164 @@
 ---
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: text
-    dtype: string
-  - name: entities
-    list:
-    - name: confidence
-      dtype: float64
-    - name: end
-      dtype: int64
-    - name: id
-      dtype: int64
-    - name: label
-      dtype: string
-    - name: start
-      dtype: int64
-    - name: text
-      dtype: string
-  - name: relations
-    list:
-    - name: confidence
-      dtype: float64
-    - name: head
-      dtype: string
-    - name: relation
-      dtype: string
-    - name: tail
-      dtype: string
-  - name: legal_concepts
-    list: string
-  - name: metadata
-    struct:
-    - name: article_number
-      dtype: string
-    - name: document_title
-      dtype: string
-    - name: entity_density
-      dtype: float64
-    - name: hierarchy
-      dtype: string
-    - name: relation_density
-      dtype: float64
-  splits:
-  - name: train
-    num_bytes: 853274
-    num_examples: 1046
-  download_size: 245781
-  dataset_size: 853274
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+license: apache-2.0
+task_categories:
+- token-classification
+language:
+- ar
+tags:
+- legal
+- arabic
+- egypt
+- egyptian-law
+- ner
+- legal-entities
+- token-classification
+size_categories:
+- 1K<n<10K
 ---
+
+# Arabic Legal Dataset - Legal Named Entity Recognition
+
+## Dataset Description
+
+Named entity recognition dataset for Arabic legal texts with specialized legal entity types and relationships.
+
+This dataset contains 1,046 examples of ner data derived from Egyptian legal texts, including criminal law, civil law, procedural law, and personal status law. The dataset is designed for training and evaluating Arabic legal AI models.
+
+### Dataset Summary
+
+- **Language**: Arabic (Egyptian Legal)
+- **Domain**: Legal texts and jurisprudence
+- **Task**: token-classification
+- **Size**: 1,046 examples (1.6 MB)
+- **Source**: Egyptian legal codes and statutes
+
+## Dataset Structure
+
+### Data Fields
+
+- **text**: Arabic legal text with entities
+- **entities**: List of legal entities with positions and types
+- **relations**: Relationships between entities
+- **legal_concepts**: Associated legal concepts
+
+### Data Example
+
+```json
+{
+  "text": "نصت محكمة النقض المصرية في الطعن رقم 123 لسنة 2023",
+  "entities": [
+    {
+      "text": "محكمة النقض المصرية",
+      "label": "COURT",
+      "start": 4,
+      "end": 25
+    },
+    {
+      "text": "الطعن رقم 123",
+      "label": "CASE_NUMBER",
+      "start": 29,
+      "end": 42
+    }
+  ],
+  "relations": [
+    {
+      "head": 0,
+      "tail": 1,
+      "relation": "CASE_COURT"
+    }
+  ]
+}
+```
+
+### Data Statistics
+
+| Statistic | Value |
+|-----------|-------|
+| Total Examples | 1,046 |
+| Average Text Length | 281 characters |
+| Vocabulary Size | ~7,222 unique terms |
+| Dataset Size | 1.6 MB |
+
+
+### Legal Domain Coverage
+
+This dataset covers the following areas of Egyptian law: Criminal Law, Labor Law, Civil Law, Administrative Law.
+
+
+## Usage
+
+### Loading the Dataset
+
+```python
+from datasets import load_dataset
+
+dataset = load_dataset("fr3on/eg-legal-ner")
+
+# Print basic info
+print(f"Number of examples: {len(dataset['train'])}")
+print(f"Features: {dataset['train'].features}")
+
+# View first example
+print(dataset['train'][0])
+```
+
+### Example Use Cases
+
+- Training legal entity extraction models
+- Building legal knowledge graphs
+- Automated legal document indexing
+- Legal research and analysis tools
+
+## Dataset Creation
+
+### Source Data
+
+This dataset was created from Egyptian legal texts including:
+
+- **Criminal Procedure Law** (قانون الإجراءات الجنائية) - 498 articles
+- **Personal Status Law** (قانون الأحوال الشخصية) - 51 articles
+- **Penal Code** (قانون العقوبات) - 497 articles
+
+### Data Processing
+
+1. **Text Extraction**: Legal articles extracted from official JSON sources
+2. **Structure Parsing**: Hierarchical legal structure preserved
+3. **Schema Conversion**: Converted to ner format
+4. **Quality Control**: Validated for consistency and proper Arabic encoding
+
+## Considerations for Use
+
+### Intended Use
+
+This dataset is intended for:
+- Research in Arabic natural language processing
+- Training legal AI models for Arabic text
+- Educational purposes in computational linguistics
+- Development of legal technology applications
+
+### Limitations
+
+- Contains only Egyptian legal texts (may not generalize to other Arabic legal systems)
+- Reflects the specific legal framework and language of Egyptian law
+- Should not be used as a substitute for professional legal advice
+- May contain biases present in the original legal texts
+
+## Citation
+
+```bibtex
+@dataset{arabic_legal_ner_2025,
+  title={Arabic Legal Dataset - Legal Named Entity Recognition},
+  author={fr3on},
+  year={2025},
+  publisher={Hugging Face},
+  url={https://huggingface.co/datasets/fr3on/eg-legal-ner}
+}
+```
+
+## License
+
+This dataset is released under the Apache 2.0 License. The original legal texts are public domain.
+
+## Acknowledgments
+
+Created by [fr3on](https://huggingface.co/fr3on) as part of efforts to advance Arabic legal AI research.