fitbenchmarking.core.fitting_benchmarking module¶

Main module of the tool, this holds the master function that calls lower level functions to fit and benchmark a set of problems for a certain fitting software.

fitbenchmarking.core.fitting_benchmarking.benchmark(options, data_dir)¶

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

loop_over_benchmark_problems()
    loop_over_starting_values()
        loop_over_software()
            loop_over_minimizers()

Parameters:	options (fitbenchmarking.utils.options.Options) – dictionary containing software used in fitting the problem, list of minimizers and location of json file contain minimizers data_dir – full path of a directory that holds a group of problem definition files
Returns:	prob_results array of fitting results for the problem group, list of failed problems and dictionary of unselected minimizers
Return type:	tuple(list, list, dict)

fitbenchmarking.core.fitting_benchmarking.loop_over_benchmark_problems(problem_group, options)¶

Loops over benchmark problems

Parameters:	problem_group (list) – locations of the benchmark problem files options (fitbenchmarking.utils.options.Options) – FitBenchmarking options for current run
Returns:	prob_results array of fitting results for the problem group, list of failed problems and dictionary of unselected minimizers
Return type:	tuple(list, list, dict)

fitbenchmarking.core.fitting_benchmarking.loop_over_fitting_software(problem, options, start_values_index, grabbed_output)¶

Loops over fitting software selected in the options

Parameters:	problem (FittingProblem) – a problem object containing information used in fitting options (fitbenchmarking.utils.options.Options) – FitBenchmarking options for current run start_values_index (int) – Integer that selects the starting values when datasets have multiple ones. grabbed_output (fitbenchmarking.utils.output_grabber.OutputGrabber) – Object that removes third part output from console
Returns:	list of all results, failed problem names and dictionary of unselected minimizers based on algorithm_type
Return type:	tuple(list of fibenchmarking.utils.fitbm_result.FittingResult, list of failed problem names, dictionary of minimizers)

fitbenchmarking.core.fitting_benchmarking.loop_over_minimizers(controller, minimizers, options, grabbed_output)¶

Loops over minimizers in fitting software

Parameters:	controller (Object derived from BaseSoftwareController) – The software controller for the fitting minimizers (list) – array of minimizers used in fitting options (fitbenchmarking.utils.options.Options) – FitBenchmarking options for current run grabbed_output (fitbenchmarking.utils.output_grabber.OutputGrabber) – Object that removes third part output from console
Returns:	list of all results and dictionary of unselected minimizers based on algorithm_type
Return type:	tuple(list of fibenchmarking.utils.fitbm_result.FittingResult, list of failed minimizers)

fitbenchmarking.core.fitting_benchmarking.loop_over_starting_values(problem, options, grabbed_output)¶

Loops over starting values from the fitting problem

Parameters:	problem (FittingProblem) – a problem object containing information used in fitting options (fitbenchmarking.utils.options.Options) – FitBenchmarking options for current run grabbed_output (fitbenchmarking.utils.output_grabber.OutputGrabber) – Object that removes third part output from console
Returns:	prob_results array of fitting results for the problem group, list of failed problems and dictionary of unselected minimizers
Return type:	tuple(list, list, dict)