StrctLinTerm

Contents

StrctLinTerm#

class liesel_gam.StrctLinTerm(basis, penalty, scale, name='', inference=None, coef_name=None, _update_on_init=True, validate_scalar_scale=True)[source]#

Bases: StrctTerm, LinMixin

Specialized StrctTerm for linear effects.

This term can be used, for example, to set up linear effects with a ridge prior.

Examples

>>> x = jnp.linspace(0.0, 1.0, 4)
>>> basis = Basis(
...     jnp.column_stack([jnp.ones_like(x), x]),
...     xname="x",
...     penalty=jnp.eye(2),
... )
>>> term = StrctLinTerm(basis, penalty=basis.penalty, scale=1.0)
>>> term.coef.value.shape
(2,)