{
"cells": [
{
"cell_type": "code",
"execution_count": 1,
"metadata": {
"block_hidden": true,
"collapsed": true
},
"outputs": [],
"source": [
"%load_ext rpy2.ipython\n",
"%matplotlib inline"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Python API\n",
"\n",
"Prophet follows the `sklearn` model API. We create an instance of the `Prophet` class and then call its `fit` and `predict` methods. "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The input to Prophet is always a dataframe with two columns: `ds` and `y`. The `ds` (datestamp) column must contain a date or datetime (either is fine). The `y` column must be numeric, and represents the measurement we wish to forecast.\n",
"\n",
"As an example, let's look at a time series of daily page views for the Wikipedia page for [Peyton Manning](https://en.wikipedia.org/wiki/Peyton_Manning). We scraped this data using the [Wikipediatrend](https://cran.r-project.org/web/packages/wikipediatrend/vignettes/using-wikipediatrend.html) package in R. Peyton Manning provides a nice example because it illustrates some of Prophet's features, like multiple seasonality, changing growth rates, and the ability to model special days (such as Manning's playoff and superbowl appearances).\n",
"\n",
"First we'll import the data and log-transform the y variable."
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {
"collapsed": true
},
"outputs": [],
"source": [
"import pandas as pd\n",
"import numpy as np\n",
"from fbprophet import Prophet"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {
"collapsed": false
},
"outputs": [
{
"data": {
"text/html": [
"\n",
"
\n",
" \n",
" \n",
" | \n",
" ds | \n",
" y | \n",
"
\n",
" \n",
" \n",
" \n",
" | 0 | \n",
" 2007-12-10 | \n",
" 9.590761 | \n",
"
\n",
" \n",
" | 1 | \n",
" 2007-12-11 | \n",
" 8.519590 | \n",
"
\n",
" \n",
" | 2 | \n",
" 2007-12-12 | \n",
" 8.183677 | \n",
"
\n",
" \n",
" | 3 | \n",
" 2007-12-13 | \n",
" 8.072467 | \n",
"
\n",
" \n",
" | 4 | \n",
" 2007-12-14 | \n",
" 7.893572 | \n",
"
\n",
" \n",
"
\n",
"
\n",
"
\n",
" \n",
" \n",
" | \n",
" ds | \n",
"
\n",
" \n",
" \n",
" \n",
" | 3265 | \n",
" 2017-01-15 | \n",
"
\n",
" \n",
" | 3266 | \n",
" 2017-01-16 | \n",
"
\n",
" \n",
" | 3267 | \n",
" 2017-01-17 | \n",
"
\n",
" \n",
" | 3268 | \n",
" 2017-01-18 | \n",
"
\n",
" \n",
" | 3269 | \n",
" 2017-01-19 | \n",
"
\n",
" \n",
"
\n",
"
\n",
"
\n",
" \n",
" \n",
" | \n",
" ds | \n",
" yhat | \n",
" yhat_lower | \n",
" yhat_upper | \n",
"
\n",
" \n",
" \n",
" \n",
" | 3265 | \n",
" 2017-01-15 | \n",
" 8.205065 | \n",
" 7.518780 | \n",
" 8.899184 | \n",
"
\n",
" \n",
" | 3266 | \n",
" 2017-01-16 | \n",
" 8.530088 | \n",
" 7.752344 | \n",
" 9.246332 | \n",
"
\n",
" \n",
" | 3267 | \n",
" 2017-01-17 | \n",
" 8.317468 | \n",
" 7.641099 | \n",
" 9.039998 | \n",
"
\n",
" \n",
" | 3268 | \n",
" 2017-01-18 | \n",
" 8.150081 | \n",
" 7.333512 | \n",
" 8.888837 | \n",
"
\n",
" \n",
" | 3269 | \n",
" 2017-01-19 | \n",
" 8.162015 | \n",
" 7.415570 | \n",
" 8.850360 | \n",
"
\n",
" \n",
"
\n",
"