bayespecon.models.SDEMPanelRE¶
- class bayespecon.models.SDEMPanelRE(**kwargs)[source]¶
Bayesian spatial Durbin error panel model with unit random effects.
\[y_{it} = X_{it}\beta_1 + (WX)_{it}\beta_2 + \alpha_i + u_{it}, \quad u_{it} = \lambda (Wu)_{it} + \varepsilon_{it}\]Combines the SDEM mean structure (covariates plus their spatial lags) with random unit effects \(\alpha_i \sim N(0, \sigma_\alpha^2)\) and a spatially-correlated error term governed by \(\lambda\).
- Parameters:¶
- formula
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- data
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- y
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- X
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- W
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- unit_col
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- time_col
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- N
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- T
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- priors
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.- logdet_method
See
SpatialPanelModel.modelis forced to 0 because unit heterogeneity is captured by the random effect rather than by within-unit demeaning.
Notes
The
priorsdict supports the following keys:lam_lower, lam_upper(float, default -1, 1)beta_mu(float, default 0)beta_sigma(float, default 1e6)sigma_sigma(float, default 10)sigma_alpha_sigma(float, default 10)nu_lam(float, default 1/30) whenrobust=True
Methods
__init__(**kwargs)fit([draws, tune, chains, target_accept, ...])Sample posterior and attach pointwise log-likelihood for IC metrics.
Return fitted values at posterior mean parameters.
Return transformed residuals
y - fitted.Run Bayesian LM specification tests and return a summary table.
spatial_diagnostics_decision([alpha])Return a model-selection decision from Bayesian LM test results.
spatial_effects([return_posterior_samples])Compute Bayesian inference for direct, indirect, and total impacts.
summary([var_names])Return posterior summary table.
Attributes
Return the ArviZ InferenceData from the most recent fit.
Return the PyMC model object built for the most recent fit.
-
fit(draws=
2000, tune=1000, chains=4, target_accept=0.9, random_seed=None, idata_kwargs=None, **sample_kwargs)[source]¶ Sample posterior and attach pointwise log-likelihood for IC metrics.
- property inference_data : arviz.data.inference_data.InferenceData | None[source]¶
Return the ArviZ InferenceData from the most recent fit.
- property pymc_model : pymc.model.core.Model | None[source]¶
Return the PyMC model object built for the most recent fit.
- spatial_diagnostics()[source]¶
Run Bayesian LM specification tests and return a summary table.
Iterates over the class-level
_spatial_diagnostics_testsregistry and calls each test function on this fitted model, collecting the results into a tidy DataFrame. The set of tests depends on the model type — for example, an OLSPanelFE model runs Panel-LM-Lag, Panel-LM-Error, Panel-LM-SDM-Joint, and Panel-LM-SLX-Error-Joint.Requires the model to have been fit (
.fit()called) and a spatial weights matrixWto have been supplied at construction time.- Returns:¶
DataFrame indexed by test name with columns:
Column
Description
statistic
Posterior mean of the LM statistic
median
Posterior median of the LM statistic
df
Degrees of freedom for the \(\chi^2\) reference
p_value
Bayesian p-value:
1 - chi2.cdf(mean, df)ci_lower
Lower bound of 95% credible interval (2.5%)
ci_upper
Upper bound of 95% credible interval (97.5%)
The DataFrame has
attrs["model_type"](class name) andattrs["n_draws"](total posterior draws) metadata.- Return type:¶
pandas.DataFrame
- Raises:¶
RuntimeError – If the model has not been fit yet.
See also
spatial_diagnostics_decisionModel-selection decision based on the test results.
-
spatial_diagnostics_decision(alpha=
0.05)[source]¶ Return a model-selection decision from Bayesian LM test results.
Implements the decision tree from Koley and Bera [2024] (the Bayesian analogue of the classical
stge_kbprocedure in Anselin et al. [1996]), adapted for panel models following Elhorst [2014].See also
spatial_diagnosticsCompute the Bayesian LM test statistics.
References
Koley and Bera [2024], Anselin et al. [1996], Elhorst [2014]
-
spatial_effects(return_posterior_samples=
False)[source]¶ Compute Bayesian inference for direct, indirect, and total impacts.
Computes impact measures for each posterior draw, then summarises the posterior distribution with means, 95% credible intervals, and Bayesian p-values.
- Parameters:¶
- Returns:¶
If return_posterior_samples is
False(default), returns a DataFrame indexed by feature names with columns for posterior means, credible-interval bounds, and Bayesian p-values.If return_posterior_samples is
True, returns(DataFrame, dict)where the dict has keys"direct","indirect","total", each mapping to a(G, k)array of posterior draws.- Return type:¶