Add Assin2 RTE task

.gitattributes

@@ -1,54 +1,54 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.lz4 filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text
-# Audio files - uncompressed
-*.pcm filter=lfs diff=lfs merge=lfs -text
-*.sam filter=lfs diff=lfs merge=lfs -text
-*.raw filter=lfs diff=lfs merge=lfs -text
-# Audio files - compressed
-*.aac filter=lfs diff=lfs merge=lfs -text
-*.flac filter=lfs diff=lfs merge=lfs -text
-*.mp3 filter=lfs diff=lfs merge=lfs -text
-*.ogg filter=lfs diff=lfs merge=lfs -text
-*.wav filter=lfs diff=lfs merge=lfs -text
-# Image files - uncompressed
-*.bmp filter=lfs diff=lfs merge=lfs -text
-*.gif filter=lfs diff=lfs merge=lfs -text
-*.png filter=lfs diff=lfs merge=lfs -text
-*.tiff filter=lfs diff=lfs merge=lfs -text
-# Image files - compressed
-*.jpg filter=lfs diff=lfs merge=lfs -text
-*.jpeg filter=lfs diff=lfs merge=lfs -text
-*.webp filter=lfs diff=lfs merge=lfs -text
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.lz4 filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+# Audio files - uncompressed
+*.pcm filter=lfs diff=lfs merge=lfs -text
+*.sam filter=lfs diff=lfs merge=lfs -text
+*.raw filter=lfs diff=lfs merge=lfs -text
+# Audio files - compressed
+*.aac filter=lfs diff=lfs merge=lfs -text
+*.flac filter=lfs diff=lfs merge=lfs -text
+*.mp3 filter=lfs diff=lfs merge=lfs -text
+*.ogg filter=lfs diff=lfs merge=lfs -text
+*.wav filter=lfs diff=lfs merge=lfs -text
+# Image files - uncompressed
+*.bmp filter=lfs diff=lfs merge=lfs -text
+*.gif filter=lfs diff=lfs merge=lfs -text
+*.png filter=lfs diff=lfs merge=lfs -text
+*.tiff filter=lfs diff=lfs merge=lfs -text
+# Image files - compressed
+*.jpg filter=lfs diff=lfs merge=lfs -text
+*.jpeg filter=lfs diff=lfs merge=lfs -text
+*.webp filter=lfs diff=lfs merge=lfs -text

portuguese_benchmark.py

@@ -2,9 +2,14 @@ import textwrap
 import datasets
 from typing import Dict, List, Optional, Union
 
-logger = datasets.logging.get_logger(__name__)
+import xml.etree.ElementTree as ET
 
+logger = datasets.logging.get_logger(__name__)
 
