Skip to main content
Version: 2.0.0

sim_metric

GlobalMetricInterface Objects​

class GlobalMetricInterface(ABC)

GlobalMetricInterface The GlobalMetricInterface is used to collect metrics from the simulation

collect_metric​

@staticmethod
@abstractmethod
def collect_metric(
        agents: list[AgentHelperInterface],
        environments: list[EnvironmentHelperInterface],
        simulation_state: SimulationStateHelperInterface) -> dict[str, Any]

Collect a metric from the simulation

Arguments:

  • agents List[AgentHelperInterface] - A list of helpers that provide access to the agents' state
  • environments List[EnvironmentHelperInterface] - A list of helpers that provide access to the environments' state
  • simulation_state SimulationStateHelperInterface - A helper that provides access to the simulation's state

Returns:

Dict[str, Any]: The collected metric