Update README.md

README.md

@@ -71,11 +71,11 @@ configs:
 
 
 ---
-# Dataset Card for Dataset Name
+# Dataset Card for XNLIeu
 
 <!-- Provide a quick summary of the dataset. -->
 
-This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+XNLIeu is an extension of [XNLI](https://huggingface.co/datasets/xnli) translated from English to **Basque**. It has been designed as a cross-lingual dataset for the Natural Language Inference task, a text-classification task that consists on classifying pairs of sentences, a premise and a hypothesis, according to their semantic relation out of three possible labels: entailment, contradiction and neutral.
 
 ## Dataset Details
 
@@ -88,7 +88,7 @@ This dataset card aims to be a base template for new datasets. It has been gener
 - **Curated by:** [More Information Needed]
 - **Funded by [optional]:** [More Information Needed]
 - **Shared by [optional]:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
+- **Language(s) (NLP):** Basque (eu)
 - **License:** [More Information Needed]
 
 ### Dataset Sources [optional]
@@ -99,27 +99,43 @@ This dataset card aims to be a base template for new datasets. It has been gener
 - **Paper [optional]:** [More Information Needed]
 - **Demo [optional]:** [More Information Needed]
 
+
 ## Uses
 
-<!-- Address questions around how the dataset is intended to be used. -->
+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.
 
-### Direct Use
+## Dataset Structure
 
-<!-- This section describes suitable use cases for the dataset. -->
+### Splits
 
-[More Information Needed]
+|    name     |train |validation|test|
+|-------------|-----:|---------:|---:|
+|eu           |392702|      2490|5010|
+|eu_mt        |392702|      2490|5010|
+|eu_native    |-     |      -   |621 |
 
-### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+### Dataset Fields
 
-[More Information Needed]
+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>
 
-## Dataset Structure
+### Dataset Instances
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+An example from the "eu" split:
+
+```
+{
+    "premise": "Dena idazten saiatu nintzen"
+    "hypothesis": "Nire helburua gauzak idaztea zen.",
+    "label": 0,
+}
+```
 
-[More Information Needed]
 
 ## Dataset Creation
 
@@ -145,27 +161,9 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 [More Information Needed]
 
-### Annotations [optional]
-
-<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
-
-#### Annotation process
-
-<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
-
-[More Information Needed]
-
-#### Who are the annotators?
-
-<!-- This section describes the people or systems who created the annotations. -->
-
-[More Information Needed]
 
-#### Personal and Sensitive Information
 
-<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
 
-[More Information Needed]
 
 ## Bias, Risks, and Limitations
 
@@ -179,6 +177,10 @@ This dataset card aims to be a base template for new datasets. It has been gener
 
 Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
 
+
+
+
+
 ## Citation [optional]
 
 <!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
@@ -201,10 +203,6 @@ Users should be made aware of the risks, biases and limitations of the dataset.
 
 [More Information Needed]
 
-## Dataset Card Authors [optional]
-
-[More Information Needed]
-
 ## Dataset Card Contact
 
 [More Information Needed]