Time Series analysis tsa ¶

statsmodels.tsa contains model classes and functions that are useful for time series analysis. Basic models include univariate autoregressive models (AR), vector autoregressive models (VAR) and univariate autoregressive moving average models (ARMA). Non-linear models include Markov switching dynamic regression and autoregression. It also includes descriptive statistics for time series, for example autocorrelation, partial autocorrelation function and periodogram, as well as the corresponding theoretical properties of ARMA or related processes. It also includes methods to work with autoregressive and moving average lag-polynomials. Additionally, related statistical tests and some useful helper functions are available.

Estimation is either done by exact or conditional Maximum Likelihood or conditional least-squares, either using Kalman Filter or direct filters.

Currently, functions and classes have to be imported from the corresponding module, but the main classes will be made available in the statsmodels.tsa namespace. The module structure is within statsmodels.tsa is

Some additional functions that are also useful for time series analysis are in other parts of statsmodels, for example additional statistical tests.

Some related functions are also available in matplotlib, nitime, and scikits.talkbox. Those functions are designed more for the use in signal processing where longer time series are available and work more often in the frequency domain.

Descriptive Statistics and Tests ¶

stattools.acovf (x[, adjusted, demean, fft, ...])

Estimate autocovariances.

stattools.acf (x[, adjusted, nlags, qstat, ...])

Calculate the autocorrelation function.

stattools.pacf (x[, nlags, method, alpha])

Partial autocorrelation estimate.

stattools.pacf_yw (x[, nlags, method])

Partial autocorrelation estimated with non-recursive yule_walker.

stattools.pacf_ols (x[, nlags, efficient, ...])

Calculate partial autocorrelations via OLS.

stattools.pacf_burg (x[, nlags, demean])

Calculate Burg"s partial autocorrelation estimator.

stattools.ccovf (x, y[, adjusted, demean, fft])

Calculate the crosscovariance between two series.

stattools.ccf (x, y[, adjusted, fft])

The cross-correlation function.

stattools.adfuller (x[, maxlag, regression, ...])

Augmented Dickey-Fuller unit root test.

stattools.kpss (x[, regression, nlags, store])

Kwiatkowski-Phillips-Schmidt-Shin test for stationarity.

stattools.range_unit_root_test (x[, store])

Range unit-root test for stationarity.

stattools.zivot_andrews

Zivot-Andrews structural-break unit-root test.

stattools.coint (y0, y1[, trend, method, ...])

Test for no-cointegration of a univariate equation.

stattools.bds (x[, max_dim, epsilon, distance])

BDS Test Statistic for Independence of a Time Series

stattools.q_stat (x, nobs)

Compute Ljung-Box Q Statistic.

stattools.breakvar_heteroskedasticity_test (resid)

Test for heteroskedasticity of residuals

stattools.grangercausalitytests (x, maxlag[, ...])

Four tests for granger non causality of 2 time series.

stattools.levinson_durbin (s[, nlags, isacov])

Levinson-Durbin recursion for autoregressive processes.

stattools.innovations_algo (acov[, nobs, rtol])

Innovations algorithm to convert autocovariances to MA parameters.

stattools.innovations_filter (endog, theta)

Filter observations using the innovations algorithm.

stattools.levinson_durbin_pacf (pacf[, nlags])

Levinson-Durbin algorithm that returns the acf and ar coefficients.

stattools.arma_order_select_ic (y[, max_ar, ...])

Compute information criteria for many ARMA models.

x13.x13_arima_select_order (endog[, ...])

Perform automatic seasonal ARIMA order identification using x12/x13 ARIMA.

x13.x13_arima_analysis (endog[, maxorder, ...])

Perform x13-arima analysis for monthly or quarterly data.

Estimation ¶

The following are the main estimation classes, which can be accessed through statsmodels.tsa.api and their result classes

Univariate Autoregressive Processes (AR) ¶

The basic autoregressive model in Statsmodels is:

ar_model.AutoReg (endog, lags[, trend, ...])

Autoregressive AR-X(p) model

ar_model.AutoRegResults (model, params, ...)

Class to hold results from fitting an AutoReg model.

ar_model.ar_select_order (endog, maxlag[, ...])

Autoregressive AR-X(p) model order selection.

The ar_model.AutoReg model estimates parameters using conditional MLE (OLS), and supports exogenous regressors (an AR-X model) and seasonal effects.

AR-X and related models can also be fitted with the arima.ARIMA class and the SARIMAX class (using full MLE via the Kalman Filter).

See the notebook Autoregressions for an overview.

Autoregressive Moving-Average Processes (ARMA) and Kalman Filter ¶

Basic ARIMA model and results classes are as follows:

arima.model.ARIMA (endog[, exog, order, ...])

Autoregressive Integrated Moving Average (ARIMA) model, and extensions

arima.model.ARIMAResults (model, params, ...)

