Classe Descrição ¶
ClasseARIMAX(data, formula, ar, ma, integ, target, família)¶
Modelos de Variável Exógena Média Móvel Integrada (ARIMAX).
| Parâmetro | Tipo | Descrição |
|---|---|---|
| dados | pd.DataFrame ou np.ndarray | Contém a série temporal univariada |
| Fórmula | Fórmula | Notação de patsy especificando a regressão |
| ar | int | The número de desfasamentos autoregressivos |
| ma | int | O número de desfasamentos médios móveis |
| integ | int | Quantas vezes diferenciar os dados(padrão): 0) |
| alvo | string ou int | Qual a coluna de DataFrame/array a utilizar. |
| família | pf.Family instance | A distribuição para a série cronológica, por exemplo pf.Normal() |
Atributos
latent_variables
A pf.LatentVariables() objeto contendo informações sobre as variáveis latentes do modelo, configurações prévias. quaisquer valores ajustados, valores iniciais e outras informações de variáveis latentes. Quando um modelo é ajustado, é aqui que as variáveis latentes são atualizadas/armazenadas. Por favor veja a documentação sobre Variáveis Latentes para informações sobre atributos dentro deste objeto, bem como métodos para acessar a informação da variável latente.
Métodos
adjust_prior(índice, anterior)¶
Ajusta os priores para as variáveis latentes do modelo. As variáveis latentes e seus índices podem ser visualizados imprimindo o atributo latent_variables anexado à instância do modelo.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| índice | int | Index da variável latente a alterar |
| prior | pf.Instância familiar | Distribuição principal, por exemplo pf.Normal() |
Retorna: void – muda o modelo latent_variables atributo
fit(método, **kwargs)¶
Ativa variáveis latentes para o modelo. O usuário escolhe uma opção de inferência e o método retorna um objeto de resultados, assim como a atualização do modelo latent_variablesatributo.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| método | str | Opção de informação: e.g. ‘M-H’ ou ‘MLE’ |
Ver as seções de Inferência Bayesiana e Inferência Clássica da documentação para a lista completa de opções de inferência. Parâmetros opcionais podem ser inseridos que são relevantes para o modo particular de inferência escolhido.
Retornos: pf.Exemplo de resultados com informações para as variáveis latentes estimadas
plot_fit(**kwargs)¶
Plota o ajuste do modelo em relação aos dados. Os argumentos opcionais incluem tamanho das figuras, as dimensões da figura a plotar.
Retornos: void – mostra um gráfico matplotlib
plot_ppc(T, nsims)¶
Plota um histograma para uma verificação preditiva posterior com uma medida de discrepância da escolha do usuário. Este método só funciona se você tiver ajustado usando a inferência Bayesiana.
| Parameter | Tipo | Descrição |
|---|---|---|
| T | função | Discrepância, por exemplo np.mean ou np.max |
| Sims | int | Quantas simulações para o PPC |
Revoluções: void – mostra um gráfico matplotlib
plot_predict(h, oos_data, past_values, intervalos, **kwargs)¶
Previsões de gráficos do modelo, juntamente com intervalos.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| h | int | Quantos passos para prever adiante |
| oos_dados | pd.DataFrame | Variáveis exógenas em um quadro para os passos h |
| valores_past_valor | int | Quantos datapoints passados para plotar |
| intervalos | booleano | Se deseja plotar intervalos ou não |
Para ser claro, o argumento oos_data deve ser um DataFrame no mesmo formato que o inicialdataframe utilizado para inicializar a instância modelo. A razão é que para prever valores futuros, você precisa especificar suposições sobre variáveis exógenas para o futuro. Por exemplo, se você previu os passos à frente, o método irá pegar as primeiras linhas h de oos_data e pegar os valores para as variáveis exógenas que você pediu na fórmula patsy.
Os argumentos opcionais incluem o tamanho dos figs – as dimensões da figura a plotar. Observe que se você usar a Probabilidade Máxima ou Inferência Variável, os intervalos mostrados não refletirão a incerteza da variável latente. Apenas Metropolis-Hastings lhe dará intervalos Bayesianprediction completos. Os intervalos Bayesianos com inferência variacional não são mostrados devido à limitação da inferência da média de campo em não levar em conta correlações posteriores.
Retornos: void – mostra um gráfico de matplotlib
plot_predict_is(h, fit_once, fit_method, **kwargs)¶
Plots in-sample rolling predictions para o modelo. Isto significa que o usuário finge que a última subseção de dados está fora da amostra, e faz previsões após cada período e avalia bem como elas fizeram. O usuário pode escolher se deseja ajustar os parâmetros uma vez no início ou a cada passo.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| h | int | Quantos tempos anteriores para usar |
| fit_once | boolean | Whether to fit once, ou a cada período de tempo |
| fit_method | str | Qual a opção de inferência, e.g. ‘MLE’ |
Os argumentos opcionais incluem tamanho dos figs – as dimensões da figura a plotar. h é uma int de quantos passos anteriores para simular o desempenho em.
Retornos: void – mostra um gráfico matplotlib
plot_sample(nsims, plot_data=True)¶
Amostras de gráficos a partir da densidade preditiva posterior do modelo. Este método só funciona se você ajustar o modelo usando a inferência Bayesiana.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Insims | int | Quantos amostras a desenhar |
| Dados_de_plot_dados | Booleano | Se também desenhar os dados reais |
Revoluções : void – mostra um gráfico matplotlib
plot_z(índices, tamanho dos figos)¶
Retorna um gráfico das variáveis latentes e sua incerteza associada.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Índices | int ou lista | Que índices variáveis latentes para plotar |
| figsize | tuplo | Tamanho da figura matplotlib |
Retornos : void – mostra um gráfico matplotlib
ppc(T, nsims)¶
Retorna um p-valor para uma verificação preditiva posterior. Este método só funciona se você tiver ajustado usando a inferência Bayesiana.
| Parameter | Tipo | Descrição |
|---|---|---|
| T | função | Discrepância, por exemplo np.mean ou np.max |
| Sims | int | Quantas simulações para o PPC |
Revoluções: int – o valor p para o teste de discrepância
predict(h, oos_dados, intervalos=Falso)¶
Retorna um DataFrame de previsões do modelo.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| h | int | Quantos passos para prever adiante |
| oos_dados | pd.DataFrame | Variáveis exógenas em um quadro para os passos h |
| intervalos | booleano | Se devolver intervalos de previsão |
Para ser claro, o argumento oos_data deve ser um DataFrame no mesmo formato que o inicialdataframe usado para inicializar a instância do modelo. A razão é que para prever valores futuros, você precisa especificar suposições sobre variáveis exógenas para o futuro. Por exemplo, se você prever os passos à frente, o método tomará as 5 primeiras linhas de oos_data e tomará os valores para as variáveis exógenas que você especificou como variáveis exógenas na fórmula patsy.
Por favor note que se você usar a Máxima Verossimilhança ou Inferência Variacional, os intervalos mostrarão que não refletirão a incerteza da variável latente. Apenas Metropolis-Hastings lhe dará intervalos de previsão totalmente Bayesianos. Os intervalos Bayesianos com inferência variacional não são mostrados devido à limitação da inferência da média de campo em não levar em conta correlações posteriores.
Retornos : pd.DataFrame – as previsões do modelo
predict_is(h, fit_once, fit_method)¶
Retornos DataFrame das previsões de rolamento in-sample para o modelo.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| h | int | Quantos tempos anteriores para usar |
| fit_once | boolean | Whether to fit once, ou a cada período de tempo |
| fit_method | str | Qual a opção de inferência, e.g. ‘MLE’ |
Retornos : pd.DataFrame – as previsões do modelo
sample(nsims)¶
Retornos np.ndarray dos desenhos dos dados da densidade preditiva posterior. Este método só funciona se você tiver ajustado o modelo usando a inferência Bayesiana.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| Insims | int | Quantos desenhos posteriores a serem feitos |
Retornos : np.ndarray – amostras da densidade preditiva posterior.