Skip to main content

Utility functions for extracting log-probabilities, parameter transforms, and Fisher information from NumPyro models.

Project description

numpyro-inferutils

Small utility functions for inference with NumPyro models.

This package provides lightweight helpers for:

  • extracting log-prior and log-likelihood from NumPyro models,
  • working with constrained / unconstrained parameter spaces,
  • computing Fisher information matrices from NumPyro models with independent Gaussian likelihoods.
  • performing MAP estimation using stochastic variational inference (SVI).

Installation

pip install numpyro-inferutils

Quick examples

A minimal NumPyro model

All examples below assume a simple NumPyro model such as:

import numpyro
import numpyro.distributions as dist
import numpy as np

x = np.linspace(-5, 5, 100)
sigma = np.ones_like(x) * np.exp(0.01)
y = 0.5 * x + 1.0 + np.random.randn(len(x)) * sigma

def model(x, y):
    w = numpyro.sample("w", dist.Normal(0.0, 1.0))
    b = numpyro.sample("b", dist.Normal(0.0, 1.0))
    sigma = numpyro.sample("sigma", dist.LogNormal(0.0, 0.01))

    mu = w * x + b
    numpyro.deterministic("mu", mu)

    numpyro.sample("obs", dist.Normal(mu, sigma), obs=y)

Log-prior and log-likelihood

from numpyro_inferutils import build_logprob_functions

logprior, loglik = build_logprob_functions(model, model_kwargs={"x": x, "y": y})

theta = {
    "w": 0.0,
    "b": 1.2,
}

lp = logprior(theta)
ll = loglik(theta)
  • logprior(theta) sums log-probabilities from non-observed sample sites.
  • loglik(theta) sums log-probabilities from observed sample sites.
  • Contributions added via numpyro.factor are treated as part of the log-likelihood.

Constrained ↔ unconstrained parameters

from numpyro_inferutils.transforms import to_unconstrained_dict

params_constrained = {"sigma": 2.0}
params_unconstrained = to_unconstrained_dict(
    model,
    params_constrained,
    keys=["sigma"],
    x=x, y=y
)

This inspects the model’s sample-site supports and applies the appropriate inverse transforms using

biject_to(site["fn"].support)

MAP estimation via SVI

For many applications, it is useful to obtain a fast maximum a posteriori (MAP) estimate, for example as an initial point for NUTS.

import jax
from numpyro_inferutils import find_map_svi

rng_key = jax.random.PRNGKey(0)

p_map = find_map_svi(
    model,
    step_size=1e-2,
    num_steps=5_000,
    rng_key=rng_key,
    x=x,
    y=y,
)
  • The MAP estimate is obtained via stochastic variational inference (SVI) using a Laplace autoguide (AutoLaplaceApproximation).
  • Only a MAP-like point estimate (the guide median) is returned; the covariance of the Laplace approximation is intentionally not used.
  • Parameter constraints defined in the NumPyro model are handled automatically.
  • The returned parameters are in the constrained space.

Fisher information (independent Gaussian likelihood)

from numpyro_inferutils.fisher import information_from_model_independent_normal

info = information_from_model_independent_normal(
    model=model,
    pdic={"w": 1.0, "b": 0.5},
    mu_name="mu",
    observed=y,
    model_args=(x, y),
    keys=["w", "b"],
    sigma_sd=sigma,
)

F = info["fisher"]

The Fisher matrix for an independent Gaussian likelihood is computed as

F = Jᵀ J,

where J_ij = ∂r_i / ∂θ_j and

r = (y − μ(θ)) / σ.

Both constrained and unconstrained parameterizations are supported.

When the model mean is split across multiple deterministic sites, mu_name may also be given as a list or tuple. In that case, the corresponding mean vectors are flattened and concatenated before constructing the standardized residuals. The same convention is supported for observed, obs_name, and sigma_sd: each may be passed either as one already-concatenated 1D array, or as a list/tuple matching the blocks in mu_name.

info = information_from_model_independent_normal(
    model=model,
    pdic={"w": 1.0, "b": 0.5},
    mu_name=["mu_flux", "mu_rv"],
    observed=[y_flux, y_rv],
    sigma_sd=[sigma_flux, sigma_rv],
    model_args=(x_flux, x_rv, y_flux, y_rv),
    keys=["w", "b"],
)

The final concatenated shapes of mu, observed, and sigma_sd must agree.


License

MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

numpyro_inferutils-0.1.3.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

numpyro_inferutils-0.1.3-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file numpyro_inferutils-0.1.3.tar.gz.

File metadata

  • Download URL: numpyro_inferutils-0.1.3.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for numpyro_inferutils-0.1.3.tar.gz
Algorithm Hash digest
SHA256 4e7f1d4faff96f033894e15b9a0750ec29d7f12db5f92a88131057678048a1d3
MD5 896bccc5361835b8fb4f2f56c0594cf8
BLAKE2b-256 4127fe235f613a1626e30b9eba6bc15611e1f41e1b27bcdfff67bff6603e1b0c

See more details on using hashes here.

Provenance

The following attestation bundles were made for numpyro_inferutils-0.1.3.tar.gz:

Publisher: release.yml on kemasuda/numpyro-inferutils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file numpyro_inferutils-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for numpyro_inferutils-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 61617d1c530afec15a10284f01a5a16aa37f60910c4ed4a58ee376ae45a1104e
MD5 7883ce80f5da7d3ac256765cb3c8c296
BLAKE2b-256 ddc9bc78bb4d0ccf5fe799637b258ac98d8e8037c4de9067df066632fbd1246e

See more details on using hashes here.

Provenance

The following attestation bundles were made for numpyro_inferutils-0.1.3-py3-none-any.whl:

Publisher: release.yml on kemasuda/numpyro-inferutils

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page