# Diagnostics

Prophet includes functionality for time series cross validation to measure forecast error using historical data. This is done by selecting cutoff points in the history, and for each of them fitting the model using data only up to that cutoff point. We can then compare the forecasted values to the actual values. This figure illustrates a simulated historical forecast on the Peyton Manning dataset, where the model was fit to a initial history of 5 years, and a forecast was made on a one year horizon.

The Prophet paper gives further description of simulated historical forecasts.

This cross validation procedure can be done automatically for a range of historical cutoffs using the `cross_validation`

function. We specify the forecast horizon (`horizon`

), and then optionally the size of the initial training period (`initial`

) and the spacing between cutoff dates (`period`

). By default, the initial training period is set to three times the horizon, and cutoffs are made every half a horizon.

The output of `cross_validation`

is a dataframe with the true values `y`

and the out-of-sample forecast values `yhat`

, at each simulated forecast date and for each cutoff date. In particular, a forecast is made for every observed point between `cutoff`

and `cutoff + horizon`

. This dataframe can then be used to compute error measures of `yhat`

vs. `y`

.

Here we do cross-validation to assess prediction performance on a horizon of 365 days, starting with 730 days of training data in the first cutoff and then making predictions every 180 days. On this 8 year time series, this corresponds to 11 total forecasts.

1
2
3

# R
df.cv <- cross_validation(m, initial = 730, period = 180, horizon = 365, units = 'days')
head(df.cv)

1
2
3
4

# Python
from fbprophet.diagnostics import cross_validation
df_cv = cross_validation(m, initial='730 days', period='180 days', horizon = '365 days')
df_cv.head()

ds | yhat | yhat_lower | yhat_upper | y | cutoff | |
---|---|---|---|---|---|---|

0 | 2010-02-16 | 8.956572 | 8.460049 | 9.460400 | 8.242493 | 2010-02-15 |

1 | 2010-02-17 | 8.723004 | 8.200557 | 9.236561 | 8.008033 | 2010-02-15 |

2 | 2010-02-18 | 8.606823 | 8.070835 | 9.123754 | 8.045268 | 2010-02-15 |

3 | 2010-02-19 | 8.528688 | 8.034782 | 9.042712 | 7.928766 | 2010-02-15 |

4 | 2010-02-20 | 8.270706 | 7.754891 | 8.739012 | 7.745003 | 2010-02-15 |

In R, the argument `units`

must be a type accepted by `as.difftime`

, which is weeks or shorter. In Python, the string for `initial`

, `period`

, and `horizon`

should be in the format used by Pandas Timedelta, which accepts units of days or shorter.

The `performance_metrics`

utility can be used to compute some useful statistics of the prediction performance (`yhat`

, `yhat_lower`

, and `yhat_upper`

compared to `y`

), as a function of the distance from the cutoff (how far into the future the prediction was). The statistics computed are mean squared error (MSE), root mean squared error (RMSE), mean absolute error (MAE), mean absolute percent error (MAPE), and coverage of the `yhat_lower`

and `yhat_upper`

estimates. These are computed on a rolling window of the predictions in `df_cv`

after sorting by horizon (`ds`

minus `cutoff`

). By default 10% of the predictions will be included in each window, but this can be changed with the `rolling_window`

argument.

1
2
3

# R
df.p <- performance_metrics(df.cv)
head(df.p)

1
2
3
4

# Python
from fbprophet.diagnostics import performance_metrics
df_p = performance_metrics(df_cv)
df_p.head()

horizon | mse | rmse | mae | mape | coverage | |
---|---|---|---|---|---|---|

0 | 37 days | 0.495378 | 0.703831 | 0.505713 | 0.058593 | 0.680448 |

1 | 38 days | 0.501134 | 0.707908 | 0.510680 | 0.059169 | 0.679077 |

2 | 39 days | 0.523334 | 0.723418 | 0.516755 | 0.059766 | 0.677707 |

3 | 40 days | 0.530625 | 0.728440 | 0.519645 | 0.060075 | 0.678849 |

4 | 41 days | 0.538117 | 0.733565 | 0.520663 | 0.060156 | 0.686386 |

Cross validation performance metrics can be visualized with `plot_cross_validation_metric`

, here shown for MAPE. Dots show the absolute percent error for each prediction in `df_cv`

. The blue line shows the MAPE, where the mean is taken over a rolling window of the dots. We see for this forecast that errors around 5% are typical for predictions one month into the future, and that errors increase up to around 11% for predictions that are a year out.

1
2

# R
plot_cross_validation_metric(df.cv, metric = 'mape')

1
2
3

# Python
from fbprophet.plot import plot_cross_validation_metric
fig = plot_cross_validation_metric(df_cv, metric='mape')

The size of the rolling window in the figure can be changed with the optional argument `rolling_window`

, which specifies the proportion of forecasts to use in each rolling window. The default is 0.1, corresponding to 10% of rows from `df_cv`

included in each window; increasing this will lead to a smoother average curve in the figure.

The `initial`

period should be long enough to capture all of the components of the model, in particular seasonalities and extra regressors: at least a year for yearly seasonality, at least a week for weekly seasonality, etc.