Add ESS Plot

.pylintrc

@@ -474,7 +474,7 @@ max-locals=15
 max-parents=7
 
 # Maximum number of public methods for a class (see R0904).
-max-public-methods=20
+max-public-methods=25
 
 # Maximum number of return / yield for function / method body
 max-returns=6

docs/source/api/plots.rst

@@ -19,7 +19,8 @@ A complementary introduction and guide to ``plot_...`` functions is available at
 
    plot_compare
    plot_dist
+   plot_ess
    plot_forest
    plot_ridge
    plot_trace
-   plot_trace_dist
+   plot_trace_dist

docs/source/api/visuals.rst

@@ -13,6 +13,7 @@ Data plotting elements
    line
    line_xy
    line_x
+   scatter_xy
    scatter_x
    ecdf_line
    hist
@@ -24,6 +25,7 @@ Data and axis annotating elements
    :toctree: generated/
 
    annotate_label
+   annotate_xy
    point_estimate_text
    labelled_title
    labelled_y

docs/source/gallery/inference_diagnostics/plot_ess_local.py

@@ -0,0 +1,26 @@
+"""
+# ESS Local plot
+
+Facetted local ESS plot
+
+---
+
+:::{seealso}
+API Documentation: {func}`~arviz_plots.plot_ess`
+:::
+"""
+
+from arviz_base import load_arviz_data
+
+import arviz_plots as azp
+
+azp.style.use("arviz-clean")
+
+data = load_arviz_data("centered_eight")
+pc = azp.plot_ess(
+    data,
+    kind="local",
+    backend="none",  # change to preferred backend
+    rug=True,
+)
+pc.show()

docs/source/gallery/inference_diagnostics/plot_ess_models.py

@@ -0,0 +1,25 @@
+"""
+# ESS comparison plot
+
+Full ESS (Either local or quantile) comparison between different models
+
+---
+
+:::{seealso}
+API Documentation: {func}`~arviz_plots.plot_ess`
+:::
+"""
+
+from arviz_base import load_arviz_data
+
+import arviz_plots as azp
+
+azp.style.use("arviz-clean")
+
+c = load_arviz_data("centered_eight")
+n = load_arviz_data("non_centered_eight")
+pc = azp.plot_ess(
+    {"Centered": c, "Non Centered": n},
+    backend="none",  # change to preferred backend
+)
+pc.show()

docs/source/gallery/inference_diagnostics/plot_ess_quantile.py

@@ -0,0 +1,25 @@
+"""
+# ESS Quantile plot
+
+Facetted quantile ESS plot
+
+---
+
+:::{seealso}
+API Documentation: {func}`~arviz_plots.plot_ess`
+:::
+"""
+
+from arviz_base import load_arviz_data
+
+import arviz_plots as azp
+
+azp.style.use("arviz-clean")
+
+data = load_arviz_data("centered_eight")
+pc = azp.plot_ess(
+    data,
+    kind="quantile",
+    backend="none",  # change to preferred backend
+)
+pc.show()

pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
 dynamic = ["version", "description"]
 dependencies = [
   "arviz-base==0.2",
-  "arviz-stats[xarray]==0.2",
+  "arviz-stats[xarray] @ git+https://github.com/arviz-devs/arviz-stats",
 ]
 
 [tool.flit.module]

src/arviz_plots/plots/__init__.py

@@ -2,6 +2,7 @@
 
 from .compareplot import plot_compare
 from .distplot import plot_dist
+from .essplot import plot_ess
 from .forestplot import plot_forest
 from .ridgeplot import plot_ridge
 from .tracedistplot import plot_trace_dist
@@ -13,5 +14,6 @@
     "plot_forest",
     "plot_trace",
     "plot_trace_dist",
+    "plot_ess",
     "plot_ridge",
 ]