PyMC Bayesian Modeling
Overview
PyMC is a Python library for Bayesian modeling and probabilistic programming. Build, fit, validate, and compare Bayesian models using PyMC's modern API (version 6.x+), including hierarchical models, MCMC sampling (NUTS), variational inference, posterior predictive checks, and model comparison (LOO, WAIC).
Current Version and Setup
PyMC 6.0.1 is the current stable release as of June 2026. It requires Python 3.12+, uses PyTensor 3 as the computational graph backend, and defaults to compiled backends such as Numba. For reproducible local environments, pin the version:
uv pip install "pymc[nutpie]==6.0.1"
The nutpie extra enables the faster Rust/Numba NUTS implementation. If using NumPyro or BlackJAX, install those optional sampler dependencies in the same environment and pin them in the project lockfile.
When to Use This Skill
This skill should be used when:
- Building Bayesian models (linear/logistic regression, hierarchical models, time series, etc.)
- Performing MCMC sampling or variational inference
- Conducting prior/posterior predictive checks
- Diagnosing sampling issues (divergences, convergence, ESS)
- Comparing multiple models using information criteria (LOO, WAIC)
- Implementing uncertainty quantification through Bayesian methods
- Working with hierarchical/multilevel data structures
- Handling missing data or measurement error in a principled way
Standard Bayesian Workflow
Never sample first and check later. The eight-step workflow — documented with code in
references/standard_workflow.md — is:
- Data preparation — including standardizing predictors so priors are interpretable.
- Model building — priors and likelihood in a
pm.Model context.
- Prior predictive check — confirm the priors imply plausible data before fitting.
- Fit model —
pm.sample() with an explicit seed.
- Check diagnostics — R-hat, ESS, divergences. Divergences invalidate the fit; fix
the model or reparameterize rather than raising
target_accept and hoping.
- Posterior predictive check — does the fitted model reproduce the observed data?
- Analyze results — summaries and intervals from the posterior.
- Make predictions — on new data via
pm.set_data and posterior predictive sampling.
Reusable model structures and model comparison are in
references/model_patterns.md.
Distribution Selection Guide
For Priors
Scale parameters (σ, τ):
pm.HalfNormal('sigma', sigma=1) - Default choice
pm.Exponential('sigma', lam=1) - Alternative
pm.Gamma('sigma', alpha=2, beta=1) - More informative
Unbounded parameters:
pm.Normal('theta', mu=0, sigma=1) - For standardized data
pm.StudentT('theta', nu=3, mu=0, sigma=1) - Robust to outliers
Positive parameters:
pm.LogNormal('theta', mu=0, sigma=1)
pm.Gamma('theta', alpha=2, beta=1)
Probabilities:
pm.Beta('p', alpha=2, beta=2) - Weakly informative
pm.Uniform('p', lower=0, upper=1) - Non-informative (use sparingly)
Correlation matrices:
pm.LKJCholeskyCov('chol', n=n_vars, eta=2, sd_dist=pm.HalfNormal.dist(1)) - Preferred covariance prior
pm.LKJCorr('corr', n=n_vars, eta=2) - Correlation-only prior; eta=1 uniform, eta>1 prefers identity
For Likelihoods
Continuous outcomes:
pm.Normal('y', mu=mu, sigma=sigma) - Default for continuous data
pm.StudentT('y', nu=nu, mu=mu, sigma=sigma) - Robust to outliers
Count data:
pm.Poisson('y', mu=lambda) - Equidispersed counts
pm.NegativeBinomial('y', mu=mu, alpha=alpha) - Overdispersed counts
pm.ZeroInflatedPoisson('y', psi=psi, mu=mu) - Excess zeros
pm.HurdleNegativeBinomial('y', psi=psi, mu=mu, alpha=alpha) - Excess zeros plus overdispersion
Binary outcomes:
pm.Bernoulli('y', p=p) or pm.Bernoulli('y', logit_p=logit_p)
Categorical outcomes:
pm.Categorical('y', p=probs)
See: references/distributions.md for comprehensive distribution reference
Sampling and Inference
MCMC with NUTS
Default and recommended for most models:
idata = pm.sample(
draws=2000,
tune=1000,
chains=4,
target_accept=0.9,
random_seed=42
)
Adjust when needed:
- Divergences →
target_accept=0.95 or higher
- Slow sampling → Use ADVI for initialization
- Discrete parameters → Use
pm.Metropolis() for discrete vars
Variational Inference
Fast approximation for exploration or initialization:
with model:
approx = pm.fit(n=20000, method='advi')
# Use for initialization
initvals = approx.sample(return_inferencedata=False)[0]
idata = pm.sample(initvals=initvals)
Trade-offs:
- Much faster than MCMC
- Approximate (may underestimate uncertainty)
- Good for large models or quick exploration
See: references/sampling_inference.md for detailed sampling guide
Diagnostic Scripts
Comprehensive Diagnostics
from scripts.model_diagnostics import create_diagnostic_report
create_diagnostic_report(
idata,
var_names=['alpha', 'beta', 'sigma'],
output_dir='diagnostics/'
)
Creates:
- Trace plots
- Rank plots (mixing check)
- Autocorrelation plots
- Energy plots
- Local ESS plots
- Summary statistics CSV
Quick Diagnostic Check
from scripts.model_diagnostics import check_diagnostics
results = check_diagnostics(idata)
Checks R-hat, ESS, divergences, and tree depth.
Common Issues and Solutions
Divergences
Symptom: idata.sample_stats.diverging.sum() > 0
Solutions:
- Increase
target_accept=0.95 or 0.99
- Use non-centered parameterization (hierarchical models)
- Add stronger priors to constrain parameters
- Check for model misspecification
Low Effective Sample Size
Symptom: ESS < 400
Solutions:
- Sample more draws:
draws=5000
- Reparameterize to reduce posterior correlation
- Use QR decomposition for regression with correlated predictors
High R-hat
Symptom: R-hat > 1.01
Solutions:
- Run longer chains:
tune=2000, draws=5000
- Check for multimodality
- Improve initialization with ADVI
Slow Sampling
Solutions:
- Use ADVI initialization
- Reduce model complexity
- Increase parallelization:
cores=8, chains=8
- Use variational inference if appropriate
Best Practices
Model Building
- Always standardize predictors for better sampling
- Use weakly informative priors (not flat)
- Use named dimensions (
dims) for clarity
- Non-centered parameterization for hierarchical models
- Check prior predictive before fitting
Sampling
- Run multiple chains (at least 4) for convergence
- Use
target_accept=0.9 as baseline (higher if needed)
- Include
log_likelihood=True for model comparison
- Set random seed for reproducibility
Validation
- Check diagnostics before interpretation (R-hat, ESS, divergences)
- Posterior predictive check for model validation
- Compare multiple models when appropriate
- Report uncertainty (HDI intervals, not just point estimates)
Workflow
- Start simple, add complexity gradually
- Prior predictive check → Fit → Diagnostics → Posterior predictive check
- Iterate on model specification based on checks
- Document assumptions and prior choices
Resources
This skill includes:
References (references/)
distributions.md: Comprehensive catalog of PyMC distributions organized by category (continuous, discrete, multivariate, mixture, time series). Use when selecting priors or likelihoods.
sampling_inference.md: Detailed guide to sampling algorithms (NUTS, Metropolis, SMC), variational inference (ADVI, SVGD), and handling sampling issues. Use when encountering convergence problems or choosing inference methods.
workflows.md: Complete workflow examples and code patterns for common model types, data preparation, prior selection, and model validation. Use as a cookbook for standard Bayesian analyses.
Scripts (scripts/)
model_diagnostics.py: Automated diagnostic checking and report generation. Functions: check_diagnostics() for quick checks, create_diagnostic_report() for comprehensive analysis with plots.
model_comparison.py: Model comparison utilities built on PSIS-LOO ELPD, the only criterion ArviZ 1.x compare() ranks on. Functions: compare_models(), check_loo_reliability(), model_averaging().
Templates (assets/)
linear_regression_template.py: Complete template for Bayesian linear regression with full workflow (data prep, prior checks, fitting, diagnostics, predictions).
hierarchical_model_template.py: Complete template for hierarchical/multilevel models with non-centered parameterization and group-level analysis.
Quick Reference
Model Building
with pm.Model(coords={'var': names}) as model:
# Priors
param = pm.Normal('param', mu=0, sigma=1, dims='var')
# Likelihood
y = pm.Normal('y', mu=..., sigma=..., observed=data)
Sampling
idata = pm.sample(draws=2000, tune=1000, chains=4, target_accept=0.9)
Diagnostics
from scripts.model_diagnostics import check_diagnostics
check_diagnostics(idata)
Model Comparison
from scripts.model_comparison import compare_models
compare_models({'m1': idata1, 'm2': idata2}, ic='loo')
Predictions
with model:
pm.set_data({'X_data': X_new})
pred = pm.sample_posterior_predictive(idata, predictions=True)
Additional Notes
- PyMC integrates with ArviZ for visualization and diagnostics; PyMC 6 / ArviZ 1 use xarray
DataTree while retaining familiar groups such as .posterior and .posterior_predictive
- Use
pm.model_to_graphviz(model) to visualize model structure
- Save results with
idata.to_netcdf('results.nc')
- Load with
az.from_netcdf('results.nc')
- For very large models, consider minibatch ADVI or data subsampling
1---2name: pymc3description: Bayesian modeling with PyMC. Build hierarchical models, MCMC (NUTS), variational inference, LOO/WAIC comparison, posterior checks, for probabilistic programming and inference.4license: Apache License, Version 2.05---6
7# PyMC Bayesian Modeling
8
9## Overview
10
11PyMC is a Python library for Bayesian modeling and probabilistic programming. Build, fit, validate, and compare Bayesian models using PyMC's modern API (version 6.x+), including hierarchical models, MCMC sampling (NUTS), variational inference, posterior predictive checks, and model comparison (LOO, WAIC).
12
13## Current Version and Setup
14
15PyMC 6.0.1 is the current stable release as of June 2026. It requires Python 3.12+, uses PyTensor 3 as the computational graph backend, and defaults to compiled backends such as Numba. For reproducible local environments, pin the version:
16
17```bash
18uv pip install "pymc[nutpie]==6.0.1"
19```
20
21The `nutpie` extra enables the faster Rust/Numba NUTS implementation. If using NumPyro or BlackJAX, install those optional sampler dependencies in the same environment and pin them in the project lockfile.
22
23## When to Use This Skill
24
25This skill should be used when:
26- Building Bayesian models (linear/logistic regression, hierarchical models, time series, etc.)
27- Performing MCMC sampling or variational inference
28- Conducting prior/posterior predictive checks
29- Diagnosing sampling issues (divergences, convergence, ESS)
30- Comparing multiple models using information criteria (LOO, WAIC)
31- Implementing uncertainty quantification through Bayesian methods
32- Working with hierarchical/multilevel data structures
33- Handling missing data or measurement error in a principled way
34
35## Standard Bayesian Workflow
36
37Never sample first and check later. The eight-step workflow — documented with code in
38[references/standard_workflow.md](references/standard_workflow.md) — is:
39
401. **Data preparation** — including standardizing predictors so priors are interpretable.
412. **Model building** — priors and likelihood in a `pm.Model` context.
423. **Prior predictive check** — confirm the priors imply plausible data *before* fitting.
434. **Fit model** — `pm.sample()` with an explicit seed.
445. **Check diagnostics** — R-hat, ESS, divergences. Divergences invalidate the fit; fix
45 the model or reparameterize rather than raising `target_accept` and hoping.
466. **Posterior predictive check** — does the fitted model reproduce the observed data?
477. **Analyze results** — summaries and intervals from the posterior.
488. **Make predictions** — on new data via `pm.set_data` and posterior predictive sampling.
49
50Reusable model structures and model comparison are in
51[references/model_patterns.md](references/model_patterns.md).
52
53## Distribution Selection Guide
54
55### For Priors
56
57**Scale parameters** (σ, τ):
58- `pm.HalfNormal('sigma', sigma=1)` - Default choice
59- `pm.Exponential('sigma', lam=1)` - Alternative
60- `pm.Gamma('sigma', alpha=2, beta=1)` - More informative
61
62**Unbounded parameters**:
63- `pm.Normal('theta', mu=0, sigma=1)` - For standardized data
64- `pm.StudentT('theta', nu=3, mu=0, sigma=1)` - Robust to outliers
65
66**Positive parameters**:
67- `pm.LogNormal('theta', mu=0, sigma=1)`
68- `pm.Gamma('theta', alpha=2, beta=1)`
69
70**Probabilities**:
71- `pm.Beta('p', alpha=2, beta=2)` - Weakly informative
72- `pm.Uniform('p', lower=0, upper=1)` - Non-informative (use sparingly)
73
74**Correlation matrices**:
75- `pm.LKJCholeskyCov('chol', n=n_vars, eta=2, sd_dist=pm.HalfNormal.dist(1))` - Preferred covariance prior
76- `pm.LKJCorr('corr', n=n_vars, eta=2)` - Correlation-only prior; eta=1 uniform, eta>1 prefers identity
77
78### For Likelihoods
79
80**Continuous outcomes**:
81- `pm.Normal('y', mu=mu, sigma=sigma)` - Default for continuous data
82- `pm.StudentT('y', nu=nu, mu=mu, sigma=sigma)` - Robust to outliers
83
84**Count data**:
85- `pm.Poisson('y', mu=lambda)` - Equidispersed counts
86- `pm.NegativeBinomial('y', mu=mu, alpha=alpha)` - Overdispersed counts
87- `pm.ZeroInflatedPoisson('y', psi=psi, mu=mu)` - Excess zeros
88- `pm.HurdleNegativeBinomial('y', psi=psi, mu=mu, alpha=alpha)` - Excess zeros plus overdispersion
89
90**Binary outcomes**:
91- `pm.Bernoulli('y', p=p)` or `pm.Bernoulli('y', logit_p=logit_p)`
92
93**Categorical outcomes**:
94- `pm.Categorical('y', p=probs)`
95
96**See:** `references/distributions.md` for comprehensive distribution reference
97
98## Sampling and Inference
99
100### MCMC with NUTS
101
102Default and recommended for most models:
103
104```python
105idata = pm.sample(
106 draws=2000,
107 tune=1000,
108 chains=4,
109 target_accept=0.9,
110 random_seed=42
111)
112```
113
114**Adjust when needed:**
115- Divergences → `target_accept=0.95` or higher
116- Slow sampling → Use ADVI for initialization
117- Discrete parameters → Use `pm.Metropolis()` for discrete vars
118
119### Variational Inference
120
121Fast approximation for exploration or initialization:
122
123```python
124with model:
125 approx = pm.fit(n=20000, method='advi')
126
127 # Use for initialization
128 initvals = approx.sample(return_inferencedata=False)[0]
129 idata = pm.sample(initvals=initvals)
130```
131
132**Trade-offs:**
133- Much faster than MCMC
134- Approximate (may underestimate uncertainty)
135- Good for large models or quick exploration
136
137**See:** `references/sampling_inference.md` for detailed sampling guide
138
139## Diagnostic Scripts
140
141### Comprehensive Diagnostics
142
143```python
144from scripts.model_diagnostics import create_diagnostic_report
145
146create_diagnostic_report(
147 idata,
148 var_names=['alpha', 'beta', 'sigma'],
149 output_dir='diagnostics/'
150)
151```
152
153Creates:
154- Trace plots
155- Rank plots (mixing check)
156- Autocorrelation plots
157- Energy plots
158- Local ESS plots
159- Summary statistics CSV
160
161### Quick Diagnostic Check
162
163```python
164from scripts.model_diagnostics import check_diagnostics
165
166results = check_diagnostics(idata)
167```
168
169Checks R-hat, ESS, divergences, and tree depth.
170
171## Common Issues and Solutions
172
173### Divergences
174
175**Symptom:** `idata.sample_stats.diverging.sum() > 0`
176
177**Solutions:**
1781. Increase `target_accept=0.95` or `0.99`
1792. Use non-centered parameterization (hierarchical models)
1803. Add stronger priors to constrain parameters
1814. Check for model misspecification
182
183### Low Effective Sample Size
184
185**Symptom:** `ESS < 400`
186
187**Solutions:**
1881. Sample more draws: `draws=5000`
1892. Reparameterize to reduce posterior correlation
1903. Use QR decomposition for regression with correlated predictors
191
192### High R-hat
193
194**Symptom:** `R-hat > 1.01`
195
196**Solutions:**
1971. Run longer chains: `tune=2000, draws=5000`
1982. Check for multimodality
1993. Improve initialization with ADVI
200
201### Slow Sampling
202
203**Solutions:**
2041. Use ADVI initialization
2052. Reduce model complexity
2063. Increase parallelization: `cores=8, chains=8`
2074. Use variational inference if appropriate
208
209## Best Practices
210
211### Model Building
212
2131. **Always standardize predictors** for better sampling
2142. **Use weakly informative priors** (not flat)
2153. **Use named dimensions** (`dims`) for clarity
2164. **Non-centered parameterization** for hierarchical models
2175. **Check prior predictive** before fitting
218
219### Sampling
220
2211. **Run multiple chains** (at least 4) for convergence
2222. **Use `target_accept=0.9`** as baseline (higher if needed)
2233. **Include `log_likelihood=True`** for model comparison
2244. **Set random seed** for reproducibility
225
226### Validation
227
2281. **Check diagnostics** before interpretation (R-hat, ESS, divergences)
2292. **Posterior predictive check** for model validation
2303. **Compare multiple models** when appropriate
2314. **Report uncertainty** (HDI intervals, not just point estimates)
232
233### Workflow
234
2351. Start simple, add complexity gradually
2362. Prior predictive check → Fit → Diagnostics → Posterior predictive check
2373. Iterate on model specification based on checks
2384. Document assumptions and prior choices
239
240## Resources
241
242This skill includes:
243
244### References (`references/`)
245
246- **`distributions.md`**: Comprehensive catalog of PyMC distributions organized by category (continuous, discrete, multivariate, mixture, time series). Use when selecting priors or likelihoods.
247
248- **`sampling_inference.md`**: Detailed guide to sampling algorithms (NUTS, Metropolis, SMC), variational inference (ADVI, SVGD), and handling sampling issues. Use when encountering convergence problems or choosing inference methods.
249
250- **`workflows.md`**: Complete workflow examples and code patterns for common model types, data preparation, prior selection, and model validation. Use as a cookbook for standard Bayesian analyses.
251
252### Scripts (`scripts/`)
253
254- **`model_diagnostics.py`**: Automated diagnostic checking and report generation. Functions: `check_diagnostics()` for quick checks, `create_diagnostic_report()` for comprehensive analysis with plots.
255
256- **`model_comparison.py`**: Model comparison utilities built on PSIS-LOO ELPD, the only criterion ArviZ 1.x `compare()` ranks on. Functions: `compare_models()`, `check_loo_reliability()`, `model_averaging()`.
257
258### Templates (`assets/`)
259
260- **`linear_regression_template.py`**: Complete template for Bayesian linear regression with full workflow (data prep, prior checks, fitting, diagnostics, predictions).
261
262- **`hierarchical_model_template.py`**: Complete template for hierarchical/multilevel models with non-centered parameterization and group-level analysis.
263
264## Quick Reference
265
266### Model Building
267```python
268with pm.Model(coords={'var': names}) as model:
269 # Priors
270 param = pm.Normal('param', mu=0, sigma=1, dims='var')
271 # Likelihood
272 y = pm.Normal('y', mu=..., sigma=..., observed=data)
273```
274
275### Sampling
276```python
277idata = pm.sample(draws=2000, tune=1000, chains=4, target_accept=0.9)
278```
279
280### Diagnostics
281```python
282from scripts.model_diagnostics import check_diagnostics
283check_diagnostics(idata)
284```
285
286### Model Comparison
287```python
288from scripts.model_comparison import compare_models
289compare_models({'m1': idata1, 'm2': idata2}, ic='loo')
290```
291
292### Predictions
293```python
294with model:
295 pm.set_data({'X_data': X_new})
296 pred = pm.sample_posterior_predictive(idata, predictions=True)
297```
298
299## Additional Notes
300
301- PyMC integrates with ArviZ for visualization and diagnostics; PyMC 6 / ArviZ 1 use xarray `DataTree` while retaining familiar groups such as `.posterior` and `.posterior_predictive`
302- Use `pm.model_to_graphviz(model)` to visualize model structure
303- Save results with `idata.to_netcdf('results.nc')`
304- Load with `az.from_netcdf('results.nc')`
305- For very large models, consider minibatch ADVI or data subsampling