From fdae43b3851400d30d9bd374542ade8a0e73422f Mon Sep 17 00:00:00 2001 From: Samuel Fadel Date: Wed, 31 Aug 2016 09:39:37 -0300 Subject: Added README file(s) and LICENSE. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..e07e668 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Introduction +These scripts are used to reproduce the experiments I ran during my Master's +research. The R scripts are the main experiments, while the python scripts in +the `datasets` directory are used to download and prepare the datasets used. + +# R scripts +The main R script is `run.R`. It is configured via `config.R`, which contains +details about which techniques and datasets we are running the experiments on. + +# Python scripts +Most scripts should run with a simple `python script.py`. If it requires +additional parameters, it will say so and explain which are those. Whenever that +happens, the parameters used in my experiments are detailed in a `README` file +inside the corresponding directory. -- cgit v1.2.3