This repo should be used with the following steps:
- Hit the Use this template button on the top of this page,
- Use the form to create a new github repository with your benchmark name,
- Clone the newly created repository on your computer,
- Run
python clean_template.py
script that will remove instruction relative to the template inREADME.rst
and update it with your repo and org name. - Edit the problem description in the
README.rst
. - Update
objective.py
and the files indatasets
andsolvers
to create the benchmark.
Benchopt is a package to simplify and make more transparent and reproducible the comparisons of optimization algorithms. This benchmark is dedicated to solver of describe your problem:
where n_samples
) stands for the number of samples, n_features
) stands for the number of features and
This benchmark can be run using the following commands:
$ pip install -U benchopt $ git clone https://github.com/#ORG/#BENCHMARK_NAME $ benchopt run #BENCHMARK_NAME
Apart from the problem, options can be passed to benchopt run
, to restrict the benchmarks to some solvers or datasets, e.g.:
$ benchopt run #BENCHMARK_NAME -s solver1 -d dataset2 --max-runs 10 --n-repetitions 10
Use benchopt run -h
for more details about these options, or visit https://benchopt.github.io/api.html.