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

Nome	Description
ts_transformer	Valor padrão: None
y_transformer	Valor padrão: None
metadata	Valor padrão: None

Métodos

align_output_to_input	Alinhar o quadro de dados de saída transformado ao quadro de dados de entrada. Observação: o quadro transformado será modificado por referência; nenhuma cópia é criada. :param X_input: o quadro de dados de entrada. :param transformed: o quadro de dados após a transformação. :returns: o quadro de dados transformado com o índice original, mas classificado como em X_input.
fit	Ajuste o modelo com entrada X e y.
forecast	Fazer previsão no quadro de dados X_pred.
forecast_quantiles	Obter a previsão e os quantis do pipeline ajustado.
is_grain_dropped	Retornar true se a granularidade for descartada.
preaggregate_data_set	Agregar o conjunto de dados de previsão. Observação: esse método não garante que o conjunto de dados será agregado. Isso ocorrerá somente se o conjunto de dados contiver carimbos de data/hora duplicados ou fora das datas de grade. :param df: o conjunto de dados a ser agregado. :patam y: os valores de destino. :param is_training_set: se true, os dados representam o conjunto de treinamento. :return: o conjunto de dados agregado ou intacto se nenhuma agregação for necessária.
preprocess_pred_X_y	Pré-processar previsão X e y.
rolling_evaluation	"Produzir previsões em uma origem contínua com relação ao conjunto de testes fornecido. Cada iteração faz uma previsão para os próximos períodos 'max_horizon' em relação à origem atual e, em seguida, avança a origem pela duração do horizonte. O contexto de cada previsão é definido para que o previsor use os valores de destino reais anteriores ao horário da origem atual para criar os recursos de atraso. Essa função retorna um quadro de dados concatenado de previsões contínuas unidas aos dados reais do conjunto de teste. Esse método foi preterido e será removido em uma versão futura. Em vez disso, use rolling_forecast().
rolling_forecast	Produza previsões em uma origem sem interrupção em um conjunto de testes. Cada iteração faz uma previsão de períodos máximos de horizonte à frente usando informações até a origem atual e, em seguida, avança a origem por períodos de tempo de "etapa". O contexto de previsão para cada previsão é definido para que o preditor use os valores de destino reais antes do tempo de origem atual para construir recursos de pesquisa. Essa função retorna um DataFrame de previsões sem interrupção unidas aos reais do conjunto de testes. As colunas no quadro de dados retornado são as seguintes: Colunas de ID de timeseries (opcional). Quando fornecido pelo usuário, os nomes de coluna fornecidos serão usados. Coluna de origem de previsão que dá o tempo de origem para cada linha. Nome da coluna: armazenado como a variável de membro do objeto forecast_origin_column_name. Coluna de tempo. O nome da coluna fornecido pelo usuário será usado. Coluna de valores de previsão. Nome da coluna: armazenado como o membro do objeto forecast_column_name Coluna valores reais. Nome da coluna: armazenado como o membro do objeto actual_column_name
short_grain_handling	Retornar true se a manipulação de granularidades curtas ou ausentes estiver habilitada para o modelo.
static_preaggregate_data_set	Agregar o conjunto de dados de previsão. Observação: esse método não garante que o conjunto de dados será agregado. Isso ocorrerá somente se o conjunto de dados contiver carimbos de data/hora duplicados ou fora das datas de grade. :param ts_transformer: o transformador de série temporal usado para o treinamento. :param time_column_name: nome da coluna de tempo. :param grain_column_names: lista de nomes de colunas de granularidade. :param df: o conjunto de dados a ser agregado. :patam y: os valores de destino. :param is_training_set: se true, os dados representam o conjunto de treinamento. :return: o conjunto de dados agregado ou intacto se nenhuma agregação for necessária.

align_output_to_input

Alinhar o quadro de dados de saída transformado ao quadro de dados de entrada.

