scikit-base 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

{scikit_base-0.5.0.dist-info → scikit_base-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.5.0
+Version: 0.5.1
 Summary: Base classes for sklearn-like parametric objects
 Author-email: sktime developers <sktime.toolbox@gmail.com>
 Maintainer: Franz Király
@@ -63,21 +63,21 @@ Requires-Dist: pandas ; extra == 'all_extras'
 Provides-Extra: binder
 Requires-Dist: jupyter ; extra == 'binder'
 Provides-Extra: dev
-Requires-Dist: scikit-learn (>=0.24.0) ; extra == 'dev'
+Requires-Dist: scikit-learn >=0.24.0 ; extra == 'dev'
 Requires-Dist: pre-commit ; extra == 'dev'
 Requires-Dist: pytest ; extra == 'dev'
 Requires-Dist: pytest-cov ; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: jupyter ; extra == 'docs'
 Requires-Dist: myst-parser ; extra == 'docs'
-Requires-Dist: nbsphinx (>=0.8.6) ; extra == 'docs'
+Requires-Dist: nbsphinx >=0.8.6 ; extra == 'docs'
 Requires-Dist: numpydoc ; extra == 'docs'
 Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
-Requires-Dist: sphinx-issues (==1.2.0) ; extra == 'docs'
-Requires-Dist: sphinx-gallery (==0.6.0) ; extra == 'docs'
+Requires-Dist: sphinx-issues ==1.2.0 ; extra == 'docs'
+Requires-Dist: sphinx-gallery ==0.6.0 ; extra == 'docs'
 Requires-Dist: sphinx-panels ; extra == 'docs'
-Requires-Dist: sphinx-design (==0.3.0) ; extra == 'docs'
-Requires-Dist: sphinx (==4.1.1) ; extra == 'docs'
+Requires-Dist: sphinx-design ==0.3.0 ; extra == 'docs'
+Requires-Dist: sphinx ==4.1.1 ; extra == 'docs'
 Requires-Dist: tabulate ; extra == 'docs'
 Provides-Extra: linters
 Requires-Dist: mypy ; extra == 'linters'
@@ -102,34 +102,36 @@ Requires-Dist: safety ; extra == 'test'
 Requires-Dist: numpy ; extra == 'test'
 Requires-Dist: scipy ; extra == 'test'
 Requires-Dist: pandas ; extra == 'test'
-Requires-Dist: scikit-learn (>=0.24.0) ; extra == 'test'
+Requires-Dist: scikit-learn >=0.24.0 ; extra == 'test'
 
 <a href="https://skbase.readthedocs.io/en/latest/"><img src="https://github.com/sktime/skbase/blob/main/docs/source/images/skbase-logo-with-name.png" width="175" align="right" /></a>
 
 # Welcome to skbase
 
-> A base class for scikit-learn-like and sktime-like parametric objects
+> A framework factory for scikit-learn-like and sktime-like parametric objects
 
 `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.
+along with tools to make it easier to build your own packages that follow these design patterns.
 
-:rocket: Version 0.5.0 is now available. Checkout our
+:rocket: Version 0.5.1 is now available. Checkout our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |
 |---|---|
 | **CI/CD** | [![Tests](https://github.com/sktime/skbase/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/sktime/skbase/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/sktime/skbase/branch/main/graph/badge.svg?token=2J424NLO82)](https://codecov.io/gh/sktime/skbase) [![Documentation Status](https://readthedocs.org/projects/skbase/badge/?version=latest)](https://skbase.readthedocs.io/en/latest/?badge=latest) [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/sktime/skbase/main.svg)](https://results.pre-commit.ci/latest/github/sktime/skbase/main) |
-| **Code** |  [![!pypi](https://img.shields.io/pypi/v/scikit-base?color=orange)](https://pypi.org/project/skbase/)  [![!python-versions](https://img.shields.io/pypi/pyversions/scikit-base)](https://www.python.org/) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit) |
+| **Code** |  [![!pypi](https://img.shields.io/pypi/v/scikit-base?color=orange)](https://pypi.org/project/scikit-base/)  [![!python-versions](https://img.shields.io/pypi/pyversions/scikit-base)](https://www.python.org/) [![!black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit) |
 | **Downloads**| [![Downloads](https://static.pepy.tech/personalized-badge/scikit-base?period=week&units=international_system&left_color=grey&right_color=blue&left_text=weekly%20(pypi))](https://pepy.tech/project/scikit-base) [![Downloads](https://static.pepy.tech/personalized-badge/scikit-base?period=month&units=international_system&left_color=grey&right_color=blue&left_text=monthly%20(pypi))](https://pepy.tech/project/scikit-base) [![Downloads](https://static.pepy.tech/personalized-badge/scikit-base?period=total&units=international_system&left_color=grey&right_color=blue&left_text=cumulative%20(pypi))](https://pepy.tech/project/scikit-base) |
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-## Documentation
+## Documentation and Tutorials
 
-To learn more about the package checkout our [documentation](https://skbase.readthedocs.io/en/latest/).
+To learn more about the package check out:
+
+* our [documentation](https://skbase.readthedocs.io/en/latest/)
+* our [introductory tutorial](https://github.com/sktime/sktime-tutorial-pydata-seattle-2023) (jupyter notebooks and video presentation)
 
 ## :hourglass_flowing_sand: Install skbase
 For trouble shooting or more information, see our

{scikit_base-0.5.0.dist-info → scikit_base-0.5.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
 docs/source/conf.py,sha256=Ob6dAIWxgemP0kwSzuO7wWknKcnybs3HyfPcuwhyNIc,9845
-skbase/__init__.py,sha256=QKJp4K0K8yb5oMWOqW7406HTe9lSC0FwmluC8BCMjRQ,454
+skbase/__init__.py,sha256=WZe3oBlNkMLhyqABTvFoT7nJhb8toJSIHTX_tYJLj1A,454
 skbase/_exceptions.py,sha256=xoucRFDeUnPhMBEWRCMyP-r2hUF8ZippKxJyi_8oAKI,1113
 skbase/_nopytest_tests.py,sha256=npL5pibSgCpulEGw0NqLKcG0majh6xcdW5A4Zibf78s,1077
 skbase/base/__init__.py,sha256=QZLPb8_XOOhV1Y6KQuIjBvnNE9Rc09TkSfqkN5SiqLc,629
 skbase/base/_base.py,sha256=czFUqCbl69MwRZvJI2ytJE34p_odgV8rKmveafBp_Sk,46750
-skbase/base/_meta.py,sha256=lz7Bmw-3TNOrBsQDuFKjac1oMAPNrd6YWvbnuY6DhW0,35626
+skbase/base/_meta.py,sha256=SQ3geft8wzciN4XQLiUWT7E9RF_r06mCFsp9It7Ev6w,36329
 skbase/base/_tagmanager.py,sha256=mcKrME8kl300ev2WxgtWkbMj_ikfF7FFTLMSa0O1OU0,7290
 skbase/base/_pretty_printing/__init__.py,sha256=bVuKnwafn8c2q2AGJ9BOu9cmu-xBjiOxHf1hxjm8K2A,492
 skbase/base/_pretty_printing/_object_html_repr.py,sha256=wU2pMg3XmpNWoJaPXUzLpoMG5vLfAF83OeI6KftYXlg,11539
@@ -14,7 +14,7 @@ skbase/lookup/_lookup.py,sha256=ITzLugUeUO6IyTth5l31UZI_Hkv1_3mQrEQW7nyi7Rw,3914
 skbase/lookup/tests/__init__.py,sha256=MVqGlWsUV-gQ4qzW_TqE3UmKO9IQ9mwdDlsIHaGt3bc,68
 skbase/lookup/tests/test_lookup.py,sha256=BZdRuUUl6gZC943wiTTV5hnjXbU2rEe-Gbmu8-hXajQ,36924
 skbase/testing/__init__.py,sha256=OdwR-aEU2KzGrU-O0gtNSMNGmF2mtgBmjAnMzcgwe6w,351
-skbase/testing/test_all_objects.py,sha256=AJPCBWCKjDbW6KD-068gWhjjJARYBJSwbbnTSbsAp1I,36442
+skbase/testing/test_all_objects.py,sha256=jJHSMGWDIruKq2rTdUl9QoLMlOxH8E6oZd82NuPDYt4,36178
 skbase/testing/utils/__init__.py,sha256=kaLuqQwJsCunRWsUb1JwTVG-iqXbzdUobuYHNHsBlQQ,113
 skbase/testing/utils/_conditional_fixtures.py,sha256=QwI7K28Lsy6RAkDP94goo8uWWvMzKKNOmXRFtc9RNtI,9890
 skbase/testing/utils/_dependencies.py,sha256=WgoHKRT6bxvJqG7lK_r9dKG3TCAHFxhjyjwE1cPEjdk,469
@@ -28,7 +28,7 @@ skbase/tests/conftest.py,sha256=g4pfthiTxU8iSWcHHVhxAd4JCBx2Lf6V9lk6A0zikKA,8398
 skbase/tests/test_base.py,sha256=LxSgtI8zJ3sulgGTPA_fgvHmACqqrW1vBXeP-YEl4v0,42582
 skbase/tests/test_baseestimator.py,sha256=6Jna9Sdecg9kwhXmTumBTBPNT_Hb9-o345RHVEMWWOI,4730
 skbase/tests/test_exceptions.py,sha256=wOdk7Gp8pvbhucna3_9FxTk9xFLjC9XNsGsVabQLYEE,629
-skbase/tests/test_meta.py,sha256=UwUDQkQqLy0-lqqocvSqANLmXSkzi-zsmtNtAQIBSlM,4436
+skbase/tests/test_meta.py,sha256=mjfa7QrSxzc1DEJ51OGgnmr9iawKsYtUjBmNrZTnUrc,5661
 skbase/tests/mock_package/__init__.py,sha256=9HanT3M2_OCF1uhdLbYNyDDo5m3djsjOkbsxxbx-TPo,135
 skbase/tests/mock_package/test_mock_package.py,sha256=qX777HIJ0-BU_K4l5q5oYbEXk-b0cpg6gkzeET8WZbQ,2021
 skbase/utils/__init__.py,sha256=z0jI3ncO4xurEUHE0eJqYxxY6TD4SDFVCiVH71gtqyU,633
@@ -36,7 +36,7 @@ skbase/utils/_check.py,sha256=mLfqYMCT-4ro5PFJXyx4QNfjbAecHuZQGl_CVM3GoqE,1395
 skbase/utils/_iter.py,sha256=Um1rq79tl7PtWAq1VMHVf-pt9vQj5C0zuvyF49ob9G0,8037
 skbase/utils/_nested_iter.py,sha256=omDI2Y75ajWTSV9d59iJTj1RcCk5YFbc7cZNQjz8AC8,4566
 skbase/utils/_utils.py,sha256=A6sTIUEscEy9TjBmCvXEuhk9q8ROBPyfJGhrjlSA4LY,3134
-skbase/utils/deep_equals.py,sha256=8PzIs8aDIoB0YGIr32rk99A3qfjDdODp_yKVDkK8C6g,11299
+skbase/utils/deep_equals.py,sha256=aeTZVkYq_gJ3gB64F1rJDHe-YrxqHetHX4yNXD7mqI4,11303
 skbase/utils/dependencies/__init__.py,sha256=89TNnES--f1PeoPm-_h6a2mCtoGXt6mAd-n89FdusMM,352
 skbase/utils/dependencies/_dependencies.py,sha256=zmlWZ10HtiHE2PK2T7AzsFNKIA95O8hmIySlz2t4Mrs,10359
 skbase/utils/tests/__init__.py,sha256=YfvP5lpCrTC_6SIakU7jBBdqYyuqE07nZ56ZYKTs3f0,165
@@ -50,9 +50,9 @@ skbase/validate/_types.py,sha256=TIoqmfhwW_kMHEhfiBtUpmN56t1trWBVtC03sAkrUjk,121
 skbase/validate/tests/__init__.py,sha256=wunQBy6rajyrDymKvuFVajsBjj90VP5IFey5b6ZIRCk,70
 skbase/validate/tests/test_iterable_named_objects.py,sha256=Pb3Y7lPo7zcuulKqJ6z9M5DkCqW-S3KZ4rR-jC5lM8w,7438
 skbase/validate/tests/test_type_validations.py,sha256=G-qwFjXk-8WvXoeOvo2omfFKKjbpWhP-sPf6hsw8q30,14131
-scikit_base-0.5.0.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
-scikit_base-0.5.0.dist-info/METADATA,sha256=FXtipuMD588sH4R-SFcnO2liPWc_mnYqAFmxWpJjkiI,8489
-scikit_base-0.5.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-scikit_base-0.5.0.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
-scikit_base-0.5.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-scikit_base-0.5.0.dist-info/RECORD,,
+scikit_base-0.5.1.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
+scikit_base-0.5.1.dist-info/METADATA,sha256=53135HaAwhlh0oRkBBODC-i2-lI1r6-EA6gk7yf5S7U,8641
+scikit_base-0.5.1.dist-info/WHEEL,sha256=5sUXSg9e4bi7lTLOHcm6QEYwO5TIF1TNbTSVFVjcJcc,92
+scikit_base-0.5.1.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
+scikit_base-0.5.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+scikit_base-0.5.1.dist-info/RECORD,,

{scikit_base-0.5.0.dist-info → scikit_base-0.5.1.dist-info}/WHEEL

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

skbase/__init__.py

@@ -8,7 +8,7 @@ sktime design principles in your project.
 """
 from typing import List
 
-__version__: str = "0.4.6"
+__version__: str = "0.5.1"
 
 __author__: List[str] = ["fkiraly", "RNKuhns", "mloning"]
 __all__: List[str] = []

skbase/base/_meta.py

@@ -188,14 +188,16 @@ class _MetaObjectMixin:
         """
         # Set variables that let us use same code for retrieving params or fitted params
         if fitted:
-            method = "_get_fitted_params"
+            method_shallow = "_get_fitted_params"
+            method_public = "get_fitted_params"
             deepkw = {}
         else:
-            method = "get_params"
+            method_shallow = "get_params"
+            method_public = "get_params"
             deepkw = {"deep": deep}
 
         # Get the direct params/fitted params
-        out = getattr(super(), method)(**deepkw)
+        out = getattr(super(), method_shallow)(**deepkw)
 
         if deep and hasattr(self, attr):
             named_objects = getattr(self, attr)
@@ -207,8 +209,15 @@ class _MetaObjectMixin:
             ]
             out.update(named_objects_)
             for name, obj in named_objects_:
-                if hasattr(obj, method):
-                    for key, value in getattr(obj, method)(**deepkw).items():
+                # checks estimator has the method we want to call
+                cond1 = hasattr(obj, method_public)
+                # checks estimator is fitted if calling get_fitted_params
+                is_fitted = hasattr(obj, "is_fitted") and obj.is_fitted
+                # if we call get_params and not get_fitted_params, this is True
+                cond2 = not fitted or is_fitted
+                # check both conditions together
+                if cond1 and cond2:
+                    for key, value in getattr(obj, method_public)(**deepkw).items():
                         out["%s__%s" % (name, key)] = value
         return out
 
@@ -234,8 +243,8 @@ class _MetaObjectMixin:
         # 2. Step replacement
         items = getattr(self, attr)
         names = []
-        if items:
-            names, _ = zip(*items)
+        if items and isinstance(items, (list, tuple)):
+            names = list(zip(*items))[0]
         for name in list(params.keys()):
             if "__" not in name and name in names:
                 self._replace_object(attr, name, params.pop(name))
@@ -247,9 +256,12 @@ class _MetaObjectMixin:
         """Replace an object in attribute that contains named objects."""
         # assumes `name` is a valid object name
         new_objects = list(getattr(self, attr))
-        for i, (object_name, _) in enumerate(new_objects):
+        for i, obj_tpl in enumerate(new_objects):
+            object_name = obj_tpl[0]
             if object_name == name:
-                new_objects[i] = (name, new_val)
+                new_tpl = list(obj_tpl)
+                new_tpl[1] = new_val
+                new_objects[i] = tuple(new_tpl)
                 break
         setattr(self, attr, new_objects)
 

skbase/testing/test_all_objects.py

@@ -659,21 +659,17 @@ class TestAllObjects(BaseFixtureGenerator, QuickTester):
         assert not hasattr(object_instance, "test__attr")
         object_instance.test__attr = 42
 
-    @pytest.mark.skipif(
-        not _check_soft_dependencies("sklearn", severity="none"),
-        reason="skip test if sklearn is not available",
-    )  # sklearn is part of the dev dependency set, test should be executed with that
     def test_get_params(self, object_instance):
         """Check that get_params works correctly, against sklearn interface."""
-        from sklearn.utils.estimator_checks import (
-            check_get_params_invariance as _check_get_params_invariance,
-        )
-
         params = object_instance.get_params()
         assert isinstance(params, dict)
-        _check_get_params_invariance(
-            object_instance.__class__.__name__, object_instance
-        )
+
+        e = object_instance.clone()
+
+        shallow_params = e.get_params(deep=False)
+        deep_params = e.get_params(deep=True)
+
+        assert all(item in deep_params.items() for item in shallow_params.items())
 
     def test_set_params(self, object_instance):
         """Check that set_params works correctly."""

skbase/tests/test_meta.py

@@ -1,13 +1,8 @@
 # -*- coding: utf-8 -*-
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
-"""Tests for BaseMetaObject and BaseMetaEstimator mixins.
+"""Tests for BaseMetaObject and BaseMetaEstimator mixins."""
 
-tests in this module:
-
-
-"""
-
-__author__ = ["RNKuhns"]
+__author__ = ["RNKuhns", "fkiraly"]
 import inspect
 
 import pytest
@@ -23,37 +18,51 @@ from skbase.base._meta import (
 
 
 class MetaObjectTester(BaseMetaObject):
-    """Class to test meta object functionality."""
+    """Class to test meta-object functionality."""
 
     def __init__(self, a=7, b="something", c=None, steps=None):
         self.a = a
         self.b = b
         self.c = c
         self.steps = steps
+        super().__init__()
 
 
 class MetaEstimatorTester(BaseMetaEstimator):
-    """Class to test meta estimator functionality."""
+    """Class to test meta-estimator functionality."""
 
     def __init__(self, a=7, b="something", c=None, steps=None):
         self.a = a
         self.b = b
         self.c = c
         self.steps = steps
+        super().__init__()
+
+
+class ComponentDummy(BaseObject):
+    """Class to use as components in meta-estimator."""
+
+    def __init__(self, a=7, b="something"):
+        self.a = a
+        self.b = b
+        super().__init__()
 
 
 @pytest.fixture
 def fixture_metaestimator_instance():
+    """BaseMetaEstimator instance fixture."""
     return BaseMetaEstimator()
 
 
 @pytest.fixture
 def fixture_meta_object():
+    """MetaObjectTester instance fixture."""
     return MetaObjectTester()
 
 
 @pytest.fixture
 def fixture_meta_estimator():
+    """MetaEstimatorTester instance fixture."""
     return MetaEstimatorTester()
 
 
@@ -129,3 +138,33 @@ def test_basemetaestimator_check_is_fitted_raises_error_when_unfitted(
 
     fixture_metaestimator_instance._is_fitted = True
     assert fixture_metaestimator_instance.check_is_fitted() is None
+
+
+@pytest.mark.parametrize("long_steps", (True, False))
+def test_metaestimator_composite(long_steps):
+    """Test composite meta-estimator functionality."""
+    if long_steps:
+        steps = [("foo", ComponentDummy(42)), ("bar", ComponentDummy(24))]
+    else:
+        steps = [("foo", ComponentDummy(42), 123), ("bar", ComponentDummy(24), 321)]
+
+    meta_est = MetaEstimatorTester(steps=steps)
+
+    meta_est_params = meta_est.get_params()
+    assert isinstance(meta_est_params, dict)
+    expected_keys = [
+        "a",
+        "b",
+        "c",
+        "steps",
+        "foo",
+        "bar",
+        "foo__a",
+        "foo__b",
+        "bar__a",
+        "bar__b",
+    ]
+    assert set(meta_est_params.keys()) == set(expected_keys)
+
+    meta_est.set_params(bar__b="something else")
+    assert meta_est.get_params()["bar__b"] == "something else"

skbase/utils/deep_equals.py

@@ -80,7 +80,7 @@ def deep_equals(x, y, return_msg=False):
         else:
             return is_equal
 
-    if type(x) != type(y):
+    if type(x) is not type(y):
         return ret(False, f".type, x.type = {type(x)} != y.type = {type(y)}")
 
     # we now know all types are the same