Compartir a través de

ForecastingPipelineWrapperBase Clase

  • Referencia

Clase base para el contenedor del modelo de previsión.

Herencia
ABC
ForecastingPipelineWrapperBase

Constructor

ForecastingPipelineWrapperBase(ts_transformer: TimeSeriesTransformer | None = None, y_transformer: Pipeline | None = None, metadata: Dict[str, Any] | None = None)

Parámetros

Nombre Description
ts_transformer
Valor predeterminado: None
y_transformer
Valor predeterminado: None
metadata
Valor predeterminado: None

Métodos

align_output_to_input

Alinea la trama de datos de salida transformada con la trama de datos de entrada.

Nota: La transformación se modificará por referencia, no se crea ninguna copia. :param X_input: la trama de datos de entrada. :param transformado: la trama de datos después de la transformación. :returns: la trama de datos transformada con su índice original, pero ordenada como en X_input.
fit

Ajuste el modelo con la entrada X e y.
forecast

Realiza la previsión en la trama de datos X_pred.
forecast_quantiles

Obtiene la predicción y los cuantiles de la canalización ajustada.
is_grain_dropped

Devuelve true si el grano se va a descartar.
preaggregate_data_set

Agrega el conjunto de datos de predicción.

Nota: Este método no garantiza que se agregue el conjunto de datos. Esto solo ocurrirá si el conjunto de datos contiene las marcas de tiempo duplicadas o está fuera de las fechas de la cuadrícula. :param df: conjunto de datos que se va a agregar. :patam y: los valores de destino. :param is_training_set: si es true, los datos representan el conjunto de entrenamiento. :return: conjunto de datos agregado o intacto si no se requiere agregación.
preprocess_pred_X_y

Preprocesar la predicción X e y.
rolling_evaluation

Produce previsiones sobre un origen gradual en el conjunto de pruebas dado.

Cada iteración realiza una previsión de los siguientes períodos de "max_horizon" con respecto al origen actual y, luego, avanza el origen según la duración del tiempo del horizonte. El contexto de predicción de cada previsión se establece para que el pronosticador use los valores de destino reales antes de la hora de origen actual para crear características de retraso.

Esta función devuelve un objeto DataFrame concatenado de previsiones graduales unidas a las reales del conjunto de pruebas.

Este método está en desuso y se quitará en una versión futura. En su lugar, use rolling_forecast().
rolling_forecast

Genere previsiones sobre un origen gradual sobre un conjunto de pruebas.

Cada iteración hace una previsión de los períodos máximos del horizonte con información hasta el origen actual y, a continuación, avanza el origen por períodos de tiempo "paso". El contexto de predicción de cada previsión se establece para que el forecaster use los valores de destino reales antes de la hora de origen actual para construir características de búsqueda.

Esta función devuelve un DataFrame de previsiones graduales combinadas con los datos reales del conjunto de pruebas. Las columnas del marco de datos devueltos son las siguientes:

  • Columnas de id. de timeseries (opcional). Cuando el usuario lo proporcione, se usarán los nombres de columna especificados.

  • Columna de origen de previsión que proporciona la hora de origen para cada fila.

    Nombre de columna: se almacena como la variable miembro del objeto forecast_origin_column_name.

  • Columna de hora. Se usará el nombre de columna proporcionado por el usuario.

  • Columna De valores de previsión. Nombre de columna: almacenado como miembro del objeto forecast_column_name

  • Columna valores reales. Nombre de columna: almacenado como miembro del objeto actual_column_name
short_grain_handling

Devuelve true si está habilitado el control de granos cortos o ausentes para el modelo.
static_preaggregate_data_set

Agrega el conjunto de datos de predicción.

Nota: Este método no garantiza que se agregue el conjunto de datos. Esto solo ocurrirá si el conjunto de datos contiene las marcas de tiempo duplicadas o está fuera de las fechas de la cuadrícula. :param ts_transformer: el transformador de series temporales que se usa para el entrenamiento. :param time_column_name: nombre de la columna de tiempo. :param grain_column_names: lista de nombres de columna de grano. :param df: conjunto de datos que se va a agregar. :patam y: los valores de destino. :param is_training_set: si es true, los datos representan el conjunto de entrenamiento. :return: conjunto de datos agregado o intacto si no se requiere agregación.

align_output_to_input

Alinea la trama de datos de salida transformada con la trama de datos de entrada.

Nota: La transformación se modificará por referencia, no se crea ninguna copia. :param X_input: la trama de datos de entrada. :param transformado: la trama de datos después de la transformación. :returns: la trama de datos transformada con su índice original, pero ordenada como en X_input.

align_output_to_input(X_input: DataFrame, transformed: DataFrame) -> DataFrame

Parámetros

Nombre Description
X_input
Requerido
transformed
Requerido

fit

Ajuste el modelo con la entrada X e y.

