Merge pull request #5 from berenslab/feat-ci-pipeline-cache-test

Merge feat ci pipeline cache test, correct some py files

.github/workflows/code_check.yml

@@ -34,6 +34,7 @@ jobs:
         path: ${{ env.sif_file }}
         key: ${{ runner.os }}-singularity-${{ hashFiles('~/resources/retinal-rl.def') }}
         restore-keys: |
+          ${{ runner.os }}-singularity-${{ hashFiles('~/resources/retinal-rl.def') }}
           ${{ runner.os }}-singularity-
     - name: Pull Singularity container
       if: steps.cache-singularity.outputs.cache-hit != 'true'

.github/workflows/config_scan.yml

@@ -21,6 +21,7 @@ jobs:
         path: ${{ env.sif_file }}
         key: ${{ runner.os }}-singularity-${{ hashFiles('~/resources/retinal-rl.def') }}
         restore-keys: |
+          ${{ runner.os }}-singularity-${{ hashFiles('~/resources/retinal-rl.def') }}
           ${{ runner.os }}-singularity-
     - name: Pull Singularity container
       if: steps.cache-singularity.outputs.cache-hit != 'true'

doom_creator/util/_templates/vizdoom.py

@@ -1,5 +1,13 @@
-def config(scenario_name):
-    return """\
+"""
+This module contains a dummy for a vizdoom config.
+"""
+
+
+def config(scenario_name: str):
+    """Returns a config for a vizdoom game,
+    referencing {scenario_name}.zip as the scenario."""
+
+    return f"""\
 doom_scenario_path = {scenario_name}.zip
 
 living_reward = 0.0
@@ -32,6 +40,4 @@ def config(scenario_name):
 available_game_variables = {{ HEALTH }}
 
 mode = PLAYER
-""".format(
-        scenario_name=scenario_name
-    )
+"""

doom_creator/util/templates.py

@@ -1 +1,8 @@
+"""Templates for doom scenario creation
+
+This module provides the templates for acs scripts, decorate
+definitions and the overall config (vizdoom)
+"""
 from doom_creator.util._templates import acs, decorate, vizdoom
+
+__all__ = ['acs', 'decorate', 'vizdoom']