From 3fbd043536b7a02793da0ddc32697b05d5ccd3f6 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 24 Apr 2020 19:23:39 +0100 Subject: Add a paragraph with a high-level overview of the repo --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index d4888787..9256f01b 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,20 @@ dataset or this benchmark should cite that paper: } ``` +For the experiments we've used the [abed](https://github.com/GjjvdBurg/abed) +command line program, which makes it easy to organize and run the experiments. +This means that all experiments are defined through the +[abed_conf.py](abed_conf.py) file. In particular, the hyperparameters and the +command line arguments to all methods are defined in that file. Next, all +methods are called as command line scripts and they are defined in the +[execs](execs) directory. The raw results from the experiments are collected +in JSON files and placed in the [abed_results](abed_results) directory, +organized by dataset and method. Finally, we use +[Make](https://www.gnu.org/software/make/) to coordinate our analysis scripts: +first we generate [summary files](analysis/output/summaries) using +[summarize.py](analysis/scripts/summarize.py), and then use these to generate +all the tables and figures in the paper. + ## Getting Started This repository contains all the code to generate the results -- cgit v1.2.3