bigframes.ml.forecasting.ARIMAPlus.predict_explain#

ARIMAPlus.predict_explain(X=None, *, horizon: int = 3, confidence_level: float = 0.95) DataFrame[source]#

Explain Forecast time series at future horizon.

Note

Output matches that of the BigQuery ML.EXPLAIN_FORECAST function. See: https://cloud.google.com/bigquery/docs/reference/standard-sql/bigqueryml-syntax-explain-forecast

Parameters:
  • X (default None) – ignored, to be compatible with other APIs.

  • (int (horizon) – 3): an int value that specifies the number of time points to forecast. The default value is 3, and the maximum value is 1000.

  • default – 3): an int value that specifies the number of time points to forecast. The default value is 3, and the maximum value is 1000.

  • confidence_level (float, default 0.95) – A float value that specifies percentage of the future values that fall in the prediction interval. The valid input range is [0.0, 1.0).

Returns:

The predicted DataFrames.

Return type:

bigframes.dataframe.DataFrame