fit(X: DataFrame, y: ndarray) -> ForecastingPipelineWrapperBase

Parámetros

Nombre Description
X
Requerido

Entrada de datos X.
y
Requerido

Datos de entrada y.

forecast

Realiza la previsión en la trama de datos X_pred.

forecast(X_pred: DataFrame | None = None, y_pred: ndarray | DataFrame | None = None, forecast_destination: Timestamp | None = None, ignore_data_errors: bool = False) -> Tuple[ndarray, DataFrame]

Parámetros

Nombre Description
X_pred

la trama de datos de predicción que combina X_past y X_future de forma contigua en el tiempo. Se imputarán valores vacíos en X_pred.

Valor predeterminado: None
y_pred

el valor de destino que combina valores definidos para y_past y valores que faltan para Y_future. Si es "None", las predicciones se realizarán para cada X_pred.

Valor predeterminado: None
forecast_destination
<xref:pandas.Timestamp>

Forecast_destination: un valor de marca de tiempo. Las previsiones se realizarán hasta la hora de forecast_destination, para todos los granos. No se aceptará la entrada de diccionario { grain -> timestamp }. Si no se proporciona forecast_destination, se imputará como la última vez que se produjo en X_pred para cada grano.

Valor predeterminado: None
ignore_data_errors
bool

Omite errores en los datos de usuario.

Valor predeterminado: False

Devoluciones

Tipo Description
tuple

Y_pred, con la subtrama correspondiente a Y_future rellena con las previsiones correspondientes. Los valores que faltan en Y_past se rellenarán con el imputador.

forecast_quantiles

Obtiene la predicción y los cuantiles de la canalización ajustada.

forecast_quantiles(X_pred: DataFrame | None = None, y_pred: ndarray | DataFrame | None = None, quantiles: float | List[float] | None = None, forecast_destination: Timestamp | None = None, ignore_data_errors: bool = False) -> DataFrame

Parámetros

Nombre Description
X_pred

la trama de datos de predicción que combina X_past y X_future de forma contigua en el tiempo. Se imputarán valores vacíos en X_pred.

Valor predeterminado: None
y_pred

el valor de destino que combina valores definidos para y_past y valores que faltan para Y_future. Si es "None", las predicciones se realizarán para cada X_pred.

Valor predeterminado: None
quantiles
float o list of <xref:floats>

Lista de cuantiles en los que queremos predecir.

Valor predeterminado: None
forecast_destination
<xref:pandas.Timestamp>

Forecast_destination: un valor de marca de tiempo. Las previsiones se realizarán hasta la hora de forecast_destination, para todos los granos. No se aceptará la entrada de diccionario { grain -> timestamp }. Si no se proporciona forecast_destination, se imputará como la última vez que se produjo en X_pred para cada grano.

Valor predeterminado: None
ignore_data_errors
bool

Omite errores en los datos de usuario.

Valor predeterminado: False

Devoluciones

Tipo Description

Trama de datos que contiene las columnas y predicciones realizadas en cuantiles solicitados.

is_grain_dropped

Devuelve true si el grano se va a descartar.

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

Parámetros

Nombre Description
grain
Requerido

El grano que se va a probar si se descarta.

Devoluciones

Tipo Description

True si se va a descartar el grano.

preaggregate_data_set

Agrega el conjunto de datos de predicción.

Nota: Este método no garantiza que se agregue el conjunto de datos. Esto solo ocurrirá si el conjunto de datos contiene las marcas de tiempo duplicadas o está fuera de las fechas de la cuadrícula. :param df: conjunto de datos que se va a agregar. :patam y: los valores de destino. :param is_training_set: si es true, los datos representan el conjunto de entrenamiento. :return: conjunto de datos agregado o intacto si no se requiere agregación.

preaggregate_data_set(df: DataFrame, y: ndarray | None = None, is_training_set: bool = False) -> Tuple[DataFrame, ndarray | None]

Parámetros

Nombre Description
df
Requerido
y
Valor predeterminado: None
is_training_set
Valor predeterminado: False

preprocess_pred_X_y

Preprocesar la predicción X e y.

preprocess_pred_X_y(X_pred: DataFrame | None = None, y_pred: ndarray | DataFrame | None = None, forecast_destination: Timestamp | None = None) -> Tuple[DataFrame, DataFrame | ndarray, Dict[str, Any]]

Parámetros

Nombre Description
X_pred
Valor predeterminado: None
y_pred
Valor predeterminado: None
forecast_destination
Valor predeterminado: None

rolling_evaluation

Produce previsiones sobre un origen gradual en el conjunto de pruebas dado.

Cada iteración realiza una previsión de los siguientes períodos de "max_horizon" con respecto al origen actual y, luego, avanza el origen según la duración del tiempo del horizonte. El contexto de predicción de cada previsión se establece para que el pronosticador use los valores de destino reales antes de la hora de origen actual para crear características de retraso.

