Browse Source

Documentation update for not failing with constant extra regressor

Ben Letham 7 years ago
parent
commit
580d4e4ea9

+ 1 - 1
docs/_docs/diagnostics.md

@@ -221,4 +221,4 @@ fig = plot_cross_validation_metric(df_cv, metric='mape')
 
 
 The size of the rolling window in the figure can be changed with the optional argument `rolling_window`, which specifies the proportion of forecasts to use in each rolling window. The default is 0.1, corresponding to 10% of rows from `df_cv` included in each window; increasing this will lead to a smoother average curve in the figure.
 The size of the rolling window in the figure can be changed with the optional argument `rolling_window`, which specifies the proportion of forecasts to use in each rolling window. The default is 0.1, corresponding to 10% of rows from `df_cv` included in each window; increasing this will lead to a smoother average curve in the figure.
 
 
-When using cross validation on a model with extra regressors, the cross validation will exit with an error if the extra regressor is constant in the simulated history. The `initial` period should be long enough for the extra regressor to take on multiple values. Similarly, the initial period should be long enough to capture any seasonalities that are included in the model: at least a year for yearly seasonality, at least a week for weekly seasonality, etc.
+The `initial` period should be long enough to capture all of the components of the model, in particular seasonalities and extra regressors: at least a year for yearly seasonality, at least a week for weekly seasonality, etc.

File diff suppressed because it is too large
+ 1 - 1
docs/_docs/seasonality,_holiday_effects,_and_regressors.md


+ 2 - 2
notebooks/diagnostics.ipynb

@@ -476,7 +476,7 @@
    "source": [
    "source": [
     "The size of the rolling window in the figure can be changed with the optional argument `rolling_window`, which specifies the proportion of forecasts to use in each rolling window. The default is 0.1, corresponding to 10% of rows from `df_cv` included in each window; increasing this will lead to a smoother average curve in the figure.\n",
     "The size of the rolling window in the figure can be changed with the optional argument `rolling_window`, which specifies the proportion of forecasts to use in each rolling window. The default is 0.1, corresponding to 10% of rows from `df_cv` included in each window; increasing this will lead to a smoother average curve in the figure.\n",
     "\n",
     "\n",
-    "When using cross validation on a model with extra regressors, the cross validation will exit with an error if the extra regressor is constant in the simulated history. The `initial` period should be long enough for the extra regressor to take on multiple values. Similarly, the initial period should be long enough to capture any seasonalities that are included in the model: at least a year for yearly seasonality, at least a week for weekly seasonality, etc."
+    "The `initial` period should be long enough to capture all of the components of the model, in particular seasonalities and extra regressors: at least a year for yearly seasonality, at least a week for weekly seasonality, etc."
    ]
    ]
   }
   }
  ],
  ],
@@ -496,7 +496,7 @@
    "name": "python",
    "name": "python",
    "nbconvert_exporter": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython2",
    "pygments_lexer": "ipython2",
-   "version": "2.7.14+"
+   "version": "2.7.13"
   }
   }
  },
  },
  "nbformat": 4,
  "nbformat": 4,

File diff suppressed because it is too large
+ 1 - 1
notebooks/seasonality,_holiday_effects,_and_regressors.ipynb