Measure energy usage instead of emissions (fitbenchmarking#1377)

* switch from emissions to energy usage * remove local changes * Discard changes to .gitignore * Update fitbenchmarking/core/results_output.py Co-authored-by: RabiyaF <[email protected]> * Update fitbenchmarking/utils/fitbm_result.py Co-authored-by: RabiyaF <[email protected]> * Add units Co-authored-by: RabiyaF <[email protected]> * rename docs page * line length fix * Reduce interval for measuring power usage Co-authored-by: RabiyaF <[email protected]> * ruff format fix --------- Co-authored-by: RabiyaF <[email protected]>
RabiyaF · Nov 18, 2024 · 67510c6 · 67510c6
1 parent 5b1cdc6
commit 67510c6
Show file tree

Hide file tree

Showing 32 changed files with 225 additions and 214 deletions.
diff --git a/docs/source/users/options/output_option.rst b/docs/source/users/options/output_option.rst
@@ -130,9 +130,9 @@ Options are:
   The value of :math:`\frac{|| J^T r||}{||r||}` for those parameters is also returned.
   The output looks like ``{bool} (norm_value)``, and the colouring is red for false and cream for true.
   This option is only meaningful for least-squares cost functions.
-* ``emissions`` indicates that the resulting table should contain the CO\ :sub:`2` \ emissions for each of the minimizers.
+* ``energy_usage`` indicates that the resulting table should contain energy consumption (kWh) for each of the minimizers.
 
-Default is ``acc``, ``runtime``, ``compare``, ``local_min``, and ``emissions``.
+Default is ``acc``, ``runtime``, ``compare``, ``local_min``, and ``energy_usage``.
 
 .. code-block:: rst
 
@@ -141,7 +141,7 @@ Default is ``acc``, ``runtime``, ``compare``, ``local_min``, and ``emissions``.
                 runtime
                 compare
                 local_min
-                emissions
+                energy_usage
 
 Run Dash (:code:`run_dash`)
 -------------------------------

diff --git a/docs/source/users/output/emissions.rst b/docs/source/users/output/emissions.rst
diff --git a/docs/source/users/output/energy_usage.rst b/docs/source/users/output/energy_usage.rst
@@ -0,0 +1,9 @@
+.. _energy_usage:
+
+##################
+Energy Usage Table
+##################
+
+.. currentmodule:: fitbenchmarking.results_processing.energy_usage_table
+.. autoclass:: fitbenchmarking.results_processing.energy_usage_table.EnergyUsageTable
+	       :noindex:
diff --git a/docs/source/users/output/index.rst b/docs/source/users/output/index.rst
@@ -18,12 +18,12 @@ Tables
     acc
     runtime
     local_min
-    emissions
+    energy_usage
 
 Display modes
 -------------
 
-The tables for ``accuracy``, ``runtime``, ``emissions``, and ``compare`` have three display
+The tables for ``accuracy``, ``runtime``, ``energy_usage``, and ``compare`` have three display
 modes:
 
 .. prettyprintmodulevalue::

diff --git a/fitbenchmarking/cli/checkpoint_handler.py b/fitbenchmarking/cli/checkpoint_handler.py
@@ -123,10 +123,10 @@ def get_parser() -> ArgumentParser:
         "--strategy",
         metavar="STRATEGY",
         default="first",
-        choices=["first", "last", "accuracy", "runtime", "emissions"],
+        choices=["first", "last", "accuracy", "runtime", "energy"],
         help=(
             "The merge strategy to use when dealing with conflicts. "
-            "Selecting accuracy, emissions, or runtime will select for the "
+            "Selecting accuracy, energy, or runtime will select for the "
             "lowest from conflicting runs."
         ),
     )
@@ -381,7 +381,7 @@ def key_gen(k: dict):
         key = key_gen(res)
         if key in A_key:
             if (
-                strategy in ["accuracy", "emissions", "runtime"]
+                strategy in ["accuracy", "energy", "runtime"]
                 and A[A_key[key]][strategy] > res[strategy]
             ):
                 A[A_key[key]] = res

diff --git a/fitbenchmarking/cli/tests/test_checkpoint_handler.py b/fitbenchmarking/cli/tests/test_checkpoint_handler.py
@@ -179,7 +179,7 @@ def test_strategy(self):
                 "result": 0.1,
             },
             {
-                "strategy": "emissions",
+                "strategy": "energy",
                 "result": 12.0,
             },
         ]

diff --git a/fitbenchmarking/cli/tests/test_files/A.json b/fitbenchmarking/cli/tests/test_files/A.json
@@ -56,7 +56,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.1,
-        "emissions": 1.9,
+        "energy": 1.9,
         "runtime": 0.2,
         "flag": 0,
         "software": "common1",
