Update README.md

README.md

@@ -22,6 +22,10 @@ configs:
   data_files:
   - split: train
     path: data/constitution.jsonl
+- config_name: v2
+  data_files:
+  - split: train
+    path: data/constitution_v2_different_table_structure.jsonl
 ---
 
 # Constitution of the Republic of Uzbekistan (Trilingual Dataset)
@@ -35,48 +39,65 @@ This dataset contains the **Constitution of the Republic of Uzbekistan** (New Ed
 
 The data was carefully scraped and processed from the official National Database of Legislation of the Republic of Uzbekistan. It serves as a high-quality parallel corpus for legal NLP tasks, machine translation, and constitutional analysis.
 
-## Dataset Structure
-
-The dataset is provided in **JSONL** format (`constitution.jsonl`). Each row represents a single Article of the constitution, perfectly aligned across all three languages.
+## Dataset Versions
 
-### Data Fields
+This dataset is available in two structural variants to support different use cases.
 
-| Field | Description | Example |
-| :--- | :--- | :--- |
-| `article_number` | The unique number of the article. | `"1"` |
-| `text_uz` | Content of the article in Uzbek. | `"Oʻzbekiston — boshqaruvning..."` |
-| `chapter_uz` | Chapter title in Uzbek (includes context). | `"I bob. Davlat suvereniteti"` |
-| `part_uz` | Part title in Uzbek (includes context). | `"BIRINCHI BOʻLIM. ASOSIY PRINSIPLAR"` |
-| `text_ru` | Content of the article in Russian. | `"Узбекистан — суверенное..."` |
-| `chapter_ru` | Chapter title in Russian. | `"Глава I. Государственный суверенитет"` |
-| `part_ru` | Part title in Russian. | `"РАЗДЕЛ ПЕРВЫЙ. ОСНОВНЫЕ ПРИНЦИПЫ"` |
-| `text_en` | Content of the article in English. | `"Uzbekistan is a sovereign..."` |
-| `chapter_en` | Chapter title in English. | `"Chapter I. State Sovereignty"` |
-| `part_en` | Part title in English. | `"PART ONE. FUNDAMENTAL PRINCIPLES"` |
-
-### Sample Data
+### 1. Default Version (Original Schema)
+*   **File:** `data/constitution.jsonl`
+*   **Description:** In this version, Chapter and Part titles are single strings that include both the numbering (Roman/Word) and the title text.
+*   **Fields:** `article_number`, `text_{lang}`, `chapter_{lang}`, `part_{lang}`.
 
+**Sample Data (V1):**
 ```json
 {
   "article_number": "1",
   "text_uz": "Oʻzbekiston — boshqaruvning respublika shakliga ega boʻlgan suveren, demokratik, huquqiy, ijtimoiy va dunyoviy davlat...",
+  "chapter_uz": "I bob. Davlat suvereniteti",
+  "part_uz": "BIRINCHI BOʻLIM. ASOSIY PRINSIPLAR",
   "text_ru": "Узбекистан — суверенное, демократическое, правовое, социальное и светское государство...",
-  "text_en": "Uzbekistan is a sovereign democratic, legal, social and secular state...",
-  "part_uz": "BIRINCHI BOʻLIM. ASOSIY PRINSIPLAR"
+  "chapter_ru": "Глава I. Государственный суверенитет",
+  "part_ru": "РАЗДЕЛ ПЕРВЫЙ. ОСНОВНЫЕ ПРИНЦИПЫ"
+}
+```
+
+### 2. Alternative Version (Structured Schema)
+*   **File:** `data/constitution_v2_different_table_structure.jsonl`
+*   **Description:** This version provides granular metadata. The Chapter and Part numbering are separated into their own integer columns, leaving the text columns clean.
+*   **Fields:** `article_number`, `text_{lang}`, `chapter_number`, `chapter_{lang}` (text only), `part_number`, `part_{lang}` (text only).
+
+**Sample Data (V2):**
+```json
+{
+  "article_number": 1,
+  "text_uz": "Oʻzbekiston — boshqaruvning respublika shakliga ega boʻlgan suveren, demokratik, huquqiy, ijtimoiy va dunyoviy davlat...",
+  "part_number": 1,
+  "part_uz": "ASOSIY PRINSIPLAR",
+  "chapter_number": 1,
+  "chapter_uz": "Davlat suvereniteti",
+  "part_en": "FUNDAMENTAL PRINCIPLES",
+  "chapter_en": "State Sovereignty"
 }
 ```
 
 ## Usage
 
+You can load specific versions of the dataset using the `data_files` argument.
+
 ### Loading with Hugging Face Datasets
 
 ```python
 from datasets import load_dataset
 
-dataset = load_dataset("sukhrobnurali/uzbek_constitution")
-# dataset = load_dataset("json", data_files="data/constitution.jsonl") # For local loading
+# Option 1: Load the Default Version (V1)
+dataset_v1 = load_dataset("sukhrobnurali/uzbek_constitution", data_files="data/constitution.jsonl")
+print(dataset_v1["train"][0]["chapter_uz"]) 
+# Output: "I bob. Davlat suvereniteti"
 
-print(dataset["train"][0])
+# Option 2: Load the Structured Version (V2)
+dataset_v2 = load_dataset("sukhrobnurali/uzbek_constitution", data_files="data/constitution_v2_different_table_structure.jsonl")
+print(dataset_v2["train"][0]["chapter_number"]) 
+# Output: 1
 ```
 
 ### Applications
@@ -87,4 +108,4 @@ print(dataset["train"][0])
 
 ## License
 
-This dataset is a derivative work of public legal documents. According to the Law of the Republic of Uzbekistan "On Copyright and Related Rights" (Article 8), official documents (laws, resolutions, decisions, etc.) and their official translations are not objects of copyright.
+This dataset is a derivative work of public legal documents. According to the Law of the Republic of Uzbekistan "On Copyright and Related Rights" (Article 8), official documents (laws, resolutions, decisions, etc.) and their official translations are not objects of copyright.