Commit 077f9b66 authored by Mario Teixeira Parente's avatar Mario Teixeira Parente
Browse files

adjust README to new folder for approaches

parent b759966e
...@@ -63,6 +63,12 @@ Directory: `general/` ...@@ -63,6 +63,12 @@ Directory: `general/`
### TAS ### TAS
Directory: `tas/` Directory: `tas/`
`tas/approaches/`: Implementation of TAS approaches.
`tas/approaches/dummies.py`: Implementation of dummy approaches.
`RandomnessApproach` chooses measurement locations uniformly at random in the valid part of the region of interest.
`GridApproach` chooses measurement locations on a grid structure in a specific order.
`tas/experiments/`: Directory for storing JSON files of conducted experiments. `tas/experiments/`: Directory for storing JSON files of conducted experiments.
It is empty after cloning. It is empty after cloning.
Each approach the benchmarking procedure is run for has its own subdirectory. Each approach the benchmarking procedure is run for has its own subdirectory.
...@@ -73,10 +79,6 @@ Each approach the benchmarking procedure is run for has its own subdirectory. ...@@ -73,10 +79,6 @@ Each approach the benchmarking procedure is run for has its own subdirectory.
`tas/test_cases/`: Directory with TAS test cases as JSON files. `tas/test_cases/`: Directory with TAS test cases as JSON files.
`tas/dummies.py`: Implementation of dummy approaches.
`RandomnessApproach` chooses measurement locations uniformly at random in the valid part of the region of interest.
`GridApproach` chooses measurement locations on a grid structure in a specific order.
`tas/run_benchmark.py`: Script for running the benchmark procedure with experiments from the approach's subdirectory in `tas/experiments/`. `tas/run_benchmark.py`: Script for running the benchmark procedure with experiments from the approach's subdirectory in `tas/experiments/`.
`tas/run_diagnostics.py`: Script for running diagnostics of the components in the TAS setting, i.e., test cases, experiments, and benchmark results. `tas/run_diagnostics.py`: Script for running diagnostics of the components in the TAS setting, i.e., test cases, experiments, and benchmark results.
...@@ -103,7 +105,7 @@ Results are stored in the approach's subdirectory in `tas/results/`. ...@@ -103,7 +105,7 @@ Results are stored in the approach's subdirectory in `tas/results/`.
8. If applicable, get results from the community, store them in a subdirectory in `tas/results` and make a comparison by running the second part of `general/run_diagnostics.py`. 8. If applicable, get results from the community, store them in a subdirectory in `tas/results` and make a comparison by running the second part of `general/run_diagnostics.py`.
#### Testing with a dummy approach in the TAS setting #### Testing with a dummy approach in the TAS setting
The procedure can be tested in the TAS setting without modifying a fresh clone of this repository with the given test cases in `tas/test_cases` and the dummy approach based on random sampling from `tas/dummies.py`. The procedure can be tested in the TAS setting without modifying a fresh clone of this repository with the given test cases in `tas/test_cases` and the dummy approach based on random sampling from `tas/approaches/dummies.py`.
1. Run `tas/run_experiments.py`. 1. Run `tas/run_experiments.py`.
2. Run `tas/run_diagnostics.py` to diagnose test cases and experiments. 2. Run `tas/run_diagnostics.py` to diagnose test cases and experiments.
3. Run `tas/run_benchmark.py`. 3. Run `tas/run_benchmark.py`.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment