Luokan kuvaus¶
luokkaARIMAX(data, formula, ar, ma, integ, target, family)¶
Autoregressiiviset integroitujen liukuvien keskiarvojen eksogeenisten muuttujien mallit (ARIMAX).
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| data | pd.DataFrame tai np.ndarray | Sisältää yksimuuttujaisen aikasarjan |
| formula | string | Patsy-merkintätapa, joka määrittelee regression |
| ar | int | Dr. autoregressiivisten viiveiden määrä |
| ma | int | Liukuvan keskiarvon viiveiden määrä |
| integ | int | Miten monta kertaa aineisto erotetaan(oletus: 0) |
| target | string tai int | Mitä DataFramen/array:n saraketta käytetään. |
| family | pf.Family instance | Aikasarjan jakauma,esim pf.Normal() |
Attributes
latent_variables¶
A pf.LatentVariables()-olio, joka sisältää tietoa mallin latenttimuuttujista,ennakkoasetuksista. mahdollisista sovitetuista arvoista, lähtöarvoista ja muista latenttimuuttujatiedoista. Kun mallia sovitetaan, latenttimuuttujat päivitetään/tallennetaan tähän.Katso latenttimuuttujien dokumentaatiosta tietoa tämän objektin sisällä olevista attribuuteista sekä metodeista, joilla latenttimuuttujatietoja voidaan käyttää.
Methods
adjust_prior(index, prior)¶
Säätää mallin latenttimuuttujien priorit. Latentteja muuttujia ja niiden indeksejävoidaan tarkastella tulostamalla malliinstanssiin liitetty latent_variables-attribuutti.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| indeksi | int | Muutettavan latenttimuuttujan indeksi |
| prior | pf.Family instance | Prior-jakauma, esim. pf.Normal() |
Returns: void – muuttaa mallia latent_variables attribuutti
fit(metodi, **kwargs)¶
Estimoi mallin latentit muuttujat. Käyttäjä valitsee päättelyvaihtoehdon ja metodi palauttaa tulosolion sekä päivittää mallin latent_variablesattribuutin.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| metodi | str | Valintavaihtoehdon päättelyvaihtoehto: e.esim. ’M-H’ tai ’MLE’ |
Katso Bayesin päättely ja Klassinen päättely -osiot dokumentaatiossa saadaksesi täyden luettelon päättelyvaihtoehdoista. Vaihtoehtoisia parametreja voidaan syöttää, jotka ovat merkityksellisiä valitun päättelytavan kannalta.
Palauttaa: pf.Results-instanssi, jossa on estimoitujen latenttien muuttujien tiedot
plot_fit(**kwargs)¶
Kuvioi mallin sopivuuden dataa vasten. Valinnaisia argumentteja ovat figsize,piirrettävän kuvion mitat.
Returns : void – näyttää matplotlib plot
plot_ppc(T, nsims)¶
Piirretään jälkikäteisen ennustetarkastelun histogrammi käyttäjän valitsemalla poikkeamamitalla. Tämä menetelmä toimii vain, jos olet sovittanut käyttäen Bayesin päättelyä.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| T | funktio | Discrepancy, esim. np.mean tai np.max |
| nsims | int | Miten monta simulointia PPC |
Palauttaa:
plot_predict(h, oos_data, past_values, intervals, **kwargs)¶
Kuvailee mallin ennusteita sekä intervalleja.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| h | int | montako askeleen verran ennustetaan eteenpäin |
| oos_data | pd.DataFrame | Exogeeniset muuttujat kehyksessä h askeleelle |
| past_values | int | Kuinka monta aiempaa datapistettä piirretään |
| intervals | boolean | Piirretäänkö intervallit vai ei |
Ymmärrettävästi, oos_data-argumentin tulisi olla DataFrame samassa muodossa kuin malliinstanssin alustamiseen käytetty initialdataframe. Syynä on se, että tulevien arvojen ennustamiseksi on määriteltävä oletuksia tulevaisuuden eksogeenisistä muuttujista. Jos esimerkiksi ennustat h askelta eteenpäin, menetelmä ottaa oos_datasta h ensimmäistä riviä ja ottaa eksogeenisten muuttujien arvot, jotka pyysit patsy-kaavassa.
Vaihtoehtoiset argumentit ovat figsize – piirrettävän kuvion mitat. Huomaa, että jos käytät Maximum Likelihood- tai Variational Inference -menetelmää, esitetyt intervalliarvot eivät heijasta latentin muuttujan epävarmuutta. Ainoastaan Metropolis-Hastings antaa täysin Bayes-ennustevälit. Bayesiläisiä intervalleja variationaalisella päättelyllä ei näytetä, koska keskikentän päättelyn rajoitus ei ota huomioon posteriorisia korrelaatioita.
Returns : void – näyttää matplotlib plot
plot_predict_is(h, fit_once, fit_method, **kwargs)¶
Plottaa otoksen sisäiset rullaavat ennusteet mallille. Tämä tarkoittaa, että käyttäjä teeskentelee, että alast datan osajakso on otoksen ulkopuolinen, ja ennustaa jokaisen jakson jälkeen ja arvioi, kuinka hyvin ne onnistuivat. Käyttäjä voi valita, sovitetaanko parametrit kerran alussa vai joka aika-askel.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| h | int | Miten monta edellistä aika-askelta käytetään |
| fit_once | boolean | Pitäisikö sovittaa kerran, vai joka aika-askel |
| fit_method | str | Mikä päättelyvaihtoehto, esim.g. ’MLE’ |
Vaihtoehtoisia argumentteja ovat figsize – piirrettävän kuvion mitat. h on int, joka kertoo, kuinka monella edellisellä askeleella simuloidaan suorituskykyä.
Returns : void – näyttää matplotlib plot
plot_sample(nsims, plot_data=True)¶
Plottaa otokset mallin posteriorisesta ennustetiheydestä. Tämä menetelmä toimii vainjos sovitit mallin Bayesin päättelyä käyttäen.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| nsims | int | Miten monta? näytteitä piirretään |
| plot_data | boolean | Piirretäänkö myös reaalidata |
Palauttaa : void – näyttää matplotlib plot
plot_z(indices, figsize)¶
Palauttaa piirtokuvan latenteista muuttujista ja niihin liittyvästä epävarmuudesta.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| indeksit | int tai lista | mikä? latentin muuttujan indeksit piirretään |
| figsize | tuple | Matplotlibin kuvion koko |
Palauttaa : void – näyttää matplotlib plot
ppc(T, nsims)¶
Palauttaa p-arvon posteriorista ennustetarkastelua varten. Tämä menetelmä toimii vain, jos oletfitannut käyttäen Bayesin päättelyä.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| T | funktio | Diskrepansio, esim. np.mean tai np.max |
| nsims | int | Miten monta simulointia PPC |
Palauttaa:
Palauttaa DataFrame mallin ennusteista: int – p-arvo poikkeavuustestiä varten
predict(h, oos_data, intervals=False)¶
Palauttaa DataFrame mallin ennusteista.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| h | int | Monella askeleella ennustetaan eteenpäin |
| oos_data | pd.DataFrame | Exogeeniset muuttujat kehyksessä h askeleelle |
| intervals | boolean | Palautetaanko ennustusväli |
Yksiselitteisesti sanottuna oos_data-argumentin tulisi olla DataFrame samassa formaatissa kuin mallin instanssin initialisoinnissa käytetty initialdataframe. Syynä on se, että tulevien arvojen ennustamiseksi on määriteltävä oletuksia tulevaisuuden eksogeenisistä muuttujista. Jos esimerkiksi ennustat h askelta eteenpäin, menetelmä ottaa oos_data-tietueesta 5 ensimmäistä riviä ja ottaa eksogeenisten muuttujien arvot, jotka määrittelit eksogeenisiksi muuttujiksi patsy-kaavassa.
Huomaa, että jos käytät Maximum Likelihood- tai Variational Inference -menetelmää, näytetyt aikavälien välit eivät kuvasta latentin muuttujan epävarmuutta. Ainoastaan Metropolis-Hastings antaa sinulle täysinBayesin ennustevälit. Variationaalisella päättelyllä käytettyjä Bayesin välejä ei näytetä, koska keskikentän päättelyn rajoituksena on, että se ei ota huomioon posteriorisia korrelaatioita.
Palauttaa : pd.DataFrame – mallin ennusteet
predict_is(h, fit_once, fit_method)¶
Palauttaa DataFrame:n mallin otoksen sisäisistä rullaavista ennusteista.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| h | int | Miten monta edellistä aika-askelta käytetään |
| fit_once | boolean | Voidaanko sovittaa kerran, vai joka aika-askel |
| fit_method | str | Mikä päättelyvaihtoehto, esim.esim. ’MLE’ |
Palauttaa : pd.DataFrame – mallin ennusteet
sample(nsims)¶
Palauttaa np.ndarray datan piirtämisestä posteriorisesta ennustetiheydestä. Tämämenetelmä toimii vain, jos olet sovittanut mallin Bayesin päättelyä käyttäen.
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| nsims | int | Kuinka monta posteriorista piirtoa otetaan |
Palauttaa : np.ndarray – näytteitä posteriorisesta ennustetiheydestä.