Feat: Specify output dir/suffix

Author: klieret

codeclash/tournaments/pvp.py

@@ -4,6 +4,7 @@
 
 import json
 from concurrent.futures import ThreadPoolExecutor
+from pathlib import Path
 
 from codeclash.agents import get_agent
 from codeclash.agents.player import Player
@@ -16,8 +17,8 @@
 
 
 class PvpTournament(AbstractTournament):
-    def __init__(self, config: dict, *, cleanup: bool = False, push: bool = False):
-        super().__init__(config, name="PvpTournament")
+    def __init__(self, config: dict, *, cleanup: bool = False, push: bool = False, output_dir: Path | None = None):
+        super().__init__(config, name="PvpTournament", output_dir=output_dir)
         self.cleanup_on_end = cleanup
         self.game: CodeGame = get_game(
             self.config,

codeclash/tournaments/single_player.py

@@ -4,6 +4,7 @@
 
 import copy
 import json
+from pathlib import Path
 
 from codeclash.agents import get_agent
 from codeclash.agents.dummy_agent import Dummy
@@ -18,8 +19,8 @@
 
 
 class SinglePlayerTraining(AbstractTournament):
-    def __init__(self, config: dict, *, cleanup: bool = False):
-        super().__init__(config, name="SinglePlayerTraining")
+    def __init__(self, config: dict, *, cleanup: bool = False, output_dir: Path | None = None):
+        super().__init__(config, name="SinglePlayerTraining", output_dir=output_dir)
         self.cleanup_on_end = cleanup
         self.game: CodeGame = get_game(
             self.config,

codeclash/tournaments/tournament.py

@@ -10,10 +10,11 @@
 
 
 class AbstractTournament:
-    def __init__(self, config: dict, *, name: str, **kwargs):
+    def __init__(self, config: dict, *, name: str, output_dir: Path | None = None, **kwargs):
         self.config: dict = config
         self.name: str = name
         self.tournament_id: str = f"{self.name}.{config['game']['name']}.{time.strftime('%y%m%d%H%M%S')}"
+        self._custom_output_dir: Path | None = output_dir
         self._metadata: dict = {
             "name": self.name,
             "tournament_id": self.tournament_id,
@@ -24,6 +25,11 @@ def __init__(self, config: dict, *, name: str, **kwargs):
 
     @property
     def local_output_dir(self) -> Path:
+        if self._custom_output_dir is not None:
+            # Custom output directory provided, add timestamp to make it unique
+            return (self._custom_output_dir / time.strftime("%y%m%d%H%M%S")).resolve()
+
+        # Default behavior
         base_dir = DIR_LOGS
         if "PYTEST_CURRENT_TEST" in os.environ:
             base_dir = Path("/tmp/codeclash")

main.py

@@ -1,18 +1,34 @@
 import argparse
+import getpass
 from pathlib import Path
 
 import yaml
 
 from codeclash import CONFIG_DIR
+from codeclash.constants import DIR_LOGS
 from codeclash.tournaments.pvp import PvpTournament
 from codeclash.utils.yaml_utils import resolve_includes
 
 
-def main(config_path: Path, *, cleanup: bool = False, push: bool = False):
+def main(
+    config_path: Path,
+    *,
+    cleanup: bool = False,
+    push: bool = False,
+    output_dir: Path | None = None,
+    suffix: str = "",
+):
     yaml_content = config_path.read_text()
     preprocessed_yaml = resolve_includes(yaml_content, base_dir=CONFIG_DIR)
     config = yaml.safe_load(preprocessed_yaml)
-    tournament = PvpTournament(config, cleanup=cleanup, push=push)
+
+    folder_name = f"PvpTournament.{config['game']['name']}{suffix}"
+    if output_dir is None:
+        full_output_dir = DIR_LOGS / getpass.getuser() / folder_name
+    else:
+        full_output_dir = output_dir / folder_name
+
+    tournament = PvpTournament(config, cleanup=cleanup, push=push, output_dir=full_output_dir)
     tournament.run()
 
 
@@ -35,6 +51,19 @@ def main_cli(argv: list[str] | None = None):
         action="store_true",
         help="If set, push each agent's codebase to a new repository after running.",
     )
+    parser.add_argument(
+        "-o",
+        "--output-dir",
+        type=Path,
+        help="Sets the output directory (default is 'logs' with current user subdirectory).",
+    )
+    parser.add_argument(
+        "-s",
+        "--suffix",
+        type=str,
+        help="Suffix to attach to the folder name. Does not include leading dot or underscore.",
+        default="",
+    )
     args = parser.parse_args(argv)
     main(**vars(args))
 

main_single_player.py

@@ -1,18 +1,33 @@
 import argparse
+import getpass
 from pathlib import Path
 
 import yaml
 
 from codeclash import CONFIG_DIR
+from codeclash.constants import DIR_LOGS
 from codeclash.tournaments.single_player import SinglePlayerTraining
 from codeclash.utils.yaml_utils import resolve_includes
 
 
-def main(config_path: Path, cleanup: bool = False):
+def main(
+    config_path: Path,
+    *,
+    cleanup: bool = False,
+    output_dir: Path | None = None,
+    suffix: str = "",
+):
     yaml_content = config_path.read_text()
     preprocessed_yaml = resolve_includes(yaml_content, base_dir=CONFIG_DIR)
     config = yaml.safe_load(preprocessed_yaml)
-    training = SinglePlayerTraining(config, cleanup=cleanup)
+
+    folder_name = f"SinglePlayerTraining.{config['game']['name']}{suffix}"
+    if output_dir is None:
+        full_output_dir = DIR_LOGS / getpass.getuser() / folder_name
+    else:
+        full_output_dir = output_dir / folder_name
+
+    training = SinglePlayerTraining(config, cleanup=cleanup, output_dir=full_output_dir)
     training.run()
 
 
@@ -29,6 +44,19 @@ def main_cli(argv: list[str] | None = None):
         action="store_true",
         help="If set, do not clean up the game environment after running.",
     )
+    parser.add_argument(
+        "-o",
+        "--output-dir",
+        type=Path,
+        help="Sets the output directory (default is 'logs' with current user subdirectory).",
+    )
+    parser.add_argument(
+        "-s",
+        "--suffix",
+        type=str,
+        help="Suffix to attach to the folder name. Does not include leading dot or underscore.",
+        default="",
+    )
     args = parser.parse_args(argv)
     main(**vars(args))