diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 490f905deab..94cf54e7510 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -16,6 +16,7 @@ - `pm.LKJCholeskyCov` now automatically computes and returns the unpacked Cholesky decomposition, the correlations and the standard deviations of the covariance matrix (see [#3881](https://github.com/pymc-devs/pymc3/pull/3881)). - `pm.Data` container can now be used for index variables, i.e with integer data and not only floats (issue [#3813](https://github.com/pymc-devs/pymc3/issues/3813), fixed by [#3925](https://github.com/pymc-devs/pymc3/pull/3925)). - `pm.Data` container can now be used as input for other random variables (issue [#3842](https://github.com/pymc-devs/pymc3/issues/3842), fixed by [#3925](https://github.com/pymc-devs/pymc3/pull/3925)). +- Plots and Stats API sections now link to ArviZ documentation [#3927](https://github.com/pymc-devs/pymc3/pull/3927) ### Maintenance - Tuning results no longer leak into sequentially sampled `Metropolis` chains (see #3733 and #3796). diff --git a/docs/source/api/plots.rst b/docs/source/api/plots.rst index 342af514989..fd22a168cd9 100644 --- a/docs/source/api/plots.rst +++ b/docs/source/api/plots.rst @@ -3,7 +3,20 @@ Plots ***** .. currentmodule:: pymc3.plots +Plots are delegated to the +`ArviZ `_. +library, a general purpose library for +"exploratory analysis of Bayesian models." +For plots, ``pymc3.`` are now aliases +for ArviZ functions. Thus, the links below will redirect you to +ArviZ docs: -.. automodule:: pymc3.plots - :members: traceplot, plot_posterior, forestplot, compareplot, autocorrplot, - energyplot, kdeplot, densityplot, pairplot +- :func:`pymc3.traceplot ` +- :func:`pymc3.plot_posterior ` +- :func:`pymc3.forestplot ` +- :func:`pymc3.compareplot ` +- :func:`pymc3.autocorrplot ` +- :func:`pymc3.energyplot ` +- :func:`pymc3.kdeplot ` +- :func:`pymc3.densityplot ` +- :func:`pymc3.pairplot ` diff --git a/docs/source/api/stats.rst b/docs/source/api/stats.rst index 1bf86de7202..8d47e1adac1 100644 --- a/docs/source/api/stats.rst +++ b/docs/source/api/stats.rst @@ -1,8 +1,25 @@ ***** Stats ***** +Statistics and diagnostics are delegated to the +`ArviZ `_. +library, a general purpose library for +"exploratory analysis of Bayesian models." +For statistics and diagnostics, ``pymc3.`` are now aliases +for ArviZ functions. Thus, the links below will redirect you to +ArviZ docs: .. currentmodule:: pymc3.stats -.. automodule:: pymc3.stats - :members: + +- :func:`pymc3.bfmi ` +- :func:`pymc3.compare ` +- :func:`pymc3.ess ` +- :data:`pymc3.geweke ` +- :func:`pymc3.hpd ` +- :func:`pymc3.loo ` +- :func:`pymc3.mcse ` +- :func:`pymc3.r2_score ` +- :func:`pymc3.rhat ` +- :func:`pymc3.summary ` +- :func:`pymc3.waic ` diff --git a/docs/source/conf.py b/docs/source/conf.py index 3c47147ef7a..a37d01cdde6 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -37,6 +37,7 @@ "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.mathjax", + "sphinx.ext.intersphinx", "nbsphinx", "numpydoc", "IPython.sphinxext.ipython_console_highlighting", @@ -130,6 +131,11 @@ # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False +# intersphinx configuration to ease linking arviz docs +intersphinx_mapping = { + "arviz": ("https://arviz-devs.github.io/arviz/", None), +} + # -- Options for HTML output ----------------------------------------------