Raw File
from typing import Optional

import tensorflow_probability as tfp

from .. import config
from .utilities import to_default_float


__all__ = ["positive", "triangular"]


def positive(lower: Optional[float] = None, base: Optional[str] = None) -> tfp.bijectors.Bijector:
    """
    Returns a positive bijector (a reversible transformation from real to positive numbers).

    :param lower: lower bound override (defaults to config.default_positive_minimum())
    :param base: overrides base positive bijector (defaults to config.default_positive_bijector())
    :returns: a bijector instance
    """
    if isinstance(base, str):
        base = base.lower()
    bijector = base if base is not None else config.default_positive_bijector()
    bijector = config.positive_bijector_type_map()[bijector]()
    if lower is None:
        lower = config.default_positive_minimum()
    if lower is not None:
        # Chain applies transformations in reverse order, so shift will be applied last
        shift = tfp.bijectors.AffineScalar(shift=to_default_float(lower))
        bijector = tfp.bijectors.Chain([shift, bijector])
    return bijector


def triangular() -> tfp.bijectors.Bijector:
    """
    Returns instance of a triangular bijector.
    """
    return tfp.bijectors.FillTriangular()
back to top