Skip to content

Commit c19962b

Browse files
committed
Note that initialize_model returns unconstrained parameters.
1 parent ab1f0dc commit c19962b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

numpyro/infer/util.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -668,12 +668,12 @@ def initialize_model(
668668
Defaults to True.
669669
:return: a namedtupe `ModelInfo` which contains the fields
670670
(`param_info`, `potential_fn`, `postprocess_fn`, `model_trace`), where
671-
`param_info` is a namedtuple `ParamInfo` containing values from the prior
672-
used to initiate MCMC, their corresponding potential energy, and their gradients;
673-
`postprocess_fn` is a callable that uses inverse transforms
674-
to convert unconstrained HMC samples to constrained values that
675-
lie within the site's support, in addition to returning values
676-
at `deterministic` sites in the model.
671+
`param_info` is a namedtuple `ParamInfo` containing *unconstrained* values from
672+
the prior used to initiate MCMC, their corresponding potential energy, and their
673+
gradients; `postprocess_fn` is a callable that uses inverse transforms to
674+
convert unconstrained HMC samples to constrained values that lie within the
675+
site's support, in addition to returning values at `deterministic` sites in the
676+
model.
677677
"""
678678
model_kwargs = {} if model_kwargs is None else model_kwargs
679679
substituted_model = substitute(

0 commit comments

Comments
 (0)