bambi-home
  • Getting Started
  • API Reference
  • Examples
  • FAQ
  • Changelog
  • Contact
  1. Custom families
  2. Link
  • Function reference
  • Model
    • Model
    • Formula
  • Setting up priors
    • Prior
  • Custom families
    • Family
    • Likelihood
    • Link
  • Plots
    • interpret.plot_comparisons
    • interpret.plot_predictions
    • interpret.plot_slopes
  • Interpretations
    • interpret.comparisons
    • interpret.predictions
    • interpret.slopes
  • Data
    • clear_data_home
    • load_data

On this page

  • Link
    • Parameters

Link

families.Link(self, name, link=None, linkinv=None, linkinv_backend=None)

Representation of a link function

This object contains two main functions. One is the link function itself, the function that maps values in the response scale to the linear predictor, and the other is the inverse of the link function, that maps values of the linear predictor to the response scale.

The great majority of users will never interact with this class unless they want to create a custom Family with a custom Link. This is automatically handled for all the built-in families.

Parameters

Name Type Description Default
name str The name of the link function. If it is a known name, it’s not necessary to pass any other arguments because functions are already defined internally. If not known, all of link, linkinv and linkinv_backend must be specified. required
link function A function that maps the response to the linear predictor. Known as the :math:g function in GLM jargon. Does not need to be specified when name is a known name. None
linkinv function A function that maps the linear predictor to the response. Known as the :math:g^{-1} function in GLM jargon. Does not need to be specified when name is a known name. None
linkinv_backend function Same than linkinv but must be something that works with PyMC backend (i.e. it must work with PyTensor tensors). Does not need to be specified when name is a known name. None
Likelihood
interpret.plot_comparisons
 

© Copyright 2024, The developers of Bambi.