Update README.md

README.md

@@ -8,228 +8,227 @@ tags:
 task_categories:
   - text-classification
 task_ids:
-  - emotion-detection
+  - multi-label-classification # Corrected from "emotion-detection"
 multilinguality:
   - multilingual
-# List every language code that has a config
-# Based on the dataset_info provided
 language:
-  - afr   # Afrikaans
-  - amh   # Amharic
-  - arq   # Algerian Arabic
-  - ary   # Moroccan Arabic
-  - chn   # Mandarin Chinese
-  - deu   # German
-  - eng   # English
-  - esp   # Spanish (LatAm)
-  - hau   # Hausa
-  - hin   # Hindi
-  - ibo   # Igbo
-  - ind   # Indonesian
-  - jav   # Javanese
-  - kin   # Kinyarwanda
-  - mar   # Marathi
-  - orm   # Oromo
-  - pcm   # Nigerian-Pidgin
-  - ron   # Romanian
-  - rus   # Russian
-  - som   # Somali
-  - sun   # Sundanese
-  - swa   # Swahili
-  - swe   # Swedish
-  - tat   # Tatar
-  - tir   # Tigrinya
-  - ukr   # Ukrainian
-  - vmw   # Emakhuwa
-  - xho   # isiXhosa
-  - yor   # Yoruba
-  - zul   # isiZulu
+  - afr
+  - amh
+  - arq
+  - ary
+  - chn
+  - deu
+  - eng
+  - esp
+  - hau
+  - hin
+  - ibo
+  - ind
+  - jav
+  - kin
+  - mar
+  - orm
+  - pcm
+  # - ptbr # Removed
+  # - ptmz # Removed
+  - ron
+  - rus
+  - som
+  - sun
+  - swa
+  - swe
+  - tat
+  - tir
+  - ukr
+  - vmw
+  - xho
+  - yor
+  - zul
 
 # ---------- DATA FILE LOCATIONS ----------
-#  Only dev (=validation) and test splits are available for Track C.
-#  The files are pushed as Parquet/Arrow by default and might be sharded.
-#  The glob pattern '-*' accounts for potential sharding (e.g., validation-00000-of-00001.parquet).
+# File structure is: <lang_code>/<split_name>-*.parquet
+# Example: amh/test-00000-of-00001-c735adead5699b31.parquet
 configs:
 - config_name: afr
   data_files:
     - split: validation
-      path: data/afr/validation-*
+      path: afr/validation-*
     - split: test
-      path: data/afr/test-*
+      path: afr/test-*
 - config_name: amh
   data_files:
     - split: validation
-      path: data/amh/validation-*
+      path: amh/validation-*
     - split: test
-      path: data/amh/test-*
+      path: amh/test-*
 - config_name: arq
   data_files:
     - split: validation
-      path: data/arq/validation-*
+      path: arq/validation-*
     - split: test
-      path: data/arq/test-*
+      path: arq/test-*
 - config_name: ary
   data_files:
     - split: validation
-      path: data/ary/validation-*
+      path: ary/validation-*
     - split: test
-      path: data/ary/test-*
+      path: ary/test-*
 - config_name: chn
   data_files:
     - split: validation
-      path: data/chn/validation-*
+      path: chn/validation-*
     - split: test
-      path: data/chn/test-*
+      path: chn/test-*
 - config_name: deu
   data_files:
     - split: validation
-      path: data/deu/validation-*
+      path: deu/validation-*
     - split: test
-      path: data/deu/test-*
+      path: deu/test-*
 - config_name: eng
   data_files:
     - split: validation
-      path: data/eng/validation-*
+      path: eng/validation-*
     - split: test
-      path: data/eng/test-*
+      path: eng/test-*
 - config_name: esp
   data_files:
     - split: validation
-      path: data/esp/validation-*
+      path: esp/validation-*
     - split: test
-      path: data/esp/test-*
+      path: esp/test-*
 - config_name: hau
   data_files:
     - split: validation
-      path: data/hau/validation-*
+      path: hau/validation-*
     - split: test
-      path: data/hau/test-*
+      path: hau/test-*
 - config_name: hin
   data_files:
     - split: validation
-      path: data/hin/validation-*
+      path: hin/validation-*
     - split: test
-      path: data/hin/test-*
+      path: hin/test-*
 - config_name: ibo
   data_files:
     - split: validation
-      path: data/ibo/validation-*
+      path: ibo/validation-*
     - split: test
-      path: data/ibo/test-*
+      path: ibo/test-*
 - config_name: ind
   data_files:
     - split: validation
-      path: data/ind/validation-*
+      path: ind/validation-*
     - split: test
-      path: data/ind/test-*
+      path: ind/test-*
 - config_name: jav
   data_files:
     - split: validation
-      path: data/jav/validation-*
+      path: jav/validation-*
     - split: test
