fitbenchmarking.results_processing.emissions_table module

Emissions table

class fitbenchmarking.results_processing.emissions_table.EmissionsTable(results, best_results, options, group_dir, pp_locations, table_name)

Bases: fitbenchmarking.results_processing.base_table.Table

The emissions (kg CO₂eq) results are calculated from an average (over num_runs) using the codecarbon module. num_runs is set in FitBenchmarking Options.

Configuration for codecarbon is set in .codecarbon.config.

Please note that for tracking CPU power usage on Windows or Mac, Intel Power Gadget shoud also be installed. For more information, see the Methodology section of the codecarbon docs.

get_value(result)

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

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

Parameters

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

Returns

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

Return type

tuple(float, float)