From 8f6203b252bbb68b43524a7531782e7f42f961af Mon Sep 17 00:00:00 2001 From: Chris Fonnesbeck Date: Wed, 22 Mar 2023 13:53:02 -0500 Subject: [PATCH 1/2] Improved docstring for predictions argument in sample_posterior_predictive --- pymc/sampling/forward.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/pymc/sampling/forward.py b/pymc/sampling/forward.py index a03c598c9e..e9276b72df 100644 --- a/pymc/sampling/forward.py +++ b/pymc/sampling/forward.py @@ -481,8 +481,7 @@ def sample_posterior_predictive( Whether to automatically use :meth:`arviz.InferenceData.extend` to add the posterior predictive samples to ``trace`` or not. If True, ``trace`` is modified inplace but still returned. predictions : bool, default False - Choose the function used to convert the samples to inferencedata. See ``idata_kwargs`` - for more details. + Flag used to set the location of posteior predictive samples within the returned ``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. idata_kwargs : dict, optional Keyword arguments for :func:`pymc.to_inference_data` if ``predictions=False`` or to :func:`pymc.predictions_to_inference_data` otherwise. From 474266f974ab1cfbb1da3e4b5f9e7bf0a542c96a Mon Sep 17 00:00:00 2001 From: Chris Fonnesbeck Date: Wed, 22 Mar 2023 15:15:24 -0500 Subject: [PATCH 2/2] Fix typos Co-authored-by: Ravin Kumar <7213793+canyon289@users.noreply.github.com> --- pymc/sampling/forward.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pymc/sampling/forward.py b/pymc/sampling/forward.py index e9276b72df..fd0260c3ae 100644 --- a/pymc/sampling/forward.py +++ b/pymc/sampling/forward.py @@ -481,7 +481,7 @@ def sample_posterior_predictive( Whether to automatically use :meth:`arviz.InferenceData.extend` to add the posterior predictive samples to ``trace`` or not. If True, ``trace`` is modified inplace but still returned. predictions : bool, default False - Flag used to set the location of posteior predictive samples within the returned ``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. + 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. idata_kwargs : dict, optional Keyword arguments for :func:`pymc.to_inference_data` if ``predictions=False`` or to :func:`pymc.predictions_to_inference_data` otherwise.