scikit-base 0.7.4__py3-none-any.whl → 0.7.6__py3-none-any.whl

{scikit_base-0.7.4.dist-info → scikit_base-0.7.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.7.4
+Version: 0.7.6
 Summary: Base classes for sklearn-like parametric objects
 Author-email: sktime developers <sktime.toolbox@gmail.com>
 Maintainer: Franz Király
@@ -114,7 +114,7 @@ Requires-Dist: scikit-learn >=0.24.0 ; extra == 'test'
 `skbase` provides base classes for creating scikit-learn-like parametric objects,
 along with tools to make it easier to build your own packages that follow these design patterns.
 
-:rocket: Version 0.7.4 is now available. Check out our
+:rocket: Version 0.7.6 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit_base-0.7.4.dist-info → scikit_base-0.7.6.dist-info}/RECORD

@@ -1,5 +1,5 @@
 docs/source/conf.py,sha256=kFc-4qkb0ZGD5cDej5KPJhMePp9kpVu6ZqFoF0fgovg,9951
-skbase/__init__.py,sha256=abk0HlHOHt1z9B3iOIIUbVD4EdH8nJ3T-1HR7UuI9u0,345
+skbase/__init__.py,sha256=CKmrUi1UR6s2fjgX9ojllx8YrEDY76KgwJ_AeS4pZ5E,345
 skbase/_exceptions.py,sha256=KXfcVa7Xit-w-Xs_qFSJOEa_Mfp1oJeiHEC3v4Z0h1Q,1112
 skbase/_nopytest_tests.py,sha256=npL5pibSgCpulEGw0NqLKcG0majh6xcdW5A4Zibf78s,1077
 skbase/base/__init__.py,sha256=5ZLlwJeyfKDA1lAylBJgZd3t5JY25xsgQB4waQnroa8,751
@@ -7,19 +7,21 @@ skbase/base/_base.py,sha256=1MJgavydCw-4TNqA4Na_7LMVoh4w4D5q81l15SbKJUM,53490
 skbase/base/_meta.py,sha256=VY6_R2tE885j-GTDuzLFyho5i382jOni5lkR_ykPZqo,38815
 skbase/base/_tagmanager.py,sha256=nKoiIC1yXFFSpN5ljWbMrwA-pwlbxsljgKuUywh1MR4,7289
 skbase/base/_pretty_printing/__init__.py,sha256=bVuKnwafn8c2q2AGJ9BOu9cmu-xBjiOxHf1hxjm8K2A,492
-skbase/base/_pretty_printing/_object_html_repr.py,sha256=0DHcM3AHIRkV1fCRi-G7lzDmiSTR2-MjU40iXUuV2AM,11538
+skbase/base/_pretty_printing/_object_html_repr.py,sha256=jvng-RT2JH4RElJkYBNdfu-lRKzlqZeBgqsNl2kNDKM,11677
 skbase/base/_pretty_printing/_pprint.py,sha256=VVnw-cywGxArfiFfVWfFSV5VMJvsxpDsJJ4RplcndqA,15634
+skbase/base/_pretty_printing/tests/__init__.py,sha256=rakHMQAO1NfuMabw-VsqVA9Jd1YQyuSop-Oc3tgc4w0,77
+skbase/base/_pretty_printing/tests/test_pprint.py,sha256=8_CFX9v41ZA-aWkAxm9UZSWcOaXt-u1sLwsNPZOSL24,731
 skbase/lookup/__init__.py,sha256=RNw1mx8nXFHsn-HgnjHzWPn9AG45jSMEKl-Z0pEH7jE,1089
 skbase/lookup/_lookup.py,sha256=7L1JIMCzpMdSF5ZqHNDeIaHu4QRwXoLJ4DgM1Z_uFts,39864
 skbase/lookup/tests/__init__.py,sha256=MVqGlWsUV-gQ4qzW_TqE3UmKO9IQ9mwdDlsIHaGt3bc,68
 skbase/lookup/tests/test_lookup.py,sha256=_VDReGKnJF52UtFbvg_D2vlAkVvREypwM-9jR7DPAXQ,38218
 skbase/testing/__init__.py,sha256=OdwR-aEU2KzGrU-O0gtNSMNGmF2mtgBmjAnMzcgwe6w,351
-skbase/testing/test_all_objects.py,sha256=FooQ_pukjKKK7q3q7gXGH5pDcg8A4xEmkBAMcAF7jcs,36166
+skbase/testing/test_all_objects.py,sha256=loDy2Zqqlg6_zmUg2EknNMxRljPKtB-k6XM2cihjJ5E,36167
 skbase/testing/utils/__init__.py,sha256=kaLuqQwJsCunRWsUb1JwTVG-iqXbzdUobuYHNHsBlQQ,113
 skbase/testing/utils/_conditional_fixtures.py,sha256=QwI7K28Lsy6RAkDP94goo8uWWvMzKKNOmXRFtc9RNtI,9890
