Add option to choose between a sentence-level dataset and a document-level dataset

dataset_infos.json

@@ -1 +1 @@
-{"default": {"description": "\u0160olar is a developmental corpus of 5485 school texts (e.g., essays), written by students in Slovenian secondary schools \n(age 15-19) and pupils in the 7th-9th grade of primary school (13-15), with a small percentage also from the 6th grade. \nPart of the corpus (2,094 texts) is annotated with teachers' corrections using a system of labels described in the \ndocument available at https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Smernice-za-oznacevanje-korpusa-Solar_V1.1.pdf (in Slovenian).\n", "citation": "@misc{solar3.0,\n    title = {Developmental corpus {\u000b S}olar 3.0},\n    author = {Arhar Holdt, {\u000b S}pela and Rozman, Tadeja and Stritar Ku{\u000b c}uk, Mojca and Krek, Simon and Krap{\u000b s} Vodopivec, Irena and Stabej, Marko and Pori, Eva and Goli, Teja and Lavri{\u000b c}, Polona and Laskowski, Cyprian and Kocjan{\u000b c}i{\u000b c}, Polonca and Klemenc, Bojan and Krsnik, Luka and Kosem, Iztok},\n    url = {http://hdl.handle.net/11356/1589},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    year = {2022}\n}\n", "homepage": "http://hdl.handle.net/11356/1589", "license": "Creative Commons - Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)", "features": {"id_doc": {"dtype": "string", "id": null, "_type": "Value"}, "doc_title": {"dtype": "string", "id": null, "_type": "Value"}, "is_manually_validated": {"dtype": "bool", "id": null, "_type": "Value"}, "id_src_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "src_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "id_tgt_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "tgt_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "corrections": [{"idx_src": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "idx_tgt": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "corr_types": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}]}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "solar3", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 120154479, "num_examples": 125867, "dataset_name": "solar3"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Solar.TEI.zip": {"num_bytes": 99287852, "checksum": "188945c90c663cc34c77c6aefd40357b60b88436b3d9fd53f24304c927ac1cbf"}}, "download_size": 99287852, "post_processing_size": null, "dataset_size": 120154479, "size_in_bytes": 219442331}}
+{"default": {"description": "\u0160olar is a developmental corpus of 5485 school texts (e.g., essays), written by students in Slovenian secondary schools \n(age 15-19) and pupils in the 7th-9th grade of primary school (13-15), with a small percentage also from the 6th grade. \nPart of the corpus (2,094 texts) is annotated with teachers' corrections using a system of labels described in the \ndocument available at https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Smernice-za-oznacevanje-korpusa-Solar_V1.1.pdf (in Slovenian).\n", "citation": "@misc{solar3.0,\n    title = {Developmental corpus {\u000b S}olar 3.0},\n    author = {Arhar Holdt, {\u000b S}pela and Rozman, Tadeja and Stritar Ku{\u000b c}uk, Mojca and Krek, Simon and Krap{\u000b s} Vodopivec, Irena and Stabej, Marko and Pori, Eva and Goli, Teja and Lavri{\u000b c}, Polona and Laskowski, Cyprian and Kocjan{\u000b c}i{\u000b c}, Polonca and Klemenc, Bojan and Krsnik, Luka and Kosem, Iztok},\n    url = {http://hdl.handle.net/11356/1589},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    year = {2022}\n}\n", "homepage": "http://hdl.handle.net/11356/1589", "license": "Creative Commons - Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)", "features": {"id_doc": {"dtype": "string", "id": null, "_type": "Value"}, "doc_title": {"dtype": "string", "id": null, "_type": "Value"}, "is_manually_validated": {"dtype": "bool", "id": null, "_type": "Value"}, "id_src_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "src_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "id_tgt_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "tgt_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "corrections": [{"idx_src": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "idx_tgt": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "corr_types": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}]}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "solar3", "config_name": "default", "version": {"version_str": "1.0.0", "description": null, "major": 1, "minor": 0, "patch": 0}, "splits": {"train": {"name": "train", "num_bytes": 120154479, "num_examples": 125867, "dataset_name": "solar3"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Solar.TEI.zip": {"num_bytes": 99287852, "checksum": "188945c90c663cc34c77c6aefd40357b60b88436b3d9fd53f24304c927ac1cbf"}}, "download_size": 99287852, "post_processing_size": null, "dataset_size": 120154479, "size_in_bytes": 219442331}, "sentence_level": {"description": "\u0160olar is a developmental corpus of 5485 school texts (e.g., essays), written by students in Slovenian secondary schools \n(age 15-19) and pupils in the 7th-9th grade of primary school (13-15), with a small percentage also from the 6th grade. \nPart of the corpus (1516 texts) is annotated with teachers' corrections using a system of labels described in the \ndocument available at https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Smernice-za-oznacevanje-korpusa-Solar_V1.1.pdf (in Slovenian).\n", "citation": "@misc{solar3.0,\n    title = {Developmental corpus {\u000b S}olar 3.0},\n    author = {Arhar Holdt, {\u000b S}pela and Rozman, Tadeja and Stritar Ku{\u000b c}uk, Mojca and Krek, Simon and Krap{\u000b s} Vodopivec, Irena and Stabej, Marko and Pori, Eva and Goli, Teja and Lavri{\u000b c}, Polona and Laskowski, Cyprian and Kocjan{\u000b c}i{\u000b c}, Polonca and Klemenc, Bojan and Krsnik, Luka and Kosem, Iztok},\n    url = {http://hdl.handle.net/11356/1589},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    year = {2022}\n}\n", "homepage": "http://hdl.handle.net/11356/1589", "license": "Creative Commons - Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)", "features": {"id_doc": {"dtype": "string", "id": null, "_type": "Value"}, "doc_title": {"dtype": "string", "id": null, "_type": "Value"}, "is_manually_validated": {"dtype": "bool", "id": null, "_type": "Value"}, "src_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "tgt_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "corrections": [{"idx_src": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "idx_tgt": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "corr_types": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}]}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "solar3", "config_name": "sentence_level", "version": {"version_str": "3.0.1", "description": null, "major": 3, "minor": 0, "patch": 1}, "splits": {"train": {"name": "train", "num_bytes": 41032273, "num_examples": 125867, "dataset_name": "solar3"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Solar.TEI.zip": {"num_bytes": 99287852, "checksum": "188945c90c663cc34c77c6aefd40357b60b88436b3d9fd53f24304c927ac1cbf"}}, "download_size": 99287852, "post_processing_size": null, "dataset_size": 41032273, "size_in_bytes": 140320125}, "document_level": {"description": "\u0160olar is a developmental corpus of 5485 school texts (e.g., essays), written by students in Slovenian secondary schools \n(age 15-19) and pupils in the 7th-9th grade of primary school (13-15), with a small percentage also from the 6th grade. \nPart of the corpus (1516 texts) is annotated with teachers' corrections using a system of labels described in the \ndocument available at https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Smernice-za-oznacevanje-korpusa-Solar_V1.1.pdf (in Slovenian).\n", "citation": "@misc{solar3.0,\n    title = {Developmental corpus {\u000b S}olar 3.0},\n    author = {Arhar Holdt, {\u000b S}pela and Rozman, Tadeja and Stritar Ku{\u000b c}uk, Mojca and Krek, Simon and Krap{\u000b s} Vodopivec, Irena and Stabej, Marko and Pori, Eva and Goli, Teja and Lavri{\u000b c}, Polona and Laskowski, Cyprian and Kocjan{\u000b c}i{\u000b c}, Polonca and Klemenc, Bojan and Krsnik, Luka and Kosem, Iztok},\n    url = {http://hdl.handle.net/11356/1589},\n    note = {Slovenian language resource repository {CLARIN}.{SI}},\n    year = {2022}\n}\n", "homepage": "http://hdl.handle.net/11356/1589", "license": "Creative Commons - Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)", "features": {"id_doc": {"dtype": "string", "id": null, "_type": "Value"}, "doc_title": {"dtype": "string", "id": null, "_type": "Value"}, "is_manually_validated": {"dtype": "bool", "id": null, "_type": "Value"}, "src_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "tgt_tokens": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "corrections": [{"idx_src": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "idx_tgt": {"feature": {"dtype": "int32", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}, "corr_types": {"feature": {"dtype": "string", "id": null, "_type": "Value"}, "length": -1, "id": null, "_type": "Sequence"}}]}, "post_processed": null, "supervised_keys": null, "task_templates": null, "builder_name": "solar3", "config_name": "document_level", "version": {"version_str": "3.0.1", "description": null, "major": 3, "minor": 0, "patch": 1}, "splits": {"train": {"name": "train", "num_bytes": 33456666, "num_examples": 5485, "dataset_name": "solar3"}}, "download_checksums": {"https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Solar.TEI.zip": {"num_bytes": 99287852, "checksum": "188945c90c663cc34c77c6aefd40357b60b88436b3d9fd53f24304c927ac1cbf"}}, "download_size": 99287852, "post_processing_size": null, "dataset_size": 33456666, "size_in_bytes": 132744518}}

solar3.py

@@ -2,6 +2,7 @@ import logging
 import os
 import re
 import xml.etree.ElementTree as ET
+from itertools import groupby
 from typing import Optional
 
 import datasets
@@ -19,7 +20,7 @@ _CITATION = """\
 _DESCRIPTION = """\
 Šolar is a developmental corpus of 5485 school texts (e.g., essays), written by students in Slovenian secondary schools 
 (age 15-19) and pupils in the 7th-9th grade of primary school (13-15), with a small percentage also from the 6th grade. 
-Part of the corpus (2,094 texts) is annotated with teachers' corrections using a system of labels described in the 
+Part of the corpus (1516 texts) is annotated with teachers' corrections using a system of labels described in the 
 document available at https://www.clarin.si/repository/xmlui/bitstream/handle/11356/1589/Smernice-za-oznacevanje-korpusa-Solar_V1.1.pdf (in Slovenian).
 """
 
@@ -131,7 +132,16 @@ class Solar3(datasets.GeneratorBasedBuilder):
     """Šolar is a developmental corpus of school texts (e.g., essays), annotated with metadata and (partially)
     with teachers' corrections. """
 
-    VERSION = datasets.Version("3.0.0")
+    VERSION = datasets.Version("3.0.1")
+
+    BUILDER_CONFIGS = [
+        datasets.BuilderConfig(name="sentence_level", version=VERSION,
+                               description="Annotations at sentence-level."),
+        datasets.BuilderConfig(name="document_level", version=VERSION,
+                               description="Annotations at document-level."),
+    ]
+
+    DEFAULT_CONFIG_NAME = "sentence_level"  # default = annotations as provided in the original data
 
     def _info(self):
         features = datasets.Features(
@@ -139,9 +149,7 @@ class Solar3(datasets.GeneratorBasedBuilder):
                 "id_doc": datasets.Value("string"),
                 "doc_title": datasets.Value("string"),
                 "is_manually_validated": datasets.Value("bool"),
-                "id_src_tokens": datasets.Sequence(datasets.Value("string")),
                 "src_tokens": datasets.Sequence(datasets.Value("string")),
-                "id_tgt_tokens": datasets.Sequence(datasets.Value("string")),
                 "tgt_tokens": datasets.Sequence(datasets.Value("string")),
                 "corrections": [
                     {
@@ -177,7 +185,8 @@ class Solar3(datasets.GeneratorBasedBuilder):
             )
         ]
 
-    def _generate_examples(self, source_path, target_path, links_path):
+    @staticmethod
+    def generate_sentences(source_path, target_path, links_path):
         source_data = read_data(source_path)
         target_data = read_data(target_path)
 
@@ -186,7 +195,6 @@ class Solar3(datasets.GeneratorBasedBuilder):
         NAMESPACE = namespace(root)
 
         for idx_corr, corrected_sent in enumerate(root.iterfind(f"{NAMESPACE}linkGrp")):
-            involved_sents = corrected_sent.attrib["corresp"].split(" ")
             # Involved sentences according to the IDs of token mappings - 'corresp' does not list all of them!
             # (possible bug in data)
             involved_src_sents, involved_tgt_sents = find_involved_sents(corrected_sent)
@@ -261,3 +269,89 @@ class Solar3(datasets.GeneratorBasedBuilder):
                 "tgt_tokens": tgt_sent_data.get("form", []),
                 "corrections": corr_data
             }
+
+    @staticmethod
+    def aggregate_docs(sent_level_data):
+        # NOTE: assuming here that `sent_level_data` is pre-sorted by id_doc, which is done in the raw data
+        for idx_doc, (curr_id, curr_group) in enumerate(groupby(sent_level_data, key=lambda tup: tup[1]["id_doc"])):
+            curr_instances = map(lambda tup: tup[1], curr_group)  # remove the redundant index info from datasets
+
+            src_tokens, tgt_tokens, mapped_corrections = [], [], []
+            seen_src_tokens, seen_tgt_tokens = {}, {}
+            # Need to keep the current base position of source and target tokens AND previous base position:
+            # A source may map into multiple targets (or vice versa), but we do not want to write it twice in a doc.
+            # Therefore, when the same sentence is encountered twice, the base is shifted to the previous one to map
+            # the indices of corrected tokens correctly.
+            src_base, tgt_base = 0, 0
+            prev_src_base, prev_tgt_base = 0, 0
+
+            doc_title, is_validated = None, None
+            for curr_inst in curr_instances:
+                doc_title, is_validated = curr_inst["doc_title"], curr_inst["is_manually_validated"]
+
+                id_src_toks, id_tgt_toks = curr_inst["id_src_tokens"], curr_inst["id_tgt_tokens"]
+                curr_src_toks, curr_tgt_toks = curr_inst["src_tokens"], curr_inst["tgt_tokens"]
+                curr_corrs = curr_inst["corrections"]
+
+                num_added_src, num_added_tgt = 0, 0
+                for id_tok, tok in zip(id_src_toks, curr_src_toks):
+                    if id_tok not in seen_src_tokens:
+                        src_tokens.append(tok)
+                        seen_src_tokens[id_tok] = tok
+                        num_added_src += 1
+
+                for id_tok, tok in zip(id_tgt_toks, curr_tgt_toks):
+                    if id_tok not in seen_tgt_tokens:
+                        tgt_tokens.append(tok)
+                        seen_tgt_tokens[id_tok] = tok
+                        num_added_tgt += 1
+
+                if num_added_src == 0:
+                    src_base, prev_src_base = prev_src_base, src_base
+
+                if num_added_tgt == 0:
+                    tgt_base, prev_tgt_base = prev_tgt_base, tgt_base
+
+                for corr in curr_corrs:
+                    mapped_corrections.append({
+                        "idx_src": list(map(lambda _i: src_base + _i, corr["idx_src"])),
+                        "idx_tgt": list(map(lambda _i: tgt_base + _i, corr["idx_tgt"])),
+                        "corr_types": corr["corr_types"]
+                    })
+
+                    # TODO: sanity check
+                    for _idx_src in mapped_corrections[-1]["idx_src"]:
+                        if _idx_src >= len(src_tokens):
+                            raise ValueError
+
+                    for _idx_tgt in mapped_corrections[-1]["idx_tgt"]:
+                        if _idx_tgt >= len(tgt_tokens):
+                            raise ValueError
+
+                src_base += num_added_src
+                tgt_base += num_added_tgt
+
+                if num_added_src == 0:
+                    src_base, prev_src_base = prev_src_base, src_base
+
+                if num_added_tgt == 0:
+                    tgt_base, prev_tgt_base = prev_tgt_base, tgt_base
+
+            yield idx_doc, {
+                "id_doc": curr_id,
+                "doc_title": doc_title,
+                "is_manually_validated": is_validated,
+                "src_tokens": src_tokens,
+                "tgt_tokens": tgt_tokens,
+                "corrections": mapped_corrections
+            }
+
+    def _generate_examples(self, source_path, target_path, links_path):
+        sent_level_data = list(Solar3.generate_sentences(source_path, target_path, links_path))
+
+        if self.config.name == "sentence_level":
+            # Remove IDs that are only useful for aggregating the document-level data
+            for i, instance in sent_level_data:
+                yield i, {_k: _v for _k, _v in instance.items() if _k not in {"id_src_tokens", "id_tgt_tokens"}}
+        else:
+            yield from list(Solar3.aggregate_docs(sent_level_data))