diff --git a/README.md b/README.md index 0f000f57aa38f255c993843b382b9429caf6bef9..63d593aac4f8c55a0514edb793043990f87d92a2 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,23 @@ The inputs are expected to be directories containing the corpus sentences (text ## Usage -+ `main.py`: +### `main.py` ``` -$ python3 main.py <corpus_sentence_directory> <corpus_sentence_directory> <output_odrl_directory> +$ python3 main.py <corpus_sentence_directory> <corpus_odrl_directory> <output_odrl_directory> +``` + +Where: + ++ `<corpus_sentence_directory>` is a path to the directory containing the corpus sentences ++ `<corpus_sentence_directory>` is a path to the directory containing the corpus ODRL representations ++ `<output_odrl_directory>` is a path to the directory containing the ODRL representations produced by the evaluated system (e.g. Tenet) + +### `stats.py` +``` +$ python3 stats.py <corpus_sentence_directory> <corpus_odrl_directory> +``` + +### `scorer.py` +``` +$ python3 scorer.py <corpus_odrl_directory> <output_odrl_directory> ``` - Where: - + `<corpus_sentence_directory>` is a path to the directory containing the corpus sentences - + `<corpus_sentence_directory>` is a path to the directory containing the corpus ODRL representations - + `<output_odrl_directory>` is a path to the directory containing the ODRL representations produced by the evaluated system (e.g. Tenet)