From 3ab42e250bb22cd49ff1a960dd9c7663602d25c7 Mon Sep 17 00:00:00 2001 From: maskomic Date: Tue, 10 Oct 2023 07:46:43 +0200 Subject: [PATCH] update readme --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 025896a..7df90ea 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ data = GroupAD.load_data("Fox") ``` 4. Running a single experiment of VAE with 5-fold crossvalidation on the Tiger dataset. ```bash -cd scripts/experiments +cd scripts/experiments_mill julia vae_basic.jl 5 Tiger ``` 5. You can quickly evaluate the results using this recursive script. @@ -26,6 +26,17 @@ julia vae_basic.jl 5 Tiger julia GroupAD.jl/scripts/evaluate_performance_single.jl path/to/results ``` +## Project structure + +Source files can be found in `src`. There are multiple modules used for utilities, and the model implementations and be found here. + +Since every experiments is a little bit different, each group has its own experimental folder in the `scripts` folder: +- MIL datasets +- LHCO dataset +- point cloud datasets (MNIST, ModelNet10) + +Each model has its own run script and bash script to submit to the cluster. Scripts for submitting experiments to run in parallel are also present. Always submit the run script from its script folder. + ## Running experiments on the RCI cluster *Note: Since LHCO dataset, Python is needed for data loading. Use Python/3.8 to install `pandas`.*