Python API

Here is a list of Python function available to construct a new benchmark.

benchopt:

run_benchmark(benchmark[, solver_names, ...])	Run full benchmark.
safe_import_context()	Context used to manage import in benchmarks.
plotting.plot_benchmark(fname, benchmark[, ...])	Plot convergence curve and bar chart for a given benchmark.
datasets.simulated.make_correlated_data([...])	Generate a linear regression with decaying correlation for the design matrix \(\rho^{|i-j|}\).
utils.profile(func)	Decorator to tell line profiler which function to profile.

List of base classes:

BaseObjective(**parameters)	Base class to define an objective function
BaseDataset(**parameters)	Base class to define a dataset in a benchmark.
BaseSolver(**parameters)	A base class for solver wrappers in BenchOpt.