summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLoïc Guégan <loic.guegan@mailbox.org>2025-09-19 10:41:19 +0200
committerLoïc Guégan <loic.guegan@mailbox.org>2025-09-19 10:41:19 +0200
commit284cee3f032bed1243f0d1256d394e9458132075 (patch)
tree613066feb20a4d45c8fbd5c102a329298b4a1a66 /README.md
parent1ff11712d1d49cd166e2df44b850ac6fecaf6f49 (diff)
Improve readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 7b2fffd..52a99f5 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,17 @@
# loosely-policies-analytics
-Analysis folder:
+## Analysis folder
- learning.R: contains two major functions:
- build_models: To generate K-fold cross-validation results (note that hyper-parameters for decisions tree is fixed (no validation set))
- generate_inputs: generate the inputs for the simulations experiments + the decision tree plots
- days.R: Implement the in-situ learning approach
-To fix: remove minbucket=1 (does not impact the results)
+Todo: remove minbucket=1 (does not impact the results)
+
+## Simulation folder
+
+- src/: contains the simulator code (based on SimGrid)
+- libs/: contains a setup script that will fetch and configure the correct SimGrid version
+ - see simulation/README.md for more info
+- results/: Contains all needed script to run the experiments
+ - In particular paper.sh generates the results present in the paper