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: pymc
3description: Bayesian modeling with PyMC. Build hierarchical models, MCMC (NUTS), variational inference, LOO/WAIC comparison, posterior checks, for probabilistic programming and inference.
4allowed-tools: Read Write Edit Bash
5compatibility: Requires Python 3.12+ and PyMC 6.0.1-compatible dependencies. Install reproducible environments with `uv pip install "pymc[nutpie]==6.0.1"`; optional NumPyro or BlackJAX samplers require separately pinned JAX-compatible dependencies.
6license: Apache License, Version 2.0
7metadata:
8 version: "1.3"
9 skill-author: K-Dense Inc.
10---
11
12# PyMC Bayesian Modeling
13
14## Overview
15
16PyMC 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).
17
18## Current Version and Setup
19
20PyMC 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:
21
22```bash
23uv pip install "pymc[nutpie]==6.0.1"
24```
25
26The `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.
27
28## When to Use This Skill
29
30This skill should be used when:
31- Building Bayesian models (linear/logistic regression, hierarchical models, time series, etc.)
32- Performing MCMC sampling or variational inference
33- Conducting prior/posterior predictive checks
34- Diagnosing sampling issues (divergences, convergence, ESS)
35- Comparing multiple models using information criteria (LOO, WAIC)
36- Implementing uncertainty quantification through Bayesian methods
37- Working with hierarchical/multilevel data structures
38- Handling missing data or measurement error in a principled way
39
40## Standard Bayesian Workflow
41
42Never sample first and check later. The eight-step workflow — documented with code in
43[references/standard_workflow.md](references/standard_workflow.md) — is:
44
451. **Data preparation** — including standardizing predictors so priors are interpretable.
462. **Model building** — priors and likelihood in a `pm.Model` context.
473. **Prior predictive check** — confirm the priors imply plausible data *before* fitting.
484. **Fit model** — `pm.sample()` with an explicit seed.
495. **Check diagnostics** — R-hat, ESS, divergences. Divergences invalidate the fit; fix
50 the model or reparameterize rather than raising `target_accept` and hoping.
516. **Posterior predictive check** — does the fitted model reproduce the observed data?
527. **Analyze results** — summaries and intervals from the posterior.
538. **Make predictions** — on new data via `pm.set_data` and posterior predictive sampling.
54
55Reusable model structures and model comparison are in
56[references/model_patterns.md](references/model_patterns.md).
57
58## Distribution Selection Guide
59
60### For Priors
61
62**Scale parameters** (σ, τ):
63- `pm.HalfNormal('sigma', sigma=1)` - Default choice
64- `pm.Exponential('sigma', lam=1)` - Alternative
65- `pm.Gamma('sigma', alpha=2, beta=1)` - More informative
66
67**Unbounded parameters**:
68- `pm.Normal('theta', mu=0, sigma=1)` - For standardized data
69- `pm.StudentT('theta', nu=3, mu=0, sigma=1)` - Robust to outliers
70
71**Positive parameters**:
72- `pm.LogNormal('theta', mu=0, sigma=1)`
73- `pm.Gamma('theta', alpha=2, beta=1)`
74
75**Probabilities**:
76- `pm.Beta('p', alpha=2, beta=2)` - Weakly informative
77- `pm.Uniform('p', lower=0, upper=1)` - Non-informative (use sparingly)
78
79**Correlation matrices**:
80- `pm.LKJCholeskyCov('chol', n=n_vars, eta=2, sd_dist=pm.HalfNormal.dist(1))` - Preferred covariance prior
81- `pm.LKJCorr('corr', n=n_vars, eta=2)` - Correlation-only prior; eta=1 uniform, eta>1 prefers identity
82
83### For Likelihoods
84
85**Continuous outcomes**:
86- `pm.Normal('y', mu=mu, sigma=sigma)` - Default for continuous data
87- `pm.StudentT('y', nu=nu, mu=mu, sigma=sigma)` - Robust to outliers
88
89**Count data**:
90- `pm.Poisson('y', mu=lambda)` - Equidispersed counts
91- `pm.NegativeBinomial('y', mu=mu, alpha=alpha)` - Overdispersed counts
92- `pm.ZeroInflatedPoisson('y', psi=psi, mu=mu)` - Excess zeros
93- `pm.HurdleNegativeBinomial('y', psi=psi, mu=mu, alpha=alpha)` - Excess zeros plus overdispersion
94
95**Binary outcomes**:
96- `pm.Bernoulli('y', p=p)` or `pm.Bernoulli('y', logit_p=logit_p)`
97
98**Categorical outcomes**:
99- `pm.Categorical('y', p=probs)`
100
101**See:** `references/distributions.md` for comprehensive distribution reference
102
103## Sampling and Inference
104
105### MCMC with NUTS
106
107Default and recommended for most models:
108
109```python
110idata = pm.sample(
111 draws=2000,
112 tune=1000,
113 chains=4,
114 target_accept=0.9,
115 random_seed=42
116)
117```
118
119**Adjust when needed:**
120- Divergences → `target_accept=0.95` or higher
121- Slow sampling → Use ADVI for initialization
122- Discrete parameters → Use `pm.Metropolis()` for discrete vars
123
124### Variational Inference
125
126Fast approximation for exploration or initialization:
127
128```python
129with model:
130 approx = pm.fit(n=20000, method='advi')
131
132 # Use for initialization
133 initvals = approx.sample(return_inferencedata=False)[0]
134 idata = pm.sample(initvals=initvals)
135```
136
137**Trade-offs:**
138- Much faster than MCMC
139- Approximate (may underestimate uncertainty)
140- Good for large models or quick exploration
141
142**See:** `references/sampling_inference.md` for detailed sampling guide
143
144## Diagnostic Scripts
145
146### Comprehensive Diagnostics
147
148```python
149from scripts.model_diagnostics import create_diagnostic_report
150
151create_diagnostic_report(
152 idata,
153 var_names=['alpha', 'beta', 'sigma'],
154 output_dir='diagnostics/'
155)
156```
157
158Creates:
159- Trace plots
160- Rank plots (mixing check)
161- Autocorrelation plots
162- Energy plots
163- Local ESS plots
164- Summary statistics CSV
165
166### Quick Diagnostic Check
167
168```python
169from scripts.model_diagnostics import check_diagnostics
170
171results = check_diagnostics(idata)
172```
173
174Checks R-hat, ESS, divergences, and tree depth.
175
176## Common Issues and Solutions
177
178### Divergences
179
180**Symptom:** `idata.sample_stats.diverging.sum() > 0`
181
182**Solutions:**
1831. Increase `target_accept=0.95` or `0.99`
1842. Use non-centered parameterization (hierarchical models)
1853. Add stronger priors to constrain parameters
1864. Check for model misspecification
187
188### Low Effective Sample Size
189
190**Symptom:** `ESS < 400`
191
192**Solutions:**
1931. Sample more draws: `draws=5000`
1942. Reparameterize to reduce posterior correlation
1953. Use QR decomposition for regression with correlated predictors
196
197### High R-hat
198
199**Symptom:** `R-hat > 1.01`
200
201**Solutions:**
2021. Run longer chains: `tune=2000, draws=5000`
2032. Check for multimodality
2043. Improve initialization with ADVI
205
206### Slow Sampling
207
208**Solutions:**
2091. Use ADVI initialization
2102. Reduce model complexity
2113. Increase parallelization: `cores=8, chains=8`
2124. Use variational inference if appropriate
213
214## Best Practices
215
216### Model Building
217
2181. **Always standardize predictors** for better sampling
2192. **Use weakly informative priors** (not flat)
2203. **Use named dimensions** (`dims`) for clarity
2214. **Non-centered parameterization** for hierarchical models
2225. **Check prior predictive** before fitting
223
224### Sampling
225
2261. **Run multiple chains** (at least 4) for convergence
2272. **Use `target_accept=0.9`** as baseline (higher if needed)
2283. **Include `log_likelihood=True`** for model comparison
2294. **Set random seed** for reproducibility
230
231### Validation
232
2331. **Check diagnostics** before interpretation (R-hat, ESS, divergences)
2342. **Posterior predictive check** for model validation
2353. **Compare multiple models** when appropriate
2364. **Report uncertainty** (HDI intervals, not just point estimates)
237
238### Workflow
239
2401. Start simple, add complexity gradually
2412. Prior predictive check → Fit → Diagnostics → Posterior predictive check
2423. Iterate on model specification based on checks
2434. Document assumptions and prior choices
244
245## Resources
246
247This skill includes:
248
249### References (`references/`)
250
251- **`distributions.md`**: Comprehensive catalog of PyMC distributions organized by category (continuous, discrete, multivariate, mixture, time series). Use when selecting priors or likelihoods.
252
253- **`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.
254
255- **`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.
256
257### Scripts (`scripts/`)
258
259- **`model_diagnostics.py`**: Automated diagnostic checking and report generation. Functions: `check_diagnostics()` for quick checks, `create_diagnostic_report()` for comprehensive analysis with plots.
260
261- **`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()`.
262
263### Templates (`assets/`)
264
265- **`linear_regression_template.py`**: Complete template for Bayesian linear regression with full workflow (data prep, prior checks, fitting, diagnostics, predictions).
266
267- **`hierarchical_model_template.py`**: Complete template for hierarchical/multilevel models with non-centered parameterization and group-level analysis.
268
269## Quick Reference
270
271### Model Building
272```python
273with pm.Model(coords={'var': names}) as model:
274 # Priors
275 param = pm.Normal('param', mu=0, sigma=1, dims='var')
276 # Likelihood
277 y = pm.Normal('y', mu=..., sigma=..., observed=data)
278```
279
280### Sampling
281```python
282idata = pm.sample(draws=2000, tune=1000, chains=4, target_accept=0.9)
283```
284
285### Diagnostics
286```python
287from scripts.model_diagnostics import check_diagnostics
288check_diagnostics(idata)
289```
290
291### Model Comparison
292```python
293from scripts.model_comparison import compare_models
294compare_models({'m1': idata1, 'm2': idata2}, ic='loo')
295```
296
297### Predictions
298```python
299with model:
300 pm.set_data({'X_data': X_new})
301 pred = pm.sample_posterior_predictive(idata, predictions=True)
302```
303
304## Additional Notes
305
306- 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`
307- Use `pm.model_to_graphviz(model)` to visualize model structure
308- Save results with `idata.to_netcdf('results.nc')`
309- Load with `az.from_netcdf('results.nc')`
310- For very large models, consider minibatch ADVI or data subsampling