Description de la classe¶
classeARIMAX(data, formula, ar, ma, integ, target, family)¶
Modèles à variables exogènes à moyenne mobile intégrée autorégressive (ARIMAX).
| Paramètre | Type | Description |
|---|---|---|
| data | pd.DataFrame ou np.ndarray | Contient la série temporelle univariée |
| formule | chaîne | Notation Patsy spécifiant la régression |
| ar | int | Le nombre de retards autorégressifs |
| ma | int | Le nombre de retards de moyenne mobile |
| integ | int | Combées de la différence des données(par défaut : 0) |
| target | string ou int | Quelle colonne de DataFrame/array utiliser. |
| famille | pf.Family instance | La distribution pour la série temporelle,par exemple pf.Normal() |
Attributs
latent_variables¶
A pf.LatentVariables() contenant des informations sur les variables latentes du modèle,les paramètres antérieurs. toute valeur ajustée, les valeurs de départ et d’autres informations sur les variables latentes. Lorsqu’un modèle est ajusté, c’est ici que les variables latentes sont mises à jour/stockées.Veuillez consulter la documentation sur les variables latentes pour obtenir des informations sur les attributs de cetobjet, ainsi que les méthodes d’accès aux informations sur les variables latentes.
Méthodes
adjust_prior(index, prior)¶
Ajuste les prieurs pour les variables latentes du modèle. Les variables latentes et leurs indicespeuvent être visualisés en imprimant l’attribut latent_variables attaché à l’instance du modèle.
| Paramètre | Type | Description |
|---|---|---|
| index | int | Index de la variable latente à modifier |
| prior | pf.Instance de famille | Distribution antérieure, par exemple pf.Normal() |
Retourne : void – modifie le modèle latent_variables attribut
fit(méthode, **kwargs)¶
Estime les variables latentes pour le modèle. L’utilisateur choisit une option d’inférence et la méthode renvoie un objet de résultats, ainsi que la mise à jour de l’attribut latent_variablesdu modèle.
| Paramètre | Type | Description |
|---|---|---|
| méthode | str | Option d’inférence : par ex.par exemple, ‘M-H’ ou ‘MLE’ |
Voir les sections Inférence bayésienne et Inférence classique de la documentation pour la liste complète des options d’inférence. Des paramètres optionnels peuvent être entrés qui sont pertinents pour le mode particulier d’inférence choisi.
Retourne : instance pf.Results avec des informations pour les variables latentes estimées
plot_fit(**kwargs)¶
Plaque l’ajustement du modèle par rapport aux données. Les arguments facultatifs incluent figsize,les dimensions de la figure à tracer.
Returns : void – montre un plot matplotlib
plot_ppc
(T, nsims)¶
Plaque un histogramme pour une vérification prédictive postérieure avec une mesure de divergence au choix de l’utilisateur. Cette méthode ne fonctionne que si vous avez ajusté en utilisant l’inférence bayésienne.
| Paramètre | Type | Description |
|---|---|---|
| T | fonction | Discrépance, par exemple. np.mean ou np.max |
| nsims | int | Combien de simulations pour le PPC |
Retourne : void – montre un matplotlib plot
plot_predict(h, oos_data, past_values, intervals, **kwargs)¶
Plaque les prédictions du modèle, ainsi que les intervalles.
| Paramètre | Type | Description |
|---|---|---|
| h | int | Combien de pas à prévoir à l’avance |
| oos_data | pd.DataFrame | Variables exogènes dans un cadre pour h pas |
| past_values | int | Combien de points de données passés. à tracer |
| intervalles | boolean | Si on doit tracer des intervalles ou non |
Pour être clair, l’argument oos_data doit être un DataFrame au même format que le initialdataframe utilisé pour initialiser l’instance du modèle. La raison en est que pour prédire des valeurs futures,vous devez spécifier des hypothèses sur les variables exogènes pour le futur. Par exemple, si vous prédisez h pas en avant, la méthode prendra les h premières lignes de oos_data et prendra les valeurs des variables exogènes que vous avez demandées dans la formule patsy.
Les arguments optionnels incluent figsize – les dimensions de la figure à tracer. Veuillez noter que si vous utilisez le maximum de vraisemblance ou l’inférence variationnelle, les intervalles affichés ne refléteront pas l’incertitude des variables latentes. Seule la méthode Metropolis-Hastings vous donnera des intervalles de prédiction entièrement bayésiens. Les intervalles bayésiens avec l’inférence variationnelle ne sont pas montrés à cause de la limitation de l’inférence de champ moyen en ne tenant pas compte des corrélations postérieures.
Returns : void – montre un plot matplotlib
plot_predict_is(h, fit_once, fit_method, **kwargs)¶
Plaque les prédictions roulantes en échantillon pour le modèle. Cela signifie que l’utilisateur prétend qu’une dernière sous-section de données est hors échantillon, et effectue des prévisions après chaque période et évalue leur efficacité. L’utilisateur peut choisir d’ajuster les paramètres une fois au début ou à chaque pas de temps.
| Paramètre | Type | Description |
|---|---|---|
| h | int | Combien de pas de temps précédents à utiliser |
| fit_once | boolean | Si l’on veut s’adapter une fois, ou chaque pas de temps |
| fit_method | str | Quelle option d’inférence, par ex.p. ex. ‘MLE’ |
Les arguments optionnels incluent figsize – les dimensions de la figure à tracer. h est un int de combien d’étapes précédentes pour simuler la performance sur.
Returns : void – montre un plot matplotlib
plot_sample(nsims, plot_data=True)¶
Plaque des échantillons de la densité prédictive postérieure du modèle. Cette méthode ne fonctionne que si vous avez ajusté le modèle en utilisant l’inférence bayésienne.
| Paramètre | Type | Description |
|---|---|---|
| nsims | int | Combien d’échantillons à tirer |
| plot_data | boolean | Si on doit aussi tracer les données réelles |
Retourne : void – montre un plot matplotlib
plot_z(indices, figsize)¶
Retourne un plot des variables latentes et de leur incertitude associée.
| Paramètre | Type | Description |
|---|---|---|
| indices | int ou liste | Quel(le) indices de variables latentes à tracer |
| figsize | tuple | Taille de la figure matplotlib |
Retourne : void – montre une figure matplotlib
ppc(T, nsims)¶
Retourne une valeur p pour une vérification prédictive postérieure. Cette méthode ne fonctionne que si vous avez ajusté en utilisant l’inférence bayésienne.
| Paramètre | Type | Description |
|---|---|---|
| T | fonction | Discordance, par exemple. np.mean ou np.max |
| nsims | int | Combien de simulations pour le PPC |
Retourne : int – la valeur p pour le test de divergence
predict(h, oos_data, intervals=False)¶
Retourne un DataFrame de prédictions du modèle.
| Paramètre | Type | Description |
|---|---|---|
| h | int | Combien de pas à prévoir en avance |
| oos_data | pd.DataFrame | Variables exogènes dans un cadre pour h étapes |
| intervalles | booléen | Si l’on veut retourner les intervalles de prédiction |
En clair, l’argument oos_data doit être un DataFrame au même format que le initialdataframe utilisé pour initialiser l’instance du modèle. La raison en est que pour prédire des valeurs futures,vous devez spécifier des hypothèses sur les variables exogènes pour le futur. Par exemple, si vousprédisez h pas en avant, la méthode prendra les 5 premières lignes de oos_data et prendra lesvaleurs des variables exogènes que vous avez spécifiées comme variables exogènes dans la formule patsy.
Veuillez noter que si vous utilisez le maximum de vraisemblance ou l’inférence variationnelle, les intervalles affichés ne refléteront pas l’incertitude des variables latentes. Seule la méthode Metropolis-Hastings vous donnera des intervalles de prédiction entièrement bayésiens. Les intervalles bayésiens avec l’inférence variationnelle ne sont pas montrés à cause de la limitation de l’inférence par champ moyen en ne tenant pas compte des corrélations postérieures.
Retourne : pd.DataFrame – les prédictions du modèle
predict_is(h, fit_once, fit_method)¶
Retourne le DataFrame des prédictions roulantes en échantillon pour le modèle.
| Paramètre | Type | Description |
|---|---|---|
| h | int | Combien de pas de temps précédents à utiliser |
| fit_once | boolean | Si l’on veut s’adapter une fois, ou chaque pas de temps |
| fit_method | str | Quelle option d’inférence, par ex.par exemple ‘MLE’ |
Returns : pd.DataFrame – les prédictions du modèle
sample(nsims)¶
Returns np.ndarray de tirages des données à partir de la densité prédictive postérieure. Cetteméthode ne fonctionne que si vous avez ajusté le modèle en utilisant l’inférence bayésienne.
| Paramètre | Type | Description |
|---|---|---|
| nsims | int | Combien de tirages postérieurs à prendre |
Retourne : np.ndarray – échantillons de la densité prédictive postérieure.