A tensor-like library for functions and distributions
Project description
Funsor
Funsor is a tensor-like library for functions and distributions.
See Functional tensors for probabilistic programming for a system description.
Installing
Install using pip:
Funsor supports Python 3.7+.
pip install funsor
Install from source:
git clone git@github.com:pyro-ppl/funsor.git
cd funsor
git checkout master
pip install .
Using funsor
Funsor can be used through a number of interfaces:
- Funsors can be used directly for probabilistic computations, using PyTorch optimizers in a standard training loop. Start with these examples: discrete_hmm, eeg_slds, kalman_filter, pcfg, sensor, slds, and vae.
- Funsors can be used to implement custom inference algorithms within Pyro, using custom elbo implementations in standard pyro.infer.SVI training. See these examples: mixed_hmm and bart forecasting.
- funsor.pyro provides a number of Pyro-compatible (and PyTorch-compatible) distribution classes that use funsors under the hood, as well utilities to convert between funsors and distributions.
- funsor.minipyro provides a limited alternate backend for the Pyro probabilistic programming language, and can perform some ELBO computations exactly.
Design
See design doc.
The goal of this library is to generalize Pyro's delayed inference algorithms from discrete to continuous variables, and to create machinery to enable partially delayed sampling compatible with universality. To achieve this goal this library makes three orthogonal design choices:
-
Open terms are objects. Funsors generalize the tensor interface to also cover arbitrary functions of multiple variables ("inputs"), where variables may be integers, real numbers, or real tensors. Function evaluation / substitution is the basic operation, generalizing tensor indexing. This allows probability distributions to be first-class Funsors and make use of existing tensor machinery, for example we can generalize tensor contraction to computing analytic integrals in conjugate probabilistic models.
-
Support nonstandard interpretation. Funsors support user-defined interpretations, including, eager, lazy, mixed eager+lazy, memoized (like opt_einsum's sharing), and approximate interpretations like Monte Carlo approximations of integration operations (e.g.
.sum()
over a funsor dimension). -
Named dimensions. Substitution is the most basic operation of Funsors. To avoid the difficulties of broadcasting and advanced indexing in positionally-indexed tensor libraries, all Funsor dimensions are named. Indexing uses the
.__call__()
method and can be interpreted as substitution (with well-understood semantics). Funsors are viewed as algebraic expressions with one algebraic free variable per dimension. Each dimension is either covariant (an output) or contravariant (an input).
Using funsor
we can easily implement Pyro-style
delayed sampling, roughly:
trace_log_prob = 0.
def pyro_sample(name, dist, obs=None):
assert isinstance(dist, Funsor)
if obs is not None:
value = obs
elif lazy:
# delayed sampling (like Pyro's parallel enumeration)
value = funsor.Variable(name, dist.support)
else:
value = dist.sample('value')[0]['value']
# save log_prob in trace
trace_log_prob += dist(value)
return value
# ...later during inference...
loss = -trace_log_prob.reduce(logaddexp) # collapses delayed variables
See funsor/minipyro.py for complete implementation.
Related projects
- Pyro's ops.packed, ops.einsum, and ops.contract
- Birch's delayed sampling
- autoconj
- dyna
- PSI solver
- Hakaru
- sympy
- namedtensor
Citation
If you use Funsor, please consider citing:
@article{obermeyer2019functional,
author = {Obermeyer, Fritz and Bingham, Eli and Jankowiak, Martin and
Phan, Du and Chen, Jonathan P},
title = {{Functional Tensors for Probabilistic Programming}},
journal = {arXiv preprint arXiv:1910.10775},
year = {2019}
}
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file funsor-0.4.5.tar.gz
.
File metadata
- Download URL: funsor-0.4.5.tar.gz
- Upload date:
- Size: 222.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.6 tqdm/4.62.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08b77e5de04d7cf5213b4013a08a2e756ab52572a48bef6774a0c70664d4fe31 |
|
MD5 | 8644e6029ee83fa2ebf6dae9abd0d6ba |
|
BLAKE2b-256 | 1b5f41b2584c91c611dfa109cd88356c9ff3d09da2768563b0d0f9ac4b5a7db8 |
File details
Details for the file funsor-0.4.5-py3-none-any.whl
.
File metadata
- Download URL: funsor-0.4.5-py3-none-any.whl
- Upload date:
- Size: 174.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.28.1 requests-toolbelt/0.9.1 urllib3/1.26.6 tqdm/4.62.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b99a2b5ddb26a93b5e9d28b82dbc8f36efc686c37da2f71086bfa5bc7f45726d |
|
MD5 | a868896dd355a3e9390b90add99636f4 |
|
BLAKE2b-256 | c29206ba28f04d94b758ab9066e916f12198f17b8b0a85f248e6439a43993233 |