ForecastingPipelineWrapperBase Classe

Classe base para wrapper de modelo de previsão.

Herança

ABC

ForecastingPipelineWrapperBase

Construtor

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

Parâmetros

ts_transformer

valor predefinido: None

y_transformer

valor predefinido: None

metadata

valor predefinido: None

Métodos

align_output_to_input	Alinhe o fotograma de dados de saída transformado ao fotograma de dados de entrada. Nota: a transformação será modificada por referência, não está a ser criada nenhuma cópia. :p aram X_input: o fotograma de dados de entrada. :p aram transformado: o fotograma de dados após a transformação. :returns: O fotograma de dados transfotmed com o respetivo índice original, mas ordenado como em X_input.
fit	Ajuste o modelo com a entrada X e y.
forecast	Faça a previsão no pacote de dados X_pred.
forecast_quantiles	Obtenha a predição e os quantiles do pipeline ajustado.
is_grain_dropped	Devolve verdadeiro se o grão vai ser largado.
preaggregate_data_set	Agregar o conjunto de dados de predição. Nota: Este método não garante que o conjunto de dados seja agregado. Isto só acontecerá se o conjunto de dados contiver os carimbos de data/hora duplicados ou fora das datas da grelha. :p aram df: o conjunto de dados a agregar. :p atam y: os valores de destino. :p aram is_training_set: se for verdade, os dados representam o conjunto de preparação. :return: o conjunto de dados agregado ou intacto se não for necessária nenhuma agregação.
preprocess_pred_X_y	Predição de pré-processamento X e y.
rolling_evaluation	" Produza previsões sobre uma origem sem interrupção sobre o conjunto de testes especificado. Cada iteração faz uma previsão para os próximos períodos de "max_horizon" relativamente à origem atual e, em seguida, avança a origem pela duração da hora do horizonte. O contexto de predição para cada previsão é definido para que o meteorologista utilize os valores de destino reais antes da hora de origem atual para construir funcionalidades de atraso. Esta função devolve um DataFrame concatenado de previsões sem interrupção associadas aos valores reais do conjunto de testes. Este método foi preterido e será removido numa versão futura. Em alternativa, utilize rolling_forecast().
rolling_forecast	Produzir previsões sobre uma origem sem interrupção num conjunto de testes. Cada iteração faz uma previsão de períodos de horizonte máximos à frente com informações até à origem atual e, em seguida, avança a origem por períodos de tempo "passo". O contexto de predição para cada previsão é definido para que o meteorologista utilize os valores de destino reais antes da hora de origem atual para construir funcionalidades de pesquisa. Esta função devolve um DataFrame de previsões sem interrupção associadas aos valores reais do conjunto de testes. As colunas no fotograma de dados devolvido são as seguintes: Colunas de ID de séries de tempo (Opcional). Quando fornecido pelo utilizador, serão utilizados os nomes de coluna especificados. Coluna de origem de previsão que dá o tempo de origem para cada linha. Nome da coluna: armazenado como a variável membro do objeto forecast_origin_column_name. Coluna de tempo. O nome da coluna fornecido pelo utilizador será utilizado. Coluna Valores de previsão. Nome da coluna: armazenado como membro do objeto forecast_column_name Coluna valores reais. Nome da coluna: armazenado como membro do objeto actual_column_name
short_grain_handling	Devolver verdadeiro se o processamento de grãos curtos ou ausentes estiver ativado para o modelo.
static_preaggregate_data_set	Agregar o conjunto de dados de predição. Nota: Este método não garante que o conjunto de dados seja agregado. Isto só acontecerá se o conjunto de dados contiver os carimbos de data/hora duplicados ou fora das datas da grelha. :p aram ts_transformer: o transformador de timeseries utilizado para a preparação. :p aram time_column_name: nome da coluna time. :p aram grain_column_names: lista de nomes de colunas de grãos. :p aram df: o conjunto de dados a agregar. :p atam y: os valores de destino. :p aram is_training_set: se for verdade, os dados representam o conjunto de preparação. :return: o conjunto de dados agregado ou intacto se não for necessária nenhuma agregação.

align_output_to_input

