ForecastingPipelineWrapperBase Klas

Basisklasse voor de wrapper van het prognosemodel.

Overname
ForecastingPipelineWrapperBase

Constructor

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

Parameters

ts_transformer
standaardwaarde: None
y_transformer
standaardwaarde: None
metadata
standaardwaarde: None

Methoden

align_output_to_input

Lijn het getransformeerde uitvoergegevensframe uit op het invoergegevensframe.

Opmerking: getransformeerd wordt gewijzigd door verwijzing, er wordt geen kopie gemaakt. :p aram X_input: het invoergegevensframe. :p aram getransformeerd: het gegevensframe na transformatie. :retourneert: Het getransfoteerde gegevensframe met de oorspronkelijke index, maar gesorteerd zoals in X_input.

fit

Pas het model aan met invoer X en y.

forecast

Voer de prognose uit op het gegevensframe X_pred.

forecast_quantiles

Haal de voorspelling en kwantielen op uit de aangepaste pijplijn.

is_grain_dropped

Retourneer waar als de korrel wordt verwijderd.

preaggregate_data_set

De voorspellingsgegevensset aggregeren.

Opmerking: Deze methode garandeert niet dat de gegevensset wordt geaggregeerd. Dit gebeurt alleen als de gegevensset de gedupliceerde tijdstempels of niet-rasterdatums bevat. :p aram df: de gegevensset die moet worden samengevoegd. :p atam y: de doelwaarden. :p aram is_training_set: Indien waar, vertegenwoordigen de gegevens een trainingsset. :return: de geaggregeerde of intacte gegevensset als er geen aggregatie is vereist.

preprocess_pred_X_y

Preprocess voorspelling X en y.

rolling_evaluation

" Maak prognoses op basis van een voortschrijdende oorsprong van de opgegeven testset.

Elke iteratie maakt een prognose voor de volgende 'max_horizon'-perioden met betrekking tot de huidige oorsprong, waarna de oorsprong wordt vervroegd met de duur van de horizon. De voorspellingscontext voor elke prognose wordt zo ingesteld dat de prognose de werkelijke doelwaarden vóór de huidige oorsprongstijd gebruikt voor het samenstellen van vertragingsfuncties.

Deze functie retourneert een samengevoegd DataFrame van rolling forecasts die zijn gekoppeld aan de werkelijke waarden uit de testset.

Deze methode is afgeschaft en wordt in een toekomstige release verwijderd. Gebruik in plaats daarvan rolling_forecast().

rolling_forecast

Maak prognoses op een rolling origin over een testset.

Elke iteratie maakt een prognose van het maximum aantal horizonperioden voor de toekomst met behulp van informatie tot aan de huidige oorsprong, waarna de oorsprong stapsgewijs verdergaat. De voorspellingscontext voor elke prognose wordt zo ingesteld dat de prognose de werkelijke doelwaarden vóór de huidige oorsprongstijd gebruikt voor het samenstellen van lookbackfuncties.

Deze functie retourneert een DataFrame met rolling prognoses die zijn gekoppeld aan de werkelijke waarden uit de testset. De kolommen in het geretourneerde gegevensframe zijn als volgt:

  • Kolommen met tijdreeks-id's (optioneel). Wanneer deze door de gebruiker wordt opgegeven, worden de opgegeven kolomnamen gebruikt.

  • De kolom Oorsprong voorspellen met de begintijd voor elke rij.

    Kolomnaam: opgeslagen als de objectlidvariabele forecast_origin_column_name.

  • Tijdkolom. De kolomnaam die door de gebruiker is opgegeven, wordt gebruikt.

  • Kolom Waarden voorspellen. Kolomnaam: opgeslagen als het objectlid forecast_column_name

  • Kolom werkelijke waarden. Kolomnaam: opgeslagen als het objectlid actual_column_name

short_grain_handling

Retourneer waar als de verwerking van korte of afwezige korrels is ingeschakeld voor het model.

static_preaggregate_data_set

De voorspellingsgegevensset aggregeren.

Opmerking: Deze methode garandeert niet dat de gegevensset wordt geaggregeerd. Dit gebeurt alleen als de gegevensset de gedupliceerde tijdstempels of niet-rasterdatums bevat. :p aram ts_transformer: de tijdserie-tranformer die wordt gebruikt voor de training. :p aram time_column_name: naam van de tijdkolom. :p aram grain_column_names: lijst met namen van korrelkolommen. :p aram df: de gegevensset die moet worden samengevoegd. :p atam y: de doelwaarden. :p aram is_training_set: Indien waar, vertegenwoordigen de gegevens een trainingsset. :return: de geaggregeerde of intacte gegevensset als er geen aggregatie is vereist.

align_output_to_input

