From 8edbf3408f32b934d2918ff276f194c235997be5 Mon Sep 17 00:00:00 2001 From: Malo Revel <malo.revel@irisa.fr> Date: Fri, 21 Apr 2023 07:10:10 +0000 Subject: [PATCH] Update Readme --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0f000f5..63d593a 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) -- GitLab