Metadata-Version: 2.4
Name: cathedral
Version: 0.1.0
Summary: A Pythonic probabilistic programming library inspired by Church and WebPPL
Author: Andrew Giessel
License: MIT
Project-URL: Homepage, https://andrewgiessel.github.io/cathedral/
Project-URL: Repository, https://github.com/andrewgiessel/cathedral
Project-URL: Documentation, https://andrewgiessel.github.io/cathedral/
Keywords: python
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24.4
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Dynamic: license-file

# Cathedral

<p align="center">
  <img src="assets/logo.jpeg" alt="Cathedral Logo" width="300"/>
</p>

[![Build status](https://img.shields.io/github/actions/workflow/status/andrewgiessel/cathedral/main.yml?branch=main)](https://github.com/andrewgiessel/cathedral/actions/workflows/main.yml?query=branch%3Amain)

A Pythonic probabilistic programming library inspired by [Church](https://cocolab.stanford.edu/papers/GoodmanEtAl2008-UncertaintyInArtificialIntelligence.pdf) and [WebPPL](http://webppl.org/). Write probabilistic models as plain Python functions, then run inference to get posteriors.

Cathedral fills a gap in the Python ecosystem: **Church/WebPPL-level expressiveness** (stochastic control flow, recursive models, stochastic memoization) with **Pythonic syntax** and access to Python's scientific computing stack.

## Quick Start

```python
from cathedral import model, infer, flip, condition

@model
def sprinkler():
    rain = flip(0.3)
    sprinkler_on = flip(0.5)
    if rain:
        wet = flip(0.9)
    elif sprinkler_on:
        wet = flip(0.8)
    else:
        wet = flip(0.1)
    condition(wet)
    return {"rain": rain, "sprinkler": sprinkler_on}

# Exact answer via enumeration
posterior = infer(sprinkler, method="enumerate")
print(f"P(rain | wet grass) = {posterior.probability('rain'):.4f}")  # 0.4615...

# Or approximate via sampling
posterior = infer(sprinkler, method="rejection", num_samples=10000)
posterior = infer(sprinkler, method="mh", num_samples=5000, burn_in=1000)
```

## Installation

```bash
pip install cathedral
```

Requires Python >= 3.10, numpy, and scipy.

## Primitives

| Primitive | Description |
|-----------|-------------|
| `flip(p)` | Flip a coin with probability `p` of True |
| `sample(dist)` | Draw from any distribution (`Normal`, `Beta`, `Gamma`, ...) |
| `condition(pred)` | Hard conditioning: reject execution if `pred` is False |
| `observe(dist, val)` | Soft conditioning: score execution by `dist.log_prob(val)` |
| `factor(score)` | Add arbitrary log-probability to the trace |
| `mem(fn)` | Stochastic memoization: same args always return same random result |
| `DPmem(alpha, fn)` | Dirichlet Process memoization for nonparametric models |

## Inference Methods

| Method | Syntax | Best for |
|--------|--------|----------|
| **Rejection sampling** | `infer(m, method="rejection")` | Small discrete models with `condition()` |
| **Importance sampling** | `infer(m, method="importance")` | Continuous models with `observe()` |
| **Single-site MH** | `infer(m, method="mh")` | Complex models, rare conditions, many latent variables |
| **Exact enumeration** | `infer(m, method="enumerate")` | Small discrete models where you want exact answers |

### MH options

```python
infer(model, method="mh", num_samples=5000, burn_in=1000, lag=2)
```

### Enumeration options

```python
infer(model, method="enumerate", strategy="likely_first", max_executions=1000)
```

Strategies: `depth_first` (default), `breadth_first`, `likely_first`.

## Distributions

**Continuous:** `Normal`, `HalfNormal`, `Beta`, `Gamma`, `Uniform`

**Discrete:** `Bernoulli`, `Categorical`, `UniformDraw`, `Poisson`, `Geometric`

**Multivariate:** `Dirichlet`

All distributions support `.sample()`, `.log_prob(value)`, and `.prob(value)`. Discrete distributions also support `.support()` for enumeration.

## Posterior Analysis

```python
posterior = infer(my_model, method="rejection", num_samples=5000)

posterior.mean("param")                  # posterior mean
posterior.std("param")                   # posterior std
posterior.probability("flag")            # P(flag = True)
posterior.probability(lambda r: r > 0)   # P(predicate)
posterior.histogram("param")             # empirical distribution
posterior.credible_interval(0.95, "param")  # 95% credible interval
```

## Examples

The `examples/` directory contains runnable demonstrations inspired by [Probabilistic Models of Cognition](http://probmods.org/):

| File | Topics |
|------|--------|
| `01_generative_models.py` | Coin flips, composition, `mem`, stochastic recursion, causal models |
| `02_conditioning.py` | Bayesian reasoning, causal vs diagnostic inference, explaining away |
| `03_patterns_of_inference.py` | Bayesian updating, Monty Hall, Occam's razor |
| `04_bayesian_data_analysis.py` | Parameter estimation, model comparison, linear regression |
| `05_mixture_models.py` | Gaussian mixtures, `DPmem` for infinite components |
| `06_social_cognition.py` | Goal inference, preference learning, theory of mind |
| `07_grammars_and_recursion.py` | PCFGs, random arithmetic, conditioned generation |

Plus standalone examples: `sprinkler.py`, `coin_flip.py`, `linear_regression.py`.

## Architecture

Models are plain Python functions. A trace-based execution engine (via `contextvars`) records every random choice without passing trace objects through user code. Inference engines run models repeatedly, using interventions to replay or modify choices.

```
User code           Trace engine           Inference
─────────           ────────────           ─────────
@model fn    →    TraceContext      →    rejection / importance
flip/sample  →    Choice records    →    MH (propose + accept)
condition    →    log_score         →    enumeration (worklist)
observe      →    log_score         →    Posterior
```

## References

- [Church: A Language for Generative Models](https://arxiv.org/pdf/1206.3255v2.pdf) -- Goodman, Mansinghka, Roy, Bonawitz, Tenenbaum
- [Lightweight Implementations of Probabilistic Programming Languages](http://web.stanford.edu/~ngoodman/papers/lightweight-mcmc-aistats2011.pdf) -- Wingate, Stuhlmuller, Goodman
- [Probabilistic Models of Cognition](http://probmods.org/) -- Goodman & Tenenbaum
- [WebPPL](http://webppl.org/) -- Goodman & Stuhlmuller
- [Gen.jl](https://www.gen.dev/) -- Cusumano-Towner, Saad, Lew, Mansinghka
- [From Word Models to World Models](https://arxiv.org/abs/2306.12672) -- Wong, Grand, Lew, Goodman et al.

## License

MIT -- see [LICENSE](LICENSE).