-skbase/testing/utils/inspect.py,sha256=XcPdm1-J3YXCTxsrqeJlStPvbC0vH1cgaApN5lzRI2c,741
+skbase/testing/utils/_inspect.py,sha256=XcPdm1-J3YXCTxsrqeJlStPvbC0vH1cgaApN5lzRI2c,741
 skbase/tests/__init__.py,sha256=d2_OTTnt0GX5otQsBuNAb1evg8C5Fi0JjqK2VsfMtXU,37
-skbase/tests/conftest.py,sha256=F-D3fqengjnaVSk2L4mYh8Wg_o0kS7L3wmGi2vU1B94,9272
+skbase/tests/conftest.py,sha256=L58JDizS0AZrdk7y-3VJ0P1iBK8e2IRJtmodHayiRt8,9263
 skbase/tests/test_base.py,sha256=-kyVDOQRdXYsBmSTqNjZ06mjnt_OWoY2i2i71qx3TF8,50648
 skbase/tests/test_baseestimator.py,sha256=fuzpwxjYzyl-Vrte1va4AWdbYElhWnED8W10236Xprc,4731
 skbase/tests/test_exceptions.py,sha256=wOdk7Gp8pvbhucna3_9FxTk9xFLjC9XNsGsVabQLYEE,629
@@ -34,14 +36,14 @@ skbase/utils/_utils.py,sha256=A6sTIUEscEy9TjBmCvXEuhk9q8ROBPyfJGhrjlSA4LY,3134
 skbase/utils/random_state.py,sha256=QxY-M2u_6my315tdml2CukKj7ZVnbqjU_T9ZzixGuq0,5127
 skbase/utils/deep_equals/__init__.py,sha256=1II3GWV1c1s43y62IidMiTjjyOnE9MFysQ5AKCXMB2g,235
 skbase/utils/deep_equals/_common.py,sha256=O0ODPJGwdq6G-KdeGoHgyote53tNcxu3y2jHvej3bdQ,1273
-skbase/utils/deep_equals/_deep_equals.py,sha256=-blJhvTGdk4WjiSjBo8t954LysODZwPZoPHk2SBPzCQ,17615
+skbase/utils/deep_equals/_deep_equals.py,sha256=XtC3GohsVpXzKtBKY8ejYoJ2q1vPqcpXnTBRqZnj0T8,18331
 skbase/utils/dependencies/__init__.py,sha256=cCUa_P-RiDs4pW6cw51uYeoBMaMa9iycwiFkwqkIizc,419
-skbase/utils/dependencies/_dependencies.py,sha256=L3_ghGBHzaHX964b0bCw7H_Q5X4ILZ5LsQYCEAmZq5U,14501
+skbase/utils/dependencies/_dependencies.py,sha256=P_kqwGOxbGlbTdOfQ8HFHRm-UsAcSWQF-1jcqrzo4IU,14502
 skbase/utils/dependencies/tests/__init__.py,sha256=UqE6wenG-HffjT2Z974OLzmXG-M8PNOP9nUnNfqtfT4,74
 skbase/utils/dependencies/tests/test_check_dependencies.py,sha256=uxAC3gr4VWTlgctN90pnT1ra_UYkPxQHEla-IljX-n0,2238
 skbase/utils/tests/__init__.py,sha256=YfvP5lpCrTC_6SIakU7jBBdqYyuqE07nZ56ZYKTs3f0,165
 skbase/utils/tests/test_check.py,sha256=rMxaQtKegaKZPGjocNB9ntMwMIAq5-7SmNZuFsWFGZE,754
-skbase/utils/tests/test_deep_equals.py,sha256=ZKrnCR4Ph14FgBhlIoxxpn8Pki7TGKbYYtymoJz0Fqk,2786
+skbase/utils/tests/test_deep_equals.py,sha256=kYR-wRvc_GGdlCwZPPlUL1NvUzJKIvpWTa3Hk8rdQZA,3985
 skbase/utils/tests/test_iter.py,sha256=XIJPZ3QjVR5szj5oNS9DBwum6WXRGHSAiC0O9MW4maY,4918
 skbase/utils/tests/test_nested_iter.py,sha256=lZF9jiU_6xw1dOo2QrrVF96Pw8ThutQuVlRspIgNy80,2230
 skbase/utils/tests/test_random_state.py,sha256=XW1KIFy2S-MQjlx4lUdP8K-w1N9eEUWa7PP_Yve7d78,3934
@@ -52,9 +54,9 @@ skbase/validate/_types.py,sha256=riVEVlj8ipErZX07OVbzv6zdGKssfegHyMr8XwaBm6M,121
 skbase/validate/tests/__init__.py,sha256=wunQBy6rajyrDymKvuFVajsBjj90VP5IFey5b6ZIRCk,70
 skbase/validate/tests/test_iterable_named_objects.py,sha256=NaEwdmtQJJy4GXMSh9ULOaR4ua7R11BcE6Khz5RKWUk,7438
 skbase/validate/tests/test_type_validations.py,sha256=G-qwFjXk-8WvXoeOvo2omfFKKjbpWhP-sPf6hsw8q30,14131
-scikit_base-0.7.4.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
-scikit_base-0.7.4.dist-info/METADATA,sha256=yktJpyUY8DuNNcflKdRmVroKTBQ1pbb-1tZldt3vGsk,8704
-scikit_base-0.7.4.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-scikit_base-0.7.4.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
-scikit_base-0.7.4.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-scikit_base-0.7.4.dist-info/RECORD,,
+scikit_base-0.7.6.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
+scikit_base-0.7.6.dist-info/METADATA,sha256=paGS65lYv7CmJ5XMvW2bjDLwCd1nE-5tyJR_Crif0Ow,8704
+scikit_base-0.7.6.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+scikit_base-0.7.6.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
+scikit_base-0.7.6.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+scikit_base-0.7.6.dist-info/RECORD,,

