{
"cells": [
{
"cell_type": "code",
"execution_count": 1,
"metadata": {
"block_hidden": true,
"collapsed": false
},
"outputs": [],
"source": [
"%load_ext rpy2.ipython\n",
"%matplotlib inline\n",
"from fbprophet import Prophet\n",
"import pandas as pd\n",
"import numpy as np\n",
"from matplotlib import pyplot as plt\n",
"df = pd.read_csv('../examples/example_wp_peyton_manning.csv')\n",
"df['y'] = np.log(df['y'])\n",
"m = Prophet()\n",
"m.fit(df)\n",
"future = m.make_future_dataframe(periods=366)"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {
"block_hidden": true,
"collapsed": false
},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"/usr/lib/python2.7/dist-packages/rpy2/rinterface/__init__.py:186: RRuntimeWarning: Loading required package: Rcpp\n",
"\n",
" warnings.warn(x, RRuntimeWarning)\n"
]
},
{
"data": {
"text/plain": [
"STAN OPTIMIZATION COMMAND (LBFGS)\n",
"init = user\n",
"save_iterations = 1\n",
"init_alpha = 0.001\n",
"tol_obj = 1e-12\n",
"tol_grad = 1e-08\n",
"tol_param = 1e-08\n",
"tol_rel_obj = 10000\n",
"tol_rel_grad = 1e+07\n",
"history_size = 5\n",
"seed = 1733845324\n",
"initial log joint probability = -19.4685\n",
"Optimization terminated normally: \n",
" Convergence detected: relative gradient magnitude is below tolerance\n"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"%%R\n",
"library(prophet)\n",
"df <- read.csv('../examples/example_wp_peyton_manning.csv')\n",
"df$y <- log(df$y)\n",
"m <- prophet(df)\n",
"future <- make_future_dataframe(m, periods=366)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Modeling Holidays\n",
"If you have holidays that you'd like to model, you must create a dataframe for them. It has two columns (`holiday` and `ds`) and a row for each occurrence of the holiday. It must include all occurrences of the holiday, both in the past (back as far as the historical data go) and in the future (out as far as the forecast is being made). If they won't repeat in the future, Prophet will model them and then not include them in the forecast.\n",
"\n",
"You can also include columns `lower_window` and `upper_window` which extend the holiday out to `[lower_window, upper_window]` days around the date. For instance, if you wanted to included Christmas Eve in addition to Christmas you'd include `lower_window=-1,upper_window=0`. If you wanted to use Black Friday in addition to Thanksgiving, you'd include `lower_window=0,upper_window=1`.\n",
"\n",
"Here we create a dataframe that includes the dates of all of Peyton Manning's playoff appearances:"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {
"collapsed": true
},
"outputs": [],
"source": [
"playoffs = pd.DataFrame({\n",
" 'holiday': 'playoff',\n",
" 'ds': pd.to_datetime(['2008-01-13', '2009-01-03', '2010-01-16',\n",
" '2010-01-24', '2010-02-07', '2011-01-08',\n",
" '2013-01-12', '2014-01-12', '2014-01-19',\n",
" '2014-02-02', '2015-01-11', '2016-01-17',\n",
" '2016-01-24', '2016-02-07']),\n",
" 'lower_window': 0,\n",
" 'upper_window': 1,\n",
"})\n",
"superbowls = pd.DataFrame({\n",
" 'holiday': 'superbowl',\n",
" 'ds': pd.to_datetime(['2010-02-07', '2014-02-02', '2016-02-07']),\n",
" 'lower_window': 0,\n",
" 'upper_window': 1,\n",
"})\n",
"holidays = pd.concat((playoffs, superbowls))"
]
},
{
"cell_type": "code",
"execution_count": 4,
"metadata": {
"collapsed": false,
"output_hidden": true
},
"outputs": [
{
"name": "stderr",
"output_type": "stream",
"text": [
"/usr/lib/python2.7/dist-packages/rpy2/rinterface/__init__.py:186: RRuntimeWarning: \n",
"Attaching package: ‘dplyr’\n",
"\n",
"\n",
" warnings.warn(x, RRuntimeWarning)\n",
"/usr/lib/python2.7/dist-packages/rpy2/rinterface/__init__.py:186: RRuntimeWarning: The following objects are masked from ‘package:stats’:\n",
"\n",
" filter, lag\n",
"\n",
"\n",
" warnings.warn(x, RRuntimeWarning)\n",
"/usr/lib/python2.7/dist-packages/rpy2/rinterface/__init__.py:186: RRuntimeWarning: The following objects are masked from ‘package:base’:\n",
"\n",
" intersect, setdiff, setequal, union\n",
"\n",
"\n",
" warnings.warn(x, RRuntimeWarning)\n"
]
}
],
"source": [
"%%R\n",
"library(dplyr)\n",
"playoffs <- data_frame(\n",
" holiday = 'playoff',\n",
" ds = as.Date(c('2008-01-13', '2009-01-03', '2010-01-16',\n",
" '2010-01-24', '2010-02-07', '2011-01-08',\n",
" '2013-01-12', '2014-01-12', '2014-01-19',\n",
" '2014-02-02', '2015-01-11', '2016-01-17',\n",
" '2016-01-24', '2016-02-07')),\n",
" lower_window = 0,\n",
" upper_window = 1\n",
")\n",
"superbowls <- data_frame(\n",
" holiday = 'superbowl',\n",
" ds = as.Date(c('2010-02-07', '2014-02-02', '2016-02-07')),\n",
" lower_window = 0,\n",
" upper_window = 1\n",
")\n",
"holidays <- bind_rows(playoffs, superbowls)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Above we have include the superbowl days as both playoff games and superbowl games. This means that the superbowl effect will be an additional additive bonus on top of the playoff effect.\n",
"\n",
"Once the table is created, holiday effects are included in the forecast by passing them in with the `holidays` argument. Here we do it with the Peyton Manning data from the Quickstart:"
]
},
{
"cell_type": "code",
"execution_count": 5,
"metadata": {
"collapsed": false
},
"outputs": [],
"source": [
"m = Prophet(holidays=holidays)\n",
"forecast = m.fit(df).predict(future)"
]
},
{
"cell_type": "code",
"execution_count": 6,
"metadata": {
"collapsed": false,
"output_hidden": true
},
"outputs": [
{
"data": {
"text/plain": [
"STAN OPTIMIZATION COMMAND (LBFGS)\n",
"init = user\n",
"save_iterations = 1\n",
"init_alpha = 0.001\n",
"tol_obj = 1e-12\n",
"tol_grad = 1e-08\n",
"tol_param = 1e-08\n",
"tol_rel_obj = 10000\n",
"tol_rel_grad = 1e+07\n",
"history_size = 5\n",
"seed = 1274276645\n",
"initial log joint probability = -19.4685\n",
"Optimization terminated normally: \n",
" Convergence detected: relative gradient magnitude is below tolerance\n",
"\r",
"|======================================================|100% ~0 s remaining "
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"%%R\n",
"m <- prophet(df, holidays = holidays)\n",
"forecast <- predict(m, future)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The holiday effect can be seen in the `forecast` dataframe:"
]
},
{
"cell_type": "code",
"execution_count": 7,
"metadata": {
"collapsed": false,
"output_hidden": true
},
"outputs": [
{
"data": {
"text/plain": [
" ds playoff superbowl\n",
"17 2014-02-02 1.219014 1.230508\n",
"18 2014-02-03 1.908609 1.398806\n",
"19 2015-01-11 1.219014 0.000000\n",
"20 2015-01-12 1.908609 0.000000\n",
"21 2016-01-17 1.219014 0.000000\n",
"22 2016-01-18 1.908609 0.000000\n",
"23 2016-01-24 1.219014 0.000000\n",
"24 2016-01-25 1.908609 0.000000\n",
"25 2016-02-07 1.219014 1.230508\n",
"26 2016-02-08 1.908609 1.398806\n"
]
},
"metadata": {},
"output_type": "display_data"
}
],
"source": [
"%%R\n",
"forecast %>% \n",
" select(ds, playoff, superbowl) %>% \n",
" filter(abs(playoff + superbowl) > 0) %>%\n",
" tail(10)"
]
},
{
"cell_type": "code",
"execution_count": 8,
"metadata": {
"collapsed": false
},
"outputs": [
{
"data": {
"text/html": [
"\n",
"
\n",
" \n",
" \n",
" | \n",
" ds | \n",
" playoff | \n",
" superbowl | \n",
"
\n",
" \n",
" \n",
" \n",
" | 2190 | \n",
" 2014-02-02 | \n",
" 1.220308 | \n",
" 1.204992 | \n",
"
\n",
" \n",
" | 2191 | \n",
" 2014-02-03 | \n",
" 1.900465 | \n",
" 1.444581 | \n",
"
\n",
" \n",
" | 2532 | \n",
" 2015-01-11 | \n",
" 1.220308 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2533 | \n",
" 2015-01-12 | \n",
" 1.900465 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2901 | \n",
" 2016-01-17 | \n",
" 1.220308 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2902 | \n",
" 2016-01-18 | \n",
" 1.900465 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2908 | \n",
" 2016-01-24 | \n",
" 1.220308 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2909 | \n",
" 2016-01-25 | \n",
" 1.900465 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2922 | \n",
" 2016-02-07 | \n",
" 1.220308 | \n",
" 1.204992 | \n",
"
\n",
" \n",
" | 2923 | \n",
" 2016-02-08 | \n",
" 1.900465 | \n",
" 1.444581 | \n",
"
\n",
" \n",
"
\n",
"
\n",
"
\n",
" \n",
" \n",
" | \n",
" ds | \n",
" playoff | \n",
" superbowl | \n",
"
\n",
" \n",
" \n",
" \n",
" | 2190 | \n",
" 2014-02-02 | \n",
" 1.362312 | \n",
" 0.693425 | \n",
"
\n",
" \n",
" | 2191 | \n",
" 2014-02-03 | \n",
" 2.033471 | \n",
" 0.542254 | \n",
"
\n",
" \n",
" | 2532 | \n",
" 2015-01-11 | \n",
" 1.362312 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2533 | \n",
" 2015-01-12 | \n",
" 2.033471 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2901 | \n",
" 2016-01-17 | \n",
" 1.362312 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2902 | \n",
" 2016-01-18 | \n",
" 2.033471 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2908 | \n",
" 2016-01-24 | \n",
" 1.362312 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2909 | \n",
" 2016-01-25 | \n",
" 2.033471 | \n",
" 0.000000 | \n",
"
\n",
" \n",
" | 2922 | \n",
" 2016-02-07 | \n",
" 1.362312 | \n",
" 0.693425 | \n",
"
\n",
" \n",
" | 2923 | \n",
" 2016-02-08 | \n",
" 2.033471 | \n",
" 0.542254 | \n",
"
\n",
" \n",
"
\n",
"