ForecastingPipelineWrapper 类

用于预测的管道。

继承
ForecastingPipelineWrapper
ForecastingPipelineWrapper

构造函数

ForecastingPipelineWrapper(pipeline: sklearn.pipeline.Pipeline, stddev: List[float])

参数

pipeline
stddev

方法

apply_time_series_transform

将所有时序转换应用到数据帧 X。

fit

针对不同的数据训练模型。

forecast

对数据帧 X_pred 执行预测。

forecast_quantiles

从拟合的管道获取预测和分位数。

is_grain_dropped

如果要删除粒度,则返回 True。

predict

对数据应用转换,然后使用最终估算器进行预测

short_grain_handling

如果为模型启用了短粒度或缺失粒度处理,则返回 true。

apply_time_series_transform

将所有时序转换应用到数据帧 X。

apply_time_series_transform(X: pandas.core.frame.DataFrame, y: Optional[numpy.ndarray] = None) -> pandas.core.frame.DataFrame

参数

X
DataFrame
必需

要转换的数据帧。

y
默认值: None

返回

转换后的数据帧,具有日期、粒度和源列作为索引。

返回类型

fit

针对不同的数据训练模型。

fit(X: pandas.core.frame.DataFrame, y: numpy.ndarray) -> azureml.automl.runtime.shared.model_wrappers.ForecastingPipelineWrapper

参数

X
必需

预测数据帧。

y
必需

目标值的数组。

返回

在 X 和 Y 上训练的 ForecastingPipelineWrapper 的实例。

forecast

对数据帧 X_pred 执行预测。

forecast(X_pred: Optional[pandas.core.frame.DataFrame] = None, y_pred: Optional[Union[pandas.core.frame.DataFrame, numpy.ndarray]] = None, forecast_destination: Optional[pandas._libs.tslibs.timestamps.Timestamp] = None, ignore_data_errors: bool = False) -> Tuple[numpy.ndarray, pandas.core.frame.DataFrame]

参数

X_pred
默认值: None

以时间连续的方式组合 X_past 和 X_future 的预测数据帧。 将估算 X_pred 中的空值。

y_pred
默认值: None

将 y_past 的明确值与 Y_future 的缺失值进行组合的目标值。 如果为“无”,则针对每个 X_pred 进行预测。

forecast_destination
<xref:pandas.Timestamp>
默认值: None

Forecast_destination:时间戳值。 对于所有粒度,将一直进行预测,直到 forecast_destination 时间。 不接受字典输入 { grain -> timestamp }。 如果未提供 forecast_destination,则估算为每个粒度在 X_pred 中最后出现的时间。

ignore_data_errors
bool
默认值: False

忽略用户数据中的错误。

返回

Y_pred,具有对应于填充了各自预测的 Y_future 的子帧。 Y_past 中任何缺失的值都将由估算器填充。

返回类型

forecast_quantiles

从拟合的管道获取预测和分位数。

forecast_quantiles(X_pred: Optional[pandas.core.frame.DataFrame] = None, y_pred: Optional[Union[pandas.core.frame.DataFrame, numpy.ndarray]] = None, forecast_destination: Optional[pandas._libs.tslibs.timestamps.Timestamp] = None, ignore_data_errors: bool = False) -> pandas.core.frame.DataFrame

参数

X_pred
默认值: None

以时间连续的方式组合 X_past 和 X_future 的预测数据帧。 将估算 X_pred 中的空值。

y_pred
默认值: None

将 y_past 的明确值与 Y_future 的缺失值进行组合的目标值。 如果为“无”,则针对每个 X_pred 进行预测。

forecast_destination
<xref:pandas.Timestamp>
默认值: None

Forecast_destination:时间戳值。 对于所有粒度,将一直进行预测,直到 forecast_destination 时间。 不接受字典输入 { grain -> timestamp }。 如果未提供 forecast_destination,则估算为每个粒度在 X_pred 中最后出现的时间。

ignore_data_errors
bool
默认值: False

忽略用户数据中的错误。

返回

包含请求预测的时间、粒度和相应分位数的数据帧。

is_grain_dropped

如果要删除粒度,则返回 True。

