fitbenchmarking.results_processing.energy_usage_table module

Energy Usage table

class fitbenchmarking.results_processing.energy_usage_table.EnergyUsageTable(results, best_results, options, group_dir, pp_locations, table_name)

Bases: Table

The energy usage (kWh) results are calculated from an average (over num_runs) using the codecarbon module. num_runs is set in FitBenchmarking Options.

For more information on how energy usage is measured, see the Methodology section of the codecarbon docs.

cbar_title = 'Problem-Specific Cell Shading: Relative Energy Usage'

get_value(result)

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

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

Parameters:

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

Returns:

The normalised energy usage with respect to the smallest energy value and absolute energy for the result.

Return type:

tuple(float, float)

name = 'energy_usage'