Alinhe o fotograma de dados de saída transformado ao fotograma de dados de entrada.

Nota: a transformação será modificada por referência, não está a ser criada nenhuma cópia. :p aram X_input: o fotograma de dados de entrada. :p aram transformado: o fotograma de dados após a transformação. :returns: O fotograma de dados transfotmed com o respetivo índice original, mas ordenado como em X_input.

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

Parâmetros

X_input

Necessário

transformed

Necessário

fit

Ajuste o modelo com a entrada X e y.

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

Parâmetros

X

Necessário

Dados X de entrada.

y

Necessário

Dados de entrada y.

forecast

Faça a previsão no pacote de dados 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

X_pred

valor predefinido: None

o dataframe de predição que combina X_past e X_future de forma contígua ao tempo. Os valores vazios no X_pred serão imputados.

y_pred

valor predefinido: None

o valor de destino que combina valores definidos para y_past e valores em falta para Y_future. Se Nenhuma, as predições serão feitas para cada X_pred.

forecast_destination

<xref:pandas.Timestamp>

valor predefinido: None

Forecast_destination: um valor de carimbo de data/hora. As previsões serão feitas até ao forecast_destination tempo, para todos os grãos. A entrada do dicionário { grain -> carimbo de data/hora } não será aceite. Se forecast_destination não for dada, será imputada como a última vez que ocorrer em X_pred para cada grão.

ignore_data_errors

bool

valor predefinido: False

Ignorar erros nos dados do utilizador.

Devoluções

Y_pred, com o subframe correspondente a Y_future preenchido com as respetivas previsões. Todos os valores em falta no Y_past serão preenchidos por imputer.

Tipo de retorno

tuple

forecast_quantiles

Obtenha a predição e os quantiles do pipeline ajustado.

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

X_pred

valor predefinido: None

o dataframe de predição que combina X_past e X_future de forma contígua ao tempo. Os valores vazios no X_pred serão imputados.

y_pred

valor predefinido: None

o valor de destino que combina valores definidos para y_past e valores em falta para Y_future. Se Nenhuma, as predições serão feitas para cada X_pred.

quantiles

float ou list of <xref:floats>

valor predefinido: None

A lista de quantiles em que queremos prever.

forecast_destination

<xref:pandas.Timestamp>

valor predefinido: None

Forecast_destination: um valor de carimbo de data/hora. As previsões serão feitas até ao forecast_destination tempo, para todos os grãos. A entrada do dicionário { grain -> carimbo de data/hora } não será aceite. Se forecast_destination não for dada, será imputada como a última vez que ocorrer em X_pred para cada grão.

ignore_data_errors

bool

valor predefinido: False

Ignorar erros nos dados do utilizador.

Devoluções

Um dataframe que contém as colunas e predições efetuadas em quantiles pedidos.

is_grain_dropped

Devolve verdadeiro se o grão vai ser largado.

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

Parâmetros

grain

Necessário

O grão a testar se será largado.

Devoluções

Verdadeiro se o grão for largado.

preaggregate_data_set

Agregar o conjunto de dados de predição.

Nota: Este método não garante que o conjunto de dados seja agregado. Isto só acontecerá se o conjunto de dados contiver os carimbos de data/hora duplicados ou fora das datas da grelha. :p aram df: o conjunto de dados a agregar. :p atam y: os valores de destino. :p aram is_training_set: se for verdade, os dados representam o conjunto de preparação. :return: o conjunto de dados agregado ou intacto se não for necessária nenhuma agregação.

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

Parâmetros

df

Necessário

y

valor predefinido: None

is_training_set

valor predefinido: False

preprocess_pred_X_y

Predição de pré-processamento 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

X_pred

valor predefinido: None

y_pred

valor predefinido: None

forecast_destination

valor predefinido: None

rolling_evaluation

" Produza previsões sobre uma origem sem interrupção sobre o conjunto de testes especificado.

Cada iteração faz uma previsão para os próximos períodos de "max_horizon" relativamente à origem atual e, em seguida, avança a origem pela duração da hora do horizonte. O contexto de predição para cada previsão é definido para que o meteorologista utilize os valores de destino reais antes da hora de origem atual para construir funcionalidades de atraso.

