Skip to main content
Version: Next

env_metric

EnvironmentMetricInterface Objects​

class EnvironmentMetricInterface(ABC)

EnvironmentMetricInterface The EnvironmentMetricInterface is used to collect metrics from the environment

collect_metric​

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

Collect a metric from the environment

Arguments:

  • environment_helper EnvironmentHelperInterface - A helper that provides access to the environment's functions
  • simulation_state SimulationStateHelperInterface - A helper that provides access to the simulation's state

Returns:

Dict[str, Any]: The collected metric