etna.datasets.generate_periodic_df#

generate_periodic_df(periods: int, start_time: Timestamp | int | str | None = None, scale: float = 10, period: int = 1, n_segments: int = 1, freq: str | None = 'D', add_noise: bool = False, sigma: float = 1, random_seed: int = 1) → DataFrame[source]#

Create DataFrame with periodic data.

Parameters:

  • periods (int) – number of timestamps

  • start_time (Timestamp | int | str | None) – start timestamp

  • scale (float) – we sample data from Uniform[0, scale)

  • period (int) – data frequency – x[i+period] = x[i]

  • n_segments (int) – number of segments

  • freq (str | None) – pandas frequency string for pandas.date_range() that is used to generate timestamp

  • add_noise (bool) – if True we add noise to final samples

  • sigma (float) – scale of added noise

  • random_seed (int) – random seed

Raises:

ValueError: – Non-integer timestamp parameter is used for integer-indexed timestamp.

Return type:

DataFrame