Coverage for src / ts_stat_tests / seasonality / __init__.py: 100%

1# ============================================================================ # 

2# # 

3# Title: Seasonality Module # 

4# Purpose: Initialize the seasonality module by importing algorithms and # 

5# tests, and defining exports. # 

6# # 

7# ============================================================================ # 

8 

9 

10# ---------------------------------------------------------------------------- # 

11# # 

12# Overview #### 

13# # 

14# ---------------------------------------------------------------------------- # 

15 

16 

17# ---------------------------------------------------------------------------- # 

18# Description #### 

19# ---------------------------------------------------------------------------- # 

20 

21 

22""" 

23!!! note "Summary" 

24 This module provides tools to assess seasonality in time series data. It includes various algorithms and tests to evaluate the presence and strength of seasonal patterns, helping to identify recurring trends and cycles within the data. 

25""" 

26 

27 

28# ---------------------------------------------------------------------------- # 

29# # 

30# Setup #### 

31# # 

32# ---------------------------------------------------------------------------- # 

33 

34 

35# ---------------------------------------------------------------------------- # 

36# Imports #### 

37# ---------------------------------------------------------------------------- # 

38 

39 

40# ## Local First Party Imports ---- 

41from ts_stat_tests.seasonality.algorithms import ( 

42 ch, 

43 ocsb, 

44 qs, 

45 seasonal_strength, 

46 spikiness, 

47 trend_strength, 

48) 

49from ts_stat_tests.seasonality.tests import is_seasonal, seasonality 

50 

51 

52# ---------------------------------------------------------------------------- # 

53# Exports #### 

54# ---------------------------------------------------------------------------- # 

55 

56 

57__all__: list[str] = [ 

58 "ch", 

59 "ocsb", 

60 "qs", 

61 "seasonal_strength", 

62 "spikiness", 

63 "trend_strength", 

64 "seasonality", 

65 "is_seasonal", 

66]