View source on GitHub

Base class for models in the Inference Gym.

A model, at the minimum, describes its support and allows evaluating its un-normalized log density via the unnormalized_log_prob method.

Given a Bayesian model conditioned on evidence, you can access the associated un-normalized density via the unnormalized_log_prob method.

The dtype, shape, and constraints over the support are returned by the dtype, event_shape, and default_event_space_bijector properties. Note that x could be structured, in which case dtype and shape will be structured as well (parallel to the structure of x). default_event_space_bijector need not be structured, but could operate on the structured x. A generic way of constructing a random number that is within the event space of this model is to do:

model = LogisticRegression(...)
unconstrained_values = tf.nest.map_structure(
    lambda d, s: tf.random.normal(s, dtype=d),
constrained_values = tf.nest.map_structure_up_to(
    lambda b, v: b(v),

A model has two names. First, the name property is used for various name scopes inside the implementation of the model. Second, a pretty name which is meant to be suitable for a table inside a publication, accessed via the __str__ method.

Models come with associated sample transformations, which describe useful ways of looking at the samples from the posterior distribution. Each transformation optionally comes equipped with various ground truth values (computed analytically or via Monte Carlo averages). You can apply the transformations to samples from the model like so:

model = LogisticRegression(...)
for name, sample_transformation in model.sample_transformations.items():
  transformed_samples = sample_transformation(samples)
  if sample_transformation.ground_truth_mean is not None:
    square_diff = tf.nest.map_structure(
        lambda gtm, sm: (gtm - tf.reduce_mean(sm, axis=0))**2,


A simple 2-variable model:

class SimpleModel(gym.targets.Model):

  def __init__(self):
    super(SimpleModel, self).__init__(
                fn=lambda x: x,

  def _unnormalized_log_prob(self, value):
    return 1. + value - tf.math.exp(value)

We don't specify the ground truth values for the identity sample transformation for demonstration purposes, which you'd normally only do if they are not known analytically. See GermanCreditNumericLogisticRegression Bayesian model for an example of how to incorporate Monte-Carlo derived values for ground truth into a sample transformation.

default_event_space_bijector A (nest of) bijectors that take unconstrained R**n tensors to the event space of the posterior.
event_shape A (nest of) shapes describing the samples from the posterior.
dtype A (nest of) dtypes describing the dtype of the posterior.
name Python str name prefixed to Ops created by this class.
pretty_name A Python str. The pretty name of this model.
sample_transformations A dictionary of Python strings to SampleTransformations.

default_event_space_bijector Bijector mapping the reals (R**n) to the event space of this model.
dtype The DType of Tensors handled by this model.
event_shape Shape of a single sample from as a TensorShape.

May be partially defined or unknown.

name Python str name prefixed to Ops created by this class.
sample_transformations A dictionary of names to SampleTransformations.

Child Classes

class SampleTransformation



View source

The un-normalized log density of evaluated at a point.

This corresponds to the target distribution associated with the model, often its posterior.

value A (nest of) Tensor to evaluate the log density at.
name Python str name prefixed to Ops created by this method.

unnormalized_log_prob A floating point Tensor.