Class to hold results from fitting an SARIMAX model.

This model allows estimating parameters by various methods (including conditional MLE via the Hannan-Rissanen method and full MLE via the Kalman filter). It is a special case of the SARIMAX model, and it includes a large number of inherited features from the state space models (including prediction / forecasting, residual diagnostics, simulation and impulse responses, etc.).

See the notebooks ARMA: Sunspots Data and ARMA: Artificial Data for an overview.

Exponential Smoothing ¶

Linear and non-linear exponential smoothing models are available:

ExponentialSmoothing (endog[, trend, ...])

Holt Winter's Exponential Smoothing

SimpleExpSmoothing (endog[, ...])

Simple Exponential Smoothing

Holt (endog[, exponential, damped_trend, ...])

Holt's Exponential Smoothing

HoltWintersResults (model, params, sse, aic, ...)

Results from fitting Exponential Smoothing models.

Separately, linear and non-linear exponential smoothing models have also been implemented based on the “innovations” state space approach. In addition to the usual support for parameter fitting, in-sample prediction, and out-of-sample forecasting, these models also support prediction intervals, simulation, and more.

exponential_smoothing.ets.ETSModel (endog[, ...])

ETS models.

exponential_smoothing.ets.ETSResults (model, ...)

Results from an error, trend, seasonal (ETS) exponential smoothing model

Finally, linear exponential smoothing models have also been separately implemented as a special case of the general state space framework (this is separate from the “innovations” state space approach described above). Although this approach does not allow for the non-linear (multiplicative) exponential smoothing models, it includes all features of state space models (including prediction / forecasting, residual diagnostics, simulation and impulse responses, etc.).

statespace.exponential_smoothing.ExponentialSmoothing (endog)

Linear exponential smoothing models

statespace.exponential_smoothing.ExponentialSmoothingResults (...)

Results from fitting a linear exponential smoothing model

See the notebook Exponential Smoothing for an overview.

ARMA Process ¶

The following are tools to work with the theoretical properties of an ARMA process for given lag-polynomials.

arima_process.ArmaProcess ([ar, ma, nobs])

Theoretical properties of an ARMA process for specified lag-polynomials.

arima_process.ar2arma (ar_des, p, q[, n, ...])

Find arma approximation to ar process.

arima_process.arma2ar (ar, ma[, lags])

A finite-lag AR approximation of an ARMA process.

arima_process.arma2ma (ar, ma[, lags])

A finite-lag approximate MA representation of an ARMA process.

arima_process.arma_acf (ar, ma[, lags])

Theoretical autocorrelation function of an ARMA process.

arima_process.arma_acovf (ar, ma[, nobs, ...])

Theoretical autocovariances of stationary ARMA processes

arima_process.arma_generate_sample (ar, ma, ...)

Simulate data from an ARMA.

arima_process.arma_impulse_response (ar, ma)

Compute the impulse response function (MA representation) for ARMA process.

arima_process.arma_pacf (ar, ma[, lags])

Theoretical partial autocorrelation function of an ARMA process.

arima_process.arma_periodogram (ar, ma[, ...])

Periodogram for ARMA process given by lag-polynomials ar and ma.

arima_process.deconvolve (num, den[, n])

Deconvolves divisor out of signal, division of polynomials for n terms

arima_process.index2lpol (coeffs, index)

Expand coefficients to lag poly

arima_process.lpol2index (ar)

Remove zeros from lag polynomial

arima_process.lpol_fiar (d[, n])

AR representation of fractional integration

arima_process.lpol_fima (d[, n])

MA representation of fractional integration

arima_process.lpol_sdiff (s)

return coefficients for seasonal difference (1-L^s)

Autoregressive Distributed Lag (ARDL) Models ¶

Autoregressive Distributed Lag models span the space between autoregressive models ( AutoReg ) and vector autoregressive models ( VAR ).

ardl.ARDL (endog, lags[, exog, order, trend, ...])

Autoregressive Distributed Lag (ARDL) Model

ardl.ARDLResults (model, params, cov_params)

Class to hold results from fitting an ARDL model.

ardl.ardl_select_order (endog, maxlag, exog, ...)

ARDL order selection

ardl.ARDLOrderSelectionResults (model, ics, ...)

Results from an ARDL order selection

The ardl.ARDL model estimates parameters using conditional MLE (OLS) and allows for both simple deterministic terms (trends and seasonal dummies) as well as complex deterministics using a DeterministicProcess .

AR-X and related models can also be fitted with SARIMAX class (using full MLE via the Kalman Filter).

See the notebook Autoregressive Distributed Lag Models for an overview.

Error Correction Models (ECM) ¶

Error correction models are reparameterizations of ARDL models that regress the difference of the endogenous variable on the lagged levels of the endogenous variables and optional lagged differences of the exogenous variables.

ardl.UECM (endog, lags[, exog, order, trend, ...])

