added information on where spans begin and end in the untouched text string

essays_SuG.py

@@ -126,6 +126,8 @@ class Fancy(datasets.GeneratorBasedBuilder):
                         )
                     ),
                     "text": datasets.Value("string"),
+                    "span_begins": datasets.Sequence(datasets.Value("int16")),
+                    "span_ends": datasets.Sequence(datasets.Value("int16")),
                 }
             )
         elif (
@@ -145,6 +147,8 @@ class Fancy(datasets.GeneratorBasedBuilder):
                         )
                     ),
                     "text": datasets.Value("string"),
+                    "span_begins": datasets.Sequence(datasets.Value("int16")),
+                    "span_ends": datasets.Sequence(datasets.Value("int16")),
                 }
             )
         elif (
@@ -166,6 +170,8 @@ class Fancy(datasets.GeneratorBasedBuilder):
                         )
                     ),
                     "text": datasets.Value("string"),
+                    "span_begins": datasets.Sequence(datasets.Value("int16")),
+                    "span_ends": datasets.Sequence(datasets.Value("int16")),
                 }
             )
         elif self.config.name == "sep_tok":
@@ -185,6 +191,8 @@ class Fancy(datasets.GeneratorBasedBuilder):
                         )
                     ),
                     "text": datasets.Value("string"),
+                    "span_begins": datasets.Sequence(datasets.Value("int16")),
+                    "span_ends": datasets.Sequence(datasets.Value("int16")),
                 }
             )
         elif self.config.name == "sep_tok_full_labels":
@@ -206,6 +214,8 @@ class Fancy(datasets.GeneratorBasedBuilder):
                         )
                     ),
                     "text": datasets.Value("string"),
+                    "span_begins": datasets.Sequence(datasets.Value("int16")),
+                    "span_ends": datasets.Sequence(datasets.Value("int16")),
                 }
             )
 
@@ -252,11 +262,15 @@ class Fancy(datasets.GeneratorBasedBuilder):
         # check for whether the data folder is in cwd.
         # if it isnt, change cwd to its parent directory
         # do this three times only (dont want infinite recursion)
-        for _ in range(3):
-            if Path.is_dir(cwd / "fancy_dataset"):
-                # print(f"found 'data' folder at {cwd}")
+        for _ in range(5):
+            if Path.is_dir(cwd / "essays_SuG"):
+                print(f"found 'essays_SuG' folder at {cwd}")
+                # input(f"returning {cwd / 'essays_SuG'}")
+                return cwd / "essays_SuG"
+            if Path.is_dir(cwd / "data"):
+                print(f"found 'data' folder at {cwd}")
                 # input(f"returning {cwd / 'data'}")
-                return cwd / "fancy_dataset"
+                return cwd / "data"
             cwd = cwd.parent
         raise FileNotFoundError("data directory has not been found")
 
@@ -340,7 +354,14 @@ class Fancy(datasets.GeneratorBasedBuilder):
         tokens = []
         for sentence in essay["sentences"]:
             for token in sentence["tokens"]:
-                tokens.append((token["surface"], token["gid"]))
+                tokens.append(
+                    (
+                        token["surface"],
+                        token["gid"],
+                        token["characterOffsetBegin"],
+                        token["characterOffsetEnd"],
+                    )
+                )
         return tokens
 
     def _get_label_dict(self, essay):
@@ -361,33 +382,44 @@ class Fancy(datasets.GeneratorBasedBuilder):
     def _match_tokens(self, tokens, label_dict):
         text = []
         labels = []
-        for surface, gid in tokens:
+        begins = []
+        ends = []
+        last_end = 0
+        for surface, gid, begin, end in tokens:
             # for each token, unpack it into its surface and gid
             # then match the gid to the label and pack them back together
 
-            # if the config requires separator tokens
-            if (
-                self.config.name == "sep_tok"
-                or self.config.name == "sep_tok_full_labels"
-            ):
-                if label_dict.get(gid, "O")[0] == "B":
-                    # if we are at the beginning of a span
-                    # insert begin of sequence token (BOS) and "O" label
+            if label_dict.get(gid, "O")[0] == "B":
+                # if we are at the beginning of a span
+                # insert begin of sequence token (BOS) and "O" label
+                if (
+                    self.config.name == "sep_tok"
+                    or self.config.name == "sep_tok_full_labels"
+                ):
+                    # if the config requires separator tokens
                     text.append("<s>")
                     labels.append("O")
-                elif (
-                    label_dict.get(gid, "O") == "O"
-                    and len(labels) != 0
-                    and labels[-1][0] != "O"
+                begins.append(begin)
+            elif (
+                label_dict.get(gid, "O") == "O"
+                and len(labels) != 0
+                and labels[-1][0] != "O"
+            ):
+                # if we are not in a span, and the previous label was
+                # of a span
+                # intert end of sequence token (EOS) and "O" label
+                if (
+                    self.config.name == "sep_tok"
+                    or self.config.name == "sep_tok_full_labels"
                 ):
-                    # if we are not in a span, and the previous label was
-                    # of a span
-                    # intert end of sequence token (EOS) and "O" label
+                    # if the config requires separator tokens
                     text.append("</s>")
                     labels.append("O")
+                ends.append(last_end)
 
             # always append the surface form
             text.append(surface)
+            last_end = end
 
             # append the correct type of label, depending on the config
             if self.config.name == "full_labels":
@@ -407,7 +439,7 @@ class Fancy(datasets.GeneratorBasedBuilder):
 
             else:
                 raise KeyError()
-        return text, labels
+        return text, labels, begins, ends
 
     def _get_text(self, essay):
         return essay["text"]
@@ -419,11 +451,18 @@ class Fancy(datasets.GeneratorBasedBuilder):
         # input(tokens)
         label_dict = self._get_label_dict(essay)
         # input(label_dict)
-        tokens, labels = self._match_tokens(tokens, label_dict)
+        tokens, labels, begins, ends = self._match_tokens(tokens, label_dict)
         # input(tokens)
         # input(labels)
         text = self._get_text(essay)
-        return {"id": id, "tokens": tokens, "ner_tags": labels, "text": text}
+        return {
+            "id": id,
+            "tokens": tokens,
+            "ner_tags": labels,
+            "text": text,
+            "span_begins": begins,
+            "span_ends": ends,
+        }
 
     # method parameters are unpacked from `gen_kwargs` as given in `_split_generators`
     def _generate_examples(self, data, id_range):