Khloraa scaffolding: benchmarks#

Documentation Status

The GitLab repository khloraascaf_results permitted to test the khloraa scaffolding python package (khloraascaf).

Content#

Reproducing the results#

First, clone the GitLab repository https://gitlab.com/khloraa_scaffolding/khloraascaf_results:

git clone git@gitlab.com:khloraa_scaffolding/khloraascaf_results.git
cd khloraascaf_results

Each directory in the repository represents a specific benchmark, associated to a specific version of khloraascaf and of klhloraascaf_utils python packages.

Benchmarks organisation#

All benchmark folder have the benchmark_ prefix.

For a given benchmark, you must run its scripts at the root of its associated folder, e.g. for benchmark_3:

cd benchmark_3
#
# Configurate
# * create the virtual environement
# * source the virtual environement
#
# Run the scripts
# * run the main script
# * run the evaluation scripts
# * format the results to LaTeX files

To run one of the benchmark, please refer to its documentation in this doc (e.g. for benchmark_3).

What follows is the conventional folder hierarchy:

.
└── benchmark_name
    ├── config
    ├── data
    ├── run
    ├── scripts
    │   ├── lib.py
    │   └── run_benchmark_name.py
    └── README.md

Licence#

This work is licensed under a GNU-GPLv3 licence.

Thanks#

Logo by Jan on Pixabay