mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-11-18 08:53:42 +00:00
Add custom cutoff option to R (#1484)
* Add test for custom cutoff cv * implement custom cutoff logic in cv function * add docstring * add description in notebook and rebuild .Rd docs * fix bug and add test case for period is NULL * replace s.POSIXct set_date
This commit is contained in:
parent
3578e93062
commit
16e632a695
4 changed files with 95 additions and 32 deletions
|
|
@ -53,9 +53,9 @@ generate_cutoffs <- function(df, horizon, initial, period) {
|
||||||
|
|
||||||
#' Cross-validation for time series.
|
#' Cross-validation for time series.
|
||||||
#'
|
#'
|
||||||
#' Computes forecasts from historical cutoff points. Beginning from
|
#' Computes forecasts from historical cutoff points which user can input.If
|
||||||
#' (end - horizon), works backwards making cutoffs with a spacing of period
|
#' not provided, these are computed beginning from (end - horizon), and working
|
||||||
#' until initial is reached.
|
#' backwards making cutoffs with a spacing of period until initial is reached.
|
||||||
#'
|
#'
|
||||||
#' When period is equal to the time interval of the data, this is the
|
#' When period is equal to the time interval of the data, this is the
|
||||||
#' technique described in https://robjhyndman.com/hyndsight/tscv/ .
|
#' technique described in https://robjhyndman.com/hyndsight/tscv/ .
|
||||||
|
|
@ -67,50 +67,64 @@ generate_cutoffs <- function(df, horizon, initial, period) {
|
||||||
#' horizon. If not provided, 0.5 * horizon is used.
|
#' horizon. If not provided, 0.5 * horizon is used.
|
||||||
#' @param initial Integer size of the first training period. If not provided,
|
#' @param initial Integer size of the first training period. If not provided,
|
||||||
#' 3 * horizon is used. Same units as horizon.
|
#' 3 * horizon is used. Same units as horizon.
|
||||||
|
#' @param cutoffs Vector of cutoff dates to be used during
|
||||||
|
#' cross-validtation. If not provided works beginning from (end - horizon),
|
||||||
|
#' works backwards making cutoffs with a spacing of period until initial is
|
||||||
|
#' reached.
|
||||||
#'
|
#'
|
||||||
#' @return A dataframe with the forecast, actual value, and cutoff date.
|
#' @return A dataframe with the forecast, actual value, and cutoff date.
|
||||||
#'
|
#'
|
||||||
#' @export
|
#' @export
|
||||||
cross_validation <- function(
|
cross_validation <- function(
|
||||||
model, horizon, units, period = NULL, initial = NULL) {
|
model, horizon, units, period = NULL, initial = NULL, cutoffs=NULL) {
|
||||||
df <- model$history
|
df <- model$history
|
||||||
horizon.dt <- as.difftime(horizon, units = units)
|
horizon.dt <- as.difftime(horizon, units = units)
|
||||||
# Set period
|
|
||||||
if (is.null(period)) {
|
predict_columns <- c('ds', 'yhat')
|
||||||
period <- 0.5 * horizon
|
if (model$uncertainty.samples){
|
||||||
|
predict_columns <- append(predict_columns, c('yhat_lower', 'yhat_upper'))
|
||||||
}
|
}
|
||||||
period.dt <- as.difftime(period, units = units)
|
|
||||||
# Identify largest seasonality period
|
# Identify largest seasonality period
|
||||||
period.max <- 0
|
period.max <- 0
|
||||||
for (s in model$seasonalities) {
|
for (s in model$seasonalities) {
|
||||||
period.max <- max(period.max, s$period)
|
period.max <- max(period.max, s$period)
|
||||||
}
|
}
|
||||||
seasonality.dt <- as.difftime(period.max, units = 'days')
|
seasonality.dt <- as.difftime(period.max, units = 'days')
|
||||||
# Set initial
|
|
||||||
if (is.null(initial)) {
|
if (is.null(cutoffs)){
|
||||||
initial.dt <- max(
|
|
||||||
as.difftime(3 * horizon, units = units),
|
# Set period
|
||||||
seasonality.dt
|
if (is.null(period)) {
|
||||||
)
|
period <- 0.5 * horizon
|
||||||
} else {
|
|
||||||
initial.dt <- as.difftime(initial, units = units)
|
|
||||||
if (initial.dt < seasonality.dt) {
|
|
||||||
warning(paste0('Seasonality has period of ', period.max, ' days which ',
|
|
||||||
'is larger than initial window. Consider increasing initial.'))
|
|
||||||
}
|
}
|
||||||
|
period.dt <- as.difftime(period, units = units)
|
||||||
|
# Set initial
|
||||||
|
if (is.null(initial)) {
|
||||||
|
initial.dt <- max(
|
||||||
|
as.difftime(3 * horizon, units = units),
|
||||||
|
seasonality.dt
|
||||||
|
)
|
||||||
|
}else {
|
||||||
|
initial.dt <- as.difftime(initial, units = units)
|
||||||
|
}
|
||||||
|
cutoffs <- generate_cutoffs(df, horizon.dt, initial.dt, period.dt)
|
||||||
|
}else{
|
||||||
|
cutoffs <- set_date(ds=cutoffs)
|
||||||
|
initial.dt <- cutoffs[1] - min(df$ds)
|
||||||
}
|
}
|
||||||
|
|
||||||
predict_columns <- c('ds', 'yhat')
|
# Check if the initial window (that is, the amount of time between the
|
||||||
if (model$uncertainty.samples){
|
# start of the history and the first cutoff) is less than the
|
||||||
predict_columns <- append(predict_columns, c('yhat_lower', 'yhat_upper'))
|
# maximum seasonality period
|
||||||
|
if (initial.dt < seasonality.dt) {
|
||||||
|
warning(paste0('Seasonality has period of ', period.max, ' days which ',
|
||||||
|
'is larger than initial window. Consider increasing initial.'))
|
||||||
}
|
}
|
||||||
|
|
||||||
cutoffs <- generate_cutoffs(df, horizon.dt, initial.dt, period.dt)
|
|
||||||
|
|
||||||
predicts <- data.frame()
|
predicts <- data.frame()
|
||||||
for (i in 1:length(cutoffs)) {
|
for (i in 1:length(cutoffs)) {
|
||||||
cutoff <- cutoffs[i]
|
|
||||||
# Copy the model
|
# Copy the model
|
||||||
|
cutoff <- cutoffs[i]
|
||||||
m <- prophet_copy(model, cutoff)
|
m <- prophet_copy(model, cutoff)
|
||||||
# Train model
|
# Train model
|
||||||
history.c <- dplyr::filter(df, ds <= cutoff)
|
history.c <- dplyr::filter(df, ds <= cutoff)
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,14 @@
|
||||||
\alias{cross_validation}
|
\alias{cross_validation}
|
||||||
\title{Cross-validation for time series.}
|
\title{Cross-validation for time series.}
|
||||||
\usage{
|
\usage{
|
||||||
cross_validation(model, horizon, units, period = NULL, initial = NULL)
|
cross_validation(
|
||||||
|
model,
|
||||||
|
horizon,
|
||||||
|
units,
|
||||||
|
period = NULL,
|
||||||
|
initial = NULL,
|
||||||
|
cutoffs = NULL
|
||||||
|
)
|
||||||
}
|
}
|
||||||
\arguments{
|
\arguments{
|
||||||
\item{model}{Fitted Prophet model.}
|
\item{model}{Fitted Prophet model.}
|
||||||
|
|
@ -18,14 +25,19 @@ horizon. If not provided, 0.5 * horizon is used.}
|
||||||
|
|
||||||
\item{initial}{Integer size of the first training period. If not provided,
|
\item{initial}{Integer size of the first training period. If not provided,
|
||||||
3 * horizon is used. Same units as horizon.}
|
3 * horizon is used. Same units as horizon.}
|
||||||
|
|
||||||
|
\item{cutoffs}{Vector of cutoff dates to be used during
|
||||||
|
cross-validtation. If not provided works beginning from (end - horizon),
|
||||||
|
works backwards making cutoffs with a spacing of period until initial is
|
||||||
|
reached.}
|
||||||
}
|
}
|
||||||
\value{
|
\value{
|
||||||
A dataframe with the forecast, actual value, and cutoff date.
|
A dataframe with the forecast, actual value, and cutoff date.
|
||||||
}
|
}
|
||||||
\description{
|
\description{
|
||||||
Computes forecasts from historical cutoff points. Beginning from
|
Computes forecasts from historical cutoff points which user can input.If
|
||||||
(end - horizon), works backwards making cutoffs with a spacing of period
|
not provided, these are computed beginning from (end - horizon), and working
|
||||||
until initial is reached.
|
backwards making cutoffs with a spacing of period until initial is reached.
|
||||||
}
|
}
|
||||||
\details{
|
\details{
|
||||||
When period is equal to the time interval of the data, this is the
|
When period is equal to the time interval of the data, this is the
|
||||||
|
|
|
||||||
|
|
@ -90,6 +90,21 @@ test_that("cross_validation_default_value_check", {
|
||||||
expect_equal(sum(dplyr::select(df.cv1 - df.cv2, y, yhat)), 0)
|
expect_equal(sum(dplyr::select(df.cv1 - df.cv2, y, yhat)), 0)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
test_that("cross_validation_custom_cutoffs", {
|
||||||
|
skip_if_not(Sys.getenv('R_ARCH') != '/i386')
|
||||||
|
m <- prophet(DATA)
|
||||||
|
# When specify a list of cutoffs the cutoff dates in df.cv1
|
||||||
|
# are those specified
|
||||||
|
cutoffs=c(as.Date('2012-07-31'), as.Date('2012-08-31'))
|
||||||
|
df.cv <-cross_validation(
|
||||||
|
m, horizon = 32, units = "days", period = 10, cutoffs=cutoffs)
|
||||||
|
expect_equal(length(unique(df.cv$cutoff)), 2)
|
||||||
|
# test this works ok when periods is NULL
|
||||||
|
df.cv <-cross_validation(
|
||||||
|
m, horizon = 32, units = "days", cutoffs=cutoffs)
|
||||||
|
expect_equal(length(unique(df.cv$cutoff)), 2)
|
||||||
|
})
|
||||||
|
|
||||||
test_that("cross_validation_uncertainty_disabled", {
|
test_that("cross_validation_uncertainty_disabled", {
|
||||||
skip_if_not(Sys.getenv('R_ARCH') != '/i386')
|
skip_if_not(Sys.getenv('R_ARCH') != '/i386')
|
||||||
for (uncertainty in c(0, FALSE)) {
|
for (uncertainty in c(0, FALSE)) {
|
||||||
|
|
|
||||||
|
|
@ -274,6 +274,28 @@
|
||||||
"source": [
|
"source": [
|
||||||
"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.\n",
|
"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.\n",
|
||||||
"\n",
|
"\n",
|
||||||
|
"Custom cutoffs can also be supplied as a list of dates to to the `cutoffs` keyword in the `cross_validation` function in Python and R. For example, three cutoffs six months apart, would need to be passed to the `cutoffs` argument in a date format like below:\n",
|
||||||
|
"```python\n",
|
||||||
|
"#Python\n",
|
||||||
|
"cutoffs = [pd.Timestamp('2013-02-15'), pd.Timestamp('2013-08-15'), pd.Timestamp('2014-02-15')]\n",
|
||||||
|
"```\n",
|
||||||
|
"```r\n",
|
||||||
|
"#R\n",
|
||||||
|
"cutoffs = c(as.Date('2013-02-15'), as.Date('2013-08-15'), as.Date('2014-02-15')\n",
|
||||||
|
"```"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"cell_type": "markdown",
|
||||||
|
"metadata": {},
|
||||||
|
"source": [
|
||||||
|
"### Cross-Validation in Parallel "
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"cell_type": "markdown",
|
||||||
|
"metadata": {},
|
||||||
|
"source": [
|
||||||
"Cross-validation can also be run in parallel mode in Python, by setting specifying the `parallel` keyword. Three modes are supported\n",
|
"Cross-validation can also be run in parallel mode in Python, by setting specifying the `parallel` keyword. Three modes are supported\n",
|
||||||
"\n",
|
"\n",
|
||||||
"* `parallel=\"processes\"`\n",
|
"* `parallel=\"processes\"`\n",
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue