arviz 0.18.0__py3-none-any.whl → 0.20.0__py3-none-any.whl

arviz/tests/base_tests/test_plot_utils.py

@@ -1,5 +1,6 @@
 # pylint: disable=redefined-outer-name
 import importlib
+import os
 
 import numpy as np
 import pytest
@@ -20,10 +21,10 @@ from ...rcparams import rc_context
 from ...sel_utils import xarray_sel_iter, xarray_to_ndarray
 from ...stats.density_utils import get_bins
 from ...utils import get_coords
-from ..helpers import running_on_ci
 
 # Check if Bokeh is installed
 bokeh_installed = importlib.util.find_spec("bokeh") is not None  # pylint: disable=invalid-name
+skip_tests = (not bokeh_installed) and ("ARVIZ_REQUIRE_ALL_DEPS" not in os.environ)
 
 
 @pytest.mark.parametrize(
@@ -212,10 +213,7 @@ def test_filter_plotter_list_warning():
     assert len(plotters_filtered) == 5
 
 
-@pytest.mark.skipif(
-    not (bokeh_installed or running_on_ci()),
-    reason="test requires bokeh which is not installed",
-)
+@pytest.mark.skipif(skip_tests, reason="test requires bokeh which is not installed")
 def test_bokeh_import():
     """Tests that correct method is returned on bokeh import"""
     plot = get_plotting_function("plot_dist", "distplot", "bokeh")
@@ -290,10 +288,7 @@ def test_mpl_dealiase_sel_kwargs():
     assert res["line_color"] == "red"
 
 
-@pytest.mark.skipif(
-    not (bokeh_installed or running_on_ci()),
-    reason="test requires bokeh which is not installed",
-)
+@pytest.mark.skipif(skip_tests, reason="test requires bokeh which is not installed")
 def test_bokeh_dealiase_sel_kwargs():
     """Check bokeh dealiase_sel_kwargs behaviour.
 
@@ -315,10 +310,7 @@ def test_bokeh_dealiase_sel_kwargs():
     assert res["line_color"] == "red"
 
 
-@pytest.mark.skipif(
-    not (bokeh_installed or running_on_ci()),
-    reason="test requires bokeh which is not installed",
-)
+@pytest.mark.skipif(skip_tests, reason="test requires bokeh which is not installed")
 def test_set_bokeh_circular_ticks_labels():
     """Assert the axes returned after placing ticks and tick labels for circular plots."""
     import bokeh.plotting as bkp

arviz/tests/base_tests/test_plots_matplotlib.py

@@ -46,12 +46,13 @@ from ...plots import (
 from ...rcparams import rc_context, rcParams
 from ...stats import compare, hdi, loo, waic
 from ...stats.density_utils import kde as _kde
-from ...utils import _cov
+from ...utils import _cov, BehaviourChangeWarning
 from ...plots.plot_utils import plot_point_interval
 from ...plots.dotplot import wilkinson_algorithm
 from ..helpers import (  # pylint: disable=unused-import
     create_model,
     create_multidimensional_model,
+    does_not_warn,
     eight_schools_params,
     models,
     multidim_models,
@@ -261,7 +262,7 @@ def test_plot_trace_legend(compact, combined):
     axes = plot_trace(
         idata, var_names=["home", "atts_star"], compact=compact, combined=combined, legend=True
     )
-    assert axes[0, 0].get_legend()
+    assert axes[0, 1].get_legend()
     compact_legend = axes[1, 0].get_legend()
     if compact:
         assert axes.shape == (2, 2)
@@ -1272,6 +1273,27 @@ def test_plot_ecdf_basic():
     assert axes is not None
 
 
+def test_plot_ecdf_eval_points():
+    """Check that BehaviourChangeWarning is raised if eval_points is not specified."""
+    data = np.random.randn(4, 1000)
+    eval_points = np.linspace(-3, 3, 100)
+    with pytest.warns(BehaviourChangeWarning):
+        axes = plot_ecdf(data)
+    assert axes is not None
+    with does_not_warn(BehaviourChangeWarning):
+        axes = plot_ecdf(data, eval_points=eval_points)
+    assert axes is not None
+
+
+@pytest.mark.parametrize("confidence_bands", [True, "pointwise", "optimized", "simulated"])
+@pytest.mark.parametrize("ndraws", [100, 10_000])
+def test_plot_ecdf_confidence_bands(confidence_bands, ndraws):
+    """Check that all confidence_bands values correctly accepted"""
+    data = np.random.randn(4, ndraws // 4)
+    axes = plot_ecdf(data, confidence_bands=confidence_bands, cdf=norm(0, 1).cdf)
+    assert axes is not None
+
+
 def test_plot_ecdf_values2():
     data = np.random.randn(4, 1000)
     data2 = np.random.randn(4, 1000)
@@ -1286,6 +1308,77 @@ def test_plot_ecdf_cdf():
     assert axes is not None
 
 
+def test_plot_ecdf_error():
+    """Check that all error conditions are correctly raised."""
+    dist = norm(0, 1)
+    data = dist.rvs(1000)
+
+    # cdf not specified
+    with pytest.raises(ValueError):
+        plot_ecdf(data, confidence_bands=True)
+    plot_ecdf(data, confidence_bands=True, cdf=dist.cdf)
+    with pytest.raises(ValueError):
+        plot_ecdf(data, difference=True)
+    plot_ecdf(data, difference=True, cdf=dist.cdf)
+    with pytest.raises(ValueError):
+        plot_ecdf(data, pit=True)
+    plot_ecdf(data, pit=True, cdf=dist.cdf)
+
+    # contradictory confidence band types
+    with pytest.raises(ValueError):
+        plot_ecdf(data, cdf=dist.cdf, confidence_bands="simulated", pointwise=True)
+    with pytest.raises(ValueError):
+        plot_ecdf(data, cdf=dist.cdf, confidence_bands="optimized", pointwise=True)
+    plot_ecdf(data, cdf=dist.cdf, confidence_bands=True, pointwise=True)
+    plot_ecdf(data, cdf=dist.cdf, confidence_bands="pointwise")
+
+    # contradictory band probabilities
+    with pytest.raises(ValueError):
+        plot_ecdf(data, cdf=dist.cdf, confidence_bands=True, ci_prob=0.9, fpr=0.1)
+    plot_ecdf(data, cdf=dist.cdf, confidence_bands=True, ci_prob=0.9)
+    plot_ecdf(data, cdf=dist.cdf, confidence_bands=True, fpr=0.1)
+
+    # contradictory reference
+    data2 = dist.rvs(200)
+    with pytest.raises(ValueError):
+        plot_ecdf(data, data2, cdf=dist.cdf, difference=True)
+    plot_ecdf(data, data2, difference=True)
+    plot_ecdf(data, cdf=dist.cdf, difference=True)
+
+
+def test_plot_ecdf_deprecations():
+    """Check that deprecations are raised correctly."""
+    dist = norm(0, 1)
+    data = dist.rvs(1000)
+    # base case, no deprecations
+    with does_not_warn(FutureWarning):
+        axes = plot_ecdf(data, cdf=dist.cdf, confidence_bands=True)
+    assert axes is not None
+
+    # values2 is deprecated
+    data2 = dist.rvs(200)
+    with pytest.warns(FutureWarning):
+        axes = plot_ecdf(data, values2=data2, difference=True)
+
+    # pit is deprecated
+    with pytest.warns(FutureWarning):
+        axes = plot_ecdf(data, cdf=dist.cdf, pit=True)
+    assert axes is not None
+
+    # fpr is deprecated
+    with does_not_warn(FutureWarning):
+        axes = plot_ecdf(data, cdf=dist.cdf, ci_prob=0.9)
+    with pytest.warns(FutureWarning):
+        axes = plot_ecdf(data, cdf=dist.cdf, confidence_bands=True, fpr=0.1)
+    assert axes is not None
+
+    # pointwise is deprecated
+    with does_not_warn(FutureWarning):
+        axes = plot_ecdf(data, cdf=dist.cdf, confidence_bands="pointwise")
+    with pytest.warns(FutureWarning):
+        axes = plot_ecdf(data, cdf=dist.cdf, confidence_bands=True, pointwise=True)
+
+
 @pytest.mark.parametrize(
     "kwargs",
     [

arviz/tests/base_tests/test_rcparams.py

@@ -127,6 +127,18 @@ def test_choice_bad_values(param):
         rcParams[param] = "bad_value"
 
 
+@pytest.mark.parametrize("args", [("stats.hdi_prob", "stats.ci_prob", 0.7, 0.7)])
+def test_deprecated_param(args):
+    """Test value and warning message correctly set for deprecated rcparams."""
+    param_old, param_new, val_old, val_new = args
+    assert param_new in rcParams
+    assert not np.isclose(rcParams[param_new], val_new)
+    msg = f"{param_old} is deprecated since .*, use {param_new} instead"
+    with pytest.warns(FutureWarning, match=msg):
+        with rc_context(rc={param_old: val_old}):
+            assert np.isclose(rcParams[param_new], val_new)
+
+
 @pytest.mark.parametrize("allow_none", (True, False))
 @pytest.mark.parametrize("typeof", (str, int))
 @pytest.mark.parametrize("args", [("not one", 10), (False, None), (False, 4)])

arviz/tests/base_tests/test_stats.py

@@ -179,7 +179,7 @@ def test_compare_same(centered_eight, multidim_models, method, multidim):
     else:
         data_dict = {"first": centered_eight, "second": centered_eight}
 
-    weight = compare(data_dict, method=method)["weight"]
+    weight = compare(data_dict, method=method)["weight"].to_numpy()
     assert_allclose(weight[0], weight[1])
     assert_allclose(np.sum(weight), 1.0)
 

arviz/tests/base_tests/test_stats_ecdf_utils.py

@@ -10,6 +10,13 @@ from ...stats.ecdf_utils import (
     _get_pointwise_confidence_band,
 )
 
+try:
+    import numba  # pylint: disable=unused-import
+
+    numba_options = [True, False]
+except ImportError:
+    numba_options = [False]
+
 
 def test_compute_ecdf():
     """Test compute_ecdf function."""
@@ -109,9 +116,15 @@ def test_get_pointwise_confidence_band(dist, prob, ndraws, num_trials=1_000, see
     ids=["continuous", "continuous default rvs", "discrete"],
 )
 @pytest.mark.parametrize("ndraws", [10_000])
-@pytest.mark.parametrize("method", ["pointwise", "simulated"])
-def test_ecdf_confidence_band(dist, rvs, prob, ndraws, method, num_trials=1_000, seed=57):
+@pytest.mark.parametrize("method", ["pointwise", "optimized", "simulated"])
+@pytest.mark.parametrize("use_numba", numba_options)
+def test_ecdf_confidence_band(
+    dist, rvs, prob, ndraws, method, use_numba, num_trials=1_000, seed=57
+):
     """Test test_ecdf_confidence_band."""
+    if use_numba and method != "optimized":
+        pytest.skip("Numba only used in optimized method")
+
     eval_points = np.linspace(*dist.interval(0.99), 10)
     cdf_at_eval_points = dist.cdf(eval_points)
     random_state = np.random.default_rng(seed)

arviz/tests/base_tests/test_stats_numba.py

@@ -1,6 +1,4 @@
 # pylint: disable=redefined-outer-name, no-member
-import importlib
-
 import numpy as np
 import pytest
 
@@ -9,15 +7,12 @@ from ...stats import r2_score, summary
 from ...utils import Numba
 from ..helpers import (  # pylint: disable=unused-import
     check_multiple_attrs,
+    importorskip,
     multidim_models,
-    running_on_ci,
 )
 from .test_stats import centered_eight, non_centered_eight  # pylint: disable=unused-import
 
-pytestmark = pytest.mark.skipif(  # pylint: disable=invalid-name
-    (importlib.util.find_spec("numba") is None) and not running_on_ci(),
-    reason="test requires numba which is not installed",
-)
+numba = importorskip("numba")
 
 rcParams["data.load"] = "eager"
 

arviz/tests/base_tests/test_utils_numba.py

@@ -8,13 +8,10 @@ import pytest
 
 from ...stats.stats_utils import stats_variance_2d as svar
 from ...utils import Numba, _numba_var, numba_check
-from ..helpers import running_on_ci
+from ..helpers import importorskip
 from .test_utils import utils_with_numba_import_fail  # pylint: disable=unused-import
 
-pytestmark = pytest.mark.skipif(  # pylint: disable=invalid-name
-    (importlib.util.find_spec("numba") is None) and not running_on_ci(),
-    reason="test requires numba which is not installed",
-)
+importorskip("numba")
 
 
 def test_utils_fixture(utils_with_numba_import_fail):

arviz/tests/external_tests/test_data_pystan.py

@@ -1,6 +1,7 @@
 # pylint: disable=no-member, invalid-name, redefined-outer-name, too-many-function-args
 import importlib
 from collections import OrderedDict
+import os
 
 import numpy as np
 import pytest
@@ -16,19 +17,18 @@ from ..helpers import (  # pylint: disable=unused-import
     importorskip,
     load_cached_models,
     pystan_version,
-    running_on_ci,
 )
 
 # Check if either pystan or pystan3 is installed
 pystan_installed = (importlib.util.find_spec("pystan") is not None) or (
     importlib.util.find_spec("stan") is not None
 )
-pytestmark = pytest.mark.skipif(
-    not (pystan_installed | running_on_ci()),
-    reason="test requires pystan/pystan3 which is not installed",
-)
 
 
+@pytest.mark.skipif(
+    not (pystan_installed or "ARVIZ_REQUIRE_ALL_DEPS" in os.environ),
+    reason="test requires pystan/pystan3 which is not installed",
+)
 class TestDataPyStan:
     @pytest.fixture(scope="class")
     def data(self, eight_schools_params, draws, chains):

arviz/tests/helpers.py

@@ -6,6 +6,8 @@ import logging
 import os
 import sys
 from typing import Any, Dict, List, Optional, Tuple, Union
+import warnings
+from contextlib import contextmanager
 
 import cloudpickle
 import numpy as np
@@ -29,6 +31,18 @@ class RandomVariableTestClass:
         return self.name
 
 
+@contextmanager
+def does_not_warn(warning=Warning):
+    with warnings.catch_warnings(record=True) as caught_warnings:
+        warnings.simplefilter("always")
+        yield
+        for w in caught_warnings:
+            if issubclass(w.category, warning):
+                raise AssertionError(
+                    f"Expected no {warning.__name__} but caught warning with message: {w.message}"
+                )
+
+
 @pytest.fixture(scope="module")
 def eight_schools_params():
     """Share setup for eight schools."""
@@ -620,11 +634,6 @@ def test_precompile_models(eight_schools_params, draws, chains):
     load_cached_models(eight_schools_params, draws, chains)
 
 
-def running_on_ci() -> bool:
-    """Return True if running on CI machine."""
-    return os.environ.get("ARVIZ_CI_MACHINE") is not None
-
-
 def importorskip(
     modname: str, minversion: Optional[str] = None, reason: Optional[str] = None
 ) -> Any:
@@ -643,11 +652,10 @@ def importorskip(
     Example::
         docutils = pytest.importorskip("docutils")
     """
-    # ARVIZ_CI_MACHINE is True if tests run on CI, where ARVIZ_CI_MACHINE env variable exists
-    ARVIZ_CI_MACHINE = running_on_ci()
-    if not ARVIZ_CI_MACHINE:
+    # Unless ARVIZ_REQUIRE_ALL_DEPS is defined, tests that require a missing dependency are skipped
+    # if set, missing optional dependencies trigger failed tests.
+    if "ARVIZ_REQUIRE_ALL_DEPS" not in os.environ:
         return pytest.importorskip(modname=modname, minversion=minversion, reason=reason)
-    import warnings
 
     compile(modname, "", "eval")  # to catch syntaxerrors
 

arviz/utils.py

@@ -17,6 +17,10 @@ from .rcparams import rcParams
 STATIC_FILES = ("static/html/icons-svg-inline.html", "static/css/style.css")
 
 
+class BehaviourChangeWarning(Warning):
+    """Custom warning to ease filtering it."""
+
+
 def _check_tilde_start(x):
     return bool(isinstance(x, str) and x.startswith("~"))
 

{arviz-0.18.0.dist-info → arviz-0.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arviz
-Version: 0.18.0
+Version: 0.20.0
 Summary: Exploratory analysis of Bayesian models
 Home-page: http://github.com/arviz-devs/arviz
 Author: ArviZ Developers
@@ -21,26 +21,30 @@ Classifier: Topic :: Scientific/Engineering :: Mathematics
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: setuptools >=60.0.0
-Requires-Dist: matplotlib >=3.5
-Requires-Dist: numpy <2.0,>=1.23.0
-Requires-Dist: scipy >=1.9.0
+Requires-Dist: setuptools>=60.0.0
+Requires-Dist: matplotlib>=3.5
+Requires-Dist: numpy>=1.23.0
+Requires-Dist: scipy>=1.9.0
 Requires-Dist: packaging
-Requires-Dist: pandas >=1.5.0
-Requires-Dist: dm-tree >=0.1.8
-Requires-Dist: xarray >=2022.6.0
-Requires-Dist: h5netcdf >=1.0.2
-Requires-Dist: typing-extensions >=4.1.0
-Requires-Dist: xarray-einstats >=0.3
+Requires-Dist: pandas>=1.5.0
+Requires-Dist: xarray>=2022.6.0
+Requires-Dist: h5netcdf>=1.0.2
+Requires-Dist: typing-extensions>=4.1.0
+Requires-Dist: xarray-einstats>=0.3
 Provides-Extra: all
-Requires-Dist: numba ; extra == 'all'
-Requires-Dist: netcdf4 ; extra == 'all'
-Requires-Dist: bokeh <3.0,>=1.4.0 ; extra == 'all'
-Requires-Dist: contourpy ; extra == 'all'
-Requires-Dist: ujson ; extra == 'all'
-Requires-Dist: dask[distributed] ; extra == 'all'
-Requires-Dist: zarr >=2.5.0 ; extra == 'all'
-Requires-Dist: xarray-datatree ; extra == 'all'
+Requires-Dist: numba; extra == "all"
+Requires-Dist: netcdf4; extra == "all"
+Requires-Dist: bokeh>=3; extra == "all"
+Requires-Dist: contourpy; extra == "all"
+Requires-Dist: ujson; extra == "all"
+Requires-Dist: dask[distributed]; extra == "all"
+Requires-Dist: zarr<3,>=2.5.0; extra == "all"
+Requires-Dist: xarray-datatree; extra == "all"
+Requires-Dist: dm-tree>=0.1.8; extra == "all"
+Provides-Extra: preview
+Requires-Dist: arviz-base[h5netcdf]; extra == "preview"
+Requires-Dist: arviz-stats[xarray]; extra == "preview"
+Requires-Dist: arviz-plots; extra == "preview"
 
 <img src="https://raw.githubusercontent.com/arviz-devs/arviz-project/main/arviz_logos/ArviZ.png#gh-light-mode-only" width=200></img>
 <img src="https://raw.githubusercontent.com/arviz-devs/arviz-project/main/arviz_logos/ArviZ_white.png#gh-dark-mode-only" width=200></img>