BenchTools#

A library for building and running benchmarks

Install#

You can install after cloning to work locally or directly from github.

By clone#

You can clone first

git clone https://github.com/ml4sts/benchtools.git

and then install

pip install benchtools

(possibly pip3)

if you clone in order to develop, you may want to install with pip’s -e option

pip install -e benchtools

To update, pull and install again.

Usage#

benchtools allows you to express templated tasks in multiple ways:

  • a yaml format

  • a txt file with tempalte and a csv file of values

a benchmark can consist of tasks that all fit a single format above or a mixture of meta-tasks each represented as a folder and then the specific tasks in one of the forms above

There are two main ways to use BenchTools. The user can mix and match between the two methods.