cogames-agents 0.0.0.7__cp312-cp312-manylinux_2_34_aarch64.whl

cogames_agents/evals/__init__.py

@@ -0,0 +1,5 @@
+"""Evaluation missions for cogames-agents."""
+
+from cogames_agents.evals.planky_evals import PLANKY_BEHAVIOR_EVALS
+
+__all__ = ["PLANKY_BEHAVIOR_EVALS"]

cogames_agents/evals/planky_evals.py

@@ -0,0 +1,415 @@
+"""Planky behavior evaluation missions.
+
+Small deterministic CogsGuard environments for testing the Planky goal-tree agent.
+Each mission loads a custom ASCII map from ``cogames/maps/planky_evals/`` and applies generous
+energy/resources so the agent can focus on demonstrating the target behavior.
+"""
+
+from __future__ import annotations
+
+import importlib.resources
+from pathlib import Path
+from typing import Dict
+
+from pydantic import Field
+
+from cogames.cogs_vs_clips.cog import CogConfig
+from cogames.cogs_vs_clips.mission import Mission, Site
+from mettagrid.config.mettagrid_config import MettaGridConfig
+from mettagrid.map_builder.map_builder import MapBuilderConfig
+from mettagrid.mapgen.mapgen import MapGen, MapGenConfig
+
+
+def _get_cogames_maps_dir() -> Path:
+    """Get the path to the cogames maps directory."""
+    # Use importlib.resources to locate the maps directory in the cogames package
+    with importlib.resources.as_file(importlib.resources.files("cogames").joinpath("maps")) as maps_path:
+        return Path(maps_path)
+
+
+MAPS_DIR = _get_cogames_maps_dir()
+
+# Dummy site — each mission overrides the map via make_env().
+_PLANKY_EVALS_SITE = Site(
+    name="planky_evals",
+    description="Planky behavior evaluation arenas.",
+    map_builder=MapGen.Config(
+        instance=MapBuilderConfig.from_uri(str(MAPS_DIR / "planky_evals" / "miner_gear.map")),
+        instances=1,
+        fixed_spawn_order=True,
+        instance_border_width=0,
+    ),
+    min_cogs=1,
+    max_cogs=8,
+)
+
+
+def _get_planky_map(map_name: str) -> MapGenConfig:
+    """Load a map from the planky_evals directory."""
+    map_path = MAPS_DIR / "planky_evals" / map_name
+    if not map_path.exists():
+        raise FileNotFoundError(f"Planky eval map not found: {map_path}")
+    return MapGen.Config(
+        instance=MapBuilderConfig.from_uri(str(map_path)),
+        instances=1,
+        fixed_spawn_order=True,
+        instance_border_width=0,
+    )
+
+
+# ---------------------------------------------------------------------------
+# Base class
+# ---------------------------------------------------------------------------
+
+
+class _PlankyDiagnosticBase(Mission):
+    """Base class for Planky behavior evaluation missions.
+
+    Provides:
+    - Custom ASCII map loading from ``planky_evals/`` directory
+    - Generous energy (255 capacity + 255 regen per tick)
+    - Generous collective resources (100 of each element, 50 hearts)
+    - Inventory seed support (per-mission starting items)
+    - ``configure_env()`` hook for per-mission customization
+    """
+
+    site: Site = _PLANKY_EVALS_SITE
+
+    map_name: str = Field(default="miner_gear.map")
+    max_steps: int = Field(default=300)
+    num_cogs: int | None = 1
+
+    # Per-mission inventory seed (applied to agent starting inventory)
+    inventory_seed: Dict[str, int] = Field(default_factory=dict)
+
+    # Generous collective resources (10x default)
+    wealth: int = Field(default=10)
+
+    # Generous agent config
+    cog: CogConfig = Field(
+        default_factory=lambda: CogConfig(
+            energy_limit=255,
+            initial_energy=255,
+            energy_regen=255,
+            initial_hp=100,
+            hp_regen=0,
+            influence_regen=0,
+        )
+    )
+
+    # Disable clips scramble/align events for deterministic tests
+    clips_scramble_start: int = Field(default=99999)
+    clips_align_start: int = Field(default=99999)
+
+    def configure_env(self, cfg: MettaGridConfig) -> None:
+        """Hook for per-mission environment customization."""
+
+    def make_env(self) -> MettaGridConfig:
+        custom_map = _get_planky_map(self.map_name)
+        original_map_builder = self.site.map_builder
+        self.site.map_builder = custom_map
+        try:
+            cfg = super().make_env()
+            cfg.game.map_builder = custom_map
+            cfg.game.max_steps = self.max_steps
+
+            # Apply inventory seed
+            if self.inventory_seed:
+                seed = dict(cfg.game.agent.inventory.initial)
+                seed.update(self.inventory_seed)
+                cfg.game.agent.inventory.initial = seed
+
+            # Per-mission hook
+            self.configure_env(cfg)
+            return cfg
+        finally:
+            self.site.map_builder = original_map_builder
+
+
+# ==============================================================================
+# Miner Missions
+# ==============================================================================
+
+
+class PlankyMinerGear(_PlankyDiagnosticBase):
+    name: str = "planky_miner_gear"
+    description: str = "Miner navigates to miner station and gets gear."
+    map_name: str = "miner_gear.map"
+    max_steps: int = Field(default=100)
+
+
+class PlankyMinerExtract(_PlankyDiagnosticBase):
+    name: str = "planky_miner_extract"
+    description: str = "Miner gets gear and extracts carbon from extractor."
+    map_name: str = "miner_extract.map"
+    max_steps: int = Field(default=200)
+
+
+class PlankyMinerBestResource(_PlankyDiagnosticBase):
+    name: str = "planky_miner_best_resource"
+    description: str = "Miner prefers carbon (more extractors) over oxygen."
+    map_name: str = "miner_best_resource.map"
+    max_steps: int = Field(default=300)
+
+
+class PlankyMinerDeposit(_PlankyDiagnosticBase):
+    name: str = "planky_miner_deposit"
+    description: str = "Miner with cargo deposits at hub."
+    map_name: str = "miner_deposit.map"
+    max_steps: int = Field(default=200)
+    inventory_seed: Dict[str, int] = Field(default_factory=lambda: {"carbon": 10, "oxygen": 5})
+
+
+class PlankyMinerFullCycle(_PlankyDiagnosticBase):
+    name: str = "planky_miner_full_cycle"
+    description: str = "Miner completes gear -> extract -> deposit cycle."
+    map_name: str = "miner_full_cycle.map"
+    max_steps: int = Field(default=400)
+
+
+# ==============================================================================
+# Aligner Missions
+# ==============================================================================
+
+
+class PlankyAlignerGear(_PlankyDiagnosticBase):
+    name: str = "planky_aligner_gear"
+    description: str = "Aligner navigates to aligner station and gets gear."
+    map_name: str = "aligner_gear.map"
+    max_steps: int = Field(default=100)
+
+
+class PlankyAlignerHearts(_PlankyDiagnosticBase):
+    name: str = "planky_aligner_hearts"
+    description: str = "Aligner with gear gets hearts from chest."
+    map_name: str = "aligner_hearts.map"
+    max_steps: int = Field(default=200)
+    inventory_seed: Dict[str, int] = Field(default_factory=lambda: {"aligner": 1})
+
+
+class PlankyAlignerJunction(_PlankyDiagnosticBase):
+    name: str = "planky_aligner_junction"
+    description: str = "Aligner with gear and hearts approaches neutral junction."
+    map_name: str = "aligner_junction.map"
+    max_steps: int = Field(default=300)
+    inventory_seed: Dict[str, int] = Field(default_factory=lambda: {"aligner": 1, "heart": 3})
+
+
+class PlankyAlignerAvoidAOE(_PlankyDiagnosticBase):
+    name: str = "planky_aligner_avoid_aoe"
+    description: str = "Aligner prefers safe junction over clips-aligned one."
+    map_name: str = "aligner_avoid_aoe.map"
+    max_steps: int = Field(default=400)
+    inventory_seed: Dict[str, int] = Field(default_factory=lambda: {"aligner": 1, "heart": 3})
+    # Let initial_clips fire at step 10 to create one clips junction
+    clips_scramble_start: int = Field(default=99999)
+    clips_align_start: int = Field(default=99999)
+
+
+# ==============================================================================
+# Scrambler Missions
+# ==============================================================================
+
+
+class PlankyScramblerGear(_PlankyDiagnosticBase):
+    name: str = "planky_scrambler_gear"
+    description: str = "Scrambler navigates to scrambler station and gets gear."
+    map_name: str = "scrambler_gear.map"
+    max_steps: int = Field(default=100)
+
+
+class PlankyScramblerTarget(_PlankyDiagnosticBase):
+    name: str = "planky_scrambler_target"
+    description: str = "Scrambler with gear and hearts approaches clips junction."
+    map_name: str = "scrambler_target.map"
+    max_steps: int = Field(default=300)
+    inventory_seed: Dict[str, int] = Field(default_factory=lambda: {"scrambler": 1, "heart": 3})
+    # Let initial_clips fire at step 10 to create the clips junction target
+    clips_scramble_start: int = Field(default=99999)
+    clips_align_start: int = Field(default=99999)
+
+
+# ==============================================================================
+# Scout Missions
+# ==============================================================================
+
+
+class PlankyScoutGear(_PlankyDiagnosticBase):
+    name: str = "planky_scout_gear"
+    description: str = "Scout navigates to scout station and gets gear."
+    map_name: str = "scout_gear.map"
+    max_steps: int = Field(default=100)
+
+
+class PlankyScoutExplore(_PlankyDiagnosticBase):
+    name: str = "planky_scout_explore"
+    description: str = "Scout with gear explores an open area."
+    map_name: str = "scout_explore.map"
+    max_steps: int = Field(default=200)
+    inventory_seed: Dict[str, int] = Field(default_factory=lambda: {"scout": 1})
+
+
+# ==============================================================================
+# Cross-cutting Missions
+# ==============================================================================
+
+
+class PlankySurviveRetreat(_PlankyDiagnosticBase):
+    name: str = "planky_survive_retreat"
+    description: str = "Agent with low HP retreats toward hub safety."
+    map_name: str = "survive_retreat.map"
+    max_steps: int = Field(default=200)
+
+    cog: CogConfig = Field(
+        default_factory=lambda: CogConfig(
+            energy_limit=255,
+            initial_energy=255,
+            energy_regen=255,
+            initial_hp=20,
+            hp_regen=0,
+            influence_regen=0,
+        )
+    )
+
+
+class PlankyMultiRole(_PlankyDiagnosticBase):
+    name: str = "planky_multi_role"
+    description: str = "Four agents with different roles work together."
+    map_name: str = "multi_role.map"
+    max_steps: int = Field(default=300)
+    num_cogs: int | None = 4
+
+
+# ==============================================================================
+# Navigation + Exploration Missions
+# ==============================================================================
+
+
+class PlankyMaze(_PlankyDiagnosticBase):
+    name: str = "planky_maze"
+    description: str = "Miner navigates maze to reach extractor."
+    map_name: str = "maze.map"
+    max_steps: int = Field(default=400)
+
+
+class PlankyExplorationDistant(_PlankyDiagnosticBase):
+    name: str = "planky_exploration_distant"
+    description: str = "Miner finds extractor outside initial FOV."
+    map_name: str = "exploration_distant.map"
+    max_steps: int = Field(default=400)
+
+
+class PlankyStuckCorridor(_PlankyDiagnosticBase):
+    name: str = "planky_stuck_corridor"
+    description: str = "Miner navigates winding corridor to reach target."
+    map_name: str = "stuck_corridor.map"
+    max_steps: int = Field(default=400)
+
+
+# ==============================================================================
+# Full Cycle Missions
+# ==============================================================================
+
+
+class PlankyAlignerFullCycle(_PlankyDiagnosticBase):
+    name: str = "planky_aligner_full_cycle"
+    description: str = "Aligner: gear -> hearts -> junction approach."
+    map_name: str = "aligner_full_cycle.map"
+    max_steps: int = Field(default=400)
+
+
+class PlankyScramblerFullCycle(_PlankyDiagnosticBase):
+    name: str = "planky_scrambler_full_cycle"
+    description: str = "Scrambler: gear -> hearts -> scramble junction."
+    map_name: str = "scrambler_full_cycle.map"
+    max_steps: int = Field(default=400)
+    # Let initial_clips fire at step 10
+    clips_scramble_start: int = Field(default=99999)
+    clips_align_start: int = Field(default=99999)
+
+
+class PlankyResourceChain(_PlankyDiagnosticBase):
+    name: str = "planky_resource_chain"
+    description: str = "Miner: mine resources -> deposit at hub end-to-end."
+    map_name: str = "resource_chain.map"
+    max_steps: int = Field(default=500)
+
+
+# ==============================================================================
+# Recovery Missions (reuse existing maps with different inventory seeds)
+# ==============================================================================
+
+
+class PlankyMinerReGear(_PlankyDiagnosticBase):
+    name: str = "planky_miner_re_gear"
+    description: str = "Miner without gear re-acquires gear then mines."
+    map_name: str = "miner_extract.map"
+    max_steps: int = Field(default=300)
+    # No gear seed — must get gear from station first
+
+
+class PlankyAlignerReGear(_PlankyDiagnosticBase):
+    name: str = "planky_aligner_re_gear"
+    description: str = "Aligner without gear re-acquires gear."
+    map_name: str = "aligner_full_cycle.map"
+    max_steps: int = Field(default=400)
+    # No gear seed — must get gear from station first
+
+
+class PlankyAlignerReHearts(_PlankyDiagnosticBase):
+    name: str = "planky_aligner_re_hearts"
+    description: str = "Aligner with gear but no hearts re-acquires hearts."
+    map_name: str = "aligner_full_cycle.map"
+    max_steps: int = Field(default=400)
+    inventory_seed: Dict[str, int] = Field(default_factory=lambda: {"aligner": 1})
+
+
+class PlankyScramblerRecovery(_PlankyDiagnosticBase):
+    name: str = "planky_scrambler_recovery"
+    description: str = "Scrambler without gear/hearts recovers both."
+    map_name: str = "scrambler_full_cycle.map"
+    max_steps: int = Field(default=400)
+    # No gear/hearts seed — must get both from stations
+    clips_scramble_start: int = Field(default=99999)
+    clips_align_start: int = Field(default=99999)
+
+
+# ==============================================================================
+# All missions list
+# ==============================================================================
+
+PLANKY_BEHAVIOR_EVALS: list[type[_PlankyDiagnosticBase]] = [
+    # Miner
+    PlankyMinerGear,
+    PlankyMinerExtract,
+    PlankyMinerBestResource,
+    PlankyMinerDeposit,
+    PlankyMinerFullCycle,
+    # Aligner
+    PlankyAlignerGear,
+    PlankyAlignerHearts,
+    PlankyAlignerJunction,
+    PlankyAlignerAvoidAOE,
+    # Scrambler
+    PlankyScramblerGear,
+    PlankyScramblerTarget,
+    # Scout
+    PlankyScoutGear,
+    PlankyScoutExplore,
+    # Cross-cutting
+    PlankySurviveRetreat,
+    PlankyMultiRole,
+    # Navigation
+    PlankyMaze,
+    PlankyExplorationDistant,
+    PlankyStuckCorridor,
+    # Full cycles
+    PlankyAlignerFullCycle,
+    PlankyScramblerFullCycle,
+    PlankyResourceChain,
+    # Recovery
+    PlankyMinerReGear,
+    PlankyAlignerReGear,
+    PlankyAlignerReHearts,
+    PlankyScramblerRecovery,
+]