Observação: o quadro transformado será modificado por referência; nenhuma cópia é criada. :param X_input: o quadro de dados de entrada. :param transformed: o quadro de dados após a transformação. :returns: o quadro de dados transformado com o índice original, mas classificado como em X_input.

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

Parâmetros

Nome	Description
X_input Obrigatório
transformed Obrigatório

fit

Ajuste o modelo com entrada X e y.

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

Parâmetros

Nome	Description
X Obrigatório	Dados X de entrada.
y Obrigatório	Dados de entrada y.

forecast

Fazer previsão no quadro 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

Nome	Description
X_pred	o quadro de dados de previsão que combina X_past e X_future de forma contínua. Os valores vazios em X_pred serão imputados. Valor padrão: None
y_pred	o valor de destino que combina os valores definitivos para y_past e os valores ausentes para Y_future. Se Nenhum, as previsões serão feitas para cada X_pred. Valor padrão: None
forecast_destination	<xref:pandas.Timestamp> Forecast_destination: um valor de carimbo de data/hora. As previsões serão feitas até o tempo de previsão_destino, para todas as granularidades. Entrada do dicionário {granularidade - > carimbo de data/hora} não será aceita. Se forecast_destination não for fornecido, será imputado como a última vez que ocorrer em X_pred para cada granularidade. Valor padrão: None
ignore_data_errors	bool Ignorar erros nos dados do usuário. Valor padrão: False

Retornos

Tipo	Description
tuple	Y_pred, com o subquadro correspondente a Y_future preenchido com as respectivas previsões. Todos os valores ausentes em Y_past serão preenchidos pelo imputador.

forecast_quantiles

Obter a previsão e os quantis 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

Nome	Description
X_pred	o quadro de dados de previsão que combina X_past e X_future de forma contínua. Os valores vazios em X_pred serão imputados. Valor padrão: None
y_pred	o valor de destino que combina os valores definitivos para y_past e os valores ausentes para Y_future. Se Nenhum, as previsões serão feitas para cada X_pred. Valor padrão: None
quantiles	float ou list of <xref:floats> A lista de quantiles em que queremos prever. Valor padrão: None
forecast_destination	<xref:pandas.Timestamp> Forecast_destination: um valor de carimbo de data/hora. As previsões serão feitas até o tempo de previsão_destino, para todas as granularidades. Entrada do dicionário {granularidade - > carimbo de data/hora} não será aceita. Se forecast_destination não for fornecido, será imputado como a última vez que ocorrer em X_pred para cada granularidade. Valor padrão: None
ignore_data_errors	bool Ignorar erros nos dados do usuário. Valor padrão: False

Retornos

Tipo	Description
	Um dataframe que contém as colunas e previsões feitas em quantiles solicitados.

is_grain_dropped

Retornar true se a granularidade for descartada.

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

Parâmetros

Nome	Description
grain Obrigatório	A granularidade a ser testada quanto ao descarte.

Retornos

Tipo	Description
	True se a granularidade for descartada.

preaggregate_data_set

Agregar o conjunto de dados de previsão.

Observação: esse método não garante que o conjunto de dados será agregado. Isso ocorrerá somente se o conjunto de dados contiver carimbos de data/hora duplicados ou fora das datas de grade. :param df: o conjunto de dados a ser agregado. :patam y: os valores de destino. :param is_training_set: se true, os dados representam o conjunto de treinamento. :return: o conjunto de dados agregado ou intacto se nenhuma agregação for necessária.

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

Parâmetros

Nome	Description
df Obrigatório
y	Valor padrão: None
is_training_set	Valor padrão: False

preprocess_pred_X_y

Pré-processar previsão 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

Nome	Description
X_pred	Valor padrão: None
y_pred	Valor padrão: None
forecast_destination	Valor padrão: None

rolling_evaluation

"Produzir previsões em uma origem contínua com relação ao conjunto de testes fornecido.

