#915 - Created app dirs and set as constants in the top-level init.

- renamed _config_values_main to training_config.py and renamed the ConfigValuesMain class to TrainingConfig.
Moved training_config.py to src/primaite/config/training_config.py
- Renamed all training config yaml file keys to make creating an instance of TrainingConfig easier.
Moved action_type and num_steps over to the training config.
- Decoupled the training config and lay down config.
- Refactored main.py so that it can be ran from CLI and can take a training config path and a lay down config path.
- refactored all outputs so that they save to the session dir.
- Added some necessary setup scripts that handle creating app dirs, fronting example config files to the user, fronting demo notebooks to the user, performing clean-up in between installations etc.
- Added functions that attempt to retrieve the file path of users example config files that have been fronted by the primaite setup.
- Added logging config and a getLogger function in the top-level init.
- Refactored all logs entries logged to use a logger using the primaite logging config.
- Added basic typer CLI for doing things like setup, viewing logs, viewing primaite version, running a basic session.
- Updated test to use new features and config structures.
- Began updating docs. More to do here.

src/primaite/transactions/transactions_to_file.py

@@ -2,9 +2,11 @@
 """Writes the Transaction log list out to file for evaluation to utilse."""
 
 import csv
-import logging
-import os.path
-from datetime import datetime
+from pathlib import Path
+
+from primaite import getLogger
+
+_LOGGER = getLogger(__name__)
 
 
 def turn_action_space_to_array(_action_space):
@@ -38,18 +40,22 @@ def turn_obs_space_to_array(_obs_space, _obs_assets, _obs_features):
     return return_array
 
 
-def write_transaction_to_file(_transaction_list):
+def write_transaction_to_file(transaction_list, session_path: Path, timestamp_str: str):
     """
     Writes transaction logs to file to support training evaluation.
 
-    Args:
-        _transaction_list: The list of transactions from all steps and all episodes
-        _num_episodes: The number of episodes that were conducted.
+    :param transaction_list: The list of transactions from all steps and all
+        episodes.
+    :param session_path: The directory path the session is writing to.
+    :param timestamp_str: The session timestamp in the format:
+        <yyyy-mm-dd>_<hh-mm-ss>.
     """
-    # Get the first transaction and use it to determine the makeup of the observation space and action space
-    # Label the obs space fields in csv as "OSI_1_1", "OSN_1_1" and action space as "AS_1"
+    # Get the first transaction and use it to determine the makeup of the
+    # observation space and action space
+    # Label the obs space fields in csv as "OSI_1_1", "OSN_1_1" and action
+    # space as "AS_1"
     # This will be tied into the PrimAITE Use Case so that they make sense
-    template_transation = _transaction_list[0]
+    template_transation = transaction_list[0]
     action_length = template_transation.action_space.size
     obs_shape = template_transation.obs_space_post.shape
     obs_assets = template_transation.obs_space_post.shape[0]
@@ -75,21 +81,15 @@ def write_transaction_to_file(_transaction_list):
     # Open up a csv file
     header = ["Timestamp", "Episode", "Step", "Reward"]
     header = header + action_header + obs_header_initial + obs_header_new
-    now = datetime.now()  # current date and time
-    time = now.strftime("%Y%m%d_%H%M%S")
+
 
     try:
-        path = "outputs/results/"
-        is_dir = os.path.isdir(path)
-        if not is_dir:
-            os.makedirs(path)
-
-        filename = "outputs/results/all_transactions_" + time + ".csv"
+        filename = session_path / f"all_transactions_{timestamp_str}.csv"
         csv_file = open(filename, "w", encoding="UTF8", newline="")
         csv_writer = csv.writer(csv_file)
         csv_writer.writerow(header)
 
-        for transaction in _transaction_list:
+        for transaction in transaction_list:
             csv_data = [
                 str(transaction.timestamp),
                 str(transaction.episode_number),
@@ -110,5 +110,4 @@ def write_transaction_to_file(_transaction_list):
 
         csv_file.close()
     except Exception:
-        logging.error("Could not save the transaction file")
-        logging.error("Exception occured", exc_info=True)
+        _LOGGER.error("Could not save the transaction file", exc_info=True)