tomMoral/template_benchmark

Template for BenchOpt Benchmark repositories

This repo should be used with the following steps:

1. Hit the Use this template button,
2. Create the repo,
3. Clone it on your computer,
4. Run python clean_template.py script that will replace the necessary part in the README.rst with your repo and org name.
5. Remove this section and describe

My BenchOpt 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:

\min_{w} f(X, w)

where n (or n_samples) stands for the number of samples, p (or n_features) stands for the number of features and

X = [x_1^\top, \dots, x_n^\top]^\top \in \mathbb{R}^{n \times p}

Install

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.