bayesplain.priors.CorrelationPrior

class bayesplain.priors.CorrelationPrior(kappa, name='custom', rationale='')[source]

A stretched-beta prior on a correlation coefficient.

Parameterised by a width kappa: the prior density is proportional to (1 - rho**2) ** (1/kappa - 1) on (-1, 1). At kappa = 1 it is flat, meaning every correlation from -1 to 1 is equally plausible before seeing data. Below 1 it concentrates near zero; above 1 it pushes mass toward the extremes.

Variables:
kappa : float

Prior width.

name : str

Short label used in printed output.

rationale : str

Plain-English statement of what this assumption commits you to.

Methods

dist()

Return the prior as a frozen scipy distribution on (-1, 1).

dist()[source]

Return the prior as a frozen scipy distribution on (-1, 1).

kappa[source]
property label[source]

Name and parameter together, for printing in a summary table.

name = 'custom'[source]
rationale = ''[source]