term_ri.f()

Contents

term_ri.f()#

classmethod term_ri.f(basis, fname='ri', scale=1000.0, inference=MCMCSpec(kernel=<class 'liesel.goose.nuts.NUTSKernel'>, kernel_kwargs={}, kernel_group=None, jitter_dist=None, jitter_method='additive'))[source]#

Construct a random-intercept term with a custom scale.

Parameters:

  • basis (Basis) – Basis encoding integer group labels.

  • fname (str) – Prefix used to build the term name (default 'ri'). (default: 'ri')

  • scale (Var | Any | float) – Scale parameter (or variable) for the group coefficients. If a scalar is provided, it is wrapped into a parameter/value as needed. (default: 1000.0)

  • inference (Any) – Inference specification forwarded to coefficient creation. (default: MCMCSpec(kernel=<class 'liesel.goose.nuts.NUTSKernel'>, kernel_kwargs={}, kernel_group=None, jitter_dist=None, jitter_method='additive'))

Return type:

term_ri

Returns:

A configured random-intercept term.

Contents