bayesplain.priors.resolve_rate

bayesplain.priors.resolve_rate(prior)[source]

Turn whatever the user passed as prior= into a RatePrior.

Accepts a preset name, a (shape, exposure) pair, an existing RatePrior, or None for the Jeffreys default.

Parameters:
prior : str, tuple, RatePrior, or None

The prior specification. None resolves to "jeffreys".

Returns:

The resolved prior.

Return type:

RatePrior

Raises:

ValueError – If a name is not a known preset, or a tuple of the wrong length.