Descripción de la clase¶
claseARIMAX(data, formula, ar, ma, integ, target, family)¶
Modelos Autorregresivos de Media Móvil Integrada de Variable Exógena (ARIMAX).
| Parámetro | Tipo | Descripción |
|---|---|---|
| datos | pd.DataFrame o np.ndarray | Contiene la serie temporal univariante |
| fórmula | cadena | notación Patsy que especifica la regresión |
| ar | int | El número de rezagos autorregresivos |
| ma | int | El número de rezagos de media móvil |
| integ | int | Cuántas veces hay que diferenciar los datos(por defecto: 0) |
| target | string o int | Qué columna de DataFrame/array utilizar. |
| family | pf.Family instance | La distribución para la serie temporal,por ejemplo pf.Normal() |
Atributos
latent_variables¶
Un objeto pf.LatentVariables() que contiene información sobre las variables latentes del modelo, los ajustes previos, los valores ajustados, los valores iniciales y otra información sobre las variables latentes. Cuando se ajusta un modelo, aquí es donde se actualizan/almacenan las variables latentes.Consulte la documentación sobre Variables Latentes para obtener información sobre los atributos dentro de este objeto, así como los métodos para acceder a la información de las variables latentes.
Métodos
adjust_prior(índice, prior)¶
Ajusta los priores para las variables latentes del modelo. Las variables latentes y sus índices se pueden ver imprimiendo el atributo latent_variables adjunto a la instancia del modelo.
| Parámetro | Tipo | Descripción |
|---|---|---|
| índice | int | Índice de la variable latente a cambiar |
| prior | pf.Instancia de la familia | Distribución anterior, por ejemplo pf.Normal() |
Devuelve: void – cambia el modelo latent_variables atributo
fit(método, **kwargs)¶
Estima las variables latentes para el modelo. El usuario elige una opción de inferencia y el método devuelve un objeto de resultados, además de actualizar el atributo latent_variablesdel modelo.
| Parámetro | Tipo | Descripción |
|---|---|---|
| método | str | Opción de inferencia: e.g. ‘M-H’ o ‘MLE’ |
Vea las secciones de Inferencia Bayesiana e Inferencia Clásica de la documentación para la lista completa de opciones de inferencia. Se pueden introducir parámetros opcionales que sean relevantes para el modo particular de inferencia elegido.
Devuelve: instancia pf.Results con información para las variables latentes estimadas
plot_fit(**kwargs)¶
Representa el ajuste del modelo frente a los datos. Los argumentos opcionales incluyen figsize, las dimensiones de la figura a trazar.
Devuelve : void – muestra un matplotlib plot
plot_ppc(T, nsims)¶
Traza un histograma para una comprobación predictiva posterior con una medida de discrepancia a elección del usuario. Este método sólo funciona si se ha ajustado utilizando la inferencia bayesiana.
| Parámetro | Tipo | Descripción |
|---|---|---|
| T | función | Discrepancia, por ejemplo np.mean o np.max |
| nsims | int | Cuántas simulaciones para el PPC |
Retorna: void – muestra un matplotlib plot
plot_predict(h, oos_data, past_values, intervals, **kwargs)¶
Representa las predicciones del modelo, junto con los intervalos.
| Parámetro | Tipo | Descripción |
|---|---|---|
| h | int | Cuántos pasos hay que predecir por adelantado |
| oos_data | pd.DataFrame | Variables exógenas en un marco para h pasos |
| valores_pasados | int | Cuántos puntos de datos pasados para trazar |
| intervalos | boolean | Si se trazan intervalos o no |
Para ser claros, el argumento oos_data debe ser un DataFrame con el mismo formato que el initialdataframe utilizado para inicializar la instancia del modelo. La razón es que para predecir los valores futuros, es necesario especificar las suposiciones sobre las variables exógenas para el futuro. Por ejemplo, si usted predice h pasos adelante, el método tomará las h primeras filas de oos_data y tomará los valores para las variables exógenas que usted pidió en la fórmula patsy.
Los argumentos opcionales incluyen figsize – las dimensiones de la figura a trazar. Tenga en cuenta que si utiliza la Máxima Verosimilitud o la Inferencia Variacional, los intervalos mostrados no reflejarán la incertidumbre de la variable latente. Sólo Metrópolis-Hastings le proporcionará intervalos de predicción completamente bayesianos. Los intervalos bayesianos con inferencia variacional no se muestran debido a la limitación de la inferencia de campo medio al no tener en cuenta las correlaciones posteriores.
Devuelve : void – muestra un gráfico matplotlib
plot_predict_is(h, fit_once, fit_method, **kwargs)¶
Proyecta predicciones rodantes dentro de la muestra para el modelo. Esto significa que el usuario finge que la última subsección de datos está fuera de la muestra, y pronostica después de cada período y evalúa lo bien que lo hizo. El usuario puede elegir si ajustar los parámetros una vez al principio o en cada paso de tiempo.
| Parámetros | Tipo | Descripción |
|---|---|---|
| h | int | Cuántos pasos de tiempo anteriores utilizar |
| fit_once | boolean | Si ajustar una vez, o cada paso de tiempo |
| fit_method | str | Qué opción de inferencia, por ejemplog. ‘MLE’ |
Los argumentos opcionales incluyen figsize – las dimensiones de la figura para trazar. h es un int de cuántos pasos anteriores para simular el rendimiento en.
Devuelve : void – muestra un matplotlib plot
plot_sample(nsims, plot_data=True)¶
Traza muestras de la densidad predictiva posterior del modelo. Este método sólo funciona si ha ajustado el modelo utilizando la inferencia bayesiana.
| Parámetro | Tipo | Descripción |
|---|---|---|
| nsims | int | Cuántas muestras a dibujar |
| plot_data | boolean | Si se trazan también los datos reales |
Devuelve : void – muestra un matplotlib plot
plot_z(indices, figsize)¶
Devuelve un gráfico de las variables latentes y su incertidumbre asociada.
| Parámetro | Tipo | Descripción |
|---|---|---|
| Índices | int o lista | Qué índices de la variable latente para trazar |
| figsize | tupla | Tamaño de la figura de matplotlib |
Devuelve : void – muestra un gráfico matplotlib
ppc(T, nsims)¶
Devuelve un valor p para una comprobación predictiva posterior. Este método sólo funciona si ha ajustado utilizando la inferencia bayesiana.
| Parámetro | Tipo | Descripción |
|---|---|---|
| T | función | Discrepancia, por ejemplo. np.mean o np.max |
| nsims | int | Cuántas simulaciones para el PPC |
Retorna: int – el valor p para la prueba de discrepancia
predict(h, oos_data, intervals=False)¶
Devuelve un DataFrame de predicciones del modelo.
| Parámetro | Tipo | Descripción |
|---|---|---|
| h | int | Cuántos pasos hay que predecir por adelantado |
| oos_data | pd.DataFrame | Variables exógenas en un marco para h pasos |
| intervalos | boolean | Si se devuelven intervalos de predicción |
Para que quede claro, el argumento oos_data debe ser un DataFrame con el mismo formato que el initialdataframe utilizado para inicializar la instancia del modelo. La razón es que para predecir valores futuros, es necesario especificar suposiciones sobre las variables exógenas para el futuro. Por ejemplo, si usted predice h pasos adelante, el método tomará las 5 primeras filas de oos_data y tomará los valores para las variables exógenas que usted especificó como variables exógenas en la fórmula patsy.
Por favor, tenga en cuenta que si usted utiliza la Máxima Verosimilitud o la Inferencia Variacional, los intervalos mostrados no reflejarán la incertidumbre de la variable latente. Sólo Metrópolis-Hastings le dará intervalos de predicción totalmente bayesianos. Los intervalos bayesianos con inferencia variacional no se muestran debido a la limitación de la inferencia de campo medio al no tener en cuenta las correlaciones posteriores.
Devuelve : pd.DataFrame – las predicciones del modelo
predict_is(h, fit_once, fit_method)¶
Devuelve DataFrame de predicciones rodantes dentro de la muestra para el modelo.
| Parámetro | Tipo | Descripción |
|---|---|---|
| h | int | Cuántos pasos de tiempo anteriores utilizar |
| fit_once | boolean | Si ajustar una vez, o cada paso de tiempo |
| fit_method | str | Qué opción de inferencia, por ejemplog. ‘MLE’ |
Devuelve : pd.DataFrame – las predicciones del modelo
sample(nsims)¶
Devuelve np.ndarray de extracciones de los datos de la densidad predictiva posterior. Este método sólo funciona si se ha ajustado el modelo utilizando la inferencia bayesiana.
| Parámetro | Tipo | Descripción |
|---|---|---|
| nsims | int | Cuántas extracciones posteriores tomar |
Devuelve : np.ndarray – muestras de la densidad predictiva posterior.