Metadata-Version: 2.1
Name: tsmoothie
Version: 0.2.0
Summary: A python library for timeseries smoothing and outlier detection in a vectorized way.
Home-page: https://github.com/cerlymarco/tsmoothie
Author: Marco Cerliani
Author-email: cerlymarco@gmail.com
License: MIT
Description: # tsmoothie
        
        A python library for time-series smoothing and outlier detection in a vectorized way.
        
        ## Overview
        
        tsmoothie computes, in a fast and efficient way, the smoothing of single or multiple time-series. 
        
        The smoothing techniques available are:
        
        - Exponential Smoothing
        - Convolutional Smoothing with various window types (constant, hanning, hamming, bartlett, blackman)
        - Polynomial Smoothing 
        - Spline Smoothing of various kind (linear, cubic, natural cubic) 
        - Gaussian Smoothing 
        - Binner Smoothing 
        - LOWESS 
        - Seasonal Decompose Smoothing of various kind (convolution, lowess, natural cubic spline)
        - Kalman Smoothing with customizable components (level, trend, seasonality, long seasonality) 
        
        tsmoothie provides the calculation of intervals as result of the smoothing process. This can be useful to identify outliers and anomalies in time-series.
        
        The interval types available are:
        
        - sigma intervals
        - confidence intervals
        - predictions intervals
        - kalman intervals
        
        The adoption of this type of intervals depends on the smoothing method used.
        
        tsmoothie can also carry out a sliding smoothing approach. This is possible splitting the time-series into equal sized pieces and smoothing them independently. As always, this functionality is implemented in a vectorized way through the WindowWrapper class.
        
        ## Media
        
        Blog Posts:
        
        - [Time Series Smoothing for better Clustering](https://towardsdatascience.com/time-series-smoothing-for-better-clustering-121b98f308e8)
        - [Time Series Smoothing for better Forecasting](https://towardsdatascience.com/time-series-smoothing-for-better-forecasting-7fbf10428b2)
        
        ## Installation
        
        ```shell
        pip install tsmoothie
        ```
        
        The module depends only on NumPy, SciPy and simdkalman. Python 3.6 or above is supported.
        
        ## Usage
        
        Below a couple of examples of how tsmoothie works. Full examples are available in the [notebooks folder](https://github.com/cerlymarco/tsmoothie/tree/master/notebooks).
        
        ```python
        # import libraries
        import numpy as np
        import matplotlib.pyplot as plt
        from tsmoothie.utils_func import sim_randomwalk
        from tsmoothie.smoother import LowessSmoother
        
        # generate 3 randomwalks of lenght 200
        np.random.seed(123)
        data = sim_randomwalk(n_series=3, timesteps=200, 
                              process_noise=10, measure_noise=30)
        
        # operate smoothing
        smoother = LowessSmoother(smooth_fraction=0.1, iterations=1)
        smoother.smooth(data)
        
        # generate intervals
        low, up = smoother.get_intervals('prediction_interval')
        
        # plot the smoothed timeseries with intervals
        plt.figure(figsize=(18,5))
        
        for i in range(3):
            
            plt.subplot(1,3,i+1)
            plt.plot(smoother.smooth_data[i], linewidth=3, color='blue')
            plt.plot(smoother.data[i], '.k')
            plt.title(f"timeseries {i+1}"); plt.xlabel('time')
        
            plt.fill_between(range(len(smoother.data[i])), low[i], up[i], alpha=0.3)
        ```
        
        ![Randomwalk Smoothing](https://raw.githubusercontent.com/cerlymarco/tsmoothie/master/imgs/randomwalk_smoothing.png)
        
        ```python
        # import libraries
        import numpy as np
        import matplotlib.pyplot as plt
        from tsmoothie.utils_func import sim_seasonal_data
        from tsmoothie.smoother import DecomposeSmoother
        
        # generate 3 periodic timeseries of lenght 300
        np.random.seed(123)
        data = sim_seasonal_data(n_series=3, timesteps=300, 
                                 freq=24, measure_noise=30)
        
        # operate smoothing
        smoother = DecomposeSmoother(smooth_type='lowess', periods=24,
                                     smooth_fraction=0.3)
        smoother.smooth(data)
        
        # generate intervals
        low, up = smoother.get_intervals('sigma_interval')
        
        # plot the smoothed timeseries with intervals
        plt.figure(figsize=(18,5))
        
        for i in range(3):
            
            plt.subplot(1,3,i+1)
            plt.plot(smoother.smooth_data[i], linewidth=3, color='blue')
            plt.plot(smoother.data[i], '.k')
            plt.title(f"timeseries {i+1}"); plt.xlabel('time')
        
            plt.fill_between(range(len(smoother.data[i])), low[i], up[i], alpha=0.3)
        ```
        
        ![Sinusoidal Smoothing](https://raw.githubusercontent.com/cerlymarco/tsmoothie/master/imgs/sinusoidal_smoothing.png)
        
        ## References
        
        - Polynomial, Spline, Gaussian and Binner smoothing are carried out building a regression on custom basis expansions. These implementations are based on the amazing intuitions of Matthew Drury available [here](https://github.com/madrury/basis-expansions/blob/master/examples/comparison-of-smoothing-methods.ipynb)
        - Time Series Modelling with Unobserved Components, Matteo M. Pelagatti
Platform: UNKNOWN
Description-Content-Type: text/markdown
