Commit 8ce0dd56 authored by born's avatar born
Browse files

Update README.md

parent 402a7709
Loading
Loading
Loading
Loading
+9 −24
Original line number Diff line number Diff line
@@ -44,30 +44,15 @@ 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":

    python main.py -year 1913 -output_path "../output/example_graph_1913_simplified.json" -text_node_simplification_mode classifier

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:
    
    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
    
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