ARIMAX modellen¶

Klasse Beschrijving¶

klasseARIMAX(data, formule, ar, ma, integ, doel, familie)¶

Autoregressief Geïntegreerd Bewegend Gemiddelde Exogene Variabele Modellen (ARIMAX).

Parameter	Type	Description
data	pd.DataFrame of np.ndarray	Bevat de univariate tijdreeks
formula	string	Patsy-notatie die de regressie specificeert
ar	int	Het aantal autoregressieve vertragingen
ma	int	Het aantal voortschrijdend gemiddelde vertragingen
integ	int	Hoe vaak de gegevens moeten worden verschilt (standaard: 0)
target	string of int	Welke kolom van DataFrame/array te gebruiken.
family	pf.Family instance	De verdeling voor de tijdreeks, bijv. pf.Normal()

Attributes

latent_variables¶

Een pf.LatentVariables() object dat informatie bevat over de latente variabelen van het model, de voorafgaande instellingen, de gepaste waarden, de beginwaarden en andere informatie over de latente variabelen. Zie de documentatie over Latente variabelen voor informatie over attributen in dit object, evenals methoden om toegang te krijgen tot de informatie over latente variabelen.

Methods

adjust_prior(index, prior)¶

Past de priors voor de latente variabelen van het model aan. De latente variabelen en hun indices kunnen worden bekeken door het latent_variables-attribuut af te drukken dat aan de modelinstantie is gekoppeld.

Parameter	Type	Beschrijving
index	int	Index van de latente variabele die moet worden gewijzigd
prior	pf.Family instance	Prior verdeling, bijv. pf.Normal()

Returns: void – wijzigt het model latent_variables attribute

fit(method, **kwargs)¶

Bepaalt latente variabelen voor het model. De gebruiker kiest een inferentie-optie en de methode geeft een resultaatobject terug, evenals een update van het latent_variablesattribuut van het model.

Parameter	Type	Beschrijving
methode	str	Inferentie-optie: bijv.b. ‘M-H’ of ‘MLE’

Zie de secties Bayesiaanse gevolgtrekking en Klassieke gevolgtrekking in de documentatie voor de volledige lijst van inferentieopties. Er kunnen optionele parameters worden ingevoerd die relevant zijn voor de gekozen wijze van inferentie.

Retourneert: pf.Results instantie met informatie voor de geschatte latente variabelen

plot_fit(**kwargs)¶

Presenteert de fit van het model tegen de gegevens. Optionele argumenten zijn figsize, de afmetingen van de figuur om te plotten.

Returns : void – toont een matplotlib plot

plot_ppc(T, nsims)¶

Platteert een histogram voor een posterior predictieve controle met een discrepantiemaat naar keuze van de gebruiker. Deze methode werkt alleen als u met Bayesiaanse inferentie hebt gepast.

Parameter	Type	Beschrijving
T	functie	Discrepantie, bijv. np.mean of np.max
nsims	int	Hoeveel simulaties voor de PPC

Ret resultaat: void – toont een matplotlib plot

plot_predict(h, oos_data, past_values, intervals, **kwargs)¶

Plots voorspellingen van het model, samen met intervallen.

Parameter	Type	Beschrijving
h	int	Hoeveel stappen om vooruit te voorspellen
oos_data	pd.DataFrame	Exogene variabelen in een frame voor h stappen
past_values	int	Hoeveel past datapoints om te plotten
intervals	boolean	Wheels to plot intervals or not

Om duidelijk te zijn, het argument oos_data moet een DataFrame zijn in hetzelfde formaat als het initialdataframe dat wordt gebruikt om de modelinstantie te initialiseren. De reden hiervoor is dat u, om toekomstige waarden te voorspellen, aannames over exogene variabelen voor de toekomst moet specificeren. Als u bijvoorbeeld h stappen vooruit voorspelt, zal de methode de eerste rijen h van oos_data nemen en de waarden voor de exogene variabelen die u in de patsy-formule hebt gevraagd.

Optionele argumenten zijn figsize – de afmetingen van de te plotten figuur. Merk op dat als u Maximum Likelihood of Variational Inference gebruikt, de getoonde intervallen de latente variabelenonzekerheid niet weergeven. Alleen Metropolis-Hastings geeft u volledig Bayesiaanse voorspellingsintervallen. Bayesiaanse intervallen met variational inference worden niet getoond vanwege de beperking van mean-field inference in het niet verantwoorden van posterior correlaties.

