From e12d528b2565eb242bc7f9700f8a15c082cda055 Mon Sep 17 00:00:00 2001 From: finn <finn@hillengass.de> Date: Thu, 29 Feb 2024 18:00:45 +0100 Subject: [PATCH] Update metrics README with setup and usage instructions --- metrics/README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/metrics/README.md b/metrics/README.md index 541261f..2c67ed5 100644 --- a/metrics/README.md +++ b/metrics/README.md @@ -10,18 +10,30 @@ This is the Metrics section of our project. In order to run the metrics we want to on our dialogues, we need to set up separate virtual environments for each of them. <br> -To set up the environments on the CoLi Cluster (to be adapted to your workspace) first you need to run: <br> <br> -**sh virtual_environment_creator.sh** <br> <br> +To set up the environments on the CoLi Cluster (to be adapted to your workspace) first you need to run: + +## 📠Overview + +- `sh virtual_environment_creator.sh` - Creates the virtual environments for the metrics. +- `sbatch virtual_environment_populator.sh` - Populates the virtual environments with the necessary packages. +- `general_execution_script.sh` - Runs the metrics on the dialogues. + +## ✔ Setup and Usage + +```sh virtual_environment_creator.sh``` + in your terminal. -Then, after that process has run through, run <br><br> -**sbatch virtual_environment_populator.sh** <br><br> +Then, after that process has run through, run + +```sbatch virtual_environment_populator.sh``` + in your terminal. -Then download the models from the different repositories of the metrics by following the instructions in the respective readmes. Then run the <br> <br> -**general_execution_script.sh** -<br><br> +Then download the models from the different repositories of the metrics by following the instructions in the respective readmes. Then run the + +``` general_execution_script.sh``` -In the **general_execution_script.sh** you can specify which dialogue dataset you want analysed by setting the DATAFRAME_PATH="example_file.csv", to the file you want. +In the **general_execution_script.sh** you can specify which dialogue dataset you want analysed by setting the *DATAFRAME_PATH="example_file.csv"*, to the file you want. <!--S3BERT setup -- GitLab