Add utility for plotting changepoints (Py), and put in plotting file (R and Py)

This commit is contained in:
Ben Letham 2018-05-03 11:10:11 -07:00
parent 7c95c62cf0
commit 3da46503ed
11 changed files with 206 additions and 161 deletions

View file

@ -1,20 +1,20 @@
# Generated by roxygen2: do not edit by hand # Generated by roxygen2: do not edit by hand
S3method(plot,prophet)
S3method(predict,prophet) S3method(predict,prophet)
export(add_changepoints_to_plot)
export(add_regressor) export(add_regressor)
export(add_seasonality) export(add_seasonality)
export(all_metrics) export(all_metrics)
export(cross_validation) export(cross_validation)
export(dyplot.prophet) export(dyplot.prophet)
export(fit.prophet) export(fit.prophet)
export(layer_changepoints)
export(mae) export(mae)
export(make_future_dataframe) export(make_future_dataframe)
export(mape) export(mape)
export(me) export(me)
export(mpe) export(mpe)
export(mse) export(mse)
export(plot.prophet)
export(plot_forecast_component) export(plot_forecast_component)
export(predictive_samples) export(predictive_samples)
export(prophet) export(prophet)

View file

@ -302,6 +302,40 @@ plot_seasonality <- function(m, name, uncertainty = TRUE) {
return(gg.s) return(gg.s)
} }
#' Get layers to overlay significant changepoints on prophet forecast plot.
#'
#' @param m Prophet model object.
#' @param threshold Numeric, changepoints where abs(delta) >= threshold are
#' significant. (Default 0.01)
#' @param cp_color Character, line color. (Default "red")
#' @param cp_linetype Character or integer, line type. (Default "dashed")
#' @param trend Logical, if FALSE, do not draw trend line. (Default TRUE)
#' @param ... Other arguments passed on to layers.
#'
#' @return A list of ggplot2 layers.
#'
#' @examples
#' \dontrun{
#' plot(m, fcst) + add_changepoints_to_plot(m)
#' }
#'
#' @export
add_changepoints_to_plot <- function(m, threshold = 0.01, cp_color = "red",
cp_linetype = "dashed", trend = TRUE, ...) {
layers <- list()
if (trend) {
trend_layer <- ggplot2::geom_line(
ggplot2::aes_string("ds", "trend"), color = cp_color, ...)
layers <- append(layers, trend_layer)
}
signif_changepoints <- m$changepoints[abs(m$params$delta) >= threshold]
cp_layer <- ggplot2::geom_vline(
xintercept = as.integer(signif_changepoints), color = cp_color,
linetype = cp_linetype, ...)
layers <- append(layers, cp_layer)
return(layers)
}
#' Plot the prophet forecast. #' Plot the prophet forecast.
#' #'
#' @param x Prophet object. #' @param x Prophet object.

View file

@ -1,33 +0,0 @@
#' Get layers to overlay significant changepoints on prophet forecast plot.
#'
#' @param m Prophet model object.
#' @param threshold Numeric, changepoints where abs(delta) >= threshold are
#' significant. (Default 0.01)
#' @param cp_color Character, line color. (Default "red")
#' @param cp_linetype Character or integer, line type. (Default "dashed")
#' @param trend Logical, if FALSE, do not draw trend line. (Default TRUE)
#' @param ... Other arguments passed on to layers.
#'
#' @return A list of ggplot2 layers.
#'
#' @examples
#' \dontrun{
#' plot(m, fcst) + layer_changepoints(m)
#' }
#'
#' @export
layer_changepoints <- function(m, threshold = 0.01, cp_color = "red",
cp_linetype = "dashed", trend = TRUE, ...) {
layers <- list()
if (trend) {
trend_layer <- ggplot2::geom_line(
ggplot2::aes_string("ds", "trend"), color = cp_color, ...)
layers <- append(layers, trend_layer)
}
signif_changepoints <- m$changepoints[abs(m$params$delta) >= threshold]
cp_layer <- ggplot2::geom_vline(
xintercept = as.integer(signif_changepoints), color = cp_color,
linetype = cp_linetype, ...)
layers <- append(layers, cp_layer)
return(layers)
}

View file

@ -1,10 +1,10 @@
% Generated by roxygen2: do not edit by hand % Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils.R % Please edit documentation in R/plot.R
\name{layer_changepoints} \name{add_changepoints_to_plot}
\alias{layer_changepoints} \alias{add_changepoints_to_plot}
\title{Get layers to overlay significant changepoints on prophet forecast plot.} \title{Get layers to overlay significant changepoints on prophet forecast plot.}
\usage{ \usage{
layer_changepoints(m, threshold = 0.01, cp_color = "red", add_changepoints_to_plot(m, threshold = 0.01, cp_color = "red",
cp_linetype = "dashed", trend = TRUE, ...) cp_linetype = "dashed", trend = TRUE, ...)
} }
\arguments{ \arguments{
@ -29,7 +29,7 @@ Get layers to overlay significant changepoints on prophet forecast plot.
} }
\examples{ \examples{
\dontrun{ \dontrun{
plot(m, fcst) + layer_changepoints(m) plot(m, fcst) + add_changepoints_to_plot(m)
} }
} }

View file

