sinergym.utils.rewards.LinearReward

class sinergym.utils.rewards.LinearReward(temperature_variables: List[str], energy_variables: List[str], range_comfort_winter: Tuple[int, int], range_comfort_summer: Tuple[int, int], summer_start: Tuple[int, int] = (6, 1), summer_final: Tuple[int, int] = (9, 30), energy_weight: float = 0.5, lambda_energy: float = 1.0, lambda_temperature: float = 1.0)
__init__(temperature_variables: List[str], energy_variables: List[str], range_comfort_winter: Tuple[int, int], range_comfort_summer: Tuple[int, int], summer_start: Tuple[int, int] = (6, 1), summer_final: Tuple[int, int] = (9, 30), energy_weight: float = 0.5, lambda_energy: float = 1.0, lambda_temperature: float = 1.0)

Linear reward function.

It considers the energy consumption and the absolute difference to temperature comfort.

\[R = - W * lambda_E * power - (1 - W) * lambda_T * (max(T - T_{low}, 0) + max(T_{up} - T, 0))\]
Parameters:

  • temperature_variables (List[str]) – Name(s) of the temperature variable(s).

  • energy_variables (List[str]) – Name(s) of the energy/power variable(s).

  • range_comfort_winter (Tuple[int,int]) – Temperature comfort range for cold season. Depends on environment you are using.

  • range_comfort_summer (Tuple[int,int]) – Temperature comfort range for hot season. Depends on environment you are using.

  • summer_start (Tuple[int,int]) – Summer session tuple with month and day start. Defaults to (6,1).

  • summer_final (Tuple[int,int]) – Summer session tuple with month and day end. defaults to (9,30).

  • energy_weight (float, optional) – Weight given to the energy term. Defaults to 0.5.

  • lambda_energy (float, optional) – Constant for removing dimensions from power(1/W). Defaults to 1e-4.

  • lambda_temperature (float, optional) – Constant for removing dimensions from temperature(1/C). Defaults to 1.0.

Methods

__init__(temperature_variables, ...[, ...])

Linear reward function.

Attributes

logger