diff --git a/README.md b/README.md index ad27c5f1f888d2a2e0e0b5993feebabf88bbe2a4..735377778d0245b6b32b0597e07e37f0cbcd2bc9 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