fitbenchmarking.results_processing.tables module

Set up and build the results tables.

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

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

Parameters:

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

  • results (dict[str, dict[str, list[utils.fitbm_result.FittingResult]]]) – Results grouped by row and category (for colouring)

  • best_results (dict[str, dict[str, utils.fitbm_result.FittingResult]]) – The best results from each row/category

  • group_dir (str) – path to the directory where group results should be stored

  • fig_dir (str) – path to the directory where figures should be stored

  • pp_locations (dict[str,str]) – the locations of the performance profiles

  • 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, fig_dir, pp_locations, table_name, suffix)

Generate html/csv tables.

Parameters:

  • results (dict[str, dict[str, list[utils.fitbm_result.FittingResult]]]) – Results grouped by row and category (for colouring)

  • best_results (dict[str, dict[str, utils.fitbm_result.FittingResult]]) – The best results from each row/category

  • 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

  • fig_dir (str) – path to the directory where figures should be stored

  • pp_locations (dict[str,str]) – the locations of the performance profiles

  • table_name (str) – name of the table

  • suffix (str) – table suffix

Returns:

(Table object, Dict of HTML strings for table and dropdowns,

text string of table, path to colourbar) :rtype: tuple(Table object, dict{str: str}, 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