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

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

2# # 

3# Title: Regularity Module # 

4# Purpose: Initialize the regularity 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 regularity of time series data. It includes various algorithms and tests to evaluate the predictability and complexity of time series, helping to identify patterns and structures 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.regularity.algorithms import ( 

42 approx_entropy, 

43 permutation_entropy, 

44 sample_entropy, 

45 spectral_entropy, 

46 svd_entropy, 

47) 

48from ts_stat_tests.regularity.tests import entropy, is_regular, regularity 

49 

50 

51# ---------------------------------------------------------------------------- # 

52# Exports #### 

53# ---------------------------------------------------------------------------- # 

54 

55 

56__all__: list[str] = [ 

57 "approx_entropy", 

58 "permutation_entropy", 

59 "sample_entropy", 

60 "spectral_entropy", 

61 "svd_entropy", 

62 "entropy", 

63 "regularity", 

64 "is_regular", 

65]