citylearn.utils.noise module

class citylearn.utils.noise.Noise[source]

Bases: object

static generate_gaussian_noise(input_data: ndarray | Iterable[float], noise_std: float) → ndarray[source]

Generates Gaussian noise matching input shape.

Parameters:
  • input_data (Union[np.ndarray, Iterable[float]]) – Time series to add noise to.

  • noise_std (float) – Noise standard deviation (ignored if <= 0)

Returns:

noise – Zero-mean noise array with same shape as input

Return type:

np.ndarray

static generate_scaled_noise(input_data: ndarray | Iterable[float], noise_std: float, scale: float = 1.0) → ndarray[source]

Generates pre-scaled noise (e.g., for percentage values).