is_grain_dropped(grain: Union[Tuple[str], str, List[str]]) -> bool

参数

grain
必需

要测试是否将删除的粒度。

返回

如果将删除粒度,则为 True。

predict

对数据应用转换,然后使用最终估算器进行预测

predict(X: pandas.core.frame.DataFrame) -> None

参数

X
<xref:iterable>
必需

要预测的数据。 必须满足管道第一步的输入要求。

**predict_params
<xref:<xref:dict of string -> object>>
必需

在管道中的所有转换结束时调用的 predict 的参数。 请注意,虽然这可用于从具有 return_std 或 return_cov 的某些模型返回不确定性,但由管道中的转换生成的不确定性不会传播到最终估算器。

返回

y_pred

返回类型

<xref:<xref:array-like>>

short_grain_handling

如果为模型启用了短粒度或缺失粒度处理,则返回 true。

short_grain_handling() -> bool

属性

FATAL_DATA_SIZE_MISMATCH

FATAL_DATA_SIZE_MISMATCH = 'The length of y_pred is different from the X_pred'

FATAL_DESTINATION_AND_X_PRED

FATAL_DESTINATION_AND_X_PRED = 'Input prediction data X_pred and forecast_destination are both set. Please provide either X_pred or a forecast_destination date, but not both.'

FATAL_DESTINATION_AND_Y_PRED

FATAL_DESTINATION_AND_Y_PRED = 'Input prediction data y_pred and forecast_destination are both set. Please provide either y_pred or a forecast_destination date, but not both.'

FATAL_EARLY_DESTINATION

FATAL_EARLY_DESTINATION = 'Input prediction data X_pred or input forecast_destination contains dates prior to the latest date in the training data. Please remove prediction rows with datetimes in the training date range or adjust the forecast_destination date.'

FATAL_NONPOSITIVE_HORIZON

FATAL_NONPOSITIVE_HORIZON = 'Forecast horizon must be a positive integer.'

FATAL_NO_DATA_CONTEXT

FATAL_NO_DATA_CONTEXT = 'No y values were provided for one of time series. We expected non-null target values as prediction context because there is a gap between train and test and the forecaster depends on previous values of target. '

FATAL_NO_DESTINATION_OR_X_PRED

FATAL_NO_DESTINATION_OR_X_PRED = 'Input prediction data X_pred and forecast_destination are both None. Please provide either X_pred or a forecast_destination date, but not both.'

FATAL_NO_GRAIN_IN_TRAIN

FATAL_NO_GRAIN_IN_TRAIN = 'One of time series was not present in the training data set. Please remove it from the prediction data set to proceed.'

FATAL_NO_LAST_DATE

FATAL_NO_LAST_DATE = 'The last training date was not provided.One of time series in scoring set was not present in training set.'

FATAL_NO_TARGET_IMPUTER

FATAL_NO_TARGET_IMPUTER = 'No target imputers were found in TimeSeriesTransformer.'

FATAL_NO_TARGET_IN_Y_DF

FATAL_NO_TARGET_IN_Y_DF = 'The y_pred is a data frame, but it does not contain the target value column'

FATAL_NO_TS_TRANSFORM

FATAL_NO_TS_TRANSFORM = 'The time series transform is absent. Please try training model again.'

FATAL_WRONG_DESTINATION_TYPE

FATAL_WRONG_DESTINATION_TYPE = 'The forecast_destination argument has wrong type, it is a {}. We expected a datetime.'

FATAL_WRONG_QUANTILE

FATAL_WRONG_QUANTILE = 'Quantile should be a number between 0 and 1 (not inclusive).'

FATAL_WRONG_X_TYPE

FATAL_WRONG_X_TYPE = 'X_pred has unsupported type, x should be pandas.DataFrame, but it is a {}.'

FATAL_WRONG_Y_TYPE

FATAL_WRONG_Y_TYPE = 'y_pred has unsupported type, y should be numpy.array or pandas.DataFrame, but it is a {}.'

FATAL_Y_ONLY

FATAL_Y_ONLY = 'If y_pred is provided X_pred should not be None.'

TEMP_PRED_COLNAME

TEMP_PRED_COLNAME = '__predicted'