incline.detect_seasonality

incline.detect_seasonality(df, column_value='value', time_column=None, max_period=None)[source]

Look for a repeating cycle, by three methods in decreasing reliability.

Parameters:
  • df (DataFrame) – Time series data.

  • column_value (str) – Column holding the values.

  • time_column (str | None) – Unused; accepted so the signature matches its neighbors.

  • max_period (int | None) – Longest cycle to consider.

Returns:

What was found.

Return type:

Seasonality