Esta função devolve um DataFrame concatenado de previsões sem interrupção associadas aos valores reais do conjunto de testes.

Este método foi preterido e será removido numa versão futura. Em alternativa, utilize rolling_forecast().

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

Parâmetros

X_pred

Necessário

o dataframe de predição que combina X_past e X_future de forma contígua ao tempo. Os valores vazios no X_pred serão imputados.

y_pred

Necessário

o valor de destino correspondente a X_pred.

ignore_data_errors

valor predefinido: False

Ignorar erros nos dados do utilizador.

Devoluções

Y_pred, com o subframe correspondente a Y_future preenchido com as respetivas previsões. Todos os valores em falta no Y_past serão preenchidos por imputer.

Tipo de retorno

tuple

rolling_forecast

Produzir previsões sobre uma origem sem interrupção num conjunto de testes.

Cada iteração faz uma previsão de períodos de horizonte máximos à frente com informações até à origem atual e, em seguida, avança a origem por períodos de tempo "passo". O contexto de predição para cada previsão é definido para que o meteorologista utilize os valores de destino reais antes da hora de origem atual para construir funcionalidades de pesquisa.

Esta função devolve um DataFrame de previsões sem interrupção associadas aos valores reais do conjunto de testes. As colunas no fotograma de dados devolvido são as seguintes:

• Colunas de ID de séries de tempo (Opcional). Quando fornecido pelo utilizador, serão utilizados os nomes de coluna especificados.

• Coluna de origem de previsão que dá o tempo de origem para cada linha.

  Nome da coluna: armazenado como a variável membro do objeto forecast_origin_column_name.

• Coluna de tempo. O nome da coluna fornecido pelo utilizador será utilizado.

• Coluna Valores de previsão. Nome da coluna: armazenado como membro do objeto forecast_column_name

• Coluna valores reais. Nome da coluna: armazenado como membro do objeto actual_column_name

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

Parâmetros

X_pred

<xref:pd.DataFrame>

Necessário

Fotograma de dados de predição

y_pred

<xref:np.ndarray>

Necessário

valores de destino correspondentes a linhas no X_pred

step

int

valor predefinido: 1

Número de períodos para avançar a janela de previsão em cada iteração.

ignore_data_errors

bool

valor predefinido: False

Ignorar erros nos dados do utilizador.

Devoluções

Fotograma de dados de previsões sem interrupção

Tipo de retorno

<xref:pd.DataFrame>

short_grain_handling

Devolver verdadeiro se o processamento de grãos curtos ou ausentes estiver ativado para o modelo.

short_grain_handling() -> bool

static_preaggregate_data_set

Agregar o conjunto de dados de predição.

Nota: Este método não garante que o conjunto de dados seja agregado. Isto só acontecerá se o conjunto de dados contiver os carimbos de data/hora duplicados ou fora das datas da grelha. :p aram ts_transformer: o transformador de timeseries utilizado para a preparação. :p aram time_column_name: nome da coluna time. :p aram grain_column_names: lista de nomes de colunas de grãos. :p aram df: o conjunto de dados a agregar. :p atam y: os valores de destino. :p aram is_training_set: se for verdade, os dados representam o conjunto de preparação. :return: o conjunto de dados agregado ou intacto se não for necessária nenhuma agregação.

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

ts_transformer

Necessário

time_column_name

Necessário

grain_column_names

Necessário

df

Necessário

y

valor predefinido: None

is_training_set

valor predefinido: False

Atributos

actual_column_name

forecast_column_name

forecast_origin_column_name

grain_column_list

max_horizon

Devolver o máximo hiorizon utilizado no modelo.

origin_col_name

Devolver o nome da coluna de origem.

target_lags

Se existir, o destino de retorno fica desfasamento.

target_rolling_window_size

Devolva o tamanho da janela de rolamento.

time_column_name

Devolva o nome da coluna de hora.

user_target_column_name

y_max_dict

Devolver o dicionário com valores de destino máximos por ID da série temporal

y_min_dict

Devolver o dicionário com valores de destino mínimos por ID da série 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.'