Lijn het getransformeerde uitvoergegevensframe uit op het invoergegevensframe.

Opmerking: getransformeerd wordt gewijzigd door verwijzing, er wordt geen kopie gemaakt. :p aram X_input: het invoergegevensframe. :p aram getransformeerd: het gegevensframe na transformatie. :retourneert: Het getransfoteerde gegevensframe met de oorspronkelijke index, maar gesorteerd zoals in X_input.

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

Parameters

X_input
Vereist
transformed
Vereist

fit

Pas het model aan met invoer X en y.

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

Parameters

X
Vereist

Voer X-gegevens in.

y
Vereist

Voer y-gegevens in.

forecast

Voer de prognose uit op het gegevensframe 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]

Parameters

X_pred
standaardwaarde: None

het voorspellingsgegevensframe waarin X_past en X_future op een tijd-aaneengesloten manier worden gecombineerd. Lege waarden in X_pred worden toegerekend.

y_pred
standaardwaarde: None

de doelwaarde waarin bepaalde waarden voor y_past en ontbrekende waarden voor Y_future worden gecombineerd. Als Geen worden de voorspellingen gedaan voor elke X_pred.

forecast_destination
<xref:pandas.Timestamp>
standaardwaarde: None

Forecast_destination: een tijdstempelwaarde. Prognoses worden helemaal tot aan de forecast_destination tijd gemaakt, voor alle granen. Woordenlijstinvoer { grain -> timestamp } wordt niet geaccepteerd. Als forecast_destination niet wordt gegeven, wordt dit als de laatste keer in X_pred voor elke korrel toegerekend.

ignore_data_errors
bool
standaardwaarde: False

Fouten in gebruikersgegevens negeren.

Retouren

Y_pred, waarbij het subframe dat overeenkomt met Y_future ingevuld met de respectieve prognoses. Ontbrekende waarden in Y_past worden ingevuld met behulp van imputer.

Retourtype

forecast_quantiles

Haal de voorspelling en kwantielen op uit de aangepaste pijplijn.

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

Parameters

X_pred
standaardwaarde: None

het voorspellingsgegevensframe waarin X_past en X_future op een tijd-aaneengesloten manier worden gecombineerd. Lege waarden in X_pred worden toegerekend.

y_pred
standaardwaarde: None

de doelwaarde waarin bepaalde waarden voor y_past en ontbrekende waarden voor Y_future worden gecombineerd. Als Geen worden de voorspellingen gedaan voor elke X_pred.

quantiles
float of list of <xref:floats>
standaardwaarde: None

De lijst met kwantielen waarop we een voorspelling willen doen.

forecast_destination
<xref:pandas.Timestamp>
standaardwaarde: None

Forecast_destination: een tijdstempelwaarde. Prognoses worden helemaal tot aan de forecast_destination tijd gemaakt, voor alle granen. Woordenlijstinvoer { grain -> timestamp } wordt niet geaccepteerd. Als forecast_destination niet wordt gegeven, wordt dit als de laatste keer in X_pred voor elke korrel toegerekend.

ignore_data_errors
bool
standaardwaarde: False

Fouten in gebruikersgegevens negeren.

Retouren

Een gegevensframe met de kolommen en voorspellingen die zijn gemaakt op aangevraagde kwantielen.

is_grain_dropped

Retourneer waar als de korrel wordt verwijderd.

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

Parameters

grain
Vereist

De korrel om te testen of het wordt verwijderd.

Retouren

Waar als de korrel wordt verwijderd.

preaggregate_data_set

De voorspellingsgegevensset aggregeren.

Opmerking: Deze methode garandeert niet dat de gegevensset wordt geaggregeerd. Dit gebeurt alleen als de gegevensset de gedupliceerde tijdstempels of niet-rasterdatums bevat. :p aram df: de gegevensset die moet worden samengevoegd. :p atam y: de doelwaarden. :p aram is_training_set: Indien waar, vertegenwoordigen de gegevens een trainingsset. :return: de geaggregeerde of intacte gegevensset als er geen aggregatie is vereist.

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

Parameters

df
Vereist
y
standaardwaarde: None
is_training_set
standaardwaarde: False

preprocess_pred_X_y

Preprocess voorspelling X en 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]]

Parameters

X_pred
standaardwaarde: None
y_pred
standaardwaarde: None
forecast_destination
standaardwaarde: None

rolling_evaluation

" Maak prognoses op basis van een voortschrijdende oorsprong van de opgegeven testset.

Elke iteratie maakt een prognose voor de volgende 'max_horizon'-perioden met betrekking tot de huidige oorsprong, waarna de oorsprong wordt vervroegd met de duur van de horizon. De voorspellingscontext voor elke prognose wordt zo ingesteld dat de prognose de werkelijke doelwaarden vóór de huidige oorsprongstijd gebruikt voor het samenstellen van vertragingsfuncties.

