From 8ce0dd56b3f3a2fcdc05678100cd82f6bcf1b57f Mon Sep 17 00:00:00 2001
From: born <born@cl.uni-heidelberg.de>
Date: Tue, 23 Jul 2019 17:17:35 +0200
Subject: [PATCH] Update README.md
---
README.md | 35 ++++++++++-------------------------
1 file changed, 10 insertions(+), 25 deletions(-)
diff --git a/README.md b/README.md
index ad27c5f..7353777 100644
--- a/README.md
+++ b/README.md
@@ -43,31 +43,16 @@ The file to interact with to generate knowledge graphs from the OBC is _main.py_
To re-create the sample knowledge graph for the year 1913, simply type:
python main.py -year 1913 -output_path "../output/example_graph_1913.json"
+
+If you want to simplify text description nodes, you can set the flag "-text\_node\_simplification\_mode":
-To display all available options, type:
+ python main.py -year 1913 -output_path "../output/example_graph_1913_simplified.json" -text_node_simplification_mode classifier
- python main.py -h
+For the classifier, the more years are used as training data, the better its simplification accuracy becomes.\
+You can add more years by simply adding years to the command:
-This gives you:
-
- usage: main.py [-h] [-year YEAR [YEAR ...]] [-output_path OUTPUT_PATH]
- [-text_node_simplification_mode {None,classifier,spacy_direct_object}]
- [-verbose {0,1,2}]
- [-prune_text_nodes_min_freq PRUNE_TEXT_NODES_MIN_FREQ]
-
- Building a graph from old bailey corpus.
-
- optional arguments:
- -h, --help show this help message and exit
- -year YEAR [YEAR ...]
- what year(s) the graph should cover, leave empty to
- cover all available years
- -output_path OUTPUT_PATH
- where to save output graph
- -text_node_simplification_mode {None,classifier,spacy_direct_object}
- simplify text nodes, e.g.: "murder of x , on the
- Monday of(...)" --> "murder"
- -verbose {0,1,2} logging level
- -prune_text_nodes_min_freq PRUNE_TEXT_NODES_MIN_FREQ
- how often a text description node has to occur to be
- included in the graph
+ python main.py -year 1820 1821 1822 -output_path "../output/example_graph_1820-1822.json"
+
+To display all available options, type:
+
+ python main.py -h
\ No newline at end of file
--
GitLab