fitbenchmarking.results_processing.fitting_report module

Set up and build the fitting reports for various types of problems.

fitbenchmarking.results_processing.fitting_report.create(results, support_pages_dir, options)

Iterate through problem results and create a fitting report html page for each.

Parameters:

• results (list[FittingResult]) – results object

• support_pages_dir (str) – directory in which the results are saved

• options (fitbenchmarking.utils.options.Options) – The options used in the fitting problem and plotting

fitbenchmarking.results_processing.fitting_report.create_prob_group(result, support_pages_dir, options)

Creates a fitting report containing figures and other details about the fit for a problem. A link to the fitting report is stored in the results object.

Parameters:

• result (fitbenchmarking.utils.fitbm_result.FittingResult) – The result for a specific benchmark problem-minimizer-etc combination

• support_pages_dir (str) – directory to store the support pages in

• options (fitbenchmarking.utils.options.Options) – The options used in the fitting problem and plotting

fitbenchmarking.results_processing.fitting_report.get_figure_paths(result)

Get the paths to the figures used in the support page.

Parameters:

result (fitbenchmarking.utils.fitbm_result.FittingProblem) – The result to get the figures for

Returns:

the paths to the required figures

Return type:

tuple(str, str)