Klassenbeschreibung¶
classARIMAX(data, formula, ar, ma, integ, target, family)¶
Autoregressive Integrated Moving Average Exogenous Variable Models (ARIMAX).
| Parameter | Typ | Beschreibung |
|---|---|---|
| Daten | pd.DataFrame oder np.ndarray | Enthält die univariate Zeitreihe |
| Formel | String | Patsy-Notation, die die Regression angibt |
| ar | int | Die Anzahl der autoregressiven Lags |
| ma | int | Die Anzahl der Lags des gleitenden Durchschnitts |
| integ | int | Wie oft werden die Daten differenziert (Standard: 0) |
| target | string oder int | Welche Spalte von DataFrame/Array verwendet werden soll. |
| family | pf.Family Instanz | Die Verteilung für die Zeitreihe, z.B. pf.Normal() |
Attributes
latent_variables¶
Ein pf.LatentVariables()-Objekt, das Informationen über die latenten Variablen des Modells, Prior-Einstellungen, alle angepassten Werte, Startwerte und andere Informationen über latente Variablen enthält. Wenn ein Modell angepasst wird, werden die latenten Variablen hier aktualisiert/gespeichert.
Methoden
adjust_prior(index, prior)
Anpassen der Prioren für die latenten Modellvariablen. Die latenten Variablen und ihre Indizes können durch Ausdrucken des Attributs latent_variables, das der Modellinstanz zugeordnet ist, angezeigt werden.
| Parameter | Typ | Beschreibung |
|---|---|---|
| Index | int | Index der zu ändernden latenten Variablen |
| prior | pf.Familieninstanz | Priorverteilung, z.B. pf.Normal() |
Returns: void – ändert das Modell latent_variablesAttribut
fit(Methode, **kwargs)¶
Schätzt latente Variablen für das Modell. Der Benutzer wählt eine Inferenzoption und die Methode gibt ein Ergebnisobjekt zurück und aktualisiert das latent_variablesAttribut des Modells.
| Parameter | Typ | Beschreibung |
|---|---|---|
| Methode | str | Inferenzoption: z.z. B. ‚M-H‘ oder ‚MLE‘ |
Die vollständige Liste der Inferenzoptionen finden Sie in den Abschnitten „Bayes’sche Inferenz“ und „Klassische Inferenz“ in der Dokumentation. Es können optionale Parameter eingegeben werden, die für den gewählten Inferenzmodus relevant sind.
Rückgabe: pf.Results-Instanz mit Informationen zu den geschätzten latenten Variablen
plot_fit(**kwargs)¶
Darstellung der Anpassung des Modells an die Daten. Optionale Argumente sind figsize, die Dimensionen der zu zeichnenden Abbildung.
Returns : void – zeigt einen matplotlib plot
plot_ppc(T, nsims)¶
Zeichnet ein Histogramm für eine posteriore Vorhersageprüfung mit einem Diskrepanzmaß nach Wahl des Benutzers. Diese Methode funktioniert nur, wenn Sie mit Bayes’scher Inferenz angepasst haben.
| Parameter | Typ | Beschreibung |
|---|---|---|
| T | Funktion | Diskrepanz, z.B. np.mean oder np.max |
| nsims | int | Wie viele Simulationen für den PPC |
Returns: void – zeigt ein matplotlib plot
plot_predict(h, oos_data, past_values, intervals, **kwargs)¶
Dargestellt werden die Vorhersagen des Modells, zusammen mit den Intervallen.
| Parameter | Typ | Beschreibung |
|---|---|---|
| h | int | Wie viele Schritte vorausgesagt werden |
| oos_data | pd.DataFrame | Exogene Variablen in einem Rahmen für h Schritte |
| past_values | int | Wie viele vergangene Datenpunkte zu plotten |
| Intervalle | boolean | Ob Intervalle geplottet werden sollen oder nicht |
Um deutlich zu sein, das Argument oos_data sollte ein DataFrame im gleichen Format sein wie der initialdataframe, der zur Initialisierung der Modellinstanz verwendet wird. Der Grund dafür ist, dass Sie zur Vorhersage zukünftiger Werte Annahmen über exogene Variablen für die Zukunft festlegen müssen. Wenn Sie beispielsweise h Schritte in die Zukunft vorhersagen, nimmt die Methode die ersten h Zeilen von oos_data und die Werte für die exogenen Variablen, die Sie in der Patsy-Formel angegeben haben.
Zu den optionalen Argumenten gehören figsize – die Abmessungen der zu zeichnenden Abbildung. Bitte beachten Sie, dass bei Verwendung von Maximum Likelihood oder Variational Inference die angezeigten Intervalle die Unsicherheit der latenten Variablen nicht widerspiegeln. Nur Metropolis-Hastings liefert Ihnen vollständig Bayes’sche Vorhersageintervalle. Bayes’sche Intervalle mit Variationsinferenz werden nicht angezeigt, da die Mean-Field-Inferenz die posterioren Korrelationen nicht berücksichtigt.
Returns : void – zeigt einen Matplotlib-Plot
plot_predict_is(h, fit_once, fit_method, **kwargs)¶
Darstellt rollierende Vorhersagen für das Modell in der Stichprobe. Das bedeutet, dass der Benutzer so tut, als ob der letzte Teilabschnitt der Daten außerhalb der Stichprobe liegt, und nach jeder Periode Prognosen erstellt und bewertet, wie gut sie waren. Der Benutzer kann wählen, ob die Parameter einmal zu Beginn oder bei jedem Zeitschritt angepasst werden sollen.
| Parameter | Typ | Beschreibung |
|---|---|---|
| h | int | Wie viele vorherige Zeitschritte verwendet werden sollen |
| fit_once | boolean | Ob einmal angepasst werden soll, oder jeden Zeitschritt |
| fit_method | str | Welche Inferenzoption, z.z. B. ‚MLE‘ |
Optionale Argumente sind figsize – die Dimensionen der Abbildung, die geplottet werden soll. h ist ein int, der angibt, auf wie vielen vorherigen Schritten die Leistung simuliert werden soll.
Returns : void – zeigt einen matplotlib plot
plot_sample(nsims, plot_data=True)¶
Geplottet Stichproben aus der posterioren Vorhersagedichte des Modells. Diese Methode funktioniert nur, wenn Sie das Modell mit Bayes’scher Inferenz angepasst haben.
| Parameter | Typ | Beschreibung |
|---|---|---|
| nsims | int | Wie viele Stichproben gezeichnet werden sollen |
| plot_data | boolean | Ob auch die realen Daten gezeichnet werden sollen |
Returns : void – zeigt einen matplotlib Plot
plot_z(indices, figsize)¶
Returnt einen Plot der latenten Variablen und ihrer zugehörigen Unsicherheit.
| Parameter | Typ | Beschreibung |
|---|---|---|
| indices | int oder list | Welche Indizes der latenten Variablen gezeichnet werden sollen |
| figsize | tuple | Größe der matplotlib-Figur |
Returns : void – zeigt einen matplotlib plot
ppc(T, nsims)¶
Returnt einen p-Wert für eine posteriore Vorhersageprüfung. Diese Methode funktioniert nur, wenn Sie mit Bayes’scher Inferenz gepasst haben.
| Parameter | Typ | Beschreibung |
|---|---|---|
| T | Funktion | Diskrepanz, z.B. np.mean oder np.max |
| nsims | int | Wie viele Simulationen für den PPC |
Returns: int – der p-Wert für den Diskrepanztest
predict(h, oos_data, intervals=False)¶
Returnt einen DataFrame der Modellvorhersagen.
| Parameter | Typ | Beschreibung |
|---|---|---|
| h | int | Wie viele Schritte vorausgesagt werden |
| oos_data | pd.DataFrame | Exogene Variablen in einem Frame für h Schritte |
| Intervalle | boolean | Ob Vorhersageintervalle zurückgegeben werden sollen |
Um es deutlich zu machen, sollte das Argument oos_data ein DataFrame im gleichen Format sein wie der initialdataframe, der zur Initialisierung der Modellinstanz verwendet wird. Der Grund dafür ist, dass Sie zur Vorhersage zukünftiger Werte Annahmen über exogene Variablen für die Zukunft festlegen müssen. Wenn Sie beispielsweise h Schritte in die Zukunft vorhersagen, nimmt die Methode die ersten 5 Zeilen von oos_data und die Werte für die exogenen Variablen, die Sie in der Patsy-Formel als exogene Variablen angegeben haben.
Bitte beachten Sie, dass die angezeigten Intervalle nicht die Unsicherheit der latenten Variablen widerspiegeln, wenn Sie Maximum Likelihood oder Variational Inference verwenden. Nur mit Metropolis-Hastings erhalten Sie vollständig bayesianische Vorhersageintervalle. Bayes’sche Intervalle mit Variationsinferenz werden nicht angezeigt, weil die Mean-Field-Inferenz die posterioren Korrelationen nicht berücksichtigt.
Returns : pd.DataFrame – die Modellvorhersagen
predict_is(h, fit_once, fit_method)¶
Returns DataFrame der rollierenden Vorhersagen für das Modell in der Stichprobe.
| Parameter | Typ | Beschreibung |
|---|---|---|
| h | int | Wie viele vorherige Zeitschritte verwendet werden sollen |
| fit_once | boolean | Ob einmal angepasst werden soll, oder jeden Zeitschritt |
| fit_method | str | Welche Inferenzoption, z.z.B. ‚MLE‘ |
Returns : pd.DataFrame – die Modellvorhersagen
sample(nsims)¶
Returns np.ndarray of draws of the data from the posterior predictive density. Diese Methode funktioniert nur, wenn Sie das Modell mit Bayes’scher Inferenz angepasst haben.
| Parameter | Typ | Beschreibung |
|---|---|---|
| nsims | int | Wie viele posteriore Ziehungen zu nehmen sind |
Returns : np.ndarray – Stichproben aus der posterioren prädiktiven Dichte