-      path: data/jav/test-*
+      path: jav/test-*
 - config_name: kin
   data_files:
     - split: validation
-      path: data/kin/validation-*
+      path: kin/validation-*
     - split: test
-      path: data/kin/test-*
+      path: kin/test-*
 - config_name: mar
   data_files:
     - split: validation
-      path: data/mar/validation-*
+      path: mar/validation-*
     - split: test
-      path: data/mar/test-*
+      path: mar/test-*
 - config_name: orm
   data_files:
     - split: validation
-      path: data/orm/validation-*
+      path: orm/validation-*
     - split: test
-      path: data/orm/test-*
+      path: orm/test-*
 - config_name: pcm
   data_files:
     - split: validation
-      path: data/pcm/validation-*
+      path: pcm/validation-*
     - split: test
-      path: data/pcm/test-*
+      path: pcm/test-*
 - config_name: ron
   data_files:
     - split: validation
-      path: data/ron/validation-*
+      path: ron/validation-*
     - split: test
-      path: data/ron/test-*
+      path: ron/test-*
 - config_name: rus
   data_files:
     - split: validation
-      path: data/rus/validation-*
+      path: rus/validation-*
     - split: test
-      path: data/rus/test-*
+      path: rus/test-*
 - config_name: som
   data_files:
     - split: validation
-      path: data/som/validation-*
+      path: som/validation-*
     - split: test
-      path: data/som/test-*
+      path: som/test-*
 - config_name: sun
   data_files:
     - split: validation
-      path: data/sun/validation-*
+      path: sun/validation-*
     - split: test
-      path: data/sun/test-*
+      path: sun/test-*
 - config_name: swa
   data_files:
     - split: validation
-      path: data/swa/validation-*
+      path: swa/validation-*
     - split: test
-      path: data/swa/test-*
+      path: swa/test-*
 - config_name: swe
   data_files:
     - split: validation
-      path: data/swe/validation-*
+      path: swe/validation-*
     - split: test
-      path: data/swe/test-*
+      path: swe/test-*
 - config_name: tat
   data_files:
     - split: validation
-      path: data/tat/validation-*
+      path: tat/validation-*
     - split: test
-      path: data/tat/test-*
+      path: tat/test-*
 - config_name: tir
   data_files:
     - split: validation
-      path: data/tir/validation-*
+      path: tir/validation-*
     - split: test
-      path: data/tir/test-*
+      path: tir/test-*
 - config_name: ukr
   data_files:
     - split: validation
-      path: data/ukr/validation-*
+      path: ukr/validation-*
     - split: test
-      path: data/ukr/test-*
+      path: ukr/test-*
 - config_name: vmw
   data_files:
     - split: validation
-      path: data/vmw/validation-*
+      path: vmw/validation-*
     - split: test
-      path: data/vmw/test-*
+      path: vmw/test-*
 - config_name: xho
   data_files:
     - split: validation
-      path: data/xho/validation-*
+      path: xho/validation-*
     - split: test
-      path: data/xho/test-*
+      path: xho/test-*
 - config_name: yor
   data_files:
     - split: validation
-      path: data/yor/validation-*
+      path: yor/validation-*
     - split: test
-      path: data/yor/test-*
+      path: yor/test-*
 - config_name: zul
   data_files:
     - split: validation
-      path: data/zul/validation-*
+      path: zul/validation-*
     - split: test
-      path: data/zul/test-*
+      path: zul/test-*
 ---
 
 # Dataset Card for **EmotionAnalysisFinal**
@@ -247,4 +246,32 @@ Each language-specific configuration (subset) contains `validation` and `test` s
 
 ## Languages and Configuration Names
 
-The dataset supports the following languages, accessible via their ISO 639-3 or custom codes as configuration names:
+The dataset supports the following languages, accessible via their ISO 639-3 or custom codes as configuration names:
+
+`afr, amh, arq, ary, chn, deu, eng, esp, hau, hin, ibo, ind, jav, kin, mar, orm, pcm, ron, rus, som, sun, swa, swe, tat, tir, ukr, vmw, xho, yor, zul`
+
+## How to Use
+
+Load a specific language and split using `load_dataset`:
+
+```python
+from datasets import load_dataset
+
+# Example: Load the Yoruba test split
+lang_code = "yor" # Replace with desired language code
+split_name = "test" # Or "validation"
+
+ds = load_dataset(
+    "llama-lang-adapt/EmotionAnalysisFinal",
+    name=lang_code,  # Configuration name (language code)
+    split=split_name
+)
+
+# Print the first example
+print(f"First example from {lang_code} {split_name} split:")
+print(ds[0])
+
+# Example: Load the Afrikaans validation split
+ds_afr_val = load_dataset("llama-lang-adapt/EmotionAnalysisFinal", "afr", split="validation")
+print(f"\nFirst example from afr validation split:")
+print(ds_afr_val[0])