sinergym.utils.rewards.HourlyLinearReward

class sinergym.utils.rewards.HourlyLinearReward(env: gym.Env, temperature_variable: str | list, energy_variable: 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), min_energy_weight: float = 0.5, lambda_energy: float = 0.0001, lambda_temperature: float = 1.0, range_comfort_hours: tuple = (9, 19))
__init__(env: gym.Env, temperature_variable: str | list, energy_variable: 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), min_energy_weight: float = 0.5, lambda_energy: float = 0.0001, lambda_temperature: float = 1.0, range_comfort_hours: tuple = (9, 19))

Linear reward function with a time-dependent weight for consumption and energy terms.

Parameters:

  • env (Env) – Gym environment.

  • temperature_variable (Union[str, list]) – Name(s) of the temperature variable(s).

  • energy_variable (str) – Name of the energy/power variable.

  • 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).

  • min_energy_weight (float, optional) – Minimum 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.

  • range_comfort_hours (tuple, optional) – Hours where thermal comfort is considered. Defaults to (9, 19).

Methods

__init__(env, temperature_variable, ...[, ...])

Linear reward function with a time-dependent weight for consumption and energy terms.