diff --git a/CHANGELOG.md b/CHANGELOG.md index 03a2311339..29f322c673 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ ### Deprecation * Deprecated `index_origin` and `order` arguments in `az.summary` ([1201](https://github.com/arviz-devs/arviz/pull/1201)) +* Improve documentation on experimental `SamplingWrapper` classes ([1582](https://github.com/arviz-devs/arviz/pull/1582)) ### Documentation * Added "Label guide" page and API section for `arviz.labels` module ([1201](https://github.com/arviz-devs/arviz/pull/1201)) diff --git a/arviz/wrappers/base.py b/arviz/wrappers/base.py index 727b7ea7a7..682221990f 100644 --- a/arviz/wrappers/base.py +++ b/arviz/wrappers/base.py @@ -12,7 +12,8 @@ class SamplingWrapper: functions requiring refitting like Leave Future Out or Simulation Based Calibration can be performed from ArviZ. - For more info on wrappers see :ref:`wrappers_api` + See other SamplingWrapper classes at :ref:`wrappers api section `. For + usage examples see user guide pages on :ref:`wrapper_guide`. Parameters ---------- diff --git a/arviz/wrappers/wrap_pystan.py b/arviz/wrappers/wrap_pystan.py index f7160b89bb..20823266a7 100644 --- a/arviz/wrappers/wrap_pystan.py +++ b/arviz/wrappers/wrap_pystan.py @@ -9,12 +9,17 @@ class PyStanSamplingWrapper(SamplingWrapper): See the documentation on :class:`~arviz.SamplingWrapper` for a more detailed description. An example of ``PyStanSamplingWrapper`` usage can be found - in the :ref:`pystan_refitting` notebook. + in the :ref:`pystan_refitting` notebook. For usage examples of other wrappers + see the user guide pages on :ref:`wrapper_guide`. Warnings -------- Sampling wrappers are an experimental feature in a very early stage. Please use them with caution. + + See Also + -------- + SamplingWrapper """ def sel_observations(self, idx): diff --git a/doc/source/user_guide/sampling_wrappers.md b/doc/source/user_guide/sampling_wrappers.md index affe6549a3..1421cf34cc 100644 --- a/doc/source/user_guide/sampling_wrappers.md +++ b/doc/source/user_guide/sampling_wrappers.md @@ -1,3 +1,4 @@ +(wrapper_guide)= # Sampling wrappers Sampling wrappers allow ArviZ to call PPLs in order to perform a limited subset of their capabilities and calculate stats and diagnostics that require