Added UlyssesNER-Br-PL dataset

portuguese_benchmark.py

@@ -139,6 +139,110 @@ hatebr_map = {
 }
 _HATEBR_KWARGS['process_label'] = lambda x: hatebr_map[x]
 
+# Extracted from: 
+# - https://github.com/ulysses-camara/ulysses-ner-br
+
+_ULYSSESNER_META_KWARGS = dict(
+    description=textwrap.dedent(
+            """\
+        UlyssesNER-Br is a corpus of Brazilian Legislative Documents for NER with quality baselines. 
+        The presented corpus consists of bills and legislative consultations from Brazilian Chamber of Deputies.
+        UlyssesNER-Br has seven semantic classes or categories. Based on HAREM,
+        we defined five typical categories: person, location, organization, event and date.
+        In addition, we defined two specific semantic classes for the legislative domain:
+        law foundation and law product. The law foundation category makes reference to
+        entities related to laws, resolutions, decrees, as well as to domain-specific entities
+        such as bills, which are law proposals being discussed by the parliament, and legislative consultations, 
+        also known as job requests made by the parliamentarians.
+        The law product entity refers to systems, programs, and other products created
+        from legislation."""
+    ),
+    task_type="ner",
+    label_classes=['DATA', 'EVENTO', 'FUNDapelido', 'FUNDlei', 'FUNDprojetodelei', 'LOCALconcreto', 'LOCALvirtual', \
+                    'ORGgovernamental', 'ORGnaogovernamental', 'ORGpartido', 'PESSOAcargo', 'PESSOAgrupocargo', 'PESSOAindividual', \
+                    'PRODUTOoutros', 'PRODUTOprograma', 'PRODUTOsistema'],
+    citation=textwrap.dedent(
+            """\
+        @InProceedings{10.1007/978-3-030-98305-5_1,
+            author="Albuquerque, Hidelberg O.
+            and Costa, Rosimeire
+            and Silvestre, Gabriel
+            and Souza, Ellen
+            and da Silva, N{\'a}dia F. F.
+            and Vit{\'o}rio, Douglas
+            and Moriyama, Gyovana
+            and Martins, Lucas
+            and Soezima, Luiza
+            and Nunes, Augusto
+            and Siqueira, Felipe
+            and Tarrega, Jo{\~a}o P.
+            and Beinotti, Joao V.
+            and Dias, Marcio
+            and Silva, Matheus
+            and Gardini, Miguel
+            and Silva, Vinicius
+            and de Carvalho, Andr{\'e} C. P. L. F.
+            and Oliveira, Adriano L. I.",
+            editor="Pinheiro, Vl{\'a}dia
+            and Gamallo, Pablo
+            and Amaro, Raquel
+            and Scarton, Carolina
+            and Batista, Fernando
+            and Silva, Diego
+            and Magro, Catarina
+            and Pinto, Hugo",
+            title="UlyssesNER-Br: A Corpus of Brazilian Legislative Documents for Named Entity Recognition",
+            booktitle="Computational Processing of the Portuguese Language",
+            year="2022",
+            publisher="Springer International Publishing",
+            address="Cham",
+            pages="3--14",
+            isbn="978-3-030-98305-5"
+        }
+        @InProceedings{10.1007/978-3-031-16474-3_62,
+            author="Costa, Rosimeire
+            and Albuquerque, Hidelberg Oliveira
+            and Silvestre, Gabriel
+            and Silva, N{\'a}dia F{\'e}lix F.
+            and Souza, Ellen
+            and Vit{\'o}rio, Douglas
+            and Nunes, Augusto
+            and Siqueira, Felipe
+            and Pedro Tarrega, Jo{\~a}o
+            and Vitor Beinotti, Jo{\~a}o
+            and de Souza Dias, M{\'a}rcio
+            and Pereira, Fab{\'i}ola S. F.
+            and Silva, Matheus
+            and Gardini, Miguel
+            and Silva, Vinicius
+            and de Carvalho, Andr{\'e} C. P. L. F.
+            and Oliveira, Adriano L. I.",
+            editor="Marreiros, Goreti
+            and Martins, Bruno
+            and Paiva, Ana
+            and Ribeiro, Bernardete
+            and Sardinha, Alberto",
+            title="Expanding UlyssesNER-Br Named Entity Recognition Corpus with Informal User-Generated Text",
+            booktitle="Progress in Artificial Intelligence",
+            year="2022",
+            publisher="Springer International Publishing",
+            address="Cham",
+            pages="767--779",
+            isbn="978-3-031-16474-3"
+        }"""
+    ),
+    url="https://github.com/ulysses-camara/ulysses-ner-br",
+)
+_ULYSSESNER_PL_KWARGS = dict(
+    name = "UlyssesNER-Br-PL",
+    data_urls = {
+        "train": "https://github.com/ulysses-camara/ulysses-ner-br/raw/main/annotated-corpora/PL_corpus_conll/pl_corpus_tipos/train.txt",
+        "validation":  "https://github.com/ulysses-camara/ulysses-ner-br/raw/main/annotated-corpora/PL_corpus_conll/pl_corpus_tipos/valid.txt",
+        "test":  "https://github.com/ulysses-camara/ulysses-ner-br/raw/main/annotated-corpora/PL_corpus_conll/pl_corpus_tipos/test.txt",
+    },
+    **_ULYSSESNER_META_KWARGS
+)
+
 class PTBenchmarkConfig(datasets.BuilderConfig):
     """BuilderConfig for PTBenchmark."""
 
@@ -184,7 +288,7 @@ class PTBenchmarkConfig(datasets.BuilderConfig):
         self.indexes_url = indexes_url
         self.process_label = process_label
 
-def _get_classification_features(config):
+def _get_classification_features(config: PTBenchmarkConfig):
     return datasets.Features(
         {
             "idx": datasets.Value("int32"),
@@ -193,7 +297,7 @@ def _get_classification_features(config):
         }
     )
 
-def _get_ner_features(config):
+def _get_ner_features(config: PTBenchmarkConfig):
     bio_labels = ["O"]
     for label_name in config.label_classes:
         bio_labels.append("B-" + label_name)
@@ -208,7 +312,7 @@ def _get_ner_features(config):
         }
     )
 
-def _get_rte_features(config):
+def _get_rte_features(config: PTBenchmarkConfig):
     return datasets.Features(
         {
             "idx": datasets.Value("int32"),
@@ -218,7 +322,7 @@ def _get_rte_features(config):
         }
     )
 
-def _get_sts_features(config):
+def _get_sts_features(config: PTBenchmarkConfig = None):
     return datasets.Features(
         {
             "idx": datasets.Value("int32"),
@@ -321,6 +425,9 @@ class PTBenchmark(datasets.GeneratorBasedBuilder):
         ),
         PTBenchmarkConfig(
             **_HATEBR_KWARGS
+        ),
+        PTBenchmarkConfig(
+            **_ULYSSESNER_PL_KWARGS
         )
     ]