Třída Popis¶
třídaARIMAX(data, formula, ar, ma, integ, target, family)¶
Autoregresivní integrované modely klouzavých průměrů exogenních proměnných (ARIMAX).
| Parametr | Typ | Popis |
|---|---|---|
| data | pd.DataFrame nebo np.ndarray | Obsahuje jednorozměrnou časovou řadu |
| formula | řetězec | Patsyho notace specifikující regresi |
| ar | int | . počet autoregresních zpoždění |
| ma | int | Počet zpoždění klouzavého průměru |
| integ | int | Kolikrát se mají data diferencovat(výchozí: |
| cíl | řetězec nebo int | Který sloupec DataFrame/ pole použít. |
| rodina | pf.instance rodiny | Rozdělení pro časovou řadu,např pf.Normal() |
Atributy
latent_variables¶
A pf.LatentVariables() objekt obsahující informace o latentních proměnných modelu,nastavení prior. případné fitované hodnoty, počáteční hodnoty a další informace o latentních proměnných. Když je model vybaven, je to místo, kde jsou latentní proměnné aktualizovány/ukládány.Informace o atributech v tomto objektu a také o metodách pro přístup k informacím o latentních proměnných naleznete v dokumentaci k Latentním proměnným.
Metody
adjust_prior(index, prior)¶
Nastavuje priory pro latentní proměnné modelu. Latentní proměnné a jejich indexy lze zobrazit vypsáním atributu latent_variables připojeného k instanci modelu.
| Parametr | Typ | Popis |
|---|---|---|
| index | int | Index latentní proměnné, která se má změnit |
| priorita | pf.Rodinná instance | Prioritní rozdělení, například pf.Normal() |
Vrací: void – změní model latent_variables atribut
fit(method, **kwargs)¶
Odhadne latentní proměnné pro model. Uživatel zvolí možnost inference a metoda vrátí objekt výsledků a také aktualizuje latent_variablesatribut modelu.
| Parametr | Typ | Popis |
|---|---|---|
| metoda | str | Možnost inference: e.např. ‚M-H‘ nebo ‚MLE‘ |
Plný seznam inferenčních voleb viz části dokumentace Bayesovská inference a Klasická inference. Lze zadat nepovinné parametry, které jsou relevantnípro konkrétní zvolený způsob inference.
Vrací: instanci pf.Results s informacemi pro odhadované latentní proměnné
plot_fit(**kwargs)¶
Vynese shodu modelu s daty. Mezi nepovinné argumenty patří figsize,rozměry obrázku, který se má vykreslit.
Vrací : void – zobrazí matplotlib plot
plot_ppc(T, nsims)¶
Vykreslí histogram pro kontrolu posteriorní predikce s mírou diskrepance, kterou si uživatel zvolí. Tato metoda funguje pouze v případě, že jste provedli fitování pomocí Bayesovské inference.
| Parametr | Typ | Popis |
|---|---|---|
| T | funkce | Diskrepance, např. np.mean nebo np.max |
| nsims | int | Kolik simulací pro PPC |
Vrátí: void – zobrazí matplotlib plot
plot_predict(h, oos_data, past_values, intervals, **kwargs)¶
Zobrazí předpovědi modelu spolu s intervaly.
| Parametr | Typ | Popis |
|---|---|---|
| h | int | Kolik kroků dopředu předpovídá |
| oos_data | pd.DataFrame | Exogenní proměnné v rámci pro h kroků |
| past_values | int | Kolik minulých datových bodů. vykreslit |
| intervaly | boolean | Zda vykreslit intervaly či nikoliv |
Pro přehlednost, argument oos_data by měl být DataFrame ve stejném formátu jako initialdataframe použitý pro inicializaci instance modelu. Důvodem je, že pro předpovídání budoucích hodnotje třeba zadat předpoklady o exogenních proměnných pro budoucnost. Pokud například předpovídáte h kroků dopředu, metoda vezme h prvních řádků z oos_data a vezme hodnoty exogenních proměnných, které jste požadovali ve vzorci patsy.
Mezi volitelné argumenty patří figsize – rozměry obrázku, který se má vykreslit. Upozorňujeme, že pokud použijete maximální věrohodnost nebo variační inferenci, zobrazené intervaly nebudou odrážet nejistotu latentních proměnných. Pouze Metropolis-Hastings vám poskytne plně bayesovské intervaly předpovědí. Bayesovské intervaly s variační inferencí nejsou zobrazeny kvůli omezení inference středního pole spočívajícímu v nezohlednění posteriorních korelací.
Vrací : void – zobrazí matplotlib plot
plot_predict_is(h, fit_once, fit_method, **kwargs)¶
Vytvoří in-sample rolling predictions pro daný model. To znamená, že uživatel předstírá, že poslední podsekce dat je mimo vzorek, a předpovídá po každém období a hodnotí, jak dobře si vedl. Uživatel si může zvolit, zda má parametry fitovat jednou na začátkunebo v každém časovém kroku.
| Parametr | Typ | Popis |
|---|---|---|
| h | int | Kolik předchozích časových kroků se má použít |
| fit_once | boolean | Zda se má fitovat jednou, nebo každý časový krok |
| fit_method | str | Která možnost inference, např.g. ‚MLE‘ |
Mezi volitelné argumenty patří figsize – rozměry obrázku, který se má vykreslit. h je int, na kolika předchozích krocích se má simulovat výkonnost.
Vrací : void – zobrazí matplotlib plot
plot_sample(nsims, plot_data=True)¶
Vykreslí vzorky z posteriorní predikční hustoty modelu. Tato metoda funguje pouze tehdy, pokud jste model vybavili pomocí bayesovské inference.
| Parametr | Typ | Popis |
|---|---|---|
| nsims | int | Kolikrát vzorků vykreslit |
| plot_data | boolean | Zda vykreslit i reálná data |
Vrací : void – zobrazí matplotlib plot
plot_z(indices, figsize)¶
Vrátí graf latentních proměnných a jejich přidružené nejistoty.
| Parametr | Typ | Popis |
|---|---|---|
| indices | int nebo seznam | Který indexy latentních proměnných pro vykreslení |
| figsize | tuple | Velikost matplotlib figure |
Vrací : void – zobrazí matplotlib plot
ppc(T, nsims)¶
Vrátí p-hodnotu pro kontrolu posteriorní predikce. Tato metoda funguje pouze v případě, že jste provedli fitting pomocí Bayesovské inference.
| Parametr | Typ | Popis |
|---|---|---|
| T | funkce | Diskrepance, např. np.mean nebo np.max |
| nsims | int | Kolik simulací pro PPC |
Vrátí: int – p-hodnota pro test diskrepance
predict(h, oos_data, intervals=False)¶
Vrátí DataFrame modelových předpovědí.
| Parametr | Typ | Popis |
|---|---|---|
| h | int | Kolik kroků dopředu se má předpovědět |
| oos_data | pd.DataFrame | Exogenní proměnné v rámci pro h kroků |
| intervaly | boolean | Zda vrátit intervaly predikce |
Aby bylo jasné, argument oos_data by měl být DataFrame ve stejném formátu jako initialdataframe použitý pro inicializaci instance modelu. Důvodem je, že pro předpovídání budoucích hodnotje třeba zadat předpoklady o exogenních proměnných pro budoucnost. Pokud například předpovídáte h kroků dopředu, metoda vezme prvních 5 řádků z oos_data a vezme hodnoty exogenních proměnných, které jste zadali jako exogenní proměnné ve vzorci patsy.
Upozorňujeme, že pokud použijete maximální věrohodnost nebo variační odvozování, zobrazené intervaly nebudou odrážet nejistotu latentních proměnných. Pouze Metropolis-Hastings vám poskytne plněBayesovské intervaly předpovědí. Bayesovské intervaly s variační inferencí se nezobrazíz důvodu omezení inference středního pole spočívajícího v nezohlednění posteriorních korelací.
Vrací : pd.DataFrame – predikce modelu
predict_is(h, fit_once, fit_method)¶
Vrací DataFrame klouzavých predikcí ve vzorku pro model.
| Parametr | Typ | Popis |
|---|---|---|
| h | int | Kolik předchozích časových kroků se má použít |
| fit_once | boolean | Zda se má fitovat jednou, nebo každý časový krok |
| fit_method | str | Která možnost inference, např.Např. ‚MLE‘ |
Vrací : pd.DataFrame – predikce modelu
sample(nsims)¶
Vrací np.ndarray tahů dat z posteriorní predikční hustoty. Tatometoda funguje pouze v případě, že jste model vybavili pomocí bayesovské inference.
| Parametr | Typ | Popis |
|---|---|---|
| nsims | int | Kolik posteriorních tahů se má provést |
Vrací : np.ndarray – vzorky z posteriorní prediktivní hustoty
.