Update README.md

README.md

@@ -5,71 +5,69 @@ language:
 pretty_name: XNLI EU
 size_categories:
 - 1K<n<10K
-
 dataset_info:
-  - config_name: eu
-    features:
-      - name: premise
-        dtype: string
-      - name: hypothesis
-        dtype: string
-      - name: label
-        dtype:
-          class_label:
-            names:
-              0: entailment
-              1: neutral
-              2: contradiction
-  - config_name: eu_mt
-    features:
-      - name: premise
-        dtype: string
-      - name: hypothesis
-        dtype: string
-      - name: label
-        dtype:
-          class_label:
-            names:
-              0: entailment
-              1: neutral
-              2: contradiction
-  - config_name: eu_native
-    features:
-      - name: premise
-        dtype: string
-      - name: hypothesis
-        dtype: string
-      - name: label
-        dtype:
-          class_label:
-            names:
-              0: entailment
-              1: neutral
-              2: contradiction
-  
+- config_name: eu
+  features:
+  - name: premise
+    dtype: string
+  - name: hypothesis
+    dtype: string
+  - name: label
+    dtype:
+      class_label:
+        names:
+          '0': entailment
+          '1': neutral
+          '2': contradiction
+- config_name: eu_mt
+  features:
+  - name: premise
+    dtype: string
+  - name: hypothesis
+    dtype: string
+  - name: label
+    dtype:
+      class_label:
+        names:
+          '0': entailment
+          '1': neutral
+          '2': contradiction
+- config_name: eu_native
+  features:
+  - name: premise
+    dtype: string
+  - name: hypothesis
+    dtype: string
+  - name: label
+    dtype:
+      class_label:
+        names:
+          '0': entailment
+          '1': neutral
+          '2': contradiction
 configs:
-  - config_name: eu
-    data_files:
-      - split: train
-        path: "xnli.train.eu.mt.tsv"
-      - split: validation
-        path: "xnli.dev.eu.tsv"
-      - split: test
-        path: "xnli.test.eu.tsv"
-  - config_name: eu_mt
-    data_files:
-      - split: train
-        path: "xnli.train.eu.mt.tsv"
-      - split: validation
-        path: "xnli.dev.eu.mt.tsv"
-      - split: test
-        path: "xnli.test.eu.mt.tsv"
-  - config_name: eu_native
-    data_files:
-      - split: test
-        path: "xnli.test.eu.native.tsv"
-
-
+- config_name: eu
+  data_files:
+  - split: train
+    path: xnli.train.eu.mt.tsv
+  - split: validation
+    path: xnli.dev.eu.tsv
+  - split: test
+    path: xnli.test.eu.tsv
+- config_name: eu_mt
+  data_files:
+  - split: train
+    path: xnli.train.eu.mt.tsv
+  - split: validation
+    path: xnli.dev.eu.mt.tsv
+  - split: test
+    path: xnli.test.eu.mt.tsv
+- config_name: eu_native
+  data_files:
+  - split: test
+    path: xnli.test.eu.native.tsv
+task_categories:
+- text-classification
 ---
 # Dataset Card for XNLIeu
 
@@ -82,29 +80,30 @@ XNLIeu is an extension of [XNLI](https://huggingface.co/datasets/xnli) translate
 ### Dataset Description
 
 <!-- Provide a longer summary of what this dataset is. -->
+XNLI is a popular Natural Language Inference (NLI) benchmark widely used to evaluate cross-lingual Natural Language Understanding (NLU) capabilities across languages. 
+We expand XNLI to include Basque, a low-resource language that can greatly benefit from transfer-learning approaches. 
+The new dataset, dubbed XNLIeu, has been developed by first machine-translating the English XNLI corpus into Basque, followed by a manual post-edition step.
 
-
-
-- **Curated by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
 - **Language(s) (NLP):** Basque (eu)
-- **License:** [More Information Needed]
+- **License:** XNLIeu is derived from XNLI and distributed under its same license. 
 
 ### Dataset Sources [optional]
 
 <!-- Provide the basic links for the dataset. -->
 
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
+- **Repository:** [Link to the GitHub Repository](https://github.com/hitz-zentroa/xnli-eu/)
+- **Paper:** [More Information Needed]
 
 ## Uses
 
 XNLieu is meant as an cross-lingual evaluation dataset. It can be used in combination with the train sets of [XNLI](https://huggingface.co/datasets/xnli) for a cross-lingual zero-shot setting, and we provide a machine-translated train set in both "eu" and "eu_mt" splits to implement a translate-train setting.
 
 ## Dataset Structure
+The dataset has three subsets:
+- **eu**: XNLIeu, machine-translated and post-edited from English to Basque.
+- **eu_MT**: XNLIeu<sub>MT</sub>, a machine-translated version prior post-edition.
+- **eu_native**: An original, non-translated test set.
+
 
 ### Splits
 
@@ -118,11 +117,9 @@ XNLieu is meant as an cross-lingual evaluation dataset. It can be used in combin
 ### Dataset Fields
 
 All splits have the same fields: *premise*, *hypothesis* and *label*.
-<ul>
-<li> premise: a string variable.</li>
-<li> hypothesis: a string variable.</li>
-<li> label: a classification label, with possible values including entailment (0), neutral (1), contradiction (2).</li>
-</ul>
+- **premise**: a string variable.
+- **hypothesis**: a string variable.
+- **label**: a classification label, with possible values including entailment (0), neutral (1), contradiction (2).
 
 ### Dataset Instances
 
@@ -137,49 +134,11 @@ An example from the "eu" split:
 ```
 
 
-## Dataset Creation
-
-### Curation Rationale
-
-<!-- Motivation for the creation of this dataset. -->
-
-[More Information Needed]
-
-### Source Data
-
-<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
-
-#### Data Collection and Processing
-
-<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
-
-[More Information Needed]
-
-#### Who are the source data producers?
-
-<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
-
-[More Information Needed]
-
-
-
-
 
 ## Bias, Risks, and Limitations
 
 <!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
-
-### Recommendations
-
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
-Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
-
-
-
-
+The biases of this dataset have been studied and reported in the paper.
 
 ## Citation [optional]
 
@@ -193,15 +152,6 @@ Users should be made aware of the risks, biases and limitations of the dataset.
 
 [More Information Needed]
 
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
 
 ## Dataset Card Contact