osztály Leírás¶
classARIMAX
(data, formula, ar, ma, integ, target, family)¶
Autoregressive Integrated Moving Average Exogenous Variable Models (ARIMAX).
Parameter | Type | Description |
---|---|---|
data | pd.DataFrame vagy np.ndarray | Tartalmazza az egyváltozós idősorokat |
formula | string | Patsy jelölés, amely meghatározza a regressziót |
ar | int | Az. autoregresszív késleltetések száma |
ma | int | A mozgóátlag késleltetések száma |
integ | int | Hányszor kell differenciálni az adatokat(default: |
target | string vagy int | A DataFrame/array melyik oszlopát használja. |
family | pf.Family instance | Az idősor eloszlása,pl. pf.Normal() |
Attributes
latent_variables
¶
A pf.LatentVariables() objektum, amely információkat tartalmaz a modell látens változóiról,előzetes beállításokról. minden illesztett értékről, kiindulási értékekről és egyéb látens változóinformációkról. A modell illesztésekor a látens változókat itt frissítik/tárolják.Az ezen objektumon belüli attribútumokról, valamint a látens változó információk elérésének módszereiről lásd a Latent Variables dokumentációját.
Methods
adjust_prior
(index, prior)¶
A modell látens változóinak priorait állítja be. A látens változók és indexeik a modellpéldányhoz csatolt latent_variables
attribútum kinyomtatásával tekinthetők meg.
Parameter | Type | Description |
---|---|---|
index | int | A módosítandó látens változó indexe |
prior | pf.Family instance | Prior eloszlás, pl. pf.Normal() |
Returns: void – megváltoztatja a modellt latent_variables
attribútum
fit
(method, **kwargs)¶
Esztimálja a modell látens változóit. A felhasználó kiválaszt egy következtetési lehetőséget, és a módszer visszaad egy eredményobjektumot, valamint frissíti a modell latent_variables
attribútumát.
Parameter | Type | Description |
---|---|---|
method | str | Inference option: e.pl. ‘M-H’ vagy ‘MLE’ |
A következtetési opciók teljes listáját lásd a dokumentáció Bayesi következtetés és klasszikus következtetés szakaszaiban. Opcionális paraméterek adhatók meg, amelyek a kiválasztott következtetési módra vonatkoznak.
Visszaadja: pf.Results példány a becsült látens változókra vonatkozó információkkal
plot_fit
(**kwargs)¶
A modell illeszkedését ábrázolja az adatokhoz képest. A választható argumentumok közé tartozik a figsize,az ábrázolandó ábra méretei.
Returns : void – egy matplotlib plot
plot_ppc
(T, nsims)¶
Plotál egy hisztogramot az utólagos prediktív ellenőrzéshez egy, a felhasználó által választott diszkrepancia mértékkel. Ez a módszer csak akkor működik, ha Bayesi következtetéssel illesztettünk.
Parameter | Type | Description |
---|---|---|
T | function | Discrepancy, pl. np.mean vagy np.max |
nsims | int | Hány szimuláció a PPC |
visszatér:
plot_predict
(h, oos_data, past_values, intervals, **kwargs)¶
A modell előrejelzéseit ábrázolja az intervallumokkal együtt.
Parameter | Type | Description |
---|---|---|
h | int | Hány lépéssel előre jósol |
oos_data | pd.DataFrame | Exogén változók egy keretben h lépésekhez |
past_values | int | Hány múltbeli adatpontra to plot |
intervals | boolean | Whether to plot intervals or not |
Hogy egyértelmű legyen, az oos_data argumentumnak a modellpéldány inicializálásához használt initialdataframe formátumú DataFrame-nek kell lennie. Ennek az az oka, hogy a jövőbeli értékek előrejelzéséhezmeg kell adnia a jövőre vonatkozó exogén változókra vonatkozó feltételezéseket. Például, ha h lépést jósol előre, a módszer az oos_data h első sorát veszi az oos_data-ból, és a patsy-képletben kért exogén változók értékeit veszi.
Az opcionális argumentumok közé tartozik a figsize – az ábrázolandó ábra méretei. Kérjük, vegye figyelembe, hogy ha Maximum Likelihood vagy Variációs következtetést használ, a megjelenített intervallumok nem tükrözik a látens változó bizonytalanságát. Csak a Metropolis-Hastings ad teljesen Bayes-előrejelzési intervallumokat. Bayesi intervallumok variációs következtetéssel nem jelennek meg, mert a középmező következtetés korlátja, hogy nem veszi figyelembe az utólagos korrelációkat.
Returns : void – shows a matplotlib plot
plot_predict_is
(h, fit_once, fit_method, **kwargs)¶
Plots in-sample rolling predictions for the model. Ez azt jelenti, hogy a felhasználó úgy tesz, mintha az adatok utolsó alszakasza mintavételen kívüli lenne, és minden egyes időszak után előrejelzéseket készít, és értékeli, hogy milyen jól sikerült. A felhasználó eldöntheti, hogy a paramétereket egyszer, az elején vagy minden egyes időlépésnél illeszti-e be.
Parameter | Type | Description |
---|---|---|
h | int | Hány korábbi időlépést kell használni |
fit_once | boolean | Egyszeri illesztés, vagy minden időlépésben |
fit_method | str | Melyik következtetési lehetőség, e.g. ‘MLE’ |
Az opcionális argumentumok: figsize – az ábrázolandó ábra méretei. h egy int, amely megadja, hogy hány korábbi lépésre szimulálja a teljesítményt.
Returns : void – egy matplotlib plot
plot_sample
(nsims, plot_data=True)¶
A modell poszterior prediktív sűrűségéből vett mintákat ábrázolja. Ez a módszer csak akkor működik,ha a modellt Bayesi következtetéssel illesztettük be.
Parameter | Type | Description |
---|---|---|
nsims | int | How many. mintákat kell rajzolni |
plot_data | boolean | A valós adatokat is ki kell-e rajzolni |
Visszaadja : void – megmutatja a matplotlib plot
plot_z
(indexek, figsize)¶
A látens változók és a hozzájuk tartozó bizonytalanságok plotját adja vissza.
Parameter | Type | Description |
---|---|---|
indices | int vagy list | melyik. látens változó indexeit kell ábrázolni |
figsize | tuple | A matplotlib ábra mérete |
Visszaadja : void – egy matplotlib plot
ppc
(T, nsims)¶
Mutat egy p-értéket az utólagos prediktív ellenőrzéshez. Ez a módszer csak akkor működik, ha Bayesi következtetéssel illesztettünk.
Parameter | Type | Description |
---|---|---|
T | function | Discrepancy, Pl. np.mean vagy np.max |
nsims | int | Hány szimuláció a PPC |
visszatér:
Visszaad egy DataFrame-ot a modell előrejelzéseiből: int – a diszkrepancia teszt p-értéke
predict
(h, oos_data, intervals=False)¶
Visszaad egy DataFrame-ot a modell előrejelzéseiből.
Parameter | Type | Description |
---|---|---|
h | int | Hány lépést kell előre jelezni |
oos_data | pd.DataFrame | Exogén változók egy keretben h lépésekhez |
intervals | boolean | Az előrejelzési intervallumok visszaadása |
Az oos_data argumentumnak egy olyan formátumú DataFrame-nek kell lennie, mint az initialdataframe, amelyet a modellpélda inicializálásához használtunk. Ennek az az oka, hogy a jövőbeli értékek előrejelzéséhezmeg kell adnia a jövőre vonatkozó exogén változókra vonatkozó feltételezéseket. Például, ha h lépést jósol előre, a módszer az 5 első sort veszi az oos_data-ból, és a patsy-képletben exogén változóként megadott exogén változók értékeit veszi.
Kérjük, vegye figyelembe, hogy ha Maximum Likelihood vagy Variational Inference-t használ, a megjelenített intervallumok nem tükrözik a látens változó bizonytalanságát. Csak a Metropolis-Hastings ad teljesenBayesian előrejelzési intervallumokat. A variációs következtetéssel használt Bayes-intervallumok nem jelennek meg, mivel a középmező következtetés korlátja, hogy nem veszi figyelembe az utólagos korrelációkat.
Returns : pd.DataFrame – the model predictions
predict_is
(h, fit_once, fit_method)¶
Returns DataFrame of in-sample rolling predictions for the model.
Parameter | Type | Description |
---|---|---|
h | int | Hány korábbi időlépést kell használni |
fit_once | boolean | Egyszeri illesztés, vagy minden időlépésben |
fit_method | str | Melyik következtetési lehetőség, e.pl. ‘MLE’ |
Returns : pd.DataFrame – a modell előrejelzései
sample
(nsims)¶
Returns np.ndarray of draws of the data from the posterior predictive density. Ez amódszer csak akkor működik, ha a modellt Bayesi következtetéssel illesztettük.
Parameter | Type | Description |
---|---|---|
nsims | int | How many posterior draws to take |
Returns : np.ndarray – minták a poszterior prediktív sűrűségből.