Klasa Opisś
klasaARIMAX(data, formula, ar, ma, integ, target, family)ś
Autoregressive Integrated Moving Average Exogenous Variable Models (ARIMAX).
| Parametr | Typ | Opis | |
|---|---|---|---|
| dane | pd.DataFrame lub np.ndarray | Zawierają jednowariantowy szereg czasowy | |
| formula | string | notacja Patsy określająca regresję | |
| ar | int | Liczba opóźnień autoregresyjnych | Przykłady. Liczba opóźnień autoregresji |
| ma | int | Liczba opóźnień średniej ruchomej | |
| integ | int | Ile razy różniczkować dane(domyślnie: 0) | |
| target | string lub int | Której kolumny DataFrame/array użyć. | |
| family | pf.Family instance | Rozkład dla szeregu czasowego,np. pf.Normal() |
Attributes
latent_variablesś
A pf.LatentVariables() obiekt zawierający informacje o zmiennych ukrytych modelu, ustawieniach wstępnych, wszelkich dopasowanych wartościach, wartościach początkowych i innych informacjach o zmiennych ukrytych. Gdy model jest dopasowywany, jest to miejsce aktualizacji/przechowywania zmiennych ukrytych.Proszę zapoznać się z dokumentacją dotyczącą zmiennych ukrytych w celu uzyskania informacji na temat atrybutów w tym obiekcie, jak również metod dostępu do informacji o zmiennych ukrytych.
Metody
adjust_prior(index, prior)¦
Dostosowuje priorytety dla zmiennych ukrytych modelu. Zmienne ukryte i ich indeksy można wyświetlić przez wydrukowanie atrybutu latent_variables dołączonego do instancji modelu.
| Parametr | Typ | Opis |
|---|---|---|
| index | int | Indeks zmiennej ukrytej do zmiany |
| prior | pf.Family instance | Prior distribution, e.g. pf.Normal() |
Returns: void – zmienia model latent_variables attribute
fit(method, **kwargs)¶
Estymuluje zmienne ukryte dla modelu. Użytkownik wybiera opcję wnioskowania, a themethod zwraca obiekt wyników, jak również aktualizuje latent_variablesatrybut modelu.
| Parametr | Typ | Opis |
|---|---|---|
| metoda | str | Opcja wnioskowania: np.np. 'M-H’ lub 'MLE’ |
Patrz sekcje Bayesian Inference i Classical Inference w dokumentacji, aby zapoznać się z pełną listą opcji wnioskowania. Można wprowadzić opcjonalne parametry, które są istotne dla wybranego trybu wnioskowania.
Wraca: instancja pf.Results z informacjami o oszacowanych zmiennych ukrytych
plot_fit(**kwargs)ś
Wykreśla dopasowanie modelu do danych. Opcjonalne argumenty zawierają figsize, wymiary figury do wykreślenia.
Returns : void – pokazuje matplotlib plot
plot_ppc(T, nsims)Ś
Wykreśla histogram dla sprawdzenia predykcji z miarą rozbieżności wybraną przez użytkownika. Ta metoda działa tylko w przypadku dopasowania przy użyciu wnioskowania bayesowskiego.
| Parametr | Typ | Opis |
|---|---|---|
| T | funkcja | Rozbieżność, np. np.mean lub np.max |
| nsims | int | Ile symulacji dla PPC |
Wraca: void – pokazuje matplotlib plot
plot_predict(h, oos_data, past_values, intervals, **kwargs)Ś
Opisuje predykcje modelu wraz z interwałami.
| Parametr | Typ | Opis |
|---|---|---|
| h | int | Ile kroków do prognozowania w przód |
| oos_data | pd.DataFrame | Zmienne egzogeniczne w ramce dla h kroków |
| past_values | int | Ile przeszłych datapoints to plot |
| intervals | boolean | Whether to plot intervals or not |
To be clear, argument oos_data powinien być DataFrame w tym samym formacie, co initialdataframe używany do inicjalizacji instancji modelu. Powodem jest to, że aby przewidzieć przyszłe wartości, musisz określić założenia dotyczące zmiennych egzogenicznych dla przyszłości. Na przykład, jeśli przewidujesz h kroków naprzód, metoda pobierze h pierwszych wierszy z oos_data i pobierze wartości dla zmiennych egzogenicznych, o które prosiłeś w formule patsy.
Opcjonalne argumenty zawierają figsize – wymiary figury do wykreślenia. Proszę zauważyć, że jeśli używasz Maximum Likelihood lub Variational Inference, pokazane przedziały nie będą odzwierciedlać niepewności zmiennych ukrytych. Tylko Metropolis-Hastings daje w pełni bayesowskie przedziały predykcji. Bayesian intervals with variational inference are not shown becauseof the limitation of mean-field inference in not accounting for posterior correlations.
Returns : void – pokazuje matplotlib plot
plot_predict_is(h, fit_once, fit_method, **kwargs)¶
Plots in-sample rolling predictions for the model. Oznacza to, że użytkownik udaje, że ostatni podrozdział danych jest poza próbą i prognozuje po każdym okresie i ocenia, jak dobrze mu poszło. Użytkownik może wybrać, czy dopasować parametry raz na początku, czy w każdym kroku czasowym.
| Parametr | Typ | Opis |
|---|---|---|
| h | int | Ile poprzednich kroków czasowych użyć |
| fit_once | boolean | Czy dopasować raz, czy w każdym kroku czasowym |
| fit_method | str | Która opcja wnioskowania, np.g. 'MLE’ |
Optional arguments include figsize – wymiary figury do wykreślenia. h is an int of how many previous steps to simulate performance on.
Returns : void – wyświetla matplotlib plot
plot_sample(nsims, plot_data=True)¶
Plots samples from the posterior predictive density of the model. Ta metoda działa tylko jeśli dopasowałeś model używając wnioskowania bayesowskiego.
| Parametr | Typ | Opis |
|---|---|---|
| nsims | int | Ilość próbek do wylosowania |
| plot_data | boolean | Czy wypisać również dane rzeczywiste |
Wraca : void – pokazuje matplotlib plot
plot_z(indices, figsize)ś
Wraca wykres zmiennych ukrytych i związanej z nimi niepewności.
| Parametr | Typ | Opis | |
|---|---|---|---|
| indices | int lub list | Które indeksy zmiennych latentnych mają być wykreślone | . indeksy zmiennych ukrytych do wykreślenia |
| figsize | tuple | Rozmiar figury matplotlib |
Wraca : void – pokazuje matplotlib plot
ppc(T, nsims)ś
Returns a p-value for a posterior predictive check. Ta metoda działa tylko wtedy, gdy dokonałeś dopasowania przy użyciu wnioskowania bayesowskiego.
| Parametr | Typ | Opis |
|---|---|---|
| T | funkcja | Różnica, np. np.mean lub np.max |
| nsims | int | Ilość symulacji dla PPC |
Zwraca: int – p-value dla testu rozbieżności
predict(h, oos_data, intervals=False)Ś
Wraca DataFrame przewidywań modelu.
| Parametr | Typ | Opis |
|---|---|---|
| h | int | Ile kroków do prognozy w przód |
| oos_data | pd.DataFrame | Zmienne egzogeniczne w ramce dla h kroków |
| intervals | boolean | Czy zwracać przedziały predykcji |
Aby było jasne, argument oos_data powinien być DataFrame w tym samym formacie, co initialdataframe używany do inicjalizacji instancji modelu. Powodem jest to, że aby przewidzieć przyszłe wartości, musisz określić założenia dotyczące zmiennych egzogenicznych dla przyszłości. Na przykład, jeśli przewidujesz h kroków naprzód, metoda weźmie 5 pierwszych wierszy z oos_data i weźmie wartości dla zmiennych egzogenicznych, które określiłeś jako zmienne egzogeniczne w formule patsy.
Proszę zauważyć, że jeśli używasz Maximum Likelihood lub Variational Inference, pokazane przedziały nie będą odzwierciedlać niepewności zmiennej ukrytej. Tylko Metropolis-Hastings da Ci w pełni bayesowskie przedziały predykcji. Bayesowskie przedziały z wnioskowaniem wariacyjnym nie są pokazywane z powodu ograniczenia wnioskowania o polu średnim w nieuwzględnianiu korelacji w czasie następczym.
Wraca : pd.DataFrame – przewidywania modelu
predict_is(h, fit_once, fit_method)Ś
Wraca DataFrame kroczących przewidywań modelu w próbie.
| Parameter | Type | Description |
|---|---|---|
| h | int | Ile poprzednich kroków czasowych użyć |
| fit_once | boolean | Czy dopasować raz, czy w każdym kroku czasowym |
| fit_method | str | Która opcja wnioskowania, np.np. 'MLE’ |
Returns : pd.DataFrame – przewidywania modelu
sample(nsims)ś
Returns np.ndarray of draws of the data from the posterior predictive density. Ta metoda działa tylko wtedy, gdy dopasowałeś model za pomocą wnioskowania bayesowskiego.
| Parameter | Type | Description |
|---|---|---|
| nsims | int | Ilość losowań danych do pobrania |
Returns : np.ndarray – próbki z gęstości posterylnej predykcji.