+# Extracted from: 
+# - https://huggingface.co/datasets/lener_br
+# - https://github.com/peluz/lener-br
+# - https://teodecampos.github.io/LeNER-Br/
 _LENERBR_KWARGS = dict(
     name = "LeNER-Br",
     description=textwrap.dedent(
@@ -24,26 +29,65 @@ _LENERBR_KWARGS = dict(
         "test": "https://raw.githubusercontent.com/peluz/lener-br/master/leNER-Br/test/test.conll",
     },  
     citation=textwrap.dedent(
-        """\
-      @InProceedings{luz_etal_propor2018,
-        author = {Pedro H. {Luz de Araujo} and Te\'{o}filo E. {de Campos} and
-                  Renato R. R. {de Oliveira} and Matheus Stauffer and
-                  Samuel Couto and Paulo Bermejo},
-        title = {{LeNER-Br}: a Dataset for Named Entity Recognition in {Brazilian} Legal Text},
-        booktitle = {International Conference on the Computational Processing of Portuguese ({PROPOR})},
-        publisher = {Springer},
-        series = {Lecture Notes on Computer Science ({LNCS})},
-        pages = {313--323},
-        year = {2018},
-        month = {September 24-26},
-        address = {Canela, RS, Brazil},	  
-        doi = {10.1007/978-3-319-99722-3_32},
-        url = {https://teodecampos.github.io/LeNER-Br/},
-      }"""
+            """\
+        @InProceedings{luz_etal_propor2018,
+            author = {Pedro H. {Luz de Araujo} and Te\'{o}filo E. {de Campos} and
+                    Renato R. R. {de Oliveira} and Matheus Stauffer and
+                    Samuel Couto and Paulo Bermejo},
+            title = {{LeNER-Br}: a Dataset for Named Entity Recognition in {Brazilian} Legal Text},
+            booktitle = {International Conference on the Computational Processing of Portuguese ({PROPOR})},
+            publisher = {Springer},
+            series = {Lecture Notes on Computer Science ({LNCS})},
+            pages = {313--323},
+            year = {2018},
+            month = {September 24-26},
+            address = {Canela, RS, Brazil},	  
+            doi = {10.1007/978-3-319-99722-3_32},
+            url = {https://teodecampos.github.io/LeNER-Br/},
+        }"""
     ),
     url="https://teodecampos.github.io/LeNER-Br/",
 )
 
+# Extracted from: 
+# - https://huggingface.co/datasets/assin2
+# - https://sites.google.com/view/assin2
+# - https://github.com/ruanchaves/assin
+_ASSIN2_BASE_KWARGS = dict(
+    description=textwrap.dedent(
+            """\
+        The ASSIN 2 corpus is composed of rather simple sentences. Following the procedures of SemEval 2014 Task 1.
+        The training and validation data are composed, respectively, of 6,500 and 500 sentence pairs in Brazilian Portuguese,
+        annotated for entailment and semantic similarity. Semantic similarity values range from 1 to 5, and text entailment
+        classes are either entailment or none. The test data are composed of approximately 3,000 sentence pairs with the same
+        annotation. All data were manually annotated."""
+    ),
+    data_urls={
+        "train": "https://github.com/ruanchaves/assin/raw/master/sources/assin2-train-only.xml",
+        "dev": "https://github.com/ruanchaves/assin/raw/master/sources/assin2-dev.xml",
+        "test": "https://github.com/ruanchaves/assin/raw/master/sources/assin2-test.xml",
+    },  
+    citation=textwrap.dedent(
+            """\
+        @inproceedings{real2020assin,
+            title={The assin 2 shared task: a quick overview},
+            author={Real, Livy and Fonseca, Erick and Oliveira, Hugo Goncalo},
+            booktitle={International Conference on Computational Processing of the Portuguese Language},
+            pages={406--412},
+            year={2020},
+            organization={Springer}
+        }"""
+    ),
+    url="https://sites.google.com/view/assin2",
+)
+_ASSIN2_RTE_KWARGS = dict(
+    name = "assin2-rte",
+    task_type="rte",
+    label_classes=["NONE", "ENTAILMENT"],
+    **_ASSIN2_BASE_KWARGS
+)
+
+
 class PTBenchmarkConfig(datasets.BuilderConfig):
     """BuilderConfig for PTBenchmark."""
 
@@ -103,6 +147,21 @@ def _get_ner_dataset_info(config):
             )
         )
 
+def _get_rte_dataset_info(config):
+    return datasets.DatasetInfo(
+            description=config.description,
+            homepage=config.url,
+            citation=config.citation,
+            features=datasets.Features(
+                {
+                    "id": datasets.Value("int32"),
+                    "sentence1": datasets.Value("string"),
+                    "sentence2": datasets.Value("string"),
+                    "label": datasets.features.ClassLabel(names=config.label_classes),
+                }
+            )
+        )
+
 def _conll_ner_generator(file_path):
     with open(file_path, encoding="utf-8") as f:
 
@@ -133,17 +192,43 @@ def _conll_ner_generator(file_path):
             "ner_tags": ner_tags,
         }
 
+def _assin2_rte_generator(file_path):
+    """Yields examples."""
+    id_ = 0
+
+    with open(file_path, "rb") as f:
+
+        tree = ET.parse(f)
+        root = tree.getroot()
+
+        for pair in root:
+
+            yield id_, {
+                "id": int(pair.attrib.get("id")),
+                "sentence1": pair.find(".//t").text,
+                "sentence2": pair.find(".//h").text,
+                #"relatedness_score": float(pair.attrib.get("similarity")),
+                "label": pair.attrib.get("entailment").upper(),
+            }
+
+            id_ += 1
+
 
 class PTBenchmark(datasets.GeneratorBasedBuilder):
     BUILDER_CONFIGS = [
         PTBenchmarkConfig(
             **_LENERBR_KWARGS
+        ),
+        PTBenchmarkConfig(
+            **_ASSIN2_RTE_KWARGS
         )
     ]
 
     def _info(self) -> datasets.DatasetInfo:
         if self.config.task_type == "ner":
             return _get_ner_dataset_info(self.config)
+        elif self.config.task_type == "rte":
+            return _get_rte_dataset_info(self.config)
         
     def _split_generators(self, dl_manager: datasets.DownloadManager):
         file_paths = dl_manager.download_and_extract(self.config.data_urls)
@@ -169,3 +254,6 @@ class PTBenchmark(datasets.GeneratorBasedBuilder):
         logger.info("⏳ Generating examples from = %s", file_path)
         if self.config.task_type == "ner":
             yield from _conll_ner_generator(file_path)
+        elif self.config.task_type == "rte":
+            if "assin2" in self.config.name:
+                yield from _assin2_rte_generator(file_path)