Klasse Beskrivelse¶
klasseARIMAX(data, formula, ar, ma, integ, target, family)¶
Autoregressive Integrated Moving Average Exogenous Variable Models (ARIMAX).
| Parameter | Type | Type | Beskrivelse |
|---|---|---|---|
| data | pd.DataFrame eller np.ndarray | Indeholder den univariate tidsserie | |
| formel | string | Patsy notation, der specificerer regressionen | |
| ar | int | Den antal autoregressive forsinkelser | |
| ma | int | Antallet af glidende gennemsnitsforsinkelser | |
| integ | int | Hvor mange gange dataene skal differentieres(standard: 0) | |
| target | string eller int | Hvilken kolonne i DataFrame/array der skal bruges. | |
| family | pf.Family instance | Den fordeling for tidsserien,f.eks. pf.Normal() |
Attributes
latent_variables¶
En pf.LatentVariables()-objekt, der indeholder oplysninger om modellens latente variabler, priorindstillinger, eventuelle tilpassede værdier, startværdier og andre oplysninger om latente variabler. Når en model er tilpasset, er det her, de latente variabler opdateres/lagres.Se dokumentationen om latente variabler for oplysninger om attributter i dette objekt samt metoder til at få adgang til oplysningerne om de latente variabler.
Metoder
adjust_prior(index, prior)¶
Regulerer prioriteterne for de latente variabler i modellen. De latente variabler og deres indekskan ses ved at udskrive latent_variables-attributten, der er knyttet til modelinstansen.
| Parameter | Type | Beskrivelse |
|---|---|---|
| index | int | Indeks for den latente variabel, der skal ændres |
| prior | pf.Family instance | Prior distribution, f.eks. pf.Normal() |
Returnerer: void – ændrer modellen latent_variables attribut
fit(method, **kwargs)¶
Optimerer latente variabler for modellen. Brugeren vælger en inferensmulighed, og metoden returnerer et resultatobjekt samt opdaterer modellens latent_variablesattribut.
| Parameter | Type | Description |
|---|---|---|
| metode | str | Inferensmulighed: e.f.eks. “M-H” eller “MLE” |
Se afsnittene Bayesiansk inferens og Klassisk inferens i dokumentationen for den fuldstændige liste over inferensmuligheder. Der kan indtastes valgfrie parametre, som er relevante for den valgte inferensmetode.
Returnerer: pf.Results-instans med oplysninger om de estimerede latente variabler
plot_fit(**kwargs)¶
Plotter modellens tilpasning i forhold til dataene. Valgfrie argumenter omfatter figsize,dimensionerne af den figur, der skal plottes.
Returnerer : void – viser et matplotlib-plot
plot_ppc(T, nsims)¶
Plotter et histogram for en efterfølgende prædiktiv kontrol med et diskrepansmål efter brugerens valg. Denne metode fungerer kun, hvis du har tilpasset ved hjælp af bayesiansk inferens.
| Parameter | Type | Type | Beskrivelse |
|---|---|---|---|
| T | funktion | Diskrepans, f.eks. np.mean eller np.max |
|
| nsims | int | Hvor mange simuleringer for PPC |
Returneringer: void – viser en matplotlib plot
plot_predict(h, oos_data, past_values, intervals, **kwargs)¶
Plotter forudsigelser af modellen sammen med intervaller.
| Parameter | Type | Beskrivelse |
|---|---|---|
| h | int | Hvor mange trin at forudsige fremad |
| oos_data | pd.DataFrame | Ekogene variabler i en ramme for h trin |
| past_values | int | Hvor mange tidligere datapunkter to plot |
| intervals | boolean | Hvorvidt der skal plottes intervaller eller ej |
For at være klar, oos_data-argumentet skal være et DataFrame i samme format som initialdataframe, der bruges til at initialisere modelinstansen. Årsagen er, at for at forudsige fremtidige værdier,skal du angive antagelser om eksogene variabler for fremtiden. Hvis du f.eks. forudsiger h trin fremad, vil metoden tage de h første rækker fra oos_data og tage de værdier for de eksogene variabler, som du bad om i patsy-formlen.
Optionelle argumenter omfatter figsize – dimensionerne af den figur, der skal plottes. Bemærk, at hvis du bruger Maximum Likelihood eller Variational Inference, vil de viste intervaller ikke afspejle usikkerheden ved latente variabler. Kun Metropolis-Hastings vil give dig fuldt ud Bayesianske forudsigelsesintervaller. Bayesianske intervaller med variational inferens vises ikke på grund af begrænsningen ved middelfeltinferens, der ikke tager højde for posteriore korrelationer.
Returnerer : void – viser et matplotlib-plot
plot_predict_is(h, fit_once, fit_method, **kwargs)¶
Plotter rullende forudsigelser i stikprøven for modellen. Det betyder, at brugeren lader som om, at den sidste underafdeling af data er out-of-sample, og prognoser efter hver periode og vurdererhvor godt de gjorde det. Brugeren kan vælge, om parametrene skal tilpasses én gang i begyndelsen eller for hvert tidstrin.
| Parameter | Type | Type | Beskrivelse |
|---|---|---|---|
| h | int | Hvor mange tidligere tidsskridt, der skal bruges | |
| fit_once | boolean | Hvorvidt der skal bruges én gang, eller hvert tidsskridt | |
| fit_method | str | Hvilken inferensmulighed, e.f.eks. ‘MLE’ |
Optionelle argumenter omfatter figsize – dimensionerne af den figur, der skal plottes. h er et int for, hvor mange tidligere trin, der skal simuleres ydeevne på.
Returnerer : void – viser et matplotlib plot
plot_sample(nsims, plot_data=True)¶
Plotter stikprøver fra modellens efterfølgende prædiktive tæthed. Denne metode fungerer kun, hvis du har tilpasset modellen ved hjælp af bayesiansk inferens.
| Parameter | Type | Type | Beskrivelse |
|---|---|---|---|
| nsims | int | Hvor mange prøver der skal trækkes | |
| plot_data | boolean | Hvorvidt de reelle data også skal plottes |
Returnerer : void – viser et matplotlib plot
plot_z(indices, figsize)¶
Returnerer et plot af de latente variabler og deres tilhørende usikkerhed.
| Parameter | Type | Beskrivelse |
|---|---|---|
| indices | int eller list | Hvilket latente variabelindekser der skal plottes |
| figsize | tuple | Størrelsen af matplotlib-figuren |
Returnerer : void – viser et matplotlib plot
ppc(T, nsims)¶
Returnerer en p-værdi for en efterfølgende prædiktiv kontrol. Denne metode virker kun, hvis du harfitted ved hjælp af bayesiansk inferens.
| Parameter | Type | Type | Beskrivelse |
|---|---|---|---|
| T | funktion | Diskrepans, f.eks. np.mean eller np.max |
|
| nsims | int | Hvor mange simuleringer for PPC |
Returneringer: int – p-værdien for diskrepanstesten
predict(h, oos_data, intervals=False)¶
Returnerer et DataFrame med modelprædiktioner.
| Parameter | Type | Beskrivelse |
|---|---|---|
| h | int | Hvor mange skridt skal der forudsiges fremad |
| oos_data | pd.DataFrame | Exogene variabler i en ramme for h trin |
| intervaller | boolean | Hvis der skal returneres forudsigelsesintervaller |
For at være helt klar skal oos_data-argumentet være en DataFrame i samme format som initialdataframe, der bruges til at initialisere modelinstansen. Årsagen er, at for at forudsige fremtidige værdier,skal du angive antagelser om eksogene variabler for fremtiden. Hvis du f.eks. forudsiger h trin fremad, vil metoden tage de 5 første rækker fra oos_data og tage værdierne for de eksogene variabler, som du har angivet som eksogene variabler i patsy-formlen.
Bemærk venligst, at hvis du bruger Maximum Likelihood eller Variational Inference, vil de viste intervaller ikke afspejle latent variabelusikkerhed. Kun Metropolis-Hastings vil give dig fuldt Bayesianske forudsigelsesintervaller. Bayesianske intervaller med variational inferens vises ikke på grund af begrænsningen ved middelfelt-inferens, idet der ikke tages hensyn til posteriore korrelationer.
Returnerer : pd.DataFrame – modellens forudsigelser
predict_is(h, fit_once, fit_method)¶
Returnerer DataFrame af rullende forudsigelser i stikprøven for modellen.
| Parameter | Type | Type | Beskrivelse |
|---|---|---|---|
| h | int | Hvor mange tidligere tidsskridt der skal bruges | |
| fit_once | boolean | Hvorvidt det skal passe én gang, eller hvert tidsskridt | |
| fit_method | str | Hvilken inferensmulighed, e.f.eks. ‘MLE’ |
Returnerer : pd.DataFrame – modelprædiktionerne
sample(nsims)¶
Returnerer np.ndarray af trækninger af dataene fra den efterfølgende prædiktive tæthed. Dennemetode fungerer kun, hvis du har tilpasset modellen ved hjælp af Bayesiansk inferens.
| Parameter | Type | Beskrivelse |
|---|---|---|
| nsims | int | Hvor mange posterior trækninger der skal tages |
Returnerer : np.ndarray – prøver fra den efterfølgende prædiktive tæthed.