Esta función devuelve un objeto DataFrame concatenado de previsiones graduales unidas a las reales del conjunto de pruebas.

Este método está en desuso y se quitará en una versión futura. En su lugar, use rolling_forecast().

rolling_evaluation(X_pred: DataFrame, y_pred: DataFrame | ndarray, ignore_data_errors: bool = False) -> Tuple[ndarray, DataFrame]

Parámetros

Nombre Description
X_pred
Requerido

la trama de datos de predicción que combina X_past y X_future de forma contigua en el tiempo. Se imputarán valores vacíos en X_pred.
y_pred
Requerido

El valor de destino correspondiente a X_pred.
ignore_data_errors

Omite errores en los datos de usuario.

Valor predeterminado: False

Devoluciones

Tipo Description
tuple

Y_pred, con la subtrama correspondiente a Y_future rellena con las previsiones correspondientes. Los valores que faltan en Y_past se rellenarán con el imputador.

rolling_forecast

Genere previsiones sobre un origen gradual sobre un conjunto de pruebas.

Cada iteración hace una previsión de los períodos máximos del horizonte con información hasta el origen actual y, a continuación, avanza el origen por períodos de tiempo "paso". El contexto de predicción de cada previsión se establece para que el forecaster use los valores de destino reales antes de la hora de origen actual para construir características de búsqueda.

Esta función devuelve un DataFrame de previsiones graduales combinadas con los datos reales del conjunto de pruebas. Las columnas del marco de datos devueltos son las siguientes:

  • Columnas de id. de timeseries (opcional). Cuando el usuario lo proporcione, se usarán los nombres de columna especificados.

  • Columna de origen de previsión que proporciona la hora de origen para cada fila.

    Nombre de columna: se almacena como la variable miembro del objeto forecast_origin_column_name.

  • Columna de hora. Se usará el nombre de columna proporcionado por el usuario.

  • Columna De valores de previsión. Nombre de columna: almacenado como miembro del objeto forecast_column_name

  • Columna valores reales. Nombre de columna: almacenado como miembro del objeto actual_column_name

rolling_forecast(X_pred: DataFrame, y_pred: ndarray, step: int = 1, ignore_data_errors: bool = False) -> DataFrame

Parámetros

Nombre Description
X_pred
Requerido
<xref:pd.DataFrame>

Marco de datos de predicción
y_pred
Requerido
<xref:np.ndarray>

valores de destino correspondientes a las filas de X_pred
step
int

Número de períodos para avanzar la ventana de previsión en cada iteración.

Valor predeterminado: 1
ignore_data_errors
bool

Omite errores en los datos de usuario.

Valor predeterminado: False

Devoluciones

Tipo Description
<xref:pd.DataFrame>

Marco de datos de previsiones graduales

short_grain_handling

Devuelve true si está habilitado el control de granos cortos o ausentes para el modelo.

short_grain_handling() -> bool

static_preaggregate_data_set

Agrega el conjunto de datos de predicción.

Nota: Este método no garantiza que se agregue el conjunto de datos. Esto solo ocurrirá si el conjunto de datos contiene las marcas de tiempo duplicadas o está fuera de las fechas de la cuadrícula. :param ts_transformer: el transformador de series temporales que se usa para el entrenamiento. :param time_column_name: nombre de la columna de tiempo. :param grain_column_names: lista de nombres de columna de grano. :param df: conjunto de datos que se va a agregar. :patam y: los valores de destino. :param is_training_set: si es true, los datos representan el conjunto de entrenamiento. :return: conjunto de datos agregado o intacto si no se requiere agregación.

static static_preaggregate_data_set(ts_transformer: TimeSeriesTransformer, time_column_name: str, grain_column_names: List[str], df: DataFrame, y: ndarray | None = None, is_training_set: bool = False) -> Tuple[DataFrame, ndarray | None]

Parámetros

Nombre Description
ts_transformer
Requerido
time_column_name
Requerido
grain_column_names
Requerido
df
Requerido
y
Valor predeterminado: None
is_training_set
Valor predeterminado: False

Atributos

actual_column_name

forecast_column_name

forecast_origin_column_name

grain_column_list

max_horizon

Devuelve el horizonte máximo usado en el modelo.

origin_col_name

Devuelve el nombre de la columna de origen.

target_lags

Devuelve los retrasos de destino, si los hay.

target_rolling_window_size

Devuelve el tamaño de la ventana gradual.

time_column_name

Devuelve el nombre de la columna de hora.

user_target_column_name

y_max_dict

Devolver el diccionario con valores máximos de destino por identificador de serie temporal

y_min_dict

Devolver el diccionario con valores de destino mínimos por identificador de serie temporal

FATAL_NO_TARGET_IMPUTER 

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

FATAL_NO_TS_TRANSFORM 

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