docs(utilities): live list_samples table + model_diagnostics demo (#915)

.coveragerc

@@ -1,7 +1,9 @@
 # .coveragerc to control coverage.py
 [run]
 branch = True
-omit = *tests*
+omit =
+    *tests*
+    */core/typing.py
 
 [report]
 show_missing = True

README.rst

@@ -21,7 +21,7 @@
 .. |Build Status| image:: https://github.com/casact/chainladder-python/actions/workflows/pytest.yml/badge.svg
    :target: https://github.com/casact/chainladder-python/actions/workflows/pytest.yml
 
-.. |codecov io| image:: https://codecov.io/gh/casact/chainladder-python/branch/master/graphs/badge.svg
+.. |codecov io| image:: https://codecov.io/gh/casact/chainladder-python/branch/main/graphs/badge.svg
    :target: https://codecov.io/github/casact/chainladder-python?branch=latest
 
 .. |Documentation Status| image:: https://readthedocs.org/projects/chainladder-python/badge/?version=main

chainladder/__init__.py

@@ -49,6 +49,23 @@
     "The parameter 'option' is deprecated and will be removed in a future release. Use 'pat' instead."
 )
 
+# Array backends slated for removal, mapped to the issue tracking each one.
+# Selecting one of these (via set_option, ARRAY_PRIORITY, or set_backend, or by
+# passing a Dask dataframe to the Triangle constructor) emits a
+# DeprecationWarning.
+_DEPRECATED_BACKENDS: dict[str, str] = {
+    "cupy": "https://github.com/casact/chainladder-python/issues/843",
+    "dask": "https://github.com/casact/chainladder-python/issues/842",
+}
+
+
+def _deprecated_backend_message(backend: str) -> str:
+    """Build the deprecation message for a soon-to-be-removed array backend."""
+    return (
+        f"The '{backend}' array backend is deprecated and will be removed in a "
+        f"future release. See {_DEPRECATED_BACKENDS[backend]}."
+    )
+
 
 @overload
 def _resolve_pat(pat: str | None, option: str | None, required: Literal[True] = ...) -> str: ...
@@ -189,28 +206,30 @@ def set_option(
         self._validate_option(pat)
         if value is _UNSET:
             raise TypeError("set_option() missing required argument: 'value'.")
-        if pat == "ARRAY_BACKEND" and value == "cupy":
+        if pat == "ARRAY_BACKEND" and value in _DEPRECATED_BACKENDS:
             warnings.warn(
-                "The 'cupy' array backend is deprecated and will be removed in a "
-                "future release. See https://github.com/casact/chainladder-python/issues/843.",
+                _deprecated_backend_message(value),
                 DeprecationWarning,
                 stacklevel=2,
             )
-        elif pat == "ARRAY_PRIORITY" and isinstance(value, list) and "cupy" in value:
-            # Only warn when 'cupy' is prioritized ahead of a non-deprecated
-            # backend ('numpy' or 'sparse'), i.e. cupy would actually be
-            # selected over a supported backend.
-            cupy_index = value.index("cupy")
-            if any(
-                backend in value and value.index(backend) > cupy_index
-                for backend in ("numpy", "sparse")
-            ):
-                warnings.warn(
-                    "The 'cupy' array backend is deprecated and will be removed in a "
-                    "future release. See https://github.com/casact/chainladder-python/issues/843.",
-                    DeprecationWarning,
-                    stacklevel=2,
-                )
+        elif pat == "ARRAY_PRIORITY" and isinstance(value, list):
+            # Only warn when a deprecated backend ('cupy' or 'dask') is
+            # prioritized ahead of a non-deprecated backend ('numpy' or
+            # 'sparse'), i.e. it would actually be selected over a supported
+            # backend. The position in the list determines precedence.
+            for backend in _DEPRECATED_BACKENDS:
+                if backend not in value:
+                    continue
+                backend_index = value.index(backend)
+                if any(
+                    supported in value and value.index(supported) > backend_index
+                    for supported in ("numpy", "sparse")
+                ):
+                    warnings.warn(
+                        _deprecated_backend_message(backend),
+                        DeprecationWarning,
+                        stacklevel=2,
+                    )
         setattr(self, pat, value)
 
     def reset_option(

chainladder/core/base.py

@@ -12,7 +12,8 @@
 from chainladder import (
     __dt64_unit__,
     __dt64_dtype__,
-    options
+    options,
+    _deprecated_backend_message
 )
 
 from chainladder.core.common import Common
@@ -105,7 +106,7 @@ def str_to_list(arg: str | list) -> None | list:
         columns = str_to_list(columns)
         origin = str_to_list(origin)
         development = str_to_list(development)
-        if "object" in data[columns].dtypes:
+        if not all(pd.api.types.is_numeric_dtype(dt) for dt in data[columns].dtypes):
             raise TypeError("column attribute must be numeric.")
         if data[columns].shape[1] != len(columns):
             raise AttributeError("Columns are required to have unique names")
@@ -162,6 +163,18 @@ def _aggregate_data(
     ):
         """Summarize dataframe to the level specified in axes"""
         if type(data) != pd.DataFrame:
+            # A non-pandas input that reaches this branch is a Dask dataframe.
+            # Only the Dask backend is deprecated, so gate the warning on the
+            # data's module rather than warning for every pandas subclass that
+            # also takes this path. stacklevel=3 points the warning at the
+            # user's Triangle(...) call (warn -> this method ->
+            # Triangle.__init__ -> user).
+            if type(data).__module__.split(".")[0] == "dask":
+                warnings.warn(
+                    _deprecated_backend_message("dask"),
+                    DeprecationWarning,
+                    stacklevel=3,
+                )
             # Dask dataframes are mutated.
             data["__origin__"] = origin_date
             data["__development__"] = development_date

chainladder/core/common.py

@@ -9,6 +9,7 @@
 import pandas as pd
 
 from chainladder import options
+from chainladder import _DEPRECATED_BACKENDS, _deprecated_backend_message
 from chainladder.utils.cupy import cp
 from chainladder.utils.dask import dp
 from chainladder.utils.sparse import sp
@@ -180,10 +181,9 @@ def set_backend(
         # Warn once, at the public entry point, so stacklevel=2 points at the
         # user's call site rather than an internal recursive call. The _warn
         # flag suppresses duplicate warnings from internal recursion below.
-        if _warn and backend == "cupy":
+        if _warn and backend in _DEPRECATED_BACKENDS:
             warnings.warn(
-                "The 'cupy' array backend is deprecated and will be removed in a "
-                "future release. See https://github.com/casact/chainladder-python/issues/843.",
+                _deprecated_backend_message(backend),
                 DeprecationWarning,
                 stacklevel=2,
             )