Skip to content

Commit 067d89b

Browse files
Improved docstring for predictions argument in sample_posterior_predictive (#6616)
* Improved docstring for predictions argument in sample_posterior_predictive * Fix typos Co-authored-by: Ravin Kumar <7213793+canyon289@users.noreply.github.com> --------- Co-authored-by: Ravin Kumar <7213793+canyon289@users.noreply.github.com>
1 parent 473c952 commit 067d89b

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

pymc/sampling/forward.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -481,8 +481,7 @@ def sample_posterior_predictive(
481481
Whether to automatically use :meth:`arviz.InferenceData.extend` to add the posterior predictive samples to
482482
``trace`` or not. If True, ``trace`` is modified inplace but still returned.
483483
predictions : bool, default False
484-
Choose the function used to convert the samples to inferencedata. See ``idata_kwargs``
485-
for more details.
484+
Flag used to set the location of posterior predictive samples within the returned ``arviz.InferenceData`` object. If False, assumes samples are generated based on the fitting data to be used for posterior predictive checks, and samples are stored in the ``posterior_predictive``. If True, assumes samples are generated based on out-of-sample data as predictions, and samples are stored in the ``predictions`` group.
486485
idata_kwargs : dict, optional
487486
Keyword arguments for :func:`pymc.to_inference_data` if ``predictions=False`` or to
488487
:func:`pymc.predictions_to_inference_data` otherwise.

0 commit comments

Comments
 (0)