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

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

2# # 

3# Title: Stability Module # 

4# Purpose: Initialize the stability 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 the stability and lumpiness of time series data. It includes various algorithms and tests to evaluate the consistency of statistical properties over time, helping to identify periods of instability or variability in 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.stability.algorithms import lumpiness, stability 

42from ts_stat_tests.stability.tests import is_lumpy, is_stable 

43 

44 

45# ---------------------------------------------------------------------------- # 

46# Exports #### 

47# ---------------------------------------------------------------------------- # 

48 

49 

50__all__: list[str] = ["stability", "lumpiness", "is_stable", "is_lumpy"]