Cada iteração faz uma previsão para os próximos períodos 'max_horizon' em relação à origem atual e, em seguida, avança a origem pela duração do horizonte. O contexto de cada previsão é definido para que o previsor use os valores de destino reais anteriores ao horário da origem atual para criar os recursos de atraso.

Essa função retorna um quadro de dados concatenado de previsões contínuas unidas aos dados reais do conjunto de teste.

Esse método foi preterido e será removido em uma versão futura. Em vez disso, use rolling_forecast().

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

Parâmetros

Nome	Description
X_pred Obrigatório	o quadro de dados de previsão que combina X_past e X_future de forma contínua. Os valores vazios em X_pred serão imputados.
y_pred Obrigatório	o valor de destino correspondente a X_pred.
ignore_data_errors	Ignorar erros nos dados do usuário. Valor padrão: False

Retornos

Tipo	Description
tuple	Y_pred, com o subquadro correspondente a Y_future preenchido com as respectivas previsões. Todos os valores ausentes em Y_past serão preenchidos pelo imputador.

rolling_forecast

Produza previsões em uma origem sem interrupção em um conjunto de testes.

Cada iteração faz uma previsão de períodos máximos de horizonte à frente usando informações até a origem atual e, em seguida, avança a origem por períodos de tempo de "etapa". O contexto de previsão para cada previsão é definido para que o preditor use os valores de destino reais antes do tempo de origem atual para construir recursos de pesquisa.

Essa função retorna um DataFrame de previsões sem interrupção unidas aos reais do conjunto de testes. As colunas no quadro de dados retornado são as seguintes:

• Colunas de ID de timeseries (opcional). Quando fornecido pelo usuário, os nomes de coluna fornecidos serão usados.

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

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

• Coluna de tempo. O nome da coluna fornecido pelo usuário será usado.

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

• Coluna valores reais. Nome da coluna: armazenado como o 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

Nome	Description
X_pred Obrigatório	<xref:pd.DataFrame> Quadro de dados de previsão
y_pred Obrigatório	<xref:np.ndarray> valores de destino correspondentes a linhas no X_pred
step	int Número de períodos para avançar a janela de previsão em cada iteração. Valor padrão: 1
ignore_data_errors	bool Ignorar erros nos dados do usuário. Valor padrão: False

Retornos

Tipo	Description
<xref:pd.DataFrame>	Quadro de dados de previsões sem interrupção

short_grain_handling

Retornar true se a manipulação de granularidades curtas ou ausentes estiver habilitada para o modelo.

short_grain_handling() -> bool

static_preaggregate_data_set

Agregar o conjunto de dados de previsão.

Observação: esse método não garante que o conjunto de dados será agregado. Isso ocorrerá somente se o conjunto de dados contiver carimbos de data/hora duplicados ou fora das datas de grade. :param ts_transformer: o transformador de série temporal usado para o treinamento. :param time_column_name: nome da coluna de tempo. :param grain_column_names: lista de nomes de colunas de granularidade. :param df: o conjunto de dados a ser agregado. :patam y: os valores de destino. :param is_training_set: se true, os dados representam o conjunto de treinamento. :return: o conjunto de dados agregado ou intacto se nenhuma agregação for necessária.

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

Nome	Description
ts_transformer Obrigatório
time_column_name Obrigatório
grain_column_names Obrigatório
df Obrigatório
y	Valor padrão: None
is_training_set	Valor padrão: False

Atributos

actual_column_name

forecast_column_name

forecast_origin_column_name

grain_column_list

max_horizon

Retornar horizonte máximo usado no modelo.

origin_col_name

Retornar o nome da coluna de origem.

target_lags

Retornar os atrasos de destino, se houver.

target_rolling_window_size

Retornar o tamanho da janela com rolagem.

time_column_name

Retornar o nome da coluna de tempo.

user_target_column_name

y_max_dict

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

y_min_dict

Retornar o dicionário com valores de destino mínimos por ID de 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.'