Documentation Index
Fetch the complete documentation index at: https://nixtlaverse.nixtla.io/llms.txt
Use this file to discover all available pages before exploring further.
Step-by-step guide on using the DynamicStandardTheta Model with
Statsforecast.
During this walkthrough, we will become familiar with the main
StatsForecast class and some relevant methods such as
StatsForecast.plot, StatsForecast.forecast and
StatsForecast.cross_validation in other.
The text in this article is largely taken from Jose A. Fiorucci, Tiago
R. Pellegrini, Francisco Louzada, Fotios Petropoulos, Anne B. Koehler
(2016). “Models for optimising the theta method and their relationship
to state space models”. International Journal of
Forecasting.
Table of Contents
Dynamic Standard Theta Models (DSTM)
The Dynamic Standard Theta Model is a case-specific variation of the
Optimized Dynamic Theta Model.
Also, for θ=2, we have a stochastic approach of Theta, which is
referred to hereafter as the dynamic standard Theta model (DSTM).
Loading libraries and data
Tip
Statsforecast will be needed. To install, see
instructions.
Next, we import plotting libraries and configure the plotting style.
import matplotlib.pyplot as plt
import seaborn as sns
from statsmodels.graphics.tsaplots import plot_acf, plot_pacf
plt.style.use('grayscale') # fivethirtyeight grayscale classic
plt.rcParams['lines.linewidth'] = 1.5
dark_style = {
'figure.facecolor': '#008080', # #212946
'axes.facecolor': '#008080',
'savefig.facecolor': '#008080',
'axes.grid': True,
'axes.grid.which': 'both',
'axes.spines.left': False,
'axes.spines.right': False,
'axes.spines.top': False,
'axes.spines.bottom': False,
'grid.color': '#000000', #2A3459
'grid.linewidth': '1',
'text.color': '0.9',
'axes.labelcolor': '0.9',
'xtick.color': '0.9',
'ytick.color': '0.9',
'font.size': 12 }
plt.rcParams.update(dark_style)
from pylab import rcParams
rcParams['figure.figsize'] = (18,7)
Read Data
import pandas as pd
df = pd.read_csv("https://raw.githubusercontent.com/Naren8520/Serie-de-tiempo-con-Machine-Learning/main/Data/milk_production.csv", usecols=[1,2])
df.head()
| month | production |
|---|
| 0 | 1962-01-01 | 589 |
| 1 | 1962-02-01 | 561 |
| 2 | 1962-03-01 | 640 |
| 3 | 1962-04-01 | 656 |
| 4 | 1962-05-01 | 727 |
The input to StatsForecast is always a data frame in long format with
three columns: unique_id, ds and y:
-
The
unique_id (string, int or category) represents an identifier
for the series.
-
The
ds (datestamp) column should be of a format expected by
Pandas, ideally YYYY-MM-DD for a date or YYYY-MM-DD HH:MM:SS for a
timestamp.
-
The
y (numeric) represents the measurement we wish to forecast.
df["unique_id"]="1"
df.columns=["ds", "y", "unique_id"]
df.head()
| ds | y | unique_id |
|---|
| 0 | 1962-01-01 | 589 | 1 |
| 1 | 1962-02-01 | 561 | 1 |
| 2 | 1962-03-01 | 640 | 1 |
| 3 | 1962-04-01 | 656 | 1 |
| 4 | 1962-05-01 | 727 | 1 |
ds object
y int64
unique_id object
dtype: object
We can see that our time variable (ds) is in an object format, we need
to convert to a date format
df["ds"] = pd.to_datetime(df["ds"])
Explore Data with the plot method
Plot some series using the plot method from the StatsForecast class.
This method prints a random series from the dataset and is useful for
basic EDA.
from statsforecast import StatsForecast
StatsForecast.plot(df)
Autocorrelation plots
fig, axs = plt.subplots(nrows=1, ncols=2)
plot_acf(df["y"], lags=30, ax=axs[0],color="fuchsia")
axs[0].set_title("Autocorrelation");
plot_pacf(df["y"], lags=30, ax=axs[1],color="lime")
axs[1].set_title('Partial Autocorrelation')
plt.show();
Decomposition of the time series
How to decompose a time series and why?
In time series analysis to forecast new values, it is very important to
know past data. More formally, we can say that it is very important to
know the patterns that values follow over time. There can be many
reasons that cause our forecast values to fall in the wrong direction.
Basically, a time series consists of four components. The variation of
those components causes the change in the pattern of the time series.
These components are:
- Level: This is the primary value that averages over time.
- Trend: The trend is the value that causes increasing or
decreasing patterns in a time series.
- Seasonality: This is a cyclical event that occurs in a time
series for a short time and causes short-term increasing or
decreasing patterns in a time series.
- Residual/Noise: These are the random variations in the time
series.
Combining these components over time leads to the formation of a time
series. Most time series consist of level and noise/residual and trend
or seasonality are optional values.
If seasonality and trend are part of the time series, then there will be
effects on the forecast value. As the pattern of the forecasted time
series may be different from the previous time series.
The combination of the components in time series can be of two types: *
Additive * Multiplicative
Additive time series
If the components of the time series are added to make the time series.
Then the time series is called the additive time series. By
visualization, we can say that the time series is additive if the
increasing or decreasing pattern of the time series is similar
throughout the series. The mathematical function of any additive time
series can be represented by:
y(t)=level+Trend+seasonality+noise
Multiplicative time series
If the components of the time series are multiplicative together, then
the time series is called a multiplicative time series. For
visualization, if the time series is having exponential growth or
decline with time, then the time series can be considered as the
multiplicative time series. The mathematical function of the
multiplicative time series can be represented as.
y(t)=Level∗Trend∗seasonality∗Noise
Additive
from statsmodels.tsa.seasonal import seasonal_decompose
a = seasonal_decompose(df["y"], model = "additive", period=12)
a.plot();
Multiplicative
from statsmodels.tsa.seasonal import seasonal_decompose
a = seasonal_decompose(df["y"], model = "Multiplicative", period=12)
a.plot();
Split the data into training and testing
Let’s divide our data into sets 1. Data to train our
Dynamic Standard Theta Model 2. Data to test our model
For the test data we will use the last 12 months to test and evaluate
the performance of our model.
train = df[df.ds<='1974-12-01']
test = df[df.ds>'1974-12-01']
Now let’s plot the training data and the test data.
sns.lineplot(train,x="ds", y="y", label="Train", linestyle="--")
sns.lineplot(test, x="ds", y="y", label="Test")
plt.title("Monthly Milk Production")
plt.show()
Implementation of DynamicStandardTheta with StatsForecast
Load libraries
from statsforecast import StatsForecast
from statsforecast.models import DynamicTheta
Instantiating Model
Import and instantiate the models. Setting the argument is sometimes
tricky. This article on Seasonal
periods by the
master, Rob Hyndmann, can be useful for season_length.
season_length = 12 # Monthly data
horizon = len(test) # number of predictions
models = [DynamicTheta(season_length=season_length,
decomposition_type="additive")] # multiplicative additive
We fit the models by instantiating a new StatsForecast object with the
following parameters:
models: a list of models. Select the models you want from models and
import them.
-
freq: a string indicating the frequency of the data. (See pandas’
available
frequencies.)
-
n_jobs: n_jobs: int, number of jobs used in the parallel
processing, use -1 for all cores.
-
fallback_model: a model to be used if a model fails.
Any settings are passed into the constructor. Then you call its fit
method and pass in the historical data frame.
sf = StatsForecast(models=models, freq='MS')
Fit Model
StatsForecast(models=[DynamicTheta])
Let’s see the results of our Dynamic Standard Theta model. We can
observe it with the following instruction:
result=sf.fitted_[0,0].model_
print(result.keys())
print(result['fit'])
dict_keys(['mse', 'amse', 'fit', 'residuals', 'm', 'states', 'par', 'n', 'modeltype', 'mean_y', 'decompose', 'decomposition_type', 'seas_forecast', 'fitted'])
results(x=array([393.28739991, 0.76875 ]), fn=10.787112115489622, nit=20, simplex=array([[399.92916541, 0.771875 ],
[393.28739991, 0.76875 ],
[384.74798713, 0.771875 ]]))
Let us now visualize the residuals of our models.
As we can see, the result obtained above has an output in a dictionary,
to extract each element from the dictionary we are going to use the
.get() function to extract the element and then we are going to save
it in a pd.DataFrame().
residual=pd.DataFrame(result.get("residuals"), columns=["residual Model"])
residual
| residual Model |
|---|
| 0 | -18.247131 |
| 1 | -46.247131 |
| 2 | 17.140198 |
| … | … |
| 153 | -58.941711 |
| 154 | -91.055420 |
| 155 | -42.624939 |
import scipy.stats as stats
fig, axs = plt.subplots(nrows=2, ncols=2)
residual.plot(ax=axs[0,0])
axs[0,0].set_title("Residuals");
sns.distplot(residual, ax=axs[0,1]);
axs[0,1].set_title("Density plot - Residual");
stats.probplot(residual["residual Model"], dist="norm", plot=axs[1,0])
axs[1,0].set_title('Plot Q-Q')
plot_acf(residual, lags=35, ax=axs[1,1],color="fuchsia")
axs[1,1].set_title("Autocorrelation");
plt.show();
Forecast Method
If you want to gain speed in productive settings where you have multiple
series or models we recommend using the StatsForecast.forecast method
instead of .fit and .predict.
The main difference is that the .forecast doest not store the fitted
values and is highly scalable in distributed environments.
The forecast method takes two arguments: forecasts next h (horizon)
and level.
-
h (int): represents the forecast h steps into the future. In this
case, 12 months ahead.
-
level (list of floats): this optional parameter is used for
probabilistic forecasting. Set the level (or confidence percentile)
of your prediction interval. For example, level=[90] means that
the model expects the real value to be inside that interval 90% of
the times.
The forecast object here is a new data frame that includes a column with
the name of the model and the y hat values, as well as columns for the
uncertainty intervals. Depending on your computer, this step should take
around 1min.
Y_hat = sf.forecast(df=train, h=horizon, fitted=True)
Y_hat
| unique_id | ds | DynamicTheta |
|---|
| 0 | 1 | 1975-01-01 | 838.531555 |
| 1 | 1 | 1975-02-01 | 800.154968 |
| 2 | 1 | 1975-03-01 | 893.430786 |
| … | … | … | … |
| 9 | 1 | 1975-10-01 | 815.959351 |
| 10 | 1 | 1975-11-01 | 786.716431 |
| 11 | 1 | 1975-12-01 | 823.539368 |
values=sf.forecast_fitted_values()
values.head()
| unique_id | ds | y | DynamicTheta |
|---|
| 0 | 1 | 1962-01-01 | 589.0 | 607.247131 |
| 1 | 1 | 1962-02-01 | 561.0 | 607.247131 |
| 2 | 1 | 1962-03-01 | 640.0 | 622.859802 |
| 3 | 1 | 1962-04-01 | 656.0 | 606.987793 |
| 4 | 1 | 1962-05-01 | 727.0 | 605.021179 |
StatsForecast.plot(values)
Adding 95% confidence interval with the forecast method
sf.forecast(df=train, h=horizon, level=[95])
| unique_id | ds | DynamicTheta | DynamicTheta-lo-95 | DynamicTheta-hi-95 |
|---|
| 0 | 1 | 1975-01-01 | 838.531555 | 741.237366 | 954.407166 |
| 1 | 1 | 1975-02-01 | 800.154968 | 640.697205 | 945.673096 |
| 2 | 1 | 1975-03-01 | 893.430786 | 703.900635 | 1065.418701 |
| … | … | … | … | … | … |
| 9 | 1 | 1975-10-01 | 815.959351 | 536.422791 | 1086.643433 |
| 10 | 1 | 1975-11-01 | 786.716431 | 484.476593 | 1033.687134 |
| 11 | 1 | 1975-12-01 | 823.539368 | 509.187256 | 1104.107788 |
Predict method with confidence interval
To generate forecasts use the predict method.
The predict method takes two arguments: forecasts the next h (for
horizon) and level.
-
h (int): represents the forecast h steps into the future. In this
case, 12 months ahead.
-
level (list of floats): this optional parameter is used for
probabilistic forecasting. Set the level (or confidence percentile)
of your prediction interval. For example, level=[95] means that
the model expects the real value to be inside that interval 95% of
the times.
The forecast object here is a new data frame that includes a column with
the name of the model and the y hat values, as well as columns for the
uncertainty intervals.
This step should take less than 1 second.
| unique_id | ds | DynamicTheta |
|---|
| 0 | 1 | 1975-01-01 | 838.531555 |
| 1 | 1 | 1975-02-01 | 800.154968 |
| 2 | 1 | 1975-03-01 | 893.430786 |
| … | … | … | … |
| 9 | 1 | 1975-10-01 | 815.959351 |
| 10 | 1 | 1975-11-01 | 786.716431 |
| 11 | 1 | 1975-12-01 | 823.539368 |
forecast_df = sf.predict(h=horizon, level=[80,95])
forecast_df
| unique_id | ds | DynamicTheta | DynamicTheta-lo-80 | DynamicTheta-hi-80 | DynamicTheta-lo-95 | DynamicTheta-hi-95 |
|---|
| 0 | 1 | 1975-01-01 | 838.531555 | 765.423828 | 927.285339 | 741.237366 | 954.407166 |
| 1 | 1 | 1975-02-01 | 800.154968 | 701.099854 | 899.316162 | 640.697205 | 945.673096 |
| 2 | 1 | 1975-03-01 | 893.430786 | 758.326416 | 1007.631165 | 703.900635 | 1065.418701 |
| … | … | … | … | … | … | … | … |
| 9 | 1 | 1975-10-01 | 815.959351 | 608.699463 | 992.552673 | 536.422791 | 1086.643433 |
| 10 | 1 | 1975-11-01 | 786.716431 | 558.429810 | 970.648376 | 484.476593 | 1033.687134 |
| 11 | 1 | 1975-12-01 | 823.539368 | 588.706787 | 1031.564941 | 509.187256 | 1104.107788 |
sf.plot(train, test.merge(forecast_df), level=[80, 95])
Cross-validation
In previous steps, we’ve taken our historical data to predict the
future. However, to asses its accuracy we would also like to know how
the model would have performed in the past. To assess the accuracy and
robustness of your models on your data perform Cross-Validation.
With time series data, Cross Validation is done by defining a sliding
window across the historical data and predicting the period following
it. This form of cross-validation allows us to arrive at a better
estimation of our model’s predictive abilities across a wider range of
temporal instances while also keeping the data in the training set
contiguous as is required by our models.
The following graph depicts such a Cross Validation Strategy:
Cross-validation of time series models is considered a best practice but
most implementations are very slow. The statsforecast library implements
cross-validation as a distributed operation, making the process less
time-consuming to perform. If you have big datasets you can also perform
Cross Validation in a distributed cluster using Ray, Dask or Spark.
In this case, we want to evaluate the performance of each model for the
last 5 months (n_windows=5), forecasting every second months
(step_size=12). Depending on your computer, this step should take
around 1 min.
The cross_validation method from the StatsForecast class takes the
following arguments.
-
df: training data frame
-
h (int): represents h steps into the future that are being
forecasted. In this case, 12 months ahead.
-
step_size (int): step size between each window. In other words:
how often do you want to run the forecasting processes.
-
n_windows(int): number of windows used for cross validation. In
other words: what number of forecasting processes in the past do you
want to evaluate.
crossvalidation_df = sf.cross_validation(df=train,
h=horizon,
step_size=12,
n_windows=3)
The crossvaldation_df object is a new data frame that includes the
following columns:
unique_id: index. If you dont like working with index just run
crossvalidation_df.resetindex()
ds: datestamp or temporal index
cutoff: the last datestamp or temporal index for the n_windows.
y: true value
"model": columns with the model’s name and fitted value.
| unique_id | ds | cutoff | y | DynamicTheta |
|---|
| 0 | 1 | 1972-01-01 | 1971-12-01 | 826.0 | 827.107239 |
| 1 | 1 | 1972-02-01 | 1971-12-01 | 799.0 | 789.924194 |
| 2 | 1 | 1972-03-01 | 1971-12-01 | 890.0 | 879.664429 |
| … | … | … | … | … | … |
| 33 | 1 | 1974-10-01 | 1973-12-01 | 812.0 | 804.398560 |
| 34 | 1 | 1974-11-01 | 1973-12-01 | 773.0 | 775.329285 |
| 35 | 1 | 1974-12-01 | 1973-12-01 | 813.0 | 811.767639 |
Model Evaluation
Now we are going to evaluate our model with the results of the
predictions, we will use different types of metrics MAE, MAPE, MASE,
RMSE, SMAPE to evaluate the accuracy.
from functools import partial
import utilsforecast.losses as ufl
from utilsforecast.evaluation import evaluate
evaluate(
test.merge(Y_hat),
metrics=[ufl.mae, ufl.mape, partial(ufl.mase, seasonality=season_length), ufl.rmse, ufl.smape],
train_df=train,
)
| unique_id | metric | DynamicTheta |
|---|
| 0 | 1 | mae | 8.182119 |
| 1 | 1 | mape | 0.009736 |
| 2 | 1 | mase | 0.367965 |
| 3 | 1 | rmse | 9.817624 |
| 4 | 1 | smape | 0.004874 |
References
- Kostas I. Nikolopoulos, Dimitrios D. Thomakos. Forecasting with the
Theta Method-Theory and Applications. 2019 John Wiley & Sons
Ltd.
- Jose A. Fiorucci, Tiago R. Pellegrini, Francisco Louzada, Fotios
Petropoulos, Anne B. Koehler (2016). “Models for optimising the
theta method and their relationship to state space models”.
International Journal of
Forecasting.
- Nixtla DynamicTheta API
- Pandas available
frequencies.
- Rob J. Hyndman and George Athanasopoulos (2018). “Forecasting
principles and practice, Time series
cross-validation”..
- Seasonal periods- Rob J
Hyndman.