fitbenchmarking.core.fitting_benchmarking module

Main module of the tool, this holds the Fit Class that calls methods to fit and benchmark a set of problems for a certain fitting software.

class fitbenchmarking.core.fitting_benchmarking.Fit(options, data_dir, checkpointer, label='benchmark')

Bases: object

The class that performs the fit benchmark and collates the results.

benchmark()

Call benchmarking on user input and list of paths. The benchmarking structure is:

__loop_over_starting_values()
    __loop_over_software()
        __loop_over_minimizers()
            __loop_over_jacobians()
                __loop_over_hessians()
                    __perform_fit()

Returns:

all results, problems where all fitting failed, and minimizers that were unselected due to algorithm_type

Return type:

list[fibenchmarking.utils.fitbm_result.FittingResult], list[str], dict[str, list[str]]