scikit-base 0.6.2__tar.gz → 0.7.0__tar.gz

{scikit-base-0.6.2/scikit_base.egg-info → scikit-base-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.6.2
+Version: 0.7.0
 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.6.1 is now available. Check out our
+:rocket: Version 0.6.2 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit-base-0.6.2 → scikit-base-0.7.0}/README.md

@@ -7,7 +7,7 @@
 `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.6.1 is now available. Check out our
+:rocket: Version 0.6.2 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit-base-0.6.2 → scikit-base-0.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "scikit-base"
-version = "0.6.2"
+version = "0.7.0"
 description = "Base classes for sklearn-like parametric objects"
 authors = [
     {name = "sktime developers", email = "sktime.toolbox@gmail.com"},

{scikit-base-0.6.2 → scikit-base-0.7.0/scikit_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.6.2
+Version: 0.7.0
 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.6.1 is now available. Check out our
+:rocket: Version 0.6.2 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit-base-0.6.2 → scikit-base-0.7.0}/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.6.2"
+__version__: str = "0.7.0"

{scikit-base-0.6.2 → scikit-base-0.7.0}/skbase/base/_base.py

@@ -77,6 +77,7 @@ class BaseObject(_FlagManager):
         "display": "diagram",
         "print_changed_only": True,
         "check_clone": False,  # whether to execute validity checks in clone
+        "clone_config": True,  # clone config values (True) or use defaults (False)
     }
 
     def __init__(self):
@@ -127,6 +128,7 @@ class BaseObject(_FlagManager):
         """
         # retrieve parameters to copy them later
         params = self.get_params(deep=False)
+        config = self.get_config()
 
         # delete all object attributes in self
         attrs = [attr for attr in dir(self) if "__" not in attr]
@@ -137,6 +139,7 @@ class BaseObject(_FlagManager):
 
         # run init with a copy of parameters self had at the start
         self.__init__(**params)
+        self.set_config(**config)
 
         return self
 
@@ -157,6 +160,9 @@ class BaseObject(_FlagManager):
         self_params = self.get_params(deep=False)
         self_clone = self._clone(self)
 
+        if self.get_config()["clone_config"]:
+            self_clone.set_config(**self.get_config())
+
         # if checking the clone is turned off, return now
         if not self.get_config()["check_clone"]:
             return self_clone

{scikit-base-0.6.2 → scikit-base-0.7.0}/skbase/tests/test_base.py

@@ -931,6 +931,41 @@ def test_clone_raises_error_for_nonconforming_objects(
     #     obj_that_modifies.clone()
 
 
+@pytest.mark.parametrize("clone_config", [True, False])
+def test_config_after_clone_tags(clone_config):
+    """Test clone also clones config works as expected."""
+
+    class TestClass(BaseObject):
+        _tags = {"some_tag": True, "another_tag": 37}
+        _config = {"check_clone": 0}
+
+    test_obj = TestClass()
+    test_obj.set_config(**{"check_clone": 42, "foo": "bar"})
+
+    if not clone_config:
+        # if clone_config config is set to False:
+        # config key check_clone should be default, 0
+        # the new config key foo should not be present
+        test_obj.set_config(**{"clone_config": False})
+        expected = 0
+    else:
+        # if clone_config config is set to True:
+        # config key check_clone should be 42, as set above
+        # the new config key foo should be present, as it has non default
+        expected = 42
+
+    test_obj_clone = test_obj.clone()
+
+    assert "check_clone" in test_obj_clone.get_config().keys()
+    assert test_obj_clone.get_config()["check_clone"] == expected
+
+    if clone_config:
+        assert "foo" in test_obj_clone.get_config().keys()
+        assert test_obj_clone.get_config()["foo"] == "bar"
+    else:
+        assert "foo" not in test_obj_clone.get_config().keys()
+
+
 @pytest.mark.skipif(
     not _check_soft_dependencies("sklearn", severity="none"),
     reason="skip test if sklearn is not available",
@@ -1297,3 +1332,37 @@ def test_eq_dunder():
     assert composite == composite_2
     assert composite != composite_3
     assert composite_2 != composite_3
+
+
+def test_get_set_config():
+    """Tests get_config and set_config methods."""
+
+    class _TestConfig(BaseObject):
+        _config = {"foo_config": 42, "bar": "a"}
+
+        clsvar = 210
+
+        def __init__(self, a, b=42):
+            self.a = a
+            self.b = b
+            self.c = 84
+
+    test_obj = _TestConfig(7)
+
+    expected_config_orig = BaseObject._config.copy()
+    expected_config_orig.update({"foo_config": 42, "bar": "a"})
+
+    # Test get_config
+    assert test_obj.get_config() == expected_config_orig
+
+    expected_config = BaseObject._config.copy()
+    expected_config.update({"foo_config": 37, "bar": "a"})
+
+    # Test set_config
+    test_obj.set_config(foo_config=37)
+
+    assert test_obj.get_config() == expected_config
+
+    # test that reset does not reset config
+    test_obj.reset()
+    assert test_obj.get_config() == expected_config

{scikit-base-0.6.2 → scikit-base-0.7.0}/skbase/utils/deep_equals/_deep_equals.py

@@ -488,7 +488,7 @@ def deep_equals_custom(x, y, return_msg=False, plugins=None):
         import numpy as np
 
     # deal with the case where != returns a vector
-    if numpy_available and np.any(x != y) or any(_coerce_list(x != y)):
+    if numpy_available and np.any(x != y) or np.any(_coerce_list(x != y)):
         return ret(False, f" !=, {x} != {y}")
 
     return ret(True, "")

{scikit-base-0.6.2 → scikit-base-0.7.0}/skbase/utils/tests/test_deep_equals.py

@@ -40,6 +40,8 @@ if _check_soft_dependencies("pandas", severity="none"):
         (np.array([1, 2, 4]), [pd.DataFrame({"a": [4, 2]})]),
         {"foo": [42], "bar": pd.Series([1, 2])},
         {"bar": [42], "foo": pd.Series([1, 2])},
+        pd.Index([1, 2, 3]),
+        pd.Index([2, 3, 4]),
     ]
 
     # nested DataFrame example