Returns : void – toont een matplotlib plot

plot_predict_is(h, fit_once, fit_method, **kwargs)¶

Plots in-sample rolling voorspellingen voor het model. Dit betekent dat de gebruiker doet alsof een laatste subsectie van de gegevens out-of-sample is, en na elke periode voorspellingen doet en beoordeelt hoe goed ze het deden. De gebruiker kan kiezen of de parameters eenmalig aan het begin of elke tijdstap moeten worden aangepast.

Parameter	Type	Beschrijving
h	int	Hoeveel voorgaande tijdstappen te gebruiken
fit_once	boolean	Wheelt u in op één keer passen, of elke tijdstap
fit_method	str	Welke inferentie-optie, bijv.b. ‘MLE’

Optionele argumenten zijn figsize – de afmetingen van de figuur om te plotten. h is een int van hoeveel vorige stappen om de prestaties te simuleren.

Returns : void – toont een matplotlib plot

plot_sample(nsims, plot_data=True)¶¶

Plots samples van de posterior voorspellende dichtheid van het model. Deze methode werkt alleen als u het model hebt ingeschaald met Bayesiaanse inferentie.

Parameter	Type	Beschrijving
nsims	int	Hoeveel monsters te tekenen
plot_data	boolean	Of de echte data ook geplot moet worden

Returns : void – toont een matplotlib plot

plot_z(indices, figsize)¶

Retourneert een plot van de latente variabelen en hun geassocieerde onzekerheid.

Parameter	Type	Beschrijving
indices	int of lijst	Welke latente variabele indices om te plotten
figsize	tuple	Grootte van de matplotlib figuur

Returns : void – toont een matplotlib plot

ppc(T, nsims)¶

Retourneert een p-waarde voor een posterior predictieve controle. Deze methode werkt alleen als u met Bayesiaanse inferentie hebt gefit.

Parameter	Type	Beschrijving
T	functie	Discrepantie, bijv. np.mean of np.max
nsims	int	Hoeveel simulaties voor de PPC

Ret resultaat: int – de p-waarde voor de discrepantietest

predict(h, oos_data, intervals=False)¶

Retourneert een DataFrame van modelvoorspellingen.

Parameter	Type	Beschrijving
h	int	Hoeveel stappen om vooruit te voorspellen
oos_data	pd.DataFrame	Exogene variabelen in een frame voor h stappen
intervallen	boolean	Welke voorspellingsintervallen moeten worden teruggegeven

Voor alle duidelijkheid, het argument oos_data moet een DataFrame zijn in hetzelfde formaat als het initialdataframe dat wordt gebruikt om de modelinstantie te initialiseren. De reden hiervoor is dat u, om toekomstige waarden te voorspellen, aannames over exogene variabelen voor de toekomst moet specificeren. Bijvoorbeeld, als u h stappen vooruit voorspelt, zal de methode de 5 eerste rijen uit oos_data nemen en de waarden voor de exogene variabelen nemen die u als exogene variabelen in de patsy-formule hebt opgegeven.

Merk op dat als u Maximum Likelihood of Variational Inference gebruikt, de getoonde intervallen de latente variabelenonzekerheid niet zullen weergeven. Alleen Metropolis-Hastings geeft u volledig Bayesiaanse voorspellingsintervallen. Bayesiaanse intervallen met variabele inferentie worden niet getoond wegens de beperking van gemiddelde-veld inferentie in het niet verantwoorden van posterior correlaties.

Retourneert : pd.DataFrame – de modelvoorspellingen

predict_is(h, fit_once, fit_method)¶

Returns DataFrame van in-sample rolling voorspellingen voor het model.

Parameter	Type	Description
h	int	Hoeveel voorgaande tijdstappen te gebruiken
fit_once	boolean	Wheelt u in op één keer passen, of elke tijdstap
fit_method	str	Welke inferentie-optie, bijv.b.v. ‘MLE’

Returns : pd.DataFrame – de modelvoorspellingen

sample(nsims)¶

Returns np.ndarray van trekkingen van de data uit de posterior predictive density. Deze methode werkt alleen als u het model hebt ingepast met Bayesiaanse inferentie.

Parameter	Type	Beschrijving
nsims	int	Hoeveel posterior trekkingen te nemen

Returns : np.ndarray – steekproeven van de posterior voorspellende dichtheid.