building to use prompt

fs.py

@@ -4,19 +4,21 @@
 
 import json
 import os
+from abc import abstractmethod
+
 import datasets
 from citations_and_descriptions import (
     _SUMM_SCREEN_DESCRIPTION, _SUMM_SCREEN_CITATION,
     _GOV_REPORT_CITATION, _GOV_REPORT_DESCRIPTION,
     _ARXIV_CITATION, _ARXIV_DESCRIPTION,
-    _FS_DESCRIPTION, _FS_CITATION
+    _FS_DESCRIPTION, _FS_CITATION,
 )
 
 
 class FSConfig(datasets.BuilderConfig):
     """BuilderConfig for FS."""
 
-    def __init__(self, features, data_url, citation, url, max_source_length, tokenizer, **kwargs):
+    def __init__(self, data_url, citation, url, max_source_length, tokenizer, **kwargs):
         """BuilderConfig for FS.
         Args:
           features: `list[string]`, list of the features that will appear in the
@@ -30,43 +32,110 @@ class FSConfig(datasets.BuilderConfig):
           **kwargs: keyword arguments forwarded to super.
         """
         super(FSConfig, self).__init__(version=datasets.Version("1.0.0"), **kwargs)
-        self.features = features
+        self.features = ["pid", self.source_key, self.source_key]
         self.data_url = data_url
         self.citation = citation
         self.url = url
         self.max_source_length = max_source_length
         self.tokenizer = tokenizer
-        self.prompt = None
-        self.input_key = None
-        self.output_key = None
-        self.redundant_fields = []
-
-        self.train_file = "train.jsonl"
-        self.validation_file = "validation.jsonl"
-        self.test_file = "test.jsonl"
 
     def remove_redundant_fields(self, example):
         for field in self.redundant_fields:
             del example[field]
 
-    def process_input(self, s):
-        return s.strip()
+    @abstractmethod
+    def postprocess(self, s):
+        pass
 
-    def process_output(self, s):
-        return s
+    @property
+    @abstractmethod
+    def original_source_key(self):
+        pass
+
+    @property
+    @abstractmethod
+    def original_target_key(self):
+        pass
+
+    @property
+    @abstractmethod
+    def train_file(self):
+        pass
+
+    @property
+    @abstractmethod
+    def validation_file(self):
+        pass
+
+    @property
+    @abstractmethod
+    def test_file(self):
+        pass
+
+    @property
+    def source_key(self):
+        return "source"
+
+    @property
+    def target_key(self):
+        return "target"
+
+    @property
+    @abstractmethod
+    def id_key(self):
+        pass
+
+    @property
+    def redundant_fields(self):
+        return []
+
+    def preprocess(self, example):  # TODO perhaps we can use this for base
+        example[self.source_key] = example[self.original_source_key].strip()
+        example[self.target_key] = example[self.original_target_key].strip()
+
+    def prompt(self, example):
+        pass # TODO
+        # prompt = get_prompt(self.dataset_name,
+        #                     self.template_name)
+        # row = prompt.apply(row)
+
+    def postprocess(self, example):  # TODO truncate source
+        pass
 
 
 class ScrollsConfig(FSConfig):
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
-        self.train_file = "train.jsonl"
-        self.validation_file = "validation.jsonl"
-        self.test_file = "test.jsonl"
 
-        self.input_key = "input"  # TODO I think that we should keep the original fields
-        self.output_key = "output"
-        self.id_key = "pid"
-        self.redundant_fields = [self.input_key, self.output_key, "id"]
+    @property
+    def original_source_key(self):
+        return "input"
+
+    @property
+    def original_target_key(self):
+        return "output"
+
+    @property
+    def train_file(self):
+        return "train.jsonl"
+
+    @property
+    def validation_file(self):
+        return "validation.jsonl"
+
+    @property
+    def test_file(self):
+        return "test.jsonl"
+
+    @property
+    def id_key(self):
+        return "pid"
+
+    @property
+    def redundant_fields(self):
+        return [self.original_source_key, self.original_target_key, "id"]
+
+
 
     def process_input(self, s):
         prefix = s.strip()
