Skip to content

Commit

Permalink
Fix get_parameter_prior_dict docstring
Browse files Browse the repository at this point in the history
Documentation did not match the code.
  • Loading branch information
dweindl committed Dec 9, 2024
1 parent 25c2f84 commit 996ae2b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions pypesto/objective/priors.py
Original file line number Diff line number Diff line change
Expand Up @@ -244,11 +244,13 @@ def get_parameter_prior_dict(
"parameterScaleUniform", "parameterScaleNormal",
"parameterScaleLaplace"}
prior_parameters:
Parameters of the priors. Parameters are defined in linear scale.
Parameters of the priors. Parameters are defined in the parameter
scale if the `prior_type` starts with ``parameterScale``, otherwise in
the linear scale.
parameter_scale:
scale in which the parameter is defined (since a parameter can be
log-transformed, while the prior is always defined in the linear
space, unless it starts with "parameterScale")
space, unless it starts with ``parameterScale``).
"""
log_f, d_log_f_dx, dd_log_f_ddx, res, d_res_dx = _prior_densities(
prior_type, prior_parameters
Expand Down

0 comments on commit 996ae2b

Please sign in to comment.