Unconstrained Error Correlation Model(UECM)

ardl.UECMResults (model, params, cov_params)

Class to hold results from fitting an UECM model.

ardl.BoundsTestResult (stat, crit_vals, ...)

Statespace Models ¶

See the statespace documentation .

Vector ARs and Vector Error Correction Models ¶

See the vector_ar documentation.

Regime switching models ¶

MarkovRegression (endog, k_regimes[, trend, ...])

First-order k-regime Markov switching regression model

See the notebooks Markov switching dynamic regression and Markov switching autoregression for an overview.

Time Series Filters ¶

bkfilter (x[, low, high, K])

Filter a time series using the Baxter-King bandpass filter.

Filter multiple time series into a single time series.

fftconvolve3 (in1[, in2, in3, mode])

Convolve two N-dimensional arrays using FFT.

fftconvolveinv (in1, in2[, mode])

Convolve two N-dimensional arrays using FFT.

seasonal_decompose (x[, model, filt, period, ...])

Seasonal decomposition using moving averages.

STL (endog[, period, seasonal, trend, ...])

Season-Trend decomposition using LOESS.

MSTL (endog[, periods, windows, lmbda, ...])

Season-Trend decomposition using LOESS for multiple seasonalities.

DecomposeResult (observed, seasonal, trend, resid)

Results class for seasonal decompositions

See the notebook Time Series Filters for an overview.

TSA Tools ¶

add_lag (x[, col, lags, drop, insert])

Returns an array with lags included given an array.

add_trend (x[, trend, prepend, has_constant])

Add a trend and/or constant to an array.

detrend (x[, order, axis])

Detrend an array with a trend of given order along axis 0 or 1.

lagmat (x, maxlag[, trim, original, use_pandas])

Create 2d array of lags.

lagmat2ds (x, maxlag0[, maxlagex, dropex, ...])

Generate lagmatrix for 2d array, columns arranged by variables.

VARMA Process ¶

VarmaPoly (ar[, ma])

class to keep track of Varma polynomial format

Interpolation ¶

dentonm (indicator, benchmark[, freq])

Modified Denton's method to convert low-frequency to high-frequency data.

Deterministic Processes ¶

Deterministic processes simplify creating deterministic sequences with time trend or seasonal patterns. They also provide methods to simplify generating deterministic terms for out-of-sample forecasting. A DeterministicProcess can be directly used with AutoReg to construct complex deterministic dynamics and to forecast without constructing exogenous trends.

DeterministicProcess (index, *[, period, ...])

Container class for deterministic terms.

TimeTrend ([constant, order])

Constant and time trend determinstic terms

Seasonality (period[, initial_period])

Seasonal dummy deterministic terms

Fourier (period, order)

Fourier series deterministic terms

CalendarTimeTrend (freq[, constant, order, ...])

Constant and time trend determinstic terms based on calendar time

CalendarSeasonality (freq, period)

Seasonal dummy deterministic terms based on calendar time

CalendarFourier (freq, order)

Fourier series deterministic terms based on calendar time

DeterministicTerm ()

Abstract Base Class for all Deterministic Terms

CalendarDeterministicTerm (freq)

Abstract Base Class for calendar deterministic terms

FourierDeterministicTerm (order)

Abstract Base Class for all Fourier Deterministic Terms

TimeTrendDeterministicTerm ([constant, order])

Abstract Base Class for all Time Trend Deterministic Terms

Users who wish to write custom deterministic terms must use subclass DeterministicTerm .

See the notebook Deterministic Terms in Time Series Models for an overview.

Forecasting Models ¶

The Theta Model ¶

The Theta model is a simple forecasting method that combines a linear time trend with a Simple Exponential Smoother (Assimakopoulos & Nikolopoulos). An estimator for the parameters of the Theta model and methods to forecast are available in:

ThetaModel (endog, *[, period, ...])

The Theta forecasting model of Assimakopoulos and Nikolopoulos (2000)

ThetaModelResults (b0, alpha, sigma2, ...)

Results class from estimated Theta Models.

Forecasting after STL Decomposition ¶

statsmodels.tsa.seasonal.STL is commonly used to remove seasonal components from a time series. The deseasonalized time series can then be modeled using a any non-seasonal model, and forecasts are constructed by adding the forecast from the non-seasonal model to the estimates of the seasonal component from the final full-cycle which are forecast using a random-walk model.

STLForecast (endog, model, *[, model_kwargs, ...])

Model-based forecasting using STL to remove seasonality

STLForecastResults (stl, result, model, ...)

Results for forecasting using STL to remove seasonality

See the notebook Seasonal Decomposition for an overview.

Prediction Results ¶

Most forecasting methods support a get_prediction method that return a PredictionResults object that contains both the prediction, its variance and can construct a prediction interval.

Results Class ¶

PredictionResults (predicted_mean, var_pred_mean)

Prediction results