Merged PR 299: Match default reward configs to Imaginary Yak.

## Summary
Change the default rewards for the data manipulation configs
Also I renamed the config files to make their names more descriptive.

## Test process
Pytests and all notebooks run without fail.

## Checklist
- [x] PR is linked to a **work item**
- [x] **acceptance criteria** of linked ticket are met
- [x] performed **self-review** of the code
- [ ] written **tests** for any new functionality added with this PR
- [ ] updated the **documentation** if this PR changes or adds functionality
- [ ] written/updated **design docs** if this PR implements new functionality
- [ ] updated the **change log**
- [x] ran **pre-commit** checks for code style
- [x] attended to any **TO-DOs** left in the code

Related work items: #2365

src/primaite/config/_package_data/data_manipulation.yaml

@@ -691,25 +691,25 @@ agents:
     reward_function:
       reward_components:
         - type: DATABASE_FILE_INTEGRITY
-          weight: 0.34
+          weight: 0.40
           options:
             node_hostname: database_server
             folder_name: database
             file_name: database.db
         - type: WEBPAGE_UNAVAILABLE_PENALTY
-          weight: 0.33
+          weight: 0.25
           options:
             node_hostname: client_1
         - type: WEBPAGE_UNAVAILABLE_PENALTY
-          weight: 0.33
+          weight: 0.25
           options:
             node_hostname: client_2
         - type: GREEN_ADMIN_DATABASE_UNREACHABLE_PENALTY
-          weight: 0.1
+          weight: 0.05
           options:
             node_hostname: client_1
         - type: GREEN_ADMIN_DATABASE_UNREACHABLE_PENALTY
-          weight: 0.1
+          weight: 0.05
           options:
             node_hostname: client_2
 

src/primaite/config/_package_data/data_manipulation_marl.yaml

@@ -695,25 +695,25 @@ agents:
     reward_function:
       reward_components:
         - type: DATABASE_FILE_INTEGRITY
-          weight: 0.34
+          weight: 0.40
           options:
             node_hostname: database_server
             folder_name: database
             file_name: database.db
         - type: WEBPAGE_UNAVAILABLE_PENALTY
-          weight: 0.33
+          weight: 0.25
           options:
             node_hostname: client_1
         - type: WEBPAGE_UNAVAILABLE_PENALTY
-          weight: 0.33
+          weight: 0.25
           options:
             node_hostname: client_2
         - type: GREEN_ADMIN_DATABASE_UNREACHABLE_PENALTY
-          weight: 0.1
+          weight: 0.05
           options:
             node_hostname: client_1
         - type: GREEN_ADMIN_DATABASE_UNREACHABLE_PENALTY
-          weight: 0.1
+          weight: 0.05
           options:
             node_hostname: client_2
 
@@ -1251,29 +1251,28 @@ agents:
         - node_name: security_suite
           nic_num: 2
 
-
     reward_function:
       reward_components:
         - type: DATABASE_FILE_INTEGRITY
-          weight: 0.34
+          weight: 0.40
           options:
             node_hostname: database_server
             folder_name: database
             file_name: database.db
         - type: WEBPAGE_UNAVAILABLE_PENALTY
-          weight: 0.33
+          weight: 0.25
           options:
             node_hostname: client_1
         - type: WEBPAGE_UNAVAILABLE_PENALTY
-          weight: 0.33
+          weight: 0.25
           options:
             node_hostname: client_2
         - type: GREEN_ADMIN_DATABASE_UNREACHABLE_PENALTY
-          weight: 0.1
+          weight: 0.05
           options:
             node_hostname: client_1
         - type: GREEN_ADMIN_DATABASE_UNREACHABLE_PENALTY
-          weight: 0.1
+          weight: 0.05
           options:
             node_hostname: client_2
 

src/primaite/config/load.py

@@ -37,7 +37,7 @@ def data_manipulation_config_path() -> Path:
     :return: Path to the example config.
     :rtype: Path
     """
-    path = _EXAMPLE_CFG / "example_config.yaml"
+    path = _EXAMPLE_CFG / "data_manipulation.yaml"
     if not path.exists():
         msg = f"Example config does not exist: {path}. Have you run `primaite setup`?"
         _LOGGER.error(msg)

src/primaite/notebooks/Training-an-RLLIB-MARL-System.ipynb

@@ -35,7 +35,7 @@
     "\n",
     "# If you get an error saying this config file doesn't exist, you may need to run `primaite setup` in your command line\n",
     "# to copy the files to your user data path.\n",
-    "with open(PRIMAITE_PATHS.user_config_path / 'example_config/example_config_2_rl_agents.yaml', 'r') as f:\n",
+    "with open(PRIMAITE_PATHS.user_config_path / 'example_config/data_manipulation_marl.yaml', 'r') as f:\n",
     "    cfg = yaml.safe_load(f)\n",
     "\n",
     "ray.init(local_mode=True)"