Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add links to samplingwrapper docs #1582

Merged
merged 3 commits into from
Feb 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
3 changes: 2 additions & 1 deletion arviz/wrappers/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 <wrappers_api>`. For
usage examples see user guide pages on :ref:`wrapper_guide`.

Parameters
----------
Expand Down
7 changes: 6 additions & 1 deletion arviz/wrappers/wrap_pystan.py
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down
1 change: 1 addition & 0 deletions doc/source/user_guide/sampling_wrappers.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down