@@ -78,7 +78,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.1,
-        "emissions": 1.8,
+        "energy": 1.8,
         "runtime": 0.2,
         "flag": 0,
         "software": "common1",
@@ -100,7 +100,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 1.7,
+        "energy": 1.7,
         "runtime": 0.0,
         "flag": 0,
         "software": "common1",
@@ -122,7 +122,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 1.6,
+        "energy": 1.6,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",
@@ -144,7 +144,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 1.5,
+        "energy": 1.5,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",
@@ -166,7 +166,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 1.4,
+        "energy": 1.4,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",

diff --git a/fitbenchmarking/cli/tests/test_files/AB.json b/fitbenchmarking/cli/tests/test_files/AB.json
@@ -72,7 +72,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.1,
-        "emissions": 1.9,
+        "energy": 1.9,
         "runtime": 0.2,
         "flag": 0,
         "software": "common1",
@@ -94,7 +94,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.1,
-        "emissions": 1.8,
+        "energy": 1.8,
         "runtime": 0.2,
         "flag": 0,
         "software": "common1",
@@ -116,7 +116,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 1.7,
+        "energy": 1.7,
         "runtime": 0.0,
         "flag": 0,
         "software": "common1",
@@ -138,7 +138,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 1.6,
+        "energy": 1.6,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",
@@ -160,7 +160,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 1.5,
+        "energy": 1.5,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",
@@ -182,7 +182,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 1.4,
+        "energy": 1.4,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",
@@ -204,7 +204,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 0.7,
+        "energy": 0.7,
         "runtime": 0.0,
         "flag": 0,
         "software": "common1",
@@ -226,7 +226,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 0.6,
+        "energy": 0.6,
         "runtime": 0.0,
         "flag": 0,
         "software": "B1",
@@ -248,7 +248,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 0.5,
+        "energy": 0.5,
         "runtime": 0.0,
         "flag": 0,
         "software": "B1",
@@ -270,7 +270,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 0.4,
+        "energy": 0.4,
         "runtime": 0.0,
         "flag": 0,
         "software": "B1",

diff --git a/fitbenchmarking/cli/tests/test_files/B.json b/fitbenchmarking/cli/tests/test_files/B.json
@@ -56,7 +56,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 12.0,
-        "emissions": 0.9,
+        "energy": 0.9,
         "runtime": 30.0,
         "flag": 0,
         "software": "common1",
@@ -78,7 +78,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 12.0,
-        "emissions": 0.8,
+        "energy": 0.8,
         "runtime": 30.0,
         "flag": 0,
         "software": "common1",
@@ -100,7 +100,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 0.7,
+        "energy": 0.7,
         "runtime": 0.0,
         "flag": 0,
         "software": "common1",
@@ -122,7 +122,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 0.6,
+        "energy": 0.6,
         "runtime": 0.0,
         "flag": 0,
         "software": "B1",
@@ -144,7 +144,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 0.5,
+        "energy": 0.5,
         "runtime": 0.0,
         "flag": 0,
         "software": "B1",
@@ -166,7 +166,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 0.4,
+        "energy": 0.4,
         "runtime": 0.0,
         "flag": 0,
         "software": "B1",

diff --git a/fitbenchmarking/cli/tests/test_files/C.json b/fitbenchmarking/cli/tests/test_files/C.json
@@ -56,7 +56,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 2.9,
+        "energy": 2.9,
         "runtime": 0.0,
         "flag": 0,
         "software": "common1",
@@ -78,7 +78,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 2.9,
+        "energy": 2.9,
         "runtime": 0.0,
         "flag": 0,
         "software": "common1",
@@ -100,7 +100,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 2.9,
+        "energy": 2.9,
         "runtime": 0.0,
         "flag": 0,
         "software": "common1",
@@ -122,7 +122,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 2.9,
+        "energy": 2.9,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",
@@ -144,7 +144,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 2.9,
+        "energy": 2.9,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",
@@ -166,7 +166,7 @@
         "fin_params": "",
         "fin_params_str": "",
         "accuracy": 0.0,
-        "emissions": 2.9,
+        "energy": 2.9,
         "runtime": 0.0,
         "flag": 0,
         "software": "A1",

diff --git a/fitbenchmarking/cli/tests/test_files/D.json b/fitbenchmarking/cli/tests/test_files/D.json
@@ -24,7 +24,7 @@
           "fin_params": "",
           "fin_params_str": "",
           "accuracy": 0.0,
-        "emissions": 2.9,
+        "energy": 2.9,
         "runtime": 0.0,
           "flag": 0,
           "software": "common1",
@@ -46,7 +46,7 @@
           "fin_params": "",
           "fin_params_str": "",
           "accuracy": 0.0,
-        "emissions": 2.9,
+        "energy": 2.9,
         "runtime": 0.0,
           "flag": 0,
           "software": "A1",