fitbenchmarking.results_processing.runtime_table module

Runtime table

class fitbenchmarking.results_processing.runtime_table.RuntimeTable(results, best_results, options, group_dir, pp_locations, table_name)

Bases: Table

The timing results are calculated from an average (over num_runs) using the timeit module in python. num_runs is set in FitBenchmarking Options.

cbar_title = 'Problem-Specific Cell Shading: Relative Runtime'

Generates the hyperlink for a given result

Parameters:

  • result (fitbenchmarking.utils.ftibm_result.FittingResult) – The result to generate a string for

  • val_str (str) – Preprocessed val_str to display

  • text_col (str) – Foreground colour for the text as html rgb strings e.g. ‘rgb(255, 255, 255)’

Returns:

The hyperlink representation.

Return type:

str

get_value(result)

Gets the main value to be reported in the tables for a given result

Note that the first value (relative runtime) will be used in the default colour handling.

Parameters:

result (FittingResult) – The result to generate the values for.

Returns:

The normalised runtime with respect to the smallest runtime and absolute runtime for the result.

Return type:

tuple(float, float)

name = 'runtime'