diff options
| author | Samuel Fadel <samuelfadel@gmail.com> | 2016-08-31 09:39:37 -0300 |
|---|---|---|
| committer | Samuel Fadel <samuelfadel@gmail.com> | 2016-08-31 09:39:37 -0300 |
| commit | fdae43b3851400d30d9bd374542ade8a0e73422f (patch) | |
| tree | b191ff4c9af5097468a7f75d4e57f9ae2e88bfd3 /README.md | |
| parent | c9003e0169f4f7775b6c84e40caec0e5ade4447b (diff) | |
Added README file(s) and LICENSE.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 14 |
1 files changed, 14 insertions, 0 deletions
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. |