Version 0.2

jdchoi77 · jdchoi77 · commit 4c331901dbf8 · 2020-08-13T02:00:56.000-04:00
diff --git a/README.md b/README.md
@@ -3,9 +3,10 @@
 StreamSide is a annotation toolkit that derives a semantic network from plain text.
 This project is maintained by the [Emory NLP](http://nlp.cs.emory.edu/) research laboratory and under the [Apache 2](http://www.apache.org/licenses/LICENSE-2.0) license.
 
-* Latest release: [0.1](../../releases/tag/streamside-0.1) (8/12/2020).
+* Latest release: [0.2](../../releases/tag/streamside-0.2) (8/13/2020).
 
 ## Documentations
 
 * [Getting Started](docs/getting_started.md)
 * [Graph Annotator](docs/graph_annotator.md)
+* [JSON to Penman Convertor](docs/json_to_penman.md)
diff --git a/docs/json_to_penman.md b/docs/json_to_penman.md
@@ -0,0 +1,9 @@
+# JSON to Penman Converter
+
+The following command converts the JSON files generated by StreamSide to the Penman notation:
+
+```bash
+python -m streamside.json_to_penman -i INPUT_PATH [-o OUTPUT_PATH] &
+```
+* `-i` or `--input`: the path to a JSON file or a directory containing JSON files (required).
+* `-o` or `--output`: the path to the output file(s) (default: the input directory).
diff --git a/docs/training-examples.jdchoi.json b/docs/training-examples.jdchoi.json
diff --git a/samples/training-examples.jdchoi.json b/samples/training-examples.jdchoi.json
diff --git a/samples/training-examples.jdchoi.penman b/samples/training-examples.jdchoi.penman
@@ -0,0 +1,17 @@
+# ::id training-examples.0 ::save-date 13/08/2020 01:51:30 ::annotator jdchoi
+# ::snt The boy wants to be believed by the girl .
+(c1 / want-01
+    :ARG0 (c0 / boy)
+    :ARG1 (c2 / believe-01
+              :ARG0 (c3 / girl)
+              :ARG1 c0)
+    :polarity +)
+
+# ::id training-examples.199 ::save-date 13/08/2020 01:39:25 ::annotator jdchoi
+# ::snt the Nobel Prize
+(c0 / award
+    :name (c1 / name
+              :op1 "Nobel"
+              :op2 "Prize")
+    :wiki "Nobel_Prize")
+
diff --git a/samples/training-examples.txt b/samples/training-examples.txt
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='streamside',
-    version='0.1',
+    version='0.2',
     scripts=[],
     author='Jinho D. Choi',
     author_email='jinho.choi@emory.edu',
diff --git a/streamside/annotator.py b/streamside/annotator.py
@@ -123,7 +123,7 @@ def exec_(self) -> Optional[str]:
 
 class RelationDialog(InputDialog):
     def __init__(self, parent, title: str, parent_desc: str, child_desc: str, label: str = '', update: bool = False):
-        super().__init__(parent, title, 350, parent.relation_list, 50)
+        super().__init__(parent, title, 550, parent.relation_list, 50)
         self.relation_dict = parent.relation_dict
         layout = QVBoxLayout()
         self.setLayout(layout)
@@ -135,6 +135,16 @@ def __init__(self, parent, title: str, parent_desc: str, child_desc: str, label:
         self.lb_desc = QPlainTextEdit('Description')
         self.lb_desc.setReadOnly(True)
 
+        # AMR only
+        self.concept_desc = None
+        if parent.mode == 'amr':
+            parent_id = parent_desc.split()[0][1:]
+            con = parent.current_graph.get_concept(parent_id)
+            d = parent.concept_dict.get(con.name, None)
+            if d and d['type'] == 'pred':
+                self.concept_desc = d['description']
+                self.lb_desc.setPlainText(self.concept_desc)
+
         # child + referent
         wg_child = QWidget()
         l = QHBoxLayout()
@@ -177,10 +187,11 @@ def __init__(self, parent, title: str, parent_desc: str, child_desc: str, label:
         self.sct_inverse.activated.connect(self.check_inverse)
 
     def edit_finished(self):
-        v = self.relation_dict.get(self.ledit.text().strip(), None)
-        text = v['description'] if v else 'No description available'
-        self.lb_desc.setPlainText(text)
-        self.lb_desc.repaint()
+        if self.concept_desc is None:
+            v = self.relation_dict.get(self.ledit.text().strip(), None)
+            text = v['description'] if v else 'No description available'
+            self.lb_desc.setPlainText(text)
+            self.lb_desc.repaint()
 
     def check_referent(self):
         self.referent.setChecked(not self.referent.isChecked())
@@ -367,8 +378,8 @@ def open_txt(txt_file):
         def open_json(json_file):
             self.filename = json_file
             with open(self.filename) as fin:
-                graphs = json.load(fin)
-                self.graphs = [Graph.factory(graph) for graph in graphs]
+                d = json.load(fin)
+                self.graphs = [Graph.factory(graph) for graph in d['graphs']]
 
         # get filename
         filename = QFileDialog.getOpenFileName(self, 'Open File')[0]
@@ -397,8 +408,8 @@ def menu_file_save(self):
 
         self.current_graph.last_saved = current_time()
         with open(self.filename, 'w') as fout:
-            d = ['  ' + graph.json_dumps() for graph in self.graphs]
-            fout.write('[\n{}\n]\n'.format(',\n'.join(d)))
+            d = ['    ' + graph.json_dumps() for graph in self.graphs]
+            fout.write('{{\n  "graphs": [\n{}\n  ]\n}}\n'.format(',\n'.join(d)))
 
         self.statusbar.showMessage('Save: {}'.format(self.filename))
 
diff --git a/streamside/json_to_penman.py b/streamside/json_to_penman.py
@@ -0,0 +1,51 @@
+#  Copyright 2020 Emory University
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+__author__ = 'Jinho D. Choi'
+
+import argparse
+import glob
+import json
+import os
+
+from streamside.struct import Graph
+
+
+def convert(input_file: str, output_dir: str):
+    output_file = os.path.join(output_dir, os.path.basename(input_file)[:-4] + 'penman')
+    fout = open(output_file, 'w')
+    d = json.load(open(input_file))
+
+    for g in d['graphs']:
+        graph = Graph.factory(g)
+        if graph.concepts:
+            fout.write('\n'.join(graph.penman_graphs(True)) + '\n\n')
+
+
+def main():
+    parser = argparse.ArgumentParser(description='JSON to Penman Converter')
+    parser.add_argument('-i', '--input', type=str, help='the path to a JSON file or a directory containing JSON files')
+    parser.add_argument('-o', '--output', type=str, default=None, help='the path to the output file(s)')
+    args = parser.parse_args()
+
+    output_dir = args.output if args.output else os.path.dirname(args.input)
+    if os.path.isdir(args.input):
+        for input_file in glob.glob(os.path.join(args.input, '*.json')):
+            convert(input_file, output_dir)
+    else:
+        convert(args.input, output_dir)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/streamside/resources/amr/concepts.json b/streamside/resources/amr/concepts.json
@@ -35467,6 +35467,10 @@
     "description": "Quantity entity",
     "type": "quant"
   },
+  "name": {
+    "description": "Miscellaneous entity",
+    "type": "misc"
+  },
   "date-entity": {
     "description": "Miscellaneous entity",
     "type": "misc"
diff --git a/streamside/struct.py b/streamside/struct.py
@@ -16,7 +16,6 @@
 
 import copy
 import json
-from datetime import datetime
 from typing import Tuple, Optional, List, Dict, Set, Iterable
 
 
@@ -281,40 +280,48 @@ def remove_relation(self, relation_id: str) -> Optional[Relation]:
         """
         return self.relations.pop(relation_id) if relation_id in self.relations else None
 
-    def penman(self, concept_id: str, amr: bool = False) -> str:
+    def penman(self, concept_id: str, amr: bool) -> str:
         """
         :param concept_id: the ID of the root concept.
         :param amr: if True, the return notation is compatible to AMR.
         :return: the Penman notation of the concept's subtree.
         """
 
-        def repr_concept(cid: str, ref: bool) -> str:
-            if ref: return cid
-            c = self.concepts[cid]
-            if amr:
-                if c.attribute and self.parent_relations(cid): return c.name
-            return '({} / {}'.format(cid, c.name)
+        def repr_concept(rel: Relation) -> str:
+            if rel.referent: return rel.child_id
+            c = self.concepts[rel.child_id]
+            if amr and c.attribute and self.parent_relations(rel.child_id):
+                if (rel.label.startswith('op') and rel.label[2:].isdigit() and self.concepts[rel.parent_id].name == 'name') or rel.label == 'wiki' or rel.label == 'value':
+                    return '"{}"'.format(c.name)
+                else:
+                    return c.name
+            return '({} / {}'.format(rel.child_id, c.name)
 
         # TODO: sort the relation labels per node
-        def aux(cid: str, ref: bool, r: List[str], indent: str):
-            cname = repr_concept(cid, ref)
+        def aux(rel: Relation, r: List[str], indent: str):
+            cname = repr_concept(rel)
             r.append(cname)
-            if not ref:
-                indent += ' ' * (len(cid) + 2)
-                for rid, relation in sorted(self.child_relations(cid), key=lambda x: x[1].label):
+            if not rel.referent:
+                indent += ' ' * (len(rel.child_id) + 2)
+                for rid, relation in sorted(self.child_relations(rel.child_id), key=lambda x: x[1].label):
                     r.append('\n{}:{} '.format(indent, relation.label))
-                    aux(relation.child_id, relation.referent, r, indent + ' ' * (len(relation.label) + 2))
+                    aux(relation, r, indent + ' ' * (len(relation.label) + 2))
                 if cname.startswith('('): r.append(')')
 
         rep = []
-        aux(concept_id, False, rep, '')
-        return ''.join(rep)
+        aux(Relation('', concept_id, ''), rep, '')
+        if amr:
+            meta = '# ::id {} ::save-date {} ::annotator {}\n# ::snt {}\n'.format(self.tid, self.last_saved, self.annotator, ' '.join(self.tokens))
+            return meta + ''.join(rep)
+        else:
+            return ''.join(rep)
 
-    def penman_graphs(self) -> List[str]:
+    def penman_graphs(self, amr: bool = False) -> List[str]:
         """
+        :param amr: if True, the return notation is compatible to AMR.
         :return: list of graphs in the Penman notation.
         """
-        return [self.penman(root_id) for root_id in self.root_ids]
+        return [self.penman(root_id, amr) for root_id in self.root_ids]
 
     def json_dumps(self, **kwargs) -> str:
         """
