Update README.md

README.md

@@ -1,38 +1,286 @@
 ---
-dataset_info:
-  features:
-  - name: id
-    dtype: string
-  - name: text
-    dtype: string
-  - name: anger
-    dtype: int64
-  - name: disgust
-    dtype: int64
-  - name: fear
-    dtype: int64
-  - name: joy
-    dtype: int64
-  - name: sadness
-    dtype: int64
-  - name: emotions
-    sequence: string
-  - name: surprise
-    dtype: int64
-  splits:
-  - name: validation
-    num_bytes: 2091334
-    num_examples: 9913
-  - name: test
-    num_bytes: 9554908
-    num_examples: 43882
-  download_size: 5121720
-  dataset_size: 11646242
+# ---------- REQUIRED METADATA ----------
+license: cc-by-sa-4.0
+pretty_name: EmotionAnalysisFinal
+tags:
+  - semeval-2025-task-11
+  - cross-lingual-emotion-detection
+task_categories:
+  - text-classification
+task_ids:
+  - multi-label-classification # Corrected
+multilinguality:
+  - multilingual
+language:
+  - 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
+
+# ---------- DATA FILE LOCATIONS ----------
+# This block is good for documentation and Hub UI understanding.
+# If a .py loading script (e.g., emotion_analysis_final.py) exists in the repo,
+# it will take precedence for `load_dataset`.
+# Paths are relative to the root of the dataset repository.
 configs:
-- config_name: default
+- config_name: afr
   data_files:
-  - split: validation
-    path: data/validation-*
-  - split: test
-    path: data/test-*
+    - split: validation
+      path: afr/validation-* 
+    - split: test
+      path: afr/test-*
+- config_name: amh
+  data_files:
+    - split: validation
+      path: amh/validation-*
+    - split: test
+      path: amh/test-*
+- config_name: arq
+  data_files:
+    - split: validation
+      path: arq/validation-*
+    - split: test
+      path: arq/test-*
+- config_name: ary
+  data_files:
+    - split: validation
+      path: ary/validation-*
+    - split: test
+      path: ary/test-*
+- config_name: chn
+  data_files:
+    - split: validation
+      path: chn/validation-*
+    - split: test
+      path: chn/test-*
+- config_name: deu
+  data_files:
+    - split: validation
+      path: deu/validation-*
+    - split: test
+      path: deu/test-*
+- config_name: eng
+  data_files:
+    - split: validation
+      path: eng/validation-*
+    - split: test
+      path: eng/test-*
+- config_name: esp
+  data_files:
+    - split: validation
+      path: esp/validation-*
+    - split: test
+      path: esp/test-*
+- config_name: hau
+  data_files:
+    - split: validation
+      path: hau/validation-*
+    - split: test
+      path: hau/test-*
+- config_name: hin
+  data_files:
+    - split: validation
+      path: hin/validation-*
+    - split: test
+      path: hin/test-*
+- config_name: ibo
+  data_files:
+    - split: validation
+      path: ibo/validation-*
+    - split: test
+      path: ibo/test-*
+- config_name: ind
+  data_files:
+    - split: validation
+      path: ind/validation-*
+    - split: test
+      path: ind/test-*
+- config_name: jav
+  data_files:
+    - split: validation
+      path: jav/validation-*
+    - split: test
+      path: jav/test-*
+- config_name: kin
+  data_files:
+    - split: validation
+      path: kin/validation-*
+    - split: test
+      path: kin/test-*
+- config_name: mar
+  data_files:
+    - split: validation
+      path: mar/validation-*
+    - split: test
+      path: mar/test-*
+- config_name: orm
+  data_files:
+    - split: validation
+      path: orm/validation-*
+    - split: test
+      path: orm/test-*
+- config_name: pcm
+  data_files:
+    - split: validation
+      path: pcm/validation-*
+    - split: test
+      path: pcm/test-*
+- config_name: ron
+  data_files:
+    - split: validation
+      path: ron/validation-*
+    - split: test
+      path: ron/test-*
+- config_name: rus
+  data_files:
+    - split: validation
+      path: rus/validation-*
+    - split: test
+      path: rus/test-*
+- config_name: som
+  data_files:
+    - split: validation
+      path: som/validation-*
+    - split: test
+      path: som/test-*
+- config_name: sun
+  data_files:
+    - split: validation
+      path: sun/validation-*
+    - split: test
+      path: sun/test-*
+- config_name: swa
+  data_files:
+    - split: validation
+      path: swa/validation-*
+    - split: test
+      path: swa/test-*
+- config_name: swe
+  data_files:
+    - split: validation
+      path: swe/validation-*
+    - split: test
+      path: swe/test-*
+- config_name: tat
+  data_files:
+    - split: validation
+      path: tat/validation-*
+    - split: test
+      path: tat/test-*
+- config_name: tir
+  data_files:
+    - split: validation
+      path: tir/validation-*
+    - split: test
+      path: tir/test-*
+- config_name: ukr
+  data_files:
+    - split: validation
+      path: ukr/validation-*
+    - split: test
+      path: ukr/test-*
+- config_name: vmw
+  data_files:
+    - split: validation
+      path: vmw/validation-*
+    - split: test
+      path: vmw/test-*
+- config_name: xho
+  data_files:
+    - split: validation
+      path: xho/validation-*
+    - split: test
+      path: xho/test-*
+- config_name: yor
+  data_files:
+    - split: validation
+      path: yor/validation-*
+    - split: test
+      path: yor/test-*
+- config_name: zul
+  data_files:
+    - split: validation
+      path: zul/validation-*
+    - split: test
+      path: zul/test-*
 ---
+
+# Dataset Card for **EmotionAnalysisFinal**
+
+`EmotionAnalysisFinal` is the official dataset for **SemEval-2025 Task 11, Track C: Cross-lingual Emotion Detection in Social Media Text**.
+This dataset comprises multilingual social media posts annotated for six basic emotions: anger, disgust, fear, joy, sadness, and surprise.
+The annotation schema is multi-label.
+
+Each language-specific configuration (subset) contains `validation` and `test` splits.
+
+| Split        | Original Source | Notes                                      |
+|--------------|-----------------|--------------------------------------------|
+| `validation` | `dev` CSV files | Used as development set during the task    |
+| `test`       | `test` CSV files| Gold labels released after task evaluation |
+
+## Languages and Configuration Names
+
+The dataset supports the following languages, accessible via their ISO 639-3 or custom codes as configuration names (which correspond to the `name` parameter in `load_dataset` if using the accompanying Python loading script, or the second argument if loading via metadata only):
+
+`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
+repo_id = "llama-lang-adapt/EmotionAnalysisFinal"
+lang_code = "yor" # Replace with desired language code
+split_name = "test" # Or "validation"
+
+# If a .py loading script (e.g., emotion_analysis_final.py) is present in the repo,
+# 'load_dataset' will use it. The 'name' parameter corresponds to the config name.
+ds = load_dataset(
+    repo_id,
+    name=lang_code,  # Configuration name (language code)
+    split=split_name
+)
+
+# Print the first example
+print(f"First example from {lang_code} {split_name} split:")
+if len(ds) > 0:
+    print(ds[0])
+else:
+    print("Dataset is empty or loading failed for the split.")
+
+# Example: Load the Afrikaans validation split
+ds_afr_val = load_dataset(repo_id, name="afr", split="validation")
+print(f"\nFirst example from afr validation split:")
+if len(ds_afr_val) > 0:
+    print(ds_afr_val[0])
+else:
+    print("Dataset is empty or loading failed for the split.")