{scikit_base-0.7.4.dist-info → scikit_base-0.7.6.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

skbase/__init__.py

@@ -6,4 +6,4 @@
 The included functionality makes it easy to reuse scikit-learn and
 sktime design principles in your project.
 """
-__version__: str = "0.7.4"
+__version__: str = "0.7.6"

skbase/base/_pretty_printing/_object_html_repr.py

@@ -22,35 +22,37 @@ class _VisualBlock:
     kind : {'serial', 'parallel', 'single'}
         kind of HTML block
 
-    objs : list of BaseObjects or `_VisualBlock`s or a single BaseObject
-        If kind != 'single', then `objs` is a list of
-        BaseObjects. If kind == 'single', then `objs` is a single BaseObject.
+    estimators : list of ``BaseObject``s or ``_VisualBlock`s or a single ``BaseObject``
+        If ``kind != 'single'``, then ``estimators`` is a list of ``BaseObjects``.
+        If ``kind == 'single'``, then ``estimators`` is a single ``BaseObject``.
 
     names : list of str, default=None
-        If kind != 'single', then `names` corresponds to BaseObjects.
-        If kind == 'single', then `names` is a single string corresponding to
-        the single BaseObject.
+        If ``kind != 'single'``, then ``names`` corresponds to ``BaseObjects``.
+        If ``kind == 'single'``, then ``names`` is a single string corresponding to
+        the single ``BaseObject``.
 
     name_details : list of str, str, or None, default=None
-        If kind != 'single', then `name_details` corresponds to `names`.
-        If kind == 'single', then `name_details` is a single string
-        corresponding to the single BaseObject.
+        If ``kind != 'single'``, then ``name_details`` corresponds to ``names``.
+        If ``kind == 'single'``, then ``name_details`` is a single string
+        corresponding to the single ``BaseObject``.
 
     dash_wrapped : bool, default=True
         If true, wrapped HTML element will be wrapped with a dashed border.
-        Only active when kind != 'single'.
+        Only active when ``kind != 'single'``.
     """
 
-    def __init__(self, kind, objs, *, names=None, name_details=None, dash_wrapped=True):
+    def __init__(
+        self, kind, estimators, *, names=None, name_details=None, dash_wrapped=True
+    ):
         self.kind = kind
-        self.objs = objs
+        self.estimators = estimators
         self.dash_wrapped = dash_wrapped
 
         if self.kind in ("parallel", "serial"):
             if names is None:
-                names = (None,) * len(objs)
+                names = (None,) * len(estimators)
             if name_details is None:
-                name_details = (None,) * len(objs)
+                name_details = (None,) * len(estimators)
 
         self.names = names
         self.name_details = name_details
@@ -135,7 +137,7 @@ def _write_base_object_html(
 
         kind = est_block.kind
         out.write(f'<div class="sk-{kind}">')
-        est_infos = zip(est_block.objs, est_block.names, est_block.name_details)
+        est_infos = zip(est_block.estimators, est_block.names, est_block.name_details)
 
         for est, name, name_details in est_infos:
             if kind == "serial":

skbase/base/_pretty_printing/tests/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+"""Tests of skbase pretty printing functionality."""

skbase/base/_pretty_printing/tests/test_pprint.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
+"""Tests for skbase pretty printing functionality."""
+
+from skbase.base import BaseObject
+
+
+class CompositionDummy(BaseObject):
+    """Potentially composite object, for testing."""
+
+    def __init__(self, foo, bar=84):
+        self.foo = foo
+        self.bar = bar
+
+        super(CompositionDummy, self).__init__()
+
+
+def test_sklearn_compatibility():
+    """Test that the pretty printing functions are compatible with sklearn."""
+    from sklearn.ensemble import RandomForestRegressor
+    from sklearn.pipeline import make_pipeline
+
+    regressor = make_pipeline(
+        RandomForestRegressor(),
+    )
+    CompositionDummy(regressor)

skbase/testing/test_all_objects.py

@@ -18,7 +18,7 @@ from skbase.lookup import all_objects
 from skbase.testing.utils._conditional_fixtures import (
     create_conditional_fixtures_and_names,
 )
-from skbase.testing.utils.inspect import _get_args
+from skbase.testing.utils._inspect import _get_args
 from skbase.utils.deep_equals import deep_equals
 from skbase.utils.dependencies import _check_soft_dependencies
 

skbase/tests/conftest.py

@@ -35,7 +35,7 @@ SKBASE_MODULES = (
     "skbase.testing.test_all_objects",
     "skbase.testing.utils",
     "skbase.testing.utils._conditional_fixtures",
-    "skbase.testing.utils.inspect",
+    "skbase.testing.utils._inspect",
     "skbase.testing.utils.tests",
     "skbase.testing.utils.tests.test_deep_equals",
     "skbase.tests",
@@ -67,7 +67,6 @@ SKBASE_PUBLIC_MODULES = (
     "skbase.testing",
     "skbase.testing.test_all_objects",
     "skbase.testing.utils",
-    "skbase.testing.utils.inspect",
     "skbase.testing.utils.tests",
     "skbase.testing.utils.tests.test_deep_equals",
     "skbase.tests",
@@ -204,7 +203,7 @@ SKBASE_FUNCTIONS_BY_MODULE.update(
             "_check_object_types",
             "_get_module_info",
         ),
-        "skbase.testing.utils.inspect": ("_get_args",),
+        "skbase.testing.utils._inspect": ("_get_args",),
         "skbase.utils._check": ("_is_scalar_nan",),
         "skbase.utils.dependencies": (
             "_check_soft_dependencies",
@@ -237,6 +236,7 @@ SKBASE_FUNCTIONS_BY_MODULE.update(
             "_numpy_equals_plugin",
             "_pandas_equals",
             "_pandas_equals_plugin",
+            "_safe_len",
             "_softdep_available",
             "_tuple_equals",
             "deep_equals",

skbase/utils/deep_equals/_deep_equals.py

@@ -122,7 +122,7 @@ def _coerce_list(x):
     return x
 
 
-def _numpy_equals_plugin(x, y, return_msg=False):
+def _numpy_equals_plugin(x, y, return_msg=False, deep_equals=None):
     numpy_available = _softdep_available("numpy")
 
     if not numpy_available or not _is_npndarray(x):
@@ -132,10 +132,21 @@ def _numpy_equals_plugin(x, y, return_msg=False):
 
     ret = _make_ret(return_msg)
 
+    if x.ndim != y.ndim:
+        return ret(False, f".ndim, x.ndim = {x.ndim} != y.ndim = {y.ndim}")
+    if x.shape != y.shape:
+        return ret(False, f".shape, x.shape = {x.shape} != y.shape = {y.shape}")
     if x.dtype != y.dtype:
         return ret(False, f".dtype, x.dtype = {x.dtype} != y.dtype = {y.dtype}")
-    if x.dtype in ["object", "str"]:
+    if x.dtype == "str":
         return ret(np.array_equal(x, y), ".values")
+    elif x.dtype == "object":
+        x_flat = x.flatten()
+        y_flat = y.flatten()
+        for i in range(len(x_flat)):
+            is_equal, msg = deep_equals(x_flat[i], y_flat[i], return_msg=True)
+            return ret(is_equal, f"[{i}]" + msg)
+        return ret(True, "")  # catches len(x_flat) == 0
     else:
         return ret(np.array_equal(x, y, equal_nan=True), ".values")
 
@@ -481,12 +492,11 @@ def deep_equals_custom(x, y, return_msg=False, plugins=None):
                 return res
 
     # if the object x and y have a len() then compare of x and y lengths else continue
-    if hasattr(x, "__len__") and hasattr(y, "__len__"):
-        if len(x) != len(y):
-            return ret(
-                False,
-                f".len, x.len = {len(x)} != y.len = {len(y)}",
-            )
+    if _safe_len(x) != _safe_len(y):
+        return ret(
+            False,
+            f".len, x.len = {len(x)} != y.len = {len(y)}",
+        )
 
     # this if covers case where != is boolean
     # some types return a vector upon !=, this is covered in the next elif
@@ -503,3 +513,14 @@ def deep_equals_custom(x, y, return_msg=False, plugins=None):
         return ret(False, f" !=, {x} != {y}")
 
     return ret(True, "")
+
+
+def _safe_len(x):
+    """Return length of x if len(x) does not result in exception, else -1."""
+    if hasattr(x, "__len__"):
+        try:
+            x_len = len(x)
+            return x_len
+        except Exception:
+            return -1
+    return -1

skbase/utils/dependencies/_dependencies.py

@@ -27,7 +27,7 @@ def _check_soft_dependencies(
     ----------
     packages : str or list/tuple of str, or length-1-tuple containing list/tuple of str
         str should be package names and/or package version specifications to check.
-        Each str must be a PEP 440 compatibe specifier string, for a single package.
+        Each str must be a PEP 440 compatible specifier string, for a single package.
         For instance, the PEP 440 compatible package name such as "pandas";
         or a package requirement specifier string such as "pandas>1.2.3".
         arg can be str, kwargs tuple, or tuple/list of str, following calls are valid:

skbase/utils/tests/test_deep_equals.py

@@ -35,6 +35,13 @@ if _check_soft_dependencies("numpy", severity="none"):
         np.array([0.2, 1, 4], dtype="object"),
     ]
 
+    # test cases with nested numpy arrays
+    a = np.array(["a", "b"], dtype="object")
+    a[0] = np.array([1, 2, 3])
+    b = np.array(["a", "b", 42], dtype="object")
+    b[1] = a
+    EXAMPLES += [a, b]
+
 if _check_soft_dependencies("pandas", severity="none"):
     import pandas as pd
 
@@ -64,15 +71,23 @@ if _check_soft_dependencies("pandas", severity="none"):
 
     EXAMPLES += [X]
 
+if _check_soft_dependencies(
+    "scikit-learn", package_import_alias={"scikit-learn": "sklearn"}, severity="none"
+):
+    from sklearn.ensemble import RandomForestRegressor
+
+    EXAMPLES += [RandomForestRegressor()]
+    EXAMPLES += [RandomForestRegressor(n_estimators=42)]
+
 
 @pytest.mark.parametrize("fixture", EXAMPLES)
 def test_deep_equals_positive(fixture):
     """Tests that deep_equals correctly identifies equal objects as equal."""
-    x = deepcopy(fixture)
-    y = deepcopy(fixture)
+    x = copy_except_if_sklearn(fixture)
+    y = copy_except_if_sklearn(fixture)
 
     msg = (
-        f"deep_copy incorrectly returned False for two identical copies of "
+        f"deep_equals incorrectly returned False for two identical copies of "
         f"the following object: {x}"
     )
     assert deep_equals(x, y), msg
@@ -87,11 +102,34 @@ DIFFERENT_PAIRS = [
 @pytest.mark.parametrize("fixture1,fixture2", DIFFERENT_PAIRS)
 def test_deep_equals_negative(fixture1, fixture2):
     """Tests that deep_equals correctly identifies unequal objects as unequal."""
-    x = deepcopy(fixture1)
-    y = deepcopy(fixture2)
+    x = copy_except_if_sklearn(fixture1)
+    y = copy_except_if_sklearn(fixture2)
 
     msg = (
-        f"deep_copy incorrectly returned True when comparing "
+        f"deep_equals incorrectly returned True when comparing "
         f"the following, different objects: x={x}, y={y}"
     )
     assert not deep_equals(x, y), msg
+
+
+def copy_except_if_sklearn(obj):
+    """Copy obj if it is not a scikit-learn estimator.
+
+    We use this functoin as deep_copy should return True for
+    identical sklearn estimators, but False for different copies.
+
+    This is the current status quo, possibly we want to change this in the future.
+    """
+    if not _check_soft_dependencies(
+        "scikit-learn",
+        package_import_alias={"scikit-learn": "sklearn"},
+        severity="none",
+    ):
+        return deepcopy(obj)
+    else:
+        from sklearn.base import BaseEstimator
+
+        if isinstance(obj, BaseEstimator):
+            return obj
+        else:
+            return deepcopy(obj)