bayesplain.priors.resolve_correlation¶
- bayesplain.priors.resolve_correlation(prior)[source]¶
Turn whatever the user passed as
prior=into aCorrelationPrior.Accepts a preset name, a positive number read as
kappa, an existingCorrelationPrior, orNonefor the flat default.- Parameters:¶
- prior : str, float, CorrelationPrior, or None¶
The prior specification.
Noneresolves to"uninformed".
- Returns:¶
The resolved prior.
- Return type:¶
- Raises:¶
ValueError – If a name is not a known preset, or the value is not a positive number.