Cost Function

The citylearn.cost_function.CostFunction utilities calculate common time-series metrics such as cost, emissions, peaks, ramping, discomfort and unserved energy. They are useful when implementing or inspecting an evaluation.

For a completed environment, use env.evaluate_v2() to obtain named building/district KPIs. Start with KPIs, then consult KPIs Reference for definitions and Baselines for the reference conditions.