@ -4,7 +4,7 @@
\alias{compile_stan_model} \alias{compile_stan_model}
\title{Compile Stan model} \title{Compile Stan model}
\usage{ \usage{
compile_stan_model(model) compile_stan_model()
} }
\arguments{ \arguments{
\item{model}{String 'linear' or 'logistic' to specify a linear or logistic \item{model}{String 'linear' or 'logistic' to specify a linear or logistic

View file

@ -4,10 +4,12 @@
\alias{create_metric_data} \alias{create_metric_data}
\title{Prepare dataframe for metrics calculation.} \title{Prepare dataframe for metrics calculation.}
\usage{ \usage{
create_metric_data(fcst) create_metric_data(m = NULL, df = NULL)
} }
\arguments{ \arguments{
\item{fcst}{Dataframe output of `predict`.} \item{m}{Prophet object. Default NULL}
\item{df}{A dataframe which is output of `simulated_historical_forecasts` or `cross_validation` Default NULL}
} }
\value{ \value{
A dataframe only with y and yhat as a column. A dataframe only with y and yhat as a column.

View file

@ -1,18 +0,0 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/prophet.R
\name{get_changepoint_matrix}
\alias{get_changepoint_matrix}
\title{Gets changepoint matrix for history dataframe.}
\usage{
get_changepoint_matrix(m)
}
\arguments{
\item{m}{Prophet object.}
}
\value{
array of indexes.
}
\description{
Gets changepoint matrix for history dataframe.
}
\keyword{internal}

View file

@ -4,7 +4,7 @@
\alias{get_prophet_stan_model} \alias{get_prophet_stan_model}
\title{Load compiled Stan model} \title{Load compiled Stan model}
\usage{ \usage{
get_prophet_stan_model(model) get_prophet_stan_model()
} }
\arguments{ \arguments{
\item{model}{String 'linear' or 'logistic' to specify a linear or logistic \item{model}{String 'linear' or 'logistic' to specify a linear or logistic

View file

@ -0,0 +1,18 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/metrics.R
\name{make_metrics_function}
\alias{make_metrics_function}
\title{Meta function to make the function which evaluate metrics.}
\usage{
make_metrics_function(metrics)
}
\arguments{
\item{metrics}{metrics function}
}
\value{
A function using for metrics evaluation.
}
\description{
Meta function to make the function which evaluate metrics.
}
\keyword{internal}

View file

@ -11,22 +11,24 @@
\alias{all_metrics} \alias{all_metrics}
\title{Metrics for Time Series Forecasts} \title{Metrics for Time Series Forecasts}
\usage{ \usage{
me(fcst) me(m = NULL, df = NULL)
mse(fcst) mse(m = NULL, df = NULL)
rmse(fcst) rmse(m = NULL, df = NULL)
mae(fcst) mae(m = NULL, df = NULL)
mpe(fcst) mpe(m = NULL, df = NULL)
mape(fcst) mape(m = NULL, df = NULL)
all_metrics(fcst) all_metrics(m = NULL, df = NULL)
} }
\arguments{ \arguments{
\item{fcst}{Dataframe output of `predict`.} \item{m}{Prophet object. Default NULL}
\item{df}{A dataframe which is output of `simulated_historical_forecasts` or `cross_validation` Default NULL}
} }
\value{ \value{
metrics value (numeric) metrics value (numeric)
@ -75,8 +77,14 @@ and is defined by the formula:
\dontrun{ \dontrun{
# Create example model # Create example model
library(readr) library(readr)
library(prophet)
df <- read_csv('../tests/testthat/data.csv') df <- read_csv('../tests/testthat/data.csv')
m <- prophet(df) m <- prophet(df)
future <- make_future_dataframe(m, periods = 365)
forecast <- predict(m, future)
all_metrics(forecast)
df.cv <- cross_validation(m, horizon = 100, units = 'days')
all_metrics(df.cv)
# You can check your models's accuracy using me, mse, rmse ...etc. # You can check your models's accuracy using me, mse, rmse ...etc.
print(rmse(m)) print(rmse(m))
} }

View file

@ -333,3 +333,37 @@ def plot_seasonality(m, name, ax=None, uncertainty=True):
ax.set_xlabel('ds') ax.set_xlabel('ds')
ax.set_ylabel(name) ax.set_ylabel(name)
return artists return artists
def add_changepoints_to_plot(
ax, m, fcst, threshold=0.01, cp_color='r', cp_linestyle='--', trend=True,
):
"""Add markers for significant changepoints to prophet forecast plot.
Example:
fig = m.plot(forecast)
add_changepoints_to_plot(fig.gca(), m, forecast)
Parameters
----------
ax: axis on which to overlay changepoint markers.
m: Prophet model.
fcst: Forecast output from m.predict.
threshold: Threshold on trend change magnitude for significance.
cp_color: Color of changepoint markers.
cp_linestyle: Linestyle for changepoint markers.
trend: If True, will also overlay the trend.
Returns
-------
a list of matplotlib artists
"""
artists = []
if trend:
artists.append(ax.plot(fcst['ds'], fcst['trend'], c=cp_color))
signif_changepoints = m.changepoints[
np.abs(np.nanmean(m.params['delta'], axis=0)) >= threshold
]
for cp in signif_changepoints:
artists.append(ax.axvline(x=cp, c=cp_color, ls=cp_linestyle))
return artists