Merge remote-tracking branch 'origin/dev' into feature/2646_Update-pre-commit-to-check-for-valid-copyright

src/primaite/utils/converters.py

@@ -0,0 +1,26 @@
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
+from enum import Enum
+from typing import Any, Dict
+
+
+def convert_dict_enum_keys_to_enum_values(d: Dict[Any, Any]) -> Dict[Any, Any]:
+    """
+    Convert dictionary keys from enums to their corresponding values.
+
+    :param d: dict
+        The dictionary with enum keys to be converted.
+    :return: dict
+        The dictionary with enum values as keys.
+    """
+    result = {}
+    for key, value in d.items():
+        if isinstance(key, Enum):
+            new_key = key.value
+        else:
+            new_key = key
+
+        if isinstance(value, dict):
+            result[new_key] = convert_dict_enum_keys_to_enum_values(value)
+        else:
+            result[new_key] = value
+    return result

src/primaite/utils/session_output_reader.py

@@ -3,7 +3,7 @@
 raise DeprecationWarning(
     "Benchmarking depends on deprecated functionality and it has not been updated to primaite v3 yet."
 )
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 from pathlib import Path
 from typing import Any, Dict, Tuple, Union
 
@@ -12,16 +12,16 @@ from typing import Any, Dict, Tuple, Union
 import polars as pl
 
 
-def av_rewards_dict(av_rewards_csv_file: Union[str, Path]) -> Dict[int, float]:
+def total_rewards_dict(total_rewards_csv_file: Union[str, Path]) -> Dict[int, float]:
     """
     Read an average rewards per episode csv file and return as a dict.
 
     The dictionary keys are the episode number, and the values are the mean reward that episode.
 
-    :param av_rewards_csv_file: The average rewards per episode csv file path.
+    :param total_rewards_csv_file: The average rewards per episode csv file path.
     :return: The average rewards per episode csv as a dict.
     """
-    df_dict = pl.read_csv(av_rewards_csv_file).to_dict()
+    df_dict = pl.read_csv(total_rewards_csv_file).to_dict()
 
     return {int(v): df_dict["Average Reward"][i] for i, v in enumerate(df_dict["Episode"])}
 

src/primaite/utils/session_output_writer.py

@@ -3,7 +3,7 @@
 raise DeprecationWarning(
     "Benchmarking depends on deprecated functionality and it has not been updated to primaite v3 yet."
 )
-# © Crown-owned copyright 2023, Defence Science and Technology Laboratory UK
+# © Crown-owned copyright 2024, Defence Science and Technology Laboratory UK
 import csv
 from logging import Logger
 from typing import Final, List, Tuple, TYPE_CHECKING, Union
@@ -27,9 +27,9 @@ class SessionOutputWriter:
     Is used to write session outputs to csv file.
     """
 
-    _AV_REWARD_PER_EPISODE_HEADER: Final[List[str]] = [
+    _TOTAL_REWARD_PER_EPISODE_HEADER: Final[List[str]] = [
         "Episode",
-        "Average Reward",
+        "Total Reward",
     ]
 
     def __init__(
@@ -44,7 +44,7 @@ class SessionOutputWriter:
         :param env: PrimAITE gym environment.
         :type env: Primaite
         :param transaction_writer: If `true`, this will output a full account of every transaction taken by the agent.
-            If `false` it will output the average reward per episode, defaults to False
+            If `false` it will output the total reward per episode, defaults to False
         :type transaction_writer: bool, optional
         :param learning_session: Set to `true` to indicate that the current session is a training session. This
             determines the name of the folder which contains the final output csv. Defaults to True
@@ -57,7 +57,7 @@ class SessionOutputWriter:
         if self.transaction_writer:
             fn = f"all_transactions_{self._env.timestamp_str}.csv"
         else:
-            fn = f"average_reward_per_episode_{self._env.timestamp_str}.csv"
+            fn = f"total_reward_per_episode_{self._env.timestamp_str}.csv"
 
         self._csv_file_path: "Path"
         if self.learning_session:
@@ -95,7 +95,7 @@ class SessionOutputWriter:
         if isinstance(data, Transaction):
             header, data = data.as_csv_data()
         else:
-            header = self._AV_REWARD_PER_EPISODE_HEADER
+            header = self._TOTAL_REWARD_PER_EPISODE_HEADER
 
         if self._first_write:
             self._init_csv_writer()