@@ -76,6 +145,7 @@ class ScrollsConfig(FSConfig):
 
 
 class ArxivConfig(FSConfig):
+    # TODO properties etc...
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
         self.train_file = "train.txt"
@@ -115,13 +185,11 @@ def _truncate_prefix(prefix, suffix, max_source_length, tokenizer):
 class Fs(datasets.GeneratorBasedBuilder):
     """The SCROLLS benchmark."""
 
-    features = ["pid", "source", "target"]
     DEFAULT_WRITER_BATCH_SIZE = 1000  # because Narrative QA is a rather large dataset
     BUILDER_CONFIGS = [
         ScrollsConfig(
             name="summ_screen_fd_debug",
             description=_SUMM_SCREEN_DESCRIPTION,
-            features=features,
             data_url="https://huggingface.co/datasets/tau/fs/resolve/main/data/summ_screen_fd_debug.zip",
             citation=_SUMM_SCREEN_CITATION,
             url="https://github.com/mingdachen/SummScreen",
@@ -131,23 +199,21 @@ class Fs(datasets.GeneratorBasedBuilder):
         ScrollsConfig(
             name="gov_report",
             description=_GOV_REPORT_CITATION,
-            features=features,
             data_url="https://huggingface.co/datasets/tau/fs/resolve/main/data/gov_report.zip",
             citation=_GOV_REPORT_DESCRIPTION,
             url="https://gov-report-data.github.io/",
             max_source_length=None,
             tokenizer=None,
         ),
-        ArxivConfig(
-            name="arxiv_debug",
-            description=_ARXIV_CITATION,
-            features=features,
-            data_url="https://huggingface.co/datasets/tau/fs/resolve/main/data/arxiv_debug.zip",
-            citation=_ARXIV_DESCRIPTION,
-            url="https://github.com/armancohan/long-summarization",
-            max_source_length=None,
-            tokenizer=None,
-        ),
+        # ArxivConfig(
+        #     name="arxiv_debug",
+        #     description=_ARXIV_CITATION,
+        #     data_url="https://huggingface.co/datasets/tau/fs/resolve/main/data/arxiv_debug.zip",
+        #     citation=_ARXIV_DESCRIPTION,
+        #     url="https://github.com/armancohan/long-summarization",
+        #     max_source_length=None,
+        #     tokenizer=None,
+        # ),
     ]
 
     def _info(self):
@@ -173,18 +239,12 @@ class Fs(datasets.GeneratorBasedBuilder):
                 name=datasets.Split.TRAIN,
                 gen_kwargs={
                     "data_file": os.path.join(dl_dir, self.config.train_file),
-                    "split": datasets.Split.TRAIN,
-                    "max_source_length": self.config.max_source_length,
-                    "tokenizer": self.config.tokenizer,
                 },
             ),
             datasets.SplitGenerator(
                 name=datasets.Split.VALIDATION,
                 gen_kwargs={
                     "data_file": os.path.join(dl_dir, self.config.validation_file),
-                    "split": datasets.Split.VALIDATION,
-                    "max_source_length": self.config.max_source_length,
-                    "tokenizer": self.config.tokenizer,
                 },
             ),
             datasets.SplitGenerator(
@@ -192,22 +252,19 @@ class Fs(datasets.GeneratorBasedBuilder):
                 gen_kwargs={
                     "data_file": os.path.join(dl_dir, self.config.test_file) if data_files is None else data_files[
                         "test"],
-                    "split": datasets.Split.TEST,
-                    "max_source_length": self.config.max_source_length,
-                    "tokenizer": self.config.tokenizer,
                 },
             ),
         ]
 
-    def _generate_examples(self, data_file, split, max_source_length, tokenizer):
+    def _generate_examples(self, data_file):
         with open(data_file, encoding="utf-8") as f:
             for line in f:
                 row = json.loads(line)
 
                 row["pid"] = row[self.config.id_key]
-                row["source"] = self.config.process_input(row[self.config.input_key])
-                row["target"] = self.config.process_output(row[self.config.output_key])
-
+                self.config.preprocess(row)
+                self.config.prompt(row)
+                self.config.postprocess(row)
                 self.config.remove_redundant_fields(row)
                 yield row["pid"], row