ethicalgardeners.metricscollectorΒΆ

The MetricsCollector module provides metrics tracking and exporting capabilities for the Ethical Gardeners simulation environment.

This module enables monitoring of simulation runs by:

  1. Collecting various metrics during simulation execution

  2. Exporting metrics to local files like CSV files for offline analysis

  3. Sending metrics to monitoring services like Weights and Biases (WandB)

The metrics tracked include:

  • Current simulation step

  • Flower planted and harvested statistics (overall and per-agent)

  • Pollution levels across the environment

  • Agent rewards and accumulated rewards

  • Currently selected agent

The module is designed to be configurable, allowing users to enable or disable metrics export and sending based on their research requirements.

members:

Classes

MetricsCollector(out_dir_path, export_on, ...)

Collects, tracks and exports metrics from the Ethical Gardeners simulation.