Skip to content

Commit

Permalink
update pymc.sample docstring
Browse files Browse the repository at this point in the history
Fix typo in idata.sample_stats
  • Loading branch information
treszkai authored and twiecki committed May 16, 2024
1 parent a144c43 commit 9c163dd
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion pymc/sampling/mcmc.py
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,7 @@ def sample(
Whether to compute sampler statistics like Gelman-Rubin and ``effective_n``.
keep_warning_stat : bool
If ``True`` the "warning" stat emitted by, for example, HMC samplers will be kept
in the returned ``idata.sample_stat`` group.
in the returned ``idata.sample_stats`` group.
This leads to the ``idata`` not supporting ``.to_netcdf()`` or ``.to_zarr()`` and
should only be set to ``True`` if you intend to use the "warning" objects right away.
Defaults to ``False`` such that ``pm.drop_warning_stat`` is applied automatically,
Expand Down

0 comments on commit 9c163dd

Please sign in to comment.