benchopt.plotting.plot_benchmark

benchopt.plotting.plot_benchmark(fname, benchmark, kinds=None, display=True, plotly=False, html=True)

Plot convergence curve and bar chart for a given benchmark.

Parameters:
fnamestr

Name of the file in which the results are saved.

benchmarkbenchopt.Benchmark object

Object to represent the benchmark.

kindslist of str or None

List of the plots that will be generated. If None are provided, use the config file to choose or default to suboptimality_curve.

displaybool

If set to True, display the curves with plt.show.

plotlybool

If set to True, generate figures with plotly if possible and save the result as a HTML file.

htmlbool

If True plot the benchmark in an HTML page. If True, plotly is necessarily used.

Returns:
figslist

The matplotlib figures for convergence curve and bar chart for each dataset.