Skip to main content
Version: 2.0.2

agent_metric

AgentMetricInterface Objects​

class AgentMetricInterface(ABC)

AgentMetricInterface The AgentMetricInterface is used to collect metrics from the agent

collect_metric​

@staticmethod
@abstractmethod
def collect_metric(
        agent_helper: AgentHelperInterface,
        simulation_state: SimulationStateHelperInterface) -> dict[str, Any]

Collect a metric from the agent

Arguments:

  • agent_helper AgentHelperInterface - A helper that provides access to the agent's state
  • simulation_state SimulationStateHelperInterface - A helper that provides access to the simulation's state

Returns:

Dict[str, Any]: The collected metric