How to Contribute A New Metric

To contribut a new metric, you create a function call which gets the metric and returns a dictionary of style:

{
    "metric_name" : metric_value
}

Then you add the metric to our data router: https://github.com/Breakend/experiment-impact-tracker/blob/master/experiment_impact_tracker/data_info_and_router.py

{
    "name": "metric_name",
    "description": "This is a description of what my metric is. It uses <units>.",
    "compatability": ["all"], # this is the compatability system, we may change this in the future
    "routing": {
        "function": path.to.metric.function
    }
},

If a new compatability is introduced, add it here: https://github.com/Breakend/experiment-impact-tracker/blob/master/experiment_impact_tracker/compute_tracker.py#L131

In the future we may modularize this as well.

If the system is compatbile, your metric should now be logged at every iteration of the main logging loop!