StructuredAdditiveTerm.summarise_by_quantiles()

StructuredAdditiveTerm.summarise_by_quantiles()#

StructuredAdditiveTerm.summarise_by_quantiles(samples, x=None, axis=(0, 1), lo=0.1, hi=0.9, center=False, scale=False)[source]#

Computes a posterior summary for this term based on quantiles.

Parameters:

  • samples (dict[str, Any]) – Array of posterior samples.

  • x (Optional[Any]) – Array of covariate values. (default: None)

  • axis (Sequence[int] | int) – Indicates the axes of samples that index the posterior samples. (default: (0, 1))

  • lo (float) – Probability level for lower quantile to include in summary. (default: 0.1)

  • hi (float) – Probability level for upper quantile to include in summary. (default: 0.9)

  • center (bool) – Whether to center the predictions. (default: False)

  • scale (bool) – Whether to scale the predictions. (default: False)

  • indices – If not None, only the columns of x with these indices are used.

Return type:

DataFrame

Contents