fitbenchmarking.results_processing.tables module

Set up and build the results tables.

fitbenchmarking.results_processing.tables.create_results_tables(options, results, best_results, group_name, group_dir, pp_locations, failed_problems, unselected_minimzers)

Saves the results of the fitting to html/txt tables.

Parameters:
  • options (fitbenchmarking.utils.options.Options) – The options used in the fitting problem and plotting
  • results (list of list of fitbenchmarking.utils.fitbm_result.FittingResult) – results nested array of objects
  • best_results (list of fitbenchmarking.utils.fitbm_result.FittingResult) – best result for each problem
  • group_name (str) – name of the problem group
  • group_dir (str) – path to the directory where group results should be stored
  • table_descriptions (dict) – dictionary containing descriptions of the tables and the comparison mode
  • pp_locations (tuple(str,str)) – tuple containing the locations of the performance profiles (acc then runtime)
  • failed_problems (list) – list of failed problems to be reported in the html output
Params unselected_minimzers:
 

Dictionary containing unselected minimizers based on the algorithm_type option
Returns:

filepaths to each table e.g {‘acc’: <acc-table-filename>, ‘runtime’: …} and dictionary of table descriptions
Return type:

tuple(dict, dict)
fitbenchmarking.results_processing.tables.generate_table(results, best_results, options, group_dir, pp_locations, table_name, suffix)

Generate html/txt tables.

Parameters:
  • results (list of list of fitbenchmarking.utils.fitbm_result.FittingResult) – results nested array of objects
  • best_results (list of fitbenchmarking.utils.fitbm_result.FittingResult) – best result for each problem
  • options (fitbenchmarking.utils.options.Options) – The options used in the fitting problem and plotting
  • group_dir (str) – path to the directory where group results should be stored
  • pp_locations (tuple(str,str)) – tuple containing the locations of the performance profiles (acc then runtime)
  • table_name (str) – name of the table
  • suffix (str) – table suffix
Returns:

Table object, HTML string of table and text string of table.
Return type:

tuple(Table object, str, str)
fitbenchmarking.results_processing.tables.load_table(table)

Create and return table object.

Parameters:table (string) – The name of the table to create a table for
Returns:Table class for the problem
Return type:fitbenchmarking/results_processing/tables.Table subclass