incline.detect_seasonality

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

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

Parameters:

  • df (DataFrame) – Time series data.

  • value_column (str) – Column holding the values.

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

Returns:

What was found.

Raises:

ValueError – If max_period is supplied but is not an integer of at least two.

Return type:

Seasonality