Deze functie retourneert een samengevoegd DataFrame van rolling forecasts die zijn gekoppeld aan de werkelijke waarden uit de testset.

Deze methode is afgeschaft en wordt in een toekomstige release verwijderd. Gebruik in plaats daarvan rolling_forecast().

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

Parameters

X_pred
Vereist

het voorspellingsgegevensframe waarin X_past en X_future op een tijd-aaneengesloten manier worden gecombineerd. Lege waarden in X_pred worden toegerekend.

y_pred
Vereist

de doelwaarde die overeenkomt met X_pred.

ignore_data_errors
standaardwaarde: False

Fouten in gebruikersgegevens negeren.

Retouren

Y_pred, waarbij het subframe dat overeenkomt met Y_future ingevuld met de respectieve prognoses. Ontbrekende waarden in Y_past worden ingevuld met behulp van imputer.

Retourtype

rolling_forecast

Maak prognoses op een rolling origin over een testset.

Elke iteratie maakt een prognose van het maximum aantal horizonperioden voor de toekomst met behulp van informatie tot aan de huidige oorsprong, waarna de oorsprong stapsgewijs verdergaat. De voorspellingscontext voor elke prognose wordt zo ingesteld dat de prognose de werkelijke doelwaarden vóór de huidige oorsprongstijd gebruikt voor het samenstellen van lookbackfuncties.

Deze functie retourneert een DataFrame met rolling prognoses die zijn gekoppeld aan de werkelijke waarden uit de testset. De kolommen in het geretourneerde gegevensframe zijn als volgt:

  • Kolommen met tijdreeks-id's (optioneel). Wanneer deze door de gebruiker wordt opgegeven, worden de opgegeven kolomnamen gebruikt.

  • De kolom Oorsprong voorspellen met de begintijd voor elke rij.

    Kolomnaam: opgeslagen als de objectlidvariabele forecast_origin_column_name.

  • Tijdkolom. De kolomnaam die door de gebruiker is opgegeven, wordt gebruikt.

  • Kolom Waarden voorspellen. Kolomnaam: opgeslagen als het objectlid forecast_column_name

  • Kolom werkelijke waarden. Kolomnaam: opgeslagen als het objectlid actual_column_name

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

Parameters

X_pred
<xref:pd.DataFrame>
Vereist

Frame voor voorspellingsgegevens

y_pred
<xref:np.ndarray>
Vereist

doelwaarden die overeenkomen met rijen in X_pred

step
int
standaardwaarde: 1

Het aantal perioden dat het prognosevenster in elke iteratie moet worden vervroegd.

ignore_data_errors
bool
standaardwaarde: False

Fouten in gebruikersgegevens negeren.

Retouren

Gegevensframe van doorlopende prognoses

Retourtype

<xref:pd.DataFrame>

short_grain_handling

Retourneer waar als de verwerking van korte of afwezige korrels is ingeschakeld voor het model.

short_grain_handling() -> bool

static_preaggregate_data_set

De voorspellingsgegevensset aggregeren.

Opmerking: Deze methode garandeert niet dat de gegevensset wordt geaggregeerd. Dit gebeurt alleen als de gegevensset de gedupliceerde tijdstempels of niet-rasterdatums bevat. :p aram ts_transformer: de tijdserie-tranformer die wordt gebruikt voor de training. :p aram time_column_name: naam van de tijdkolom. :p aram grain_column_names: lijst met namen van korrelkolommen. :p aram df: de gegevensset die moet worden samengevoegd. :p atam y: de doelwaarden. :p aram is_training_set: Indien waar, vertegenwoordigen de gegevens een trainingsset. :return: de geaggregeerde of intacte gegevensset als er geen aggregatie is vereist.

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]

Parameters

ts_transformer
Vereist
time_column_name
Vereist
grain_column_names
Vereist
df
Vereist
y
standaardwaarde: None
is_training_set
standaardwaarde: False

Kenmerken

actual_column_name

forecast_column_name

forecast_origin_column_name

grain_column_list

max_horizon

Retourneer het maximum aantal hiorizon dat in het model is gebruikt.

origin_col_name

Retourneer de naam van de oorspronkelijke kolom.

target_lags

Retourneer doelvertragingen, indien van toepassing.

target_rolling_window_size

Retourneer de grootte van het lopende venster.

time_column_name

Retourneer de naam van de tijdkolom.

user_target_column_name

y_max_dict

De woordenlijst retourneren met maximale doelwaarden op tijdreeks-id

y_min_dict

Retourneer de woordenlijst met minimale doelwaarden op tijdreeks-id

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.'