include event generation mode with input/target/references fields

turku_hockey_data2text.py

@@ -53,6 +53,12 @@ _URLs = {
 }
 
 
+# relevant keys in input representation for different event types (text and event_id skipped as not being relevant for the input)
+relevant_keys = {"game result": ["event_type", "home_team", "guest_team", "score", "periods", "features"],\
+                 "goal": ["event_type", "score", "features", "player", "assist", "team", "team_name", "time"],\
+                 "penalty": ["event_type", "player", "team", "team_name", "time", "penalty_minutes"],\
+                 "saves": ["event_type", "player", "team", "team_name", "saves"]}
+
 
 class TurkuHockeyData2Text(datasets.GeneratorBasedBuilder):
     """The Turky Hockey Data2Text is a manually curated corpus for Finnish news generation in the area of ice hockey reporting."""
@@ -71,41 +77,56 @@ class TurkuHockeyData2Text(datasets.GeneratorBasedBuilder):
     # data = datasets.load_dataset('my_dataset', 'first_domain')
     # data = datasets.load_dataset('my_dataset', 'second_domain')
     BUILDER_CONFIGS = [
-        datasets.BuilderConfig(name="main", version=VERSION, description="Main config"),
+        datasets.BuilderConfig(name="event-generation", version=VERSION, description="This loads the dataset in its event generation mode, where an output description is generated for each game event separately. The full game information is not availbale."),
+        datasets.BuilderConfig(name="game-generation", version=VERSION, description="This loads the dataset in its game generation mode, where the full game information is provided, but the actual input–output pairs must be created by the user."),
     ]
 
-    DEFAULT_CONFIG_NAME = "main"  # It's not mandatory to have a default configuration. Just use one if it make sense.
+    DEFAULT_CONFIG_NAME = "event-generation"  # It's not mandatory to have a default configuration. Just use one if it make sense.
 
     def _info(self):
         # This method specifies the datasets.DatasetInfo object which contains informations and typings for the dataset
-        #if self.config.name == "main":  # This is the name of the configuration selected in BUILDER_CONFIGS above
-        features = datasets.Features(
-            {
-                "gem_id": datasets.Value("string"),
-                "id": datasets.Value("string"),
-                "news_article": datasets.Value("string"),
-                "events": datasets.features.Sequence(
-                    {
+        if self.config.name == "event-generation":  # This is the name of the configuration selected in BUILDER_CONFIGS above
+            features = datasets.Features(
+                {
+                
+                    "gem_id": datasets.Value("string"),
+                    "game_id": datasets.Value("string"),
                     "event_id": datasets.Value("string"),
-                    "event_type": datasets.Value("string"),
-                    "text": datasets.Value("string"),
-                    "home_team": datasets.Value("string"),
-                    "guest_team": datasets.Value("string"),
-                    "score": datasets.Value("string"),
-                    "periods": datasets.features.Sequence(datasets.Value("string")),
-                    "features": datasets.features.Sequence(datasets.Value("string")),
-                    "player": datasets.Value("string"),
-                    "assist": datasets.features.Sequence(datasets.Value("string")),
-                    "team": datasets.Value("string"),
-                    "team_name": datasets.Value("string"),
-                    "time": datasets.Value("string"),
-                    "penalty_minutes": datasets.Value("string"),
-                    "saves": datasets.Value("string"),
-                    "multi_reference": datasets.Value("bool")
-                    }
-                ),
-            }
-        )
+                    "input": datasets.Value("string"),
+                    "target": datasets.Value("string"),
+                    "references": [datasets.Value("string")]
+                }
+            )
+                
+        else: # game-generation
+            features = datasets.Features(
+                {
+                    "gem_id": datasets.Value("string"),
+                    "id": datasets.Value("string"),
+                    "news_article": datasets.Value("string"),
+                    "events": datasets.features.Sequence(
+                        {
+                        "event_id": datasets.Value("string"),
+                        "event_type": datasets.Value("string"),
+                        "text": datasets.Value("string"),
+                        "home_team": datasets.Value("string"),
+                        "guest_team": datasets.Value("string"),
+                        "score": datasets.Value("string"),
+                        "periods": datasets.features.Sequence(datasets.Value("string")),
+                        "features": datasets.features.Sequence(datasets.Value("string")),
+                        "player": datasets.Value("string"),
+                        "assist": datasets.features.Sequence(datasets.Value("string")),
+                        "team": datasets.Value("string"),
+                        "team_name": datasets.Value("string"),
+                        "time": datasets.Value("string"),
+                        "penalty_minutes": datasets.Value("string"),
+                        "saves": datasets.Value("string"),
+                        "multi_reference": datasets.Value("bool")
+                        }
+                    ),
+                }
+            )
+            
         # define other configs
         return datasets.DatasetInfo(
             description=_DESCRIPTION,
@@ -142,10 +163,22 @@ class TurkuHockeyData2Text(datasets.GeneratorBasedBuilder):
 
         with open(filepath, "rt", encoding="utf-8") as f:
             data = json.load(f)
-        for i, example in enumerate(data):
-            example["gem_id"] = f"gem-turku_hockey_data2text-{split}-{i}" # fill in gem_id
-            example = self._generate_features(example)
-            yield i, example
+        idx = 0
+        for i, example in enumerate(data): # one game
+            if self.config.name == "game-generation":
+                example["gem_id"] = f"gem-turku_hockey_data2text-{split}-{idx}" # fill in gem_id
+                idx += 1
+                example = self._generate_features(example)
+                yield idx, example
+            else:
+                game_data = self._generate_features(example)
+                events = self.create_event_data(game_data["events"])
+                for e in events:
+                    e["gem_id"] = f"gem-turku_hockey_data2text-{split}-{idx}" # fill in gem_id
+                    idx += 1
+                    e["game_id"] = game_data["id"]
+                    yield idx, e
+
                     
                     
     def _generate_features(self, example):
@@ -191,3 +224,40 @@ class TurkuHockeyData2Text(datasets.GeneratorBasedBuilder):
       if events[i]["event_id"] in multi_events:
           return True
       return False
+      
+      
+
+
+    def create_event_data(self, events):
+        simplified_events = []
+        for i, event in enumerate(events):
+            e_idx, event_input, event_output = self.event2string(i, events)
+            if not event_input: # skip empty annotations and multi-reference events
+                continue 
+            simplified_events.append({"gem_id": "", "game_id": "", "event_id": e_idx, "input": event_input, "target": event_output, "references": [event_output]})
+        return simplified_events
+      
+    def event2string(self, i, events):
+        """Featurize i:th event into string input.
+        Example:
+        input: "event_type: saves [SEP] player: Jani Hurme [SEP] team: home [SEP] team_name: TPS [SEP] saves: 25"
+        output: "TPS:n maalissa Jani Hurme ehti 25 kiekon tielle."
+        """
+        if events[i]["text"] == "": # skip, event is not annotated
+            return None, None, None
+        if events[i]["multi_reference"] == True: # skip multireference events in simple representation
+            return None, None, None
+        event_type = events[i]["event_type"] # use only relevant features for this event type
+        
+        e_data = []
+        for key in relevant_keys[event_type]:
+            if isinstance(events[i][key], str) or isinstance(events[i][key], float):
+                s = f"{key} = {events[i][key]}"
+                e_data.append(s)
+            if isinstance(events[i][key], list) and len(events[i][key]) > 0:
+                s = f'{key} = {" , ".join(events[i][key])}'
+                e_data.append(s)
+        event_input = " [SEP] ".join(e_data)
+        
+        e_idx = events[i]["event_id"]
+        return e_idx, event_input, events[i]["text"]