BenchOpt is a package to simplify, make more transparent and more reproducible the comparisons of optimization algorithms.
BenchOpt is written in Python but it is available with many programming languages. So far it has been tested with Python, R, Julia and compiled binaries written in C/C++ available via a terminal command. If it can be installed via conda it should just work!
BenchOpt is used through a command line as described in the API Documentation. Ultimately running and replicating an optimization benchmark should be as simple as doing:
$ git clone https://github.com/benchopt/benchmark_logreg_l2 $ benchopt run --env ./benchmark_logreg_l2
Running this command will give you a benchmark plot on l2-regularized logistic regression:
To discover which benchmarks are presently available look for benchmark_* repositories on GitHub, such as for l1-regularized logistic regression.
Learn how to write a benchmark on our documentation and use our template to kickstart it.
This package can be installed through pip. To get the last release, use:
$ pip install benchopt
And to get the latest development version, you can use:
$ pip install -U https://github.com/benchopt/benchopt/archive/master.zip
This will install the command line tool to run the benchmark. Then, existing benchmarks can be retrieved from git or created locally. For instance, the benchmark for Lasso can be retrieved with:
$ git clone https://github.com/benchopt/benchmark_lasso
To run the Lasso benchmark on all datasets and with all solvers, run:
$ benchopt run --env ./benchmark_lasso
Use
$ benchopt run -h
to get more details about the different options or read the API Documentation.
