Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding default priors for Binomial/Bernoulli families with logit link #830

Merged
merged 19 commits into from
Aug 22, 2024
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ docs/_build
pytest.ini
/.quarto/
.Rproj.user
# Git ignore all the notebook files in the root
*.ipynb
78 changes: 69 additions & 9 deletions bambi/priors/scaler.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
import numpy as np
import pymc as pm

from bambi.families.univariate import Cumulative, Gaussian, StoppingRatio, StudentT, VonMises
from bambi.families.univariate import (
Bernoulli,
Binomial,
Cumulative,
Gaussian,
StoppingRatio,
StudentT,
VonMises,
)
from bambi.model_components import ConstantComponent
from bambi.priors.prior import Prior

Expand Down Expand Up @@ -30,8 +38,7 @@ def __init__(self, model):
def get_intercept_stats(self):
mu = self.response_mean
sigma = self.STD * self.response_std

# Only adjust mu and sigma if there is at least one Normal prior for a common term.
# Only adjust sigma if there is at least one Normal prior for a common term.
if self.priors:
sigmas = np.hstack([prior["sigma"] for prior in self.priors.values()])
x_mean = np.hstack(
Expand All @@ -58,23 +65,76 @@ def scale_response(self):
def scale_intercept(self, term):
if term.prior.name != "Normal":
return
mu, sigma = self.get_intercept_stats()
# Special case for logit links with bernoulli or binomial family
if (
isinstance(self.model.family, (Bernoulli, Binomial))
and self.model.family.link["p"].name == "logit"
):
mu = 0
sigma = 1.5
else:
mu, sigma = self.get_intercept_stats()
term.prior.update(mu=mu, sigma=sigma)

def scale_common(self, term):
if term.prior.name != "Normal":
return

# It can be greater than 1 for categorical variables
if term.data.ndim == 1:
mu = 0
sigma = self.get_slope_sigma(term.data)
# Special case for logit links with bernoulli or binomial family
if (
isinstance(self.model.family, (Bernoulli, Binomial))
and self.model.family.link["p"].name == "logit"
):
# For interaction terms, distinguish cases where all factor terms are categorical
if term.kind == "interaction":
tomicapretto marked this conversation as resolved.
Show resolved Hide resolved
all_categoric = all(
component.kind == "categoric" for component in term.term.components
)
if all_categoric:
sigma = 1
else:
sigma = 1 / np.std(term.data, axis=0)
# Single categorical term
elif term.categorical:
sigma = 1
# Single numerical term
else:
sigma = 1 / np.std(term.data, axis=0)
# If not, fall back to the regular case
else:
julianlheureux marked this conversation as resolved.
Show resolved Hide resolved
sigma = self.get_slope_sigma(term.data)
# It's a term that spans multiple columns of the design matrix
else:
julianlheureux marked this conversation as resolved.
Show resolved Hide resolved
mu = np.zeros(term.data.shape[1])
sigma = np.zeros(term.data.shape[1])
# Iterate over columns in the data
for i, value in enumerate(term.data.T):
sigma[i] = self.get_slope_sigma(value)
# Special case for logit links with bernoulli or binomial family
if (
isinstance(self.model.family, (Bernoulli, Binomial))
and self.model.family.link["p"].name == "logit"
):
# Iterate over columns in the data
for i, value in enumerate(term.data.T):
if term.kind == "interaction":
# Distinguish cases where all interaction factor terms are categorical
all_categoric = all(
component.kind == "categoric" for component in term.term.components
)
if all_categoric:
sigma[i] = 1
# It's the standard deviation of the marginal numerical variable (_not_ by group)
else:
julianlheureux marked this conversation as resolved.
Show resolved Hide resolved
sigma[i] = 1 / np.std(np.sum(term.data, axis=1))
# Single categorical term
elif term.categorical:
sigma[i] = 1
# Single numerical term
else:
sigma[i] = 1 / np.std(term.data, axis=0)
else:
for i, value in enumerate(term.data.T):
sigma[i] = self.get_slope_sigma(value)

# Save and set prior
self.priors.update({term.name: {"mu": mu, "sigma": sigma}})
Expand Down
Loading