mirror of
https://github.com/saymrwulf/prophet.git
synced 2026-11-17 08:40:56 +00:00
Adding changepoint threshold (#299)
This commit is contained in:
parent
6d2e93c8bc
commit
ba1bac834e
2 changed files with 26 additions and 6 deletions
|
|
@ -28,7 +28,9 @@ utils::globalVariables(c(
|
||||||
#' @param n.changepoints Number of potential changepoints to include. Not used
|
#' @param n.changepoints Number of potential changepoints to include. Not used
|
||||||
#' if input `changepoints` is supplied. If `changepoints` is not supplied,
|
#' if input `changepoints` is supplied. If `changepoints` is not supplied,
|
||||||
#' then n.changepoints potential changepoints are selected uniformly from the
|
#' then n.changepoints potential changepoints are selected uniformly from the
|
||||||
#' first 80 percent of df$ds.
|
#' first `changepoint.threshold` percent of df$ds.
|
||||||
|
#' @param changepoint.threshold Parameter controling where to select the changepoints.
|
||||||
|
#' Not used if input `changepoints` is supplied.
|
||||||
#' @param yearly.seasonality Fit yearly seasonality. Can be 'auto', TRUE,
|
#' @param yearly.seasonality Fit yearly seasonality. Can be 'auto', TRUE,
|
||||||
#' FALSE, or a number of Fourier terms to generate.
|
#' FALSE, or a number of Fourier terms to generate.
|
||||||
#' @param weekly.seasonality Fit weekly seasonality. Can be 'auto', TRUE,
|
#' @param weekly.seasonality Fit weekly seasonality. Can be 'auto', TRUE,
|
||||||
|
|
@ -79,6 +81,7 @@ prophet <- function(df = NULL,
|
||||||
growth = 'linear',
|
growth = 'linear',
|
||||||
changepoints = NULL,
|
changepoints = NULL,
|
||||||
n.changepoints = 25,
|
n.changepoints = 25,
|
||||||
|
changepoint.threshold = 0.8,
|
||||||
yearly.seasonality = 'auto',
|
yearly.seasonality = 'auto',
|
||||||
weekly.seasonality = 'auto',
|
weekly.seasonality = 'auto',
|
||||||
daily.seasonality = 'auto',
|
daily.seasonality = 'auto',
|
||||||
|
|
@ -103,6 +106,7 @@ prophet <- function(df = NULL,
|
||||||
growth = growth,
|
growth = growth,
|
||||||
changepoints = changepoints,
|
changepoints = changepoints,
|
||||||
n.changepoints = n.changepoints,
|
n.changepoints = n.changepoints,
|
||||||
|
changepoint.threshold = changepoint.threshold,
|
||||||
yearly.seasonality = yearly.seasonality,
|
yearly.seasonality = yearly.seasonality,
|
||||||
weekly.seasonality = weekly.seasonality,
|
weekly.seasonality = weekly.seasonality,
|
||||||
daily.seasonality = daily.seasonality,
|
daily.seasonality = daily.seasonality,
|
||||||
|
|
@ -451,9 +455,14 @@ set_changepoints <- function(m) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
# Place potential changepoints evenly through the first 80 pcnt of
|
# Place potential changepoints evenly through the first changepoint.threshold pcnt of
|
||||||
# the history.
|
# the history.
|
||||||
hist.size <- floor(nrow(m$history) * .8)
|
if (m$changepoint.threshold > 1 || m$changepoint.threshold <= 0){
|
||||||
|
m$changepoint.threshold <- .8
|
||||||
|
message('changepoint.threshold greater than 1 or less than equal to 0. Using ',
|
||||||
|
m$changepoint.threshold)
|
||||||
|
}
|
||||||
|
hist.size <- floor(nrow(m$history) * m$changepoint.threshold)
|
||||||
if (m$n.changepoints + 1 > hist.size) {
|
if (m$n.changepoints + 1 > hist.size) {
|
||||||
m$n.changepoints <- hist.size - 1
|
m$n.changepoints <- hist.size - 1
|
||||||
message('n.changepoints greater than number of observations. Using ',
|
message('n.changepoints greater than number of observations. Using ',
|
||||||
|
|
|
||||||
|
|
@ -57,7 +57,9 @@ class Prophet(object):
|
||||||
n_changepoints: Number of potential changepoints to include. Not used
|
n_changepoints: Number of potential changepoints to include. Not used
|
||||||
if input `changepoints` is supplied. If `changepoints` is not supplied,
|
if input `changepoints` is supplied. If `changepoints` is not supplied,
|
||||||
then n_changepoints potential changepoints are selected uniformly from
|
then n_changepoints potential changepoints are selected uniformly from
|
||||||
the first 80 percent of the history.
|
the first `changepoint_threshold` percent of the history.
|
||||||
|
changepoint_threshold: Parameter controling where to select the changepoints.
|
||||||
|
Not used if input `changepoints` is supplied.
|
||||||
yearly_seasonality: Fit yearly seasonality.
|
yearly_seasonality: Fit yearly seasonality.
|
||||||
Can be 'auto', True, False, or a number of Fourier terms to generate.
|
Can be 'auto', True, False, or a number of Fourier terms to generate.
|
||||||
weekly_seasonality: Fit weekly seasonality.
|
weekly_seasonality: Fit weekly seasonality.
|
||||||
|
|
@ -97,6 +99,7 @@ class Prophet(object):
|
||||||
growth='linear',
|
growth='linear',
|
||||||
changepoints=None,
|
changepoints=None,
|
||||||
n_changepoints=25,
|
n_changepoints=25,
|
||||||
|
changepoint_threshold=0.8,
|
||||||
yearly_seasonality='auto',
|
yearly_seasonality='auto',
|
||||||
weekly_seasonality='auto',
|
weekly_seasonality='auto',
|
||||||
daily_seasonality='auto',
|
daily_seasonality='auto',
|
||||||
|
|
@ -119,6 +122,7 @@ class Prophet(object):
|
||||||
self.n_changepoints = n_changepoints
|
self.n_changepoints = n_changepoints
|
||||||
self.specified_changepoints = False
|
self.specified_changepoints = False
|
||||||
|
|
||||||
|
self.changepoint_threshold = changepoint_threshold
|
||||||
self.yearly_seasonality = yearly_seasonality
|
self.yearly_seasonality = yearly_seasonality
|
||||||
self.weekly_seasonality = weekly_seasonality
|
self.weekly_seasonality = weekly_seasonality
|
||||||
self.daily_seasonality = daily_seasonality
|
self.daily_seasonality = daily_seasonality
|
||||||
|
|
@ -332,8 +336,15 @@ class Prophet(object):
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
'Changepoints must fall within training data.')
|
'Changepoints must fall within training data.')
|
||||||
else:
|
else:
|
||||||
# Place potential changepoints evenly through first 80% of history
|
# Place potential changepoints evenly through first changepoint_threshold
|
||||||
hist_size = np.floor(self.history.shape[0] * 0.8)
|
# of history
|
||||||
|
if (self.changepoint_threshold > 1 or self.changepoint_threshold <= 0):
|
||||||
|
self.changepoint_threshold = 0.8
|
||||||
|
logger.info(
|
||||||
|
'changepoint_threshold greater than 1 or less than equal to 0.'
|
||||||
|
'Using {}.'.format(self.changepoint_threshold)
|
||||||
|
)
|
||||||
|
hist_size = np.floor(self.history.shape[0] * self.changepoint_threshold)
|
||||||
if self.n_changepoints + 1 > hist_size:
|
if self.n_changepoints + 1 > hist_size:
|
||||||
self.n_changepoints = hist_size - 1
|
self.n_changepoints = hist_size - 1
|
||||||
logger.info(
|
logger.info(
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue