API Reference

A task-to-section map for the public API. Use the search box (top right) for known-name lookups.

What are you trying to do?

Goal	Look here
Sample, evaluate density, compute moments, condition	Operations
Use a built-in distribution family	Distributions
Compose, transform, or stack distributions	Distributions → Composite and joint
Work with empirical samples or bootstrap replicates	Distributions → Empirical and bootstrap
Hold structured, immutable data	Records and data
Define a probabilistic model	Modeling and inference → Models
Run inference (MCMC, VI, SBI)	Modeling and inference → Inference methods
Check a posterior with predictive simulations	Modeling and inference → Predictive checks
Scale to Prefect / Ray / Dask	Workflows and orchestration
Constrain parameters / move to unconstrained space	Constraints and bijectors
Interop with TFP, scipy, xarray, or pandas	Conversion and interop
Inspect provenance of computed quantities	Provenance
Write a new distribution, inference method, or converter	Extending ProbPipe

Pages

• Operations — sample, log_prob, prob, unnormalized_log_prob, unnormalized_prob, random_log_prob, random_unnormalized_log_prob, mean, variance, cov, expectation, condition_on, from_distribution.
• Distributions — continuous, discrete, multivariate, composite and joint, empirical and bootstrap, random functions.
• Records and data — Record, NumericRecord, the RecordArray family, Weights, parameter-sweep Designs, and the auxiliary-metadata registry.
• Modeling and inference — model and likelihood classes, the inference-method registry and built-ins, iterative transformations, predictive checks.
• Workflows and orchestration — WorkflowFunction, Module, the workflow decorators, and Prefect-orchestration configuration.
• Constraints and bijectors — Constraint singletons and factories, the bijector_for map for reparameterization.
• Conversion and interop — converter_registry, Converter, the conversion-info dataclasses.
• Provenance — Provenance, provenance_ancestors, provenance_dag.
• Extending ProbPipe — base classes, protocols, and extension contracts.
• Internals — implementation details that may move between releases.