Dates in timeseries models

In [1]:
from __future__ import print_function
import statsmodels.api as sm
import numpy as np
import pandas as pd

Getting started

In [2]:
data = sm.datasets.sunspots.load()

/home/travis/build/statsmodels/statsmodels/statsmodels/datasets/utils.py:337: FutureWarning: load will return datasets containing pandas DataFrames and Series in the Future.  To suppress this message, specify as_pandas=False
  FutureWarning)

Right now an annual date series must be datetimes at the end of the year.

In [3]:
from datetime import datetime
dates = sm.tsa.datetools.dates_from_range('1700', length=len(data.endog))

Using Pandas

Make a pandas TimeSeries or DataFrame

In [4]:
endog = pd.Series(data.endog, index=dates)

Instantiate the model

In [5]:
ar_model = sm.tsa.AR(endog, freq='A')
pandas_ar_res = ar_model.fit(maxlag=9, method='mle', disp=-1)

Out-of-sample prediction

In [6]:
pred = pandas_ar_res.predict(start='2005', end='2015')
print(pred)

2005-12-31    20.003293
2006-12-31    24.703980
2007-12-31    20.026125
2008-12-31    23.473639
2009-12-31    30.858582
2010-12-31    61.335455
2011-12-31    87.024687
2012-12-31    91.321234
2013-12-31    79.921599
2014-12-31    60.799502
2015-12-31    40.374871
Freq: A-DEC, dtype: float64

Using explicit dates

In [7]:
ar_model = sm.tsa.AR(data.endog, dates=dates, freq='A')
ar_res = ar_model.fit(maxlag=9, method='mle', disp=-1)
pred = ar_res.predict(start='2005', end='2015')
print(pred)

[20.00329308 24.70398036 20.02612492 23.47363929 30.85858227 61.33545516
 87.02468683 91.3212336  79.92159926 60.79950228 40.37487059]

This just returns a regular array, but since the model has date information attached, you can get the prediction dates in a roundabout way.

In [8]:
print(ar_res.data.predict_dates)

DatetimeIndex(['2005-12-31', '2006-12-31', '2007-12-31', '2008-12-31',
               '2009-12-31', '2010-12-31', '2011-12-31', '2012-12-31',
               '2013-12-31', '2014-12-31', '2015-12-31'],
              dtype='datetime64[ns]', freq='A-DEC')

Note: This attribute only exists if predict has been called. It holds the dates associated with the last call to predict.