README updated to reflect change in data format

README.md

@@ -26,10 +26,7 @@ paperswithcode_id: scifi-tv-plots
 ## Table of Contents
 - [Dataset Description](#dataset-description)
   - [Format](#format)
-- [Raw Dataset Structure](#dataset-structure)
-  - [_all-sci-fi-data.txt_](#all-data)
-  - [Files in _Test-Train-Val_ Directory](#test-train-val)
-  - [Files in _Input_OutputFiles_ Directory](#input-output)
+- [Dataset Structure](#dataset-structure)
   - [Files in _OriginalStoriesSeparated_ Directory](#original-stories)
 - [Additional Information](#additional-information)
   - [Citation](#citation)
@@ -63,51 +60,32 @@ Dataset is "eventified" and generalized (see LJ Martin, P Ammanabrolu, X Wang, W
 | Test          | 450                        | 30,938                   |
 
 ---
-## Raw Dataset Structure
-### _all-sci-fi-data.txt_
-* Each line of the stories contains data in the format: 5-tuple events in a list (subject, verb, direct object, modifier noun, preposition) ||| generalized 5-tuple events in a list ||| original sentence ||| generalized sentence
-
-e.g.,
-``
-[[u'Voyager', u'run', 'EmptyParameter', u'deuterium', u'out'], [u'Voyager', u'force', u'go', 'EmptyParameter', 'EmptyParameter'], [u'Voyager', u'go', 'EmptyParameter', u'mode', u'into']]|||[['<VESSEL>0', 'function-105.2.1', 'EmptyParameter', "Synset('atom.n.01')", u'out'], ['<VESSEL>0', 'urge-58.1-1', u'escape-51.1-1', 'EmptyParameter', 'EmptyParameter'], ['<VESSEL>0', u'escape-51.1-1', 'EmptyParameter', "Synset('statistic.n.01')", u'into']]|||The USS Voyager is running out of deuterium as a fuel and is forced to go into Gray mode.|||the <VESSEL>0 is running out of Synset('atom.n.01') as a Synset('matter.n.03') and is forced to go into Synset('horse.n.01') Synset('statistic.n.01').
-``
-* Stories end with &lt;EOS> (end of story) tag on its own line
-* On the line after &lt;EOS>, there is a defaultdict of entities found in the story by tag and in order (e.g. the second entity in the "&lt;ORGANIZATION>" list in the dictionary would be &lt;ORGANIZATION>1 in the story above&mdash;index starts at 0). These lines start with "%%%%%%%%%%%%%%%%%".
-
-e.g.,
-``
-%%%%%%%%%%%%%%%%%defaultdict(<type 'list'>, {'<ORGANIZATION>': ['seven of nine', 'silver blood'], '<LOCATION>': ['sickbay', 'astrometrics', 'paris', 'cavern', 'vorik', 'caves'], '<DATE>': ['an hour ago', 'now'], '<MISC>': ['selected works', 'demon class', 'electromagnetic', 'parises', 'mimetic'], '<DURATION>': ['less than a week', 'the past four years', 'thirty seconds', 'an hour', 'two hours'], '<NUMBER>': ['two', 'dozen', '14', '15'], '<ORDINAL>': ['first'], '<PERSON>': ['tom paris', 'harry kim', 'captain kathryn janeway', 'tuvok', 'chakotay', 'jirex', 'neelix', 'the doctor', 'seven', 'ensign kashimuro nozawa', 'green', 'lt jg elanna torres', 'ensign vorik'], '<VESSEL>': ['uss voyager', 'starfleet']})
-``
-
-### Files in _Test-Train-Val_ Directory
-* File names: all-sci-fi-val.txt, all-sci-fi-test.txt, & all-sci-fi-train.txt
-* Each line of the stories contains data in the format: 5-tuple events in a list ||| generalized 5-tuple events in a list ||| original sentence ||| generalized sentence
-
-e.g.,
-``
-[[u'Voyager', u'run', 'EmptyParameter', u'deuterium', u'out'], [u'Voyager', u'force', u'go', 'EmptyParameter', 'EmptyParameter'], [u'Voyager', u'go', 'EmptyParameter', u'mode', u'into']]|||[['<VESSEL>0', 'function-105.2.1', 'EmptyParameter', "Synset('atom.n.01')", u'out'], ['<VESSEL>0', 'urge-58.1-1', u'escape-51.1-1', 'EmptyParameter', 'EmptyParameter'], ['<VESSEL>0', u'escape-51.1-1', 'EmptyParameter', "Synset('statistic.n.01')", u'into']]|||The USS Voyager is running out of deuterium as a fuel and is forced to go into Gray mode.|||the <VESSEL>0 is running out of Synset('atom.n.01') as a Synset('matter.n.03') and is forced to go into Synset('horse.n.01') Synset('statistic.n.01').
-``
-* No &lt;EOS> tags or dictionary.
-* Separated 80-10-10 for train-test-val, but by story instead of individual lines.
-
-
-### Files in _Input_OutputFiles_ Directory
-**Files ending with _*\_input.txt_**
-* 5-tuple generalized event on each line; formatted as a string instead of a list
-
-e.g.,
-``
-<VESSEL>0 function-105.2.1 EmptyParameter Synset('atom.n.01') out
-``
-
-**Files ending with _*\_output.txt_**
-* Corresponding generalized sentence for events in the matching _input.txt file
-
-e.g.,
-``
-the <VESSEL>0 is running out of Synset('atom.n.01') as a Synset('matter.n.03') and is forced to go into Synset('horse.n.01') Synset('statistic.n.01').
-``
-
+## Dataset Structure
+* File names: scifi-val.txt, scifi-test.txt, & scifi-train.txt
+* Each sentence of the stories are split into smaller sentences and the events are extracted.
+* Each line of the file contains information about a single sentence, delimited by "|||". Each line contains, in order:
+    * The story number
+    * The line number (within the story)
+    * 5-tuple events in a list (subject, verb, direct object, modifier noun, preposition)
+    ``
+[[u'Voyager', u'run', 'EmptyParameter', u'deuterium', u'out'], [u'Voyager', u'force', u'go', 'EmptyParameter', 'EmptyParameter'], [u'Voyager', u'go', 'EmptyParameter', u'mode', u'into']]
+    ``
+    * generalized 5-tuple events in a list
+    ``
+    [['<VESSEL>0', 'function-105.2.1', 'EmptyParameter', "Synset('atom.n.01')", u'out'], ['<VESSEL>0', 'urge-58.1-1', u'escape-51.1-1', 'EmptyParameter', 'EmptyParameter'], ['<VESSEL>0', u'escape-51.1-1', 'EmptyParameter', "Synset('statistic.n.01')", u'into']]
+    ``
+    * original sentence
+    ``
+    The USS Voyager is running out of deuterium as a fuel and is forced to go into Gray mode.
+    ``
+    * generalized sentence
+    ``
+    the <VESSEL>0 is running out of Synset('atom.n.01') as a Synset('matter.n.03') and is forced to go into Synset('horse.n.01') Synset('statistic.n.01').
+    ``
+    * a dictionary of numbered entities by tag within the entire story (e.g. the second entity in the "&lt;ORGANIZATION>" list in the dictionary would be &lt;ORGANIZATION>1 in the story above&mdash;index starts at 0)
+    ``
+    {'<ORGANIZATION>': ['seven of nine', 'silver blood'], '<LOCATION>': ['sickbay', 'astrometrics', 'paris', 'cavern', 'vorik', 'caves'], '<DATE>': ['an hour ago', 'now'], '<MISC>': ['selected works', 'demon class', 'electromagnetic', 'parises', 'mimetic'], '<DURATION>': ['less than a week', 'the past four years', 'thirty seconds', 'an hour', 'two hours'], '<NUMBER>': ['two', 'dozen', '14', '15'], '<ORDINAL>': ['first'], '<PERSON>': ['tom paris', 'harry kim', 'captain kathryn janeway', 'tuvok', 'chakotay', 'jirex', 'neelix', 'the doctor', 'seven', 'ensign kashimuro nozawa', 'green', 'lt jg elanna torres', 'ensign vorik'], '<VESSEL>': ['uss voyager', 'starfleet']}
+    ``
 
 ### Files in _OriginalStoriesSeparated_ Directory
 * Contains unedited, unparsed original stories scraped from the respective Fandom wikis.