neighbayes.models.SARNegBin¶
-
class neighbayes.models.SARNegBin(formula=
None, data=None, y=None, X=None, W=None, *, unit_effects=None, time_effects=False, dynamic=False, mundlak=False, latent=None, unit_col=None, time_col=None, N=None, T=None, priors=None, logdet_method=None, robust=False, durbin_vars=None, logdet_decomp='auto', logdet_adapt=True)[source]¶ Bayesian SAR negative binomial: the latent SAR, or the reduced form with
latent=False.The latent SAR’s multiplier propagates the negative binomial’s own disturbance as well as the covariates:
\[y_i \sim \mathrm{Poisson}(e^{\eta_i}), \qquad (I - \rho W)\eta = X\beta + \varepsilon, \qquad \varepsilon_i = \log\gamma_i,\; \gamma_i \sim \mathrm{Gamma}(\alpha, \alpha),\]so that \(\rho = 0\) is
NegBin. It is sampled by an exact Gibbs sweep over the log-means (neighbayes.samplers.negbin_latent), on JAX by default; there is no NUTS path. Its pointwise log-likelihood integrates each log-mean out given the rest, and its impacts are on the log-mean or,impacts(scale="count"), the expected count.latent=Falseis the reduced form,\[y_i \sim \mathrm{NegBin}(\mu_i, \alpha), \qquad \mu = \exp(\eta), \qquad \eta = (I - \rho W)^{-1} X \beta ,\]whose spatial lag acts on the log-mean only;
yis not transformed, so the likelihood carries no \(\log|I - \rho W|\) Jacobian. Itsfit()defaults to Pólya–Gamma Gibbs, andsampler="nuts"fits it in PyMC.- Parameters:¶
- formula : str, optional¶
Wilkinson-style formula, e.g.
"y ~ x1 + x2". Requiresdata.- data : pandas.DataFrame or geopandas.GeoDataFrame, optional¶
Data source for formula mode.
- y : array-like, optional¶
Non-negative integer counts of shape
(n,)(matrix mode).- X : array-like or pandas.DataFrame, optional¶
Design matrix (matrix mode).
- W : libpysal.graph.Graph or scipy.sparse matrix¶
Spatial weights,
n × n(N × Nin a panel), row-standardized.- priors : dict, optional¶
Override default priors:
beta_mu,beta_sigma(default Gelman et al. 2008 on the log scale),rho_lower,rho_upper,alpha_sigma,alpha_nu(Half-Student-t on α) andalpha_fixed(hold α; a large value is essentially Poisson). SeeSARNegBinPriors; a panel’s arePanelCountPriors, which add the effects’unit_effect_mu,unit_effect_sd_scale,time_effect_muandtime_effect_sigma.- logdet_method : {"eigenvalue", "cheb", "aaa", "spline", "stochastic"}, optional¶
How
log|I - rho*W|is computed over rho: summed over the eigenvalues ofW; interpolated (Chebyshev, AAA rational, or cubic spline) through values from a sparse factorization, exact to the interpolant’s tolerance; or expanded stochastically with no factorization, the one method with sampling error.None(default) selects from the size and symmetry ofW:"eigenvalue"forn <= 500;"aaa"up ton = 60000(NEIGHBAYES_LOGDET_FACTOR_MAX_N) unless the factorization’s fill-in would dominate;"stochastic"beyond.- logdet_decomp : {"auto", "chol", "lu"}, default "auto"¶
The factorization an interpolating method uses: sparse Cholesky (undirected
W; scikit-sparse CHOLMOD) or sparse LU (KLU or UMFPACK, chosen by the sparsity pattern)."auto"takes"chol"where the method has it andWis undirected, else"lu". Ignored by"eigenvalue"and"stochastic";"spline"on"chol"raises.- time_col : str, optional¶
Formula-mode panel: the period and unit columns of
data. Given time, the model is a panel (neighbayes.models.panel._count), stacked by period, then unit, whose Gibbs sampler integrates β, the period effects and the unit effects out of every ρ update.- unit_col : str, optional¶
Formula-mode panel: the period and unit columns of
data. Given time, the model is a panel (neighbayes.models.panel._count), stacked by period, then unit, whose Gibbs sampler integrates β, the period effects and the unit effects out of every ρ update.- N : int, optional¶
Matrix-mode panel: the numbers of units and periods.
- T : int, optional¶
Matrix-mode panel: the numbers of units and periods.
- unit_effects : {None, "random"}, default None¶
A panel’s random unit effects inside the filter,
unit_effect. A cross-section takes none: one draw per observation is a disturbance, not a unit effect.- time_effects : bool, default False¶
A panel’s fixed time effects,
time_effect.- mundlak : bool, default False¶
Add the unit means of the time-varying columns to a panel’s design (inside the filter), absorbing a correlation between the unit effects and
X. Needs unit effects.- latent : bool, default True¶
The latent SAR;
Falsefits the reduced form. As a panel the latent SAR takes random unit effects and period effects, both inside the filter with the covariates and each period’s gamma disturbance; with period effects and a row-standardizedWits target carries Lee and Yu’s (2010) time-effects term, \(-T\log(1 - \rho)\), so that the period effects are flat on each period’s log-mean level.
-
__init__(formula=
None, data=None, y=None, X=None, W=None, *, unit_effects=None, time_effects=False, dynamic=False, mundlak=False, latent=None, **kwargs)[source]¶
Methods
__init__([formula, data, y, X, W, ...])fit([draws, tune, chains, target_accept, ...])Draw samples from the posterior.
Return fitted values at posterior mean parameters.
impacts([return_posterior_samples, scale])Compute Bayesian inference for direct, indirect, and total impacts.
posterior_predictive(*args, **kwargs)Posterior-predictive counts, shape
(n_draws, n_obs).Return residuals
y - fitted_values.Run Bayesian LM specification tests and return a summary table.
spatial_diagnostics_decision([alpha, format])Return a model-selection decision from Bayesian LM test results.
summary([var_names])Return posterior summary table.
Attributes
Return the ArviZ DataTree 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=None, random_seed=None, progressbar=True, sampler=None, backend=None, thin=1, n_jobs=-1, idata_kwargs=None, **sample_kwargs)[source]¶ Draw samples from the posterior.
Dispatches to this model’s Gibbs sampler (
sampler="gibbs") or NUTS (sampler="nuts"). WhensamplerisNone(default), Gibbs is used if the model has a registered Gibbs sampler, otherwise NUTS.- Parameters:¶
- draws : int¶
Post-warmup draws, warmup steps, and number of chains.
- tune : int¶
Post-warmup draws, warmup steps, and number of chains.
- chains : int¶
Post-warmup draws, warmup steps, and number of chains.
- target_accept : float, optional¶
Target acceptance rate for NUTS. NUTS-only: passing it with the Gibbs sampler raises
TypeError. Defaults to0.9for NUTS.- random_seed : int, optional¶
Seed for reproducibility.
- progressbar : bool, default True¶
Show progress bar(s) during sampling.
- sampler : {"gibbs", "nuts", None}, default None¶
Sampling method.
Noneauto-selects Gibbs when this model has one, else NUTS.- backend : str, optional¶
What executes the sampler. For Gibbs,
"auto"(the default),"jax"or"numpy";"auto"takes JAX when it is installed and supported by the family, else NumPy. For NUTS,"pymc"(the default),"nutpie","numpyro"or"blackjax".- thin : int, default 1¶
Keep every
thin-th post-warmup Gibbs draw (Gibbs only).- n_jobs : int, default -1¶
Parallel workers for the NumPy Gibbs path (Gibbs only).
- idata_kwargs : dict, optional¶
{"log_likelihood": True}stores the complete Jacobian-corrected pointwise log-likelihood thataz.loo/az.compareneed, for Gibbs and NUTS alike. Off by default, as in PyMC: it holds one value per draw, chain, and observation (16 GB at n = 250,000 with 4 × 2,000 draws). For NUTS the dict is also passed topm.sample.- **sample_kwargs¶
For NUTS, forwarded to
pm.sample; for Gibbs, the family’s declared options (an unsupported key raises).
- Return type:¶
xarray.DataTree
-
impacts(return_posterior_samples=
False, scale='logmean')[source]¶ Compute Bayesian inference for direct, indirect, and total impacts.
- Parameters:¶
- return_posterior_samples : bool, optional¶
If
True, also return the posterior draws for each effect type.- scale : {"logmean", "count"}, default "logmean"¶
Scale on which impacts are reported.
"logmean"returns the current default impacts on the linear predictor scale \(\log \mu\)."count"returns impacts on the expected-count scale \(\mu = \exp(\eta)\), which also needs the diagonal of the spatial multiplier at each posterior draw.
- property pymc_model[source]¶
Return the PyMC model object built for the most recent fit.
For a Gibbs-fitted cross-section the PyMC model is not constructed during sampling; it is built lazily on first access so that downstream consumers (e.g. bridge sampling for marginal likelihoods) can evaluate
logpand the prior under the same model definition used by the NUTS path.
- residuals()[source]¶
Return residuals
y - fitted_values.- Returns:¶
Residual vector
y - fitted_valueson the same scale asfitted_values().- Return type:¶
np.ndarray
- spatial_diagnostics()[source]¶
Run Bayesian LM specification tests and return a summary table.
Looks up the diagnostic suite registered for this model class 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 OLS model runs LM-Lag, LM-Error, LM-SDM-Joint, and LM-SLX-Error-Joint, while an SAR model runs LM-Error, LM-WX, and Robust-LM-WX. Panel models run the
Panel--prefixed analogues (e.g. Panel-LM-Lag).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.
ValueError – If no spatial weights matrix
Wwas supplied.
See also
spatial_diagnostics_decisionModel-selection decision based on the test results.
impactsPosterior inference for direct/indirect/total impacts.
Examples
>>> ols = OLS(formula="price ~ income + crime", data=df, W=w) >>> ols.fit() >>> ols.spatial_diagnostics() statistic median df p_value ci_lower ci_upper LM-Lag 3.21 2.98 1 0.073 0.12 8.54 LM-Error 5.67 5.34 1 0.017 0.34 12.10 LM-SDM-Joint 7.89 7.12 4 0.096 1.23 18.32 LM-SLX-Error-Joint 6.45 5.98 4 0.168 0.89 15.67
-
spatial_diagnostics_decision(alpha=
0.05, format='graphviz')[source]¶ Return a model-selection decision from Bayesian LM test results.
One rule reads every fitted model’s tests: the specific-to-general rule of Anselin et al. [1996], which
spreg’sstge_classicimplements. A model that leaves two directions untested runs a plain and a robust LM test for each:Neither plain test is significant → keep the model.
One is → add that direction.
Both are → add the direction whose robust test is significant; if both or neither are, the one with the smaller robust p-value.
A plain test is valid when the other direction is absent and a robust one is valid either way, at a cost in power, so the robust pair only chooses between two plain rejections. The SDM and SDEM leave one direction, and its test decides. The directions, and the models they lead to:
OLS: lag → SAR, error → SEM,
WX→ SLX. With three directions untested, the lag and the error together go to their robust pair whether or notWXalso rejects (the SAR or SEM then tests it); the lag andWXgo to the robust pair of Koley and Bera [2024], whose lag test is LM-Error at the OLS fit; the error andWX, whose scores are uncorrelated there, to the smaller p-value.SAR:
WX→ SDM, error → SARAR.SEM: lag → SARAR,
WX→ SDEM.SLX: lag → SDM, error → SDEM.
SDM: error → GNS. SDEM: lag → GNS.
SARAR and GNS are where the tests point; neighbayes does not fit them. The
WXtests are those of Koley and Bera [2024]. Panel models run thePanel-tests through the same trees ([Elhorst, 2014]), and the Tobit classes the same trees with Tobit leaves. The logit, probit and NB at their aspatial null read their tests as a pair of their own.- Parameters:¶
- alpha : float, default 0.05¶
Significance level for the Bayesian p-values.
- format : {"graphviz", "ascii", "model"}, default "graphviz"¶
Output format.
"model"returns the recommended-model name string."ascii"returns an indented box-drawing rendering of the full decision tree with the chosen path highlighted."graphviz"returns agraphviz.Digraphobject that renders inline in Jupyter; if the optionalgraphvizpackage is not installed aUserWarningis issued and the ASCII rendering is returned instead.
- Returns:¶
Recommended model name when
format="model", an ASCII tree string whenformat="ascii", or agraphviz.Digraphwhenformat="graphviz"(with ASCII fallback on missing dep).- Return type:¶
str or graphviz.Digraph
See also
spatial_diagnosticsCompute the Bayesian LM test statistics.
References
Koley and Bera [2024], Anselin et al. [1996], Elhorst [2014]