scikit-base 0.11.0__tar.gz → 0.12.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. {scikit_base-0.11.0/scikit_base.egg-info → scikit_base-0.12.0}/PKG-INFO +6 -7
  2. {scikit_base-0.11.0 → scikit_base-0.12.0}/README.md +2 -2
  3. {scikit_base-0.11.0 → scikit_base-0.12.0}/pyproject.toml +4 -5
  4. {scikit_base-0.11.0 → scikit_base-0.12.0/scikit_base.egg-info}/PKG-INFO +6 -7
  5. {scikit_base-0.11.0 → scikit_base-0.12.0}/scikit_base.egg-info/SOURCES.txt +3 -0
  6. {scikit_base-0.11.0 → scikit_base-0.12.0}/scikit_base.egg-info/requires.txt +2 -2
  7. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/__init__.py +1 -1
  8. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/_base.py +32 -105
  9. scikit_base-0.12.0/skbase/base/_clone_base.py +129 -0
  10. scikit_base-0.12.0/skbase/base/_clone_plugins.py +215 -0
  11. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/tests/conftest.py +17 -4
  12. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/tests/test_base.py +19 -2
  13. scikit_base-0.12.0/skbase/utils/dependencies/_import.py +28 -0
  14. {scikit_base-0.11.0 → scikit_base-0.12.0}/LICENSE +0 -0
  15. {scikit_base-0.11.0 → scikit_base-0.12.0}/docs/source/conf.py +0 -0
  16. {scikit_base-0.11.0 → scikit_base-0.12.0}/scikit_base.egg-info/dependency_links.txt +0 -0
  17. {scikit_base-0.11.0 → scikit_base-0.12.0}/scikit_base.egg-info/top_level.txt +0 -0
  18. {scikit_base-0.11.0 → scikit_base-0.12.0}/scikit_base.egg-info/zip-safe +0 -0
  19. {scikit_base-0.11.0 → scikit_base-0.12.0}/setup.cfg +0 -0
  20. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/_exceptions.py +0 -0
  21. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/_nopytest_tests.py +0 -0
  22. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/__init__.py +0 -0
  23. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/_meta.py +0 -0
  24. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/_pretty_printing/__init__.py +0 -0
  25. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/_pretty_printing/_object_html_repr.py +0 -0
  26. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/_pretty_printing/_pprint.py +0 -0
  27. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/_pretty_printing/tests/__init__.py +0 -0
  28. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/_pretty_printing/tests/test_pprint.py +0 -0
  29. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/base/_tagmanager.py +0 -0
  30. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/lookup/__init__.py +0 -0
  31. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/lookup/_lookup.py +0 -0
  32. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/lookup/tests/__init__.py +0 -0
  33. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/lookup/tests/test_lookup.py +0 -0
  34. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/testing/__init__.py +0 -0
  35. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/testing/test_all_objects.py +0 -0
  36. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/testing/utils/__init__.py +0 -0
  37. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/testing/utils/_conditional_fixtures.py +0 -0
  38. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/testing/utils/inspect.py +0 -0
  39. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/tests/__init__.py +0 -0
  40. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/tests/mock_package/__init__.py +0 -0
  41. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/tests/mock_package/test_mock_package.py +0 -0
  42. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/tests/test_baseestimator.py +0 -0
  43. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/tests/test_exceptions.py +0 -0
  44. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/tests/test_meta.py +0 -0
  45. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/__init__.py +0 -0
  46. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/_check.py +0 -0
  47. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/_iter.py +0 -0
  48. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/_nested_iter.py +0 -0
  49. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/_utils.py +0 -0
  50. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/deep_equals/__init__.py +0 -0
  51. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/deep_equals/_common.py +0 -0
  52. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/deep_equals/_deep_equals.py +0 -0
  53. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/dependencies/__init__.py +0 -0
  54. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/dependencies/_dependencies.py +0 -0
  55. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/dependencies/tests/__init__.py +0 -0
  56. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/dependencies/tests/test_check_dependencies.py +0 -0
  57. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/random_state.py +0 -0
  58. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/stderr_mute.py +0 -0
  59. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/stdout_mute.py +0 -0
  60. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/tests/__init__.py +0 -0
  61. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/tests/test_check.py +0 -0
  62. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/tests/test_deep_equals.py +0 -0
  63. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/tests/test_iter.py +0 -0
  64. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/tests/test_nested_iter.py +0 -0
  65. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/tests/test_random_state.py +0 -0
  66. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/tests/test_std_mute.py +0 -0
  67. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/utils/tests/test_utils.py +0 -0
  68. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/validate/__init__.py +0 -0
  69. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/validate/_named_objects.py +0 -0
  70. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/validate/_types.py +0 -0
  71. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/validate/tests/__init__.py +0 -0
  72. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/validate/tests/test_iterable_named_objects.py +0 -0
  73. {scikit_base-0.11.0 → scikit_base-0.12.0}/skbase/validate/tests/test_type_validations.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: scikit-base
3
- Version: 0.11.0
3
+ Version: 0.12.0
4
4
  Summary: Base classes for sklearn-like parametric objects
5
5
  Author-email: sktime developers <sktime.toolbox@gmail.com>
6
6
  Maintainer: Franz Király
@@ -50,13 +50,12 @@ Classifier: Operating System :: Microsoft :: Windows
50
50
  Classifier: Operating System :: POSIX
51
51
  Classifier: Operating System :: Unix
52
52
  Classifier: Operating System :: MacOS
53
- Classifier: Programming Language :: Python :: 3.8
54
53
  Classifier: Programming Language :: Python :: 3.9
55
54
  Classifier: Programming Language :: Python :: 3.10
56
55
  Classifier: Programming Language :: Python :: 3.11
57
56
  Classifier: Programming Language :: Python :: 3.12
58
57
  Classifier: Programming Language :: Python :: 3.13
59
- Requires-Python: <3.14,>=3.8
58
+ Requires-Python: <3.14,>=3.9
60
59
  Description-Content-Type: text/markdown
61
60
  License-File: LICENSE
62
61
  Provides-Extra: all-extras
@@ -90,8 +89,8 @@ Requires-Dist: myst-parser; extra == "docs"
90
89
  Requires-Dist: nbsphinx>=0.8.6; extra == "docs"
91
90
  Requires-Dist: numpydoc; extra == "docs"
92
91
  Requires-Dist: pydata-sphinx-theme; extra == "docs"
93
- Requires-Dist: sphinx-issues<5.0.0; extra == "docs"
94
- Requires-Dist: sphinx-gallery<0.18.0; extra == "docs"
92
+ Requires-Dist: sphinx-issues<6.0.0; extra == "docs"
93
+ Requires-Dist: sphinx-gallery<0.19.0; extra == "docs"
95
94
  Requires-Dist: sphinx-panels; extra == "docs"
96
95
  Requires-Dist: sphinx-design<0.7.0; extra == "docs"
97
96
  Requires-Dist: Sphinx!=7.2.0,<9.0.0; extra == "docs"
@@ -115,7 +114,7 @@ Requires-Dist: scikit-learn>=0.24.0; extra == "test"
115
114
  `skbase` provides base classes for creating scikit-learn-like parametric objects,
116
115
  along with tools to make it easier to build your own packages that follow these design patterns.
117
116
 
118
- :rocket: Version 0.11.0 is now available. Check out our
117
+ :rocket: Version 0.12.0 is now available. Check out our
119
118
  [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
120
119
 
121
120
  | Overview | |
@@ -141,7 +140,7 @@ For trouble shooting or more information, see our
141
140
  [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
142
141
 
143
142
  - **Operating system**: macOS X · Linux · Windows 8.1 or higher
144
- - **Python version**: Python 3.8, 3.9, 3.10, 3.11 and 3.12
143
+ - **Python version**: Python 3.9, 3.10, 3.11, 3.12, and 3.13
145
144
  - **Package managers**: [pip]
146
145
 
147
146
  [pip]: https://pip.pypa.io/en/stable/
@@ -7,7 +7,7 @@
7
7
  `skbase` provides base classes for creating scikit-learn-like parametric objects,
8
8
  along with tools to make it easier to build your own packages that follow these design patterns.
9
9
 
10
- :rocket: Version 0.11.0 is now available. Check out our
10
+ :rocket: Version 0.12.0 is now available. Check out our
11
11
  [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
12
12
 
13
13
  | Overview | |
@@ -33,7 +33,7 @@ For trouble shooting or more information, see our
33
33
  [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
34
34
 
35
35
  - **Operating system**: macOS X · Linux · Windows 8.1 or higher
36
- - **Python version**: Python 3.8, 3.9, 3.10, 3.11 and 3.12
36
+ - **Python version**: Python 3.9, 3.10, 3.11, 3.12, and 3.13
37
37
  - **Package managers**: [pip]
38
38
 
39
39
  [pip]: https://pip.pypa.io/en/stable/
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "scikit-base"
3
- version = "0.11.0"
3
+ version = "0.12.0"
4
4
  description = "Base classes for sklearn-like parametric objects"
5
5
  authors = [
6
6
  {name = "sktime developers", email = "sktime.toolbox@gmail.com"},
@@ -26,14 +26,13 @@ classifiers = [
26
26
  "Operating System :: POSIX",
27
27
  "Operating System :: Unix",
28
28
  "Operating System :: MacOS",
29
- "Programming Language :: Python :: 3.8",
30
29
  "Programming Language :: Python :: 3.9",
31
30
  "Programming Language :: Python :: 3.10",
32
31
  "Programming Language :: Python :: 3.11",
33
32
  "Programming Language :: Python :: 3.12",
34
33
  "Programming Language :: Python :: 3.13",
35
34
  ]
36
- requires-python = ">=3.8,<3.14"
35
+ requires-python = ">=3.9,<3.14"
37
36
  dependencies = []
38
37
 
39
38
  [project.optional-dependencies]
@@ -71,8 +70,8 @@ docs = [
71
70
  "nbsphinx>=0.8.6",
72
71
  "numpydoc",
73
72
  "pydata-sphinx-theme",
74
- "sphinx-issues<5.0.0",
75
- "sphinx-gallery<0.18.0",
73
+ "sphinx-issues<6.0.0",
74
+ "sphinx-gallery<0.19.0",
76
75
  "sphinx-panels",
77
76
  "sphinx-design<0.7.0",
78
77
  "Sphinx!=7.2.0,<9.0.0",
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: scikit-base
3
- Version: 0.11.0
3
+ Version: 0.12.0
4
4
  Summary: Base classes for sklearn-like parametric objects
5
5
  Author-email: sktime developers <sktime.toolbox@gmail.com>
6
6
  Maintainer: Franz Király
@@ -50,13 +50,12 @@ Classifier: Operating System :: Microsoft :: Windows
50
50
  Classifier: Operating System :: POSIX
51
51
  Classifier: Operating System :: Unix
52
52
  Classifier: Operating System :: MacOS
53
- Classifier: Programming Language :: Python :: 3.8
54
53
  Classifier: Programming Language :: Python :: 3.9
55
54
  Classifier: Programming Language :: Python :: 3.10
56
55
  Classifier: Programming Language :: Python :: 3.11
57
56
  Classifier: Programming Language :: Python :: 3.12
58
57
  Classifier: Programming Language :: Python :: 3.13
59
- Requires-Python: <3.14,>=3.8
58
+ Requires-Python: <3.14,>=3.9
60
59
  Description-Content-Type: text/markdown
61
60
  License-File: LICENSE
62
61
  Provides-Extra: all-extras
@@ -90,8 +89,8 @@ Requires-Dist: myst-parser; extra == "docs"
90
89
  Requires-Dist: nbsphinx>=0.8.6; extra == "docs"
91
90
  Requires-Dist: numpydoc; extra == "docs"
92
91
  Requires-Dist: pydata-sphinx-theme; extra == "docs"
93
- Requires-Dist: sphinx-issues<5.0.0; extra == "docs"
94
- Requires-Dist: sphinx-gallery<0.18.0; extra == "docs"
92
+ Requires-Dist: sphinx-issues<6.0.0; extra == "docs"
93
+ Requires-Dist: sphinx-gallery<0.19.0; extra == "docs"
95
94
  Requires-Dist: sphinx-panels; extra == "docs"
96
95
  Requires-Dist: sphinx-design<0.7.0; extra == "docs"
97
96
  Requires-Dist: Sphinx!=7.2.0,<9.0.0; extra == "docs"
@@ -115,7 +114,7 @@ Requires-Dist: scikit-learn>=0.24.0; extra == "test"
115
114
  `skbase` provides base classes for creating scikit-learn-like parametric objects,
116
115
  along with tools to make it easier to build your own packages that follow these design patterns.
117
116
 
118
- :rocket: Version 0.11.0 is now available. Check out our
117
+ :rocket: Version 0.12.0 is now available. Check out our
119
118
  [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
120
119
 
121
120
  | Overview | |
@@ -141,7 +140,7 @@ For trouble shooting or more information, see our
141
140
  [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
142
141
 
143
142
  - **Operating system**: macOS X · Linux · Windows 8.1 or higher
144
- - **Python version**: Python 3.8, 3.9, 3.10, 3.11 and 3.12
143
+ - **Python version**: Python 3.9, 3.10, 3.11, 3.12, and 3.13
145
144
  - **Package managers**: [pip]
146
145
 
147
146
  [pip]: https://pip.pypa.io/en/stable/
@@ -14,6 +14,8 @@ skbase/_exceptions.py
14
14
  skbase/_nopytest_tests.py
15
15
  skbase/base/__init__.py
16
16
  skbase/base/_base.py
17
+ skbase/base/_clone_base.py
18
+ skbase/base/_clone_plugins.py
17
19
  skbase/base/_meta.py
18
20
  skbase/base/_tagmanager.py
19
21
  skbase/base/_pretty_printing/__init__.py
@@ -51,6 +53,7 @@ skbase/utils/deep_equals/_common.py
51
53
  skbase/utils/deep_equals/_deep_equals.py
52
54
  skbase/utils/dependencies/__init__.py
53
55
  skbase/utils/dependencies/_dependencies.py
56
+ skbase/utils/dependencies/_import.py
54
57
  skbase/utils/dependencies/tests/__init__.py
55
58
  skbase/utils/dependencies/tests/test_check_dependencies.py
56
59
  skbase/utils/tests/__init__.py
@@ -18,8 +18,8 @@ myst-parser
18
18
  nbsphinx>=0.8.6
19
19
  numpydoc
20
20
  pydata-sphinx-theme
21
- sphinx-issues<5.0.0
22
- sphinx-gallery<0.18.0
21
+ sphinx-issues<6.0.0
22
+ sphinx-gallery<0.19.0
23
23
  sphinx-panels
24
24
  sphinx-design<0.7.0
25
25
  Sphinx!=7.2.0,<9.0.0
@@ -6,4 +6,4 @@
6
6
  The included functionality makes it easy to reuse scikit-learn and
7
7
  sktime design principles in your project.
8
8
  """
9
- __version__: str = "0.11.0"
9
+ __version__: str = "0.12.0"
@@ -60,6 +60,7 @@ from copy import deepcopy
60
60
  from typing import List
61
61
 
62
62
  from skbase._exceptions import NotFittedError
63
+ from skbase.base._clone_base import _check_clone, _clone
63
64
  from skbase.base._pretty_printing._object_html_repr import _object_html_repr
64
65
  from skbase.base._tagmanager import _FlagManager
65
66
 
@@ -175,11 +176,41 @@ class BaseObject(_FlagManager):
175
176
  ------
176
177
  RuntimeError if the clone is non-conforming, due to faulty ``__init__``.
177
178
  """
178
- self_clone = _clone(self)
179
+ # get plugins for cloning, if present (empty by default)
180
+ clone_plugins = self._get_clone_plugins()
181
+
182
+ # clone the object
183
+ self_clone = _clone(self, base_cls=BaseObject, clone_plugins=clone_plugins)
184
+
185
+ # check the clone, if check_clone is set (False by default)
179
186
  if self.get_config()["check_clone"]:
180
187
  _check_clone(original=self, clone=self_clone)
188
+
189
+ # return the clone
181
190
  return self_clone
182
191
 
192
+ @classmethod
193
+ def _get_clone_plugins(cls):
194
+ """Get clone plugins for BaseObject.
195
+
196
+ Can be overridden in subclasses to add custom clone plugins.
197
+
198
+ If implemented, must return a list of clone plugins for descendants.
199
+
200
+ Plugins are loaded ahead of the default plugins, and are used in the order
201
+ they are returned.
202
+ This allows extenders to override the default behaviours, if desired.
203
+
204
+ Returns
205
+ -------
206
+ list of str
207
+ List of clone plugins for descendants.
208
+ Each plugin must inherit from ``BaseCloner``
209
+ in ``skbase.base._clone_plugins``, and implement
210
+ the methods ``_check`` and ``_clone``.
211
+ """
212
+ return None
213
+
183
214
  @classmethod
184
215
  def _get_init_signature(cls):
185
216
  """Get class init signature.
@@ -1653,107 +1684,3 @@ class BaseEstimator(BaseObject):
1653
1684
  fitted parameters, keyed by names of fitted parameter
1654
1685
  """
1655
1686
  return self._get_fitted_params_default()
1656
-
1657
-
1658
- # Adapted from sklearn's `_clone_parametrized()`
1659
- def _clone(estimator, *, safe=True):
1660
- """Construct a new unfitted estimator with the same parameters.
1661
-
1662
- Clone does a deep copy of the model in an estimator
1663
- without actually copying attached data. It returns a new estimator
1664
- with the same parameters that has not been fitted on any data.
1665
-
1666
- Parameters
1667
- ----------
1668
- estimator : {list, tuple, set} of estimator instance or a single \
1669
- estimator instance
1670
- The estimator or group of estimators to be cloned.
1671
- safe : bool, default=True
1672
- If safe is False, clone will fall back to a deep copy on objects
1673
- that are not estimators.
1674
-
1675
- Returns
1676
- -------
1677
- estimator : object
1678
- The deep copy of the input, an estimator if input is an estimator.
1679
-
1680
- Notes
1681
- -----
1682
- If the estimator's `random_state` parameter is an integer (or if the
1683
- estimator doesn't have a `random_state` parameter), an *exact clone* is
1684
- returned: the clone and the original estimator will give the exact same
1685
- results. Otherwise, *statistical clone* is returned: the clone might
1686
- return different results from the original estimator. More details can be
1687
- found in :ref:`randomness`.
1688
- """
1689
- estimator_type = type(estimator)
1690
- if estimator_type is dict:
1691
- return {k: _clone(v, safe=safe) for k, v in estimator.items()}
1692
- if estimator_type in (list, tuple, set, frozenset):
1693
- return estimator_type([_clone(e, safe=safe) for e in estimator])
1694
- elif not hasattr(estimator, "get_params") or isinstance(estimator, type):
1695
- if not safe:
1696
- return deepcopy(estimator)
1697
- else:
1698
- if isinstance(estimator, type):
1699
- raise TypeError(
1700
- "Cannot clone object. "
1701
- + "You should provide an instance of "
1702
- + "scikit-learn estimator instead of a class."
1703
- )
1704
- else:
1705
- raise TypeError(
1706
- "Cannot clone object '%s' (type %s): "
1707
- "it does not seem to be a scikit-learn "
1708
- "estimator as it does not implement a "
1709
- "'get_params' method." % (repr(estimator), type(estimator))
1710
- )
1711
-
1712
- klass = estimator.__class__
1713
- new_object_params = estimator.get_params(deep=False)
1714
- for name, param in new_object_params.items():
1715
- new_object_params[name] = _clone(param, safe=False)
1716
- new_object = klass(**new_object_params)
1717
- params_set = new_object.get_params(deep=False)
1718
-
1719
- # quick sanity check of the parameters of the clone
1720
- for name in new_object_params:
1721
- param1 = new_object_params[name]
1722
- param2 = params_set[name]
1723
- if param1 is not param2:
1724
- raise RuntimeError(
1725
- "Cannot clone object %s, as the constructor "
1726
- "either does not set or modifies parameter %s" % (estimator, name)
1727
- )
1728
-
1729
- # This is an extension to the original sklearn implementation
1730
- if isinstance(estimator, BaseObject) and estimator.get_config()["clone_config"]:
1731
- new_object.set_config(**estimator.get_config())
1732
-
1733
- return new_object
1734
-
1735
-
1736
- def _check_clone(original, clone):
1737
- from skbase.utils.deep_equals import deep_equals
1738
-
1739
- self_params = original.get_params(deep=False)
1740
-
1741
- # check that all attributes are written to the clone
1742
- for attrname in self_params.keys():
1743
- if not hasattr(clone, attrname):
1744
- raise RuntimeError(
1745
- f"error in {original}.clone, __init__ must write all arguments "
1746
- f"to self and not mutate them, but {attrname} was not found. "
1747
- f"Please check __init__ of {original}."
1748
- )
1749
-
1750
- clone_attrs = {attr: getattr(clone, attr) for attr in self_params.keys()}
1751
-
1752
- # check equality of parameters post-clone and pre-clone
1753
- clone_attrs_valid, msg = deep_equals(self_params, clone_attrs, return_msg=True)
1754
- if not clone_attrs_valid:
1755
- raise RuntimeError(
1756
- f"error in {original}.clone, __init__ must write all arguments "
1757
- f"to self and not mutate them, but this is not the case. "
1758
- f"Error on equality check of arguments (x) vs parameters (y): {msg}"
1759
- )
@@ -0,0 +1,129 @@
1
+ # -*- coding: utf-8 -*-
2
+ # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
3
+ # Elements of BaseObject reuse code developed in scikit-learn. These elements
4
+ # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
5
+ # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING
6
+ """Logic and plugins for cloning objects.
7
+
8
+ This module contains logic for cloning objects:
9
+
10
+ _clone(estimator, *, safe=True, plugins=None) - central entry point for cloning
11
+ _check_clone(original, clone) - validation utility to check clones
12
+
13
+ Default plugins for _clone are stored in _clone_plugins:
14
+
15
+ DEFAULT_CLONE_PLUGINS - list with default plugins for cloning
16
+
17
+ Each element of DEFAULT_CLONE_PLUGINS inherits from BaseCloner, with methods:
18
+
19
+ * check(obj) -> boolean - fast checker whether plugin applies
20
+ * clone(obj) -> type(obj) - method to clone obj
21
+ """
22
+ __all__ = ["_clone", "_check_clone"]
23
+
24
+ from skbase.base._clone_plugins import DEFAULT_CLONE_PLUGINS
25
+
26
+
27
+ # Adapted from sklearn's `_clone_parametrized()`
28
+ def _clone(estimator, *, safe=True, clone_plugins=None, base_cls=None):
29
+ """Construct a new unfitted estimator with the same parameters.
30
+
31
+ Clone does a deep copy of the model in an estimator
32
+ without actually copying attached data. It returns a new estimator
33
+ with the same parameters that has not been fitted on any data.
34
+
35
+ Parameters
36
+ ----------
37
+ estimator : {list, tuple, set} of estimator instance or a single estimator instance
38
+ The estimator or group of estimators to be cloned.
39
+ safe : bool, default=True
40
+ If ``safe`` is False, clone will fall back to a deep copy on objects
41
+ that are not estimators.
42
+ clone_plugins : list of BaseCloner clone plugins, concrete descendant classes.
43
+ Must implement ``_check`` and ``_clone`` method, see ``BaseCloner`` interface.
44
+ If passed, will work through clone plugins in ``clone_plugins``
45
+ before working through ``DEFAULT_CLONE_PLUGINS``. To override
46
+ a cloner in ``DEAULT_CLONE_PLUGINS``, simply ensure a cloner with
47
+ the same ``_check`` logis is present in ``clone_plugins``.
48
+ base_cls : reference to BaseObject
49
+ Reference to the BaseObject class from skbase.base._base.
50
+ Present for easy reference, fast imports, and potential extensions.
51
+
52
+ Returns
53
+ -------
54
+ estimator : object
55
+ The deep copy of the input, an estimator if input is an estimator.
56
+
57
+ Notes
58
+ -----
59
+ If the estimator's `random_state` parameter is an integer (or if the
60
+ estimator doesn't have a `random_state` parameter), an *exact clone* is
61
+ returned: the clone and the original estimator will give the exact same
62
+ results. Otherwise, *statistical clone* is returned: the clone might
63
+ return different results from the original estimator. More details can be
64
+ found in :ref:`randomness`.
65
+ """
66
+ # handle cloning plugins:
67
+ # if no plugins provided by user, work through the DEFAULT_CLONE_PLUGINS
68
+ # if provided by user, work through user provided plugins first, then defaults
69
+ if clone_plugins is not None:
70
+ all_plugins = clone_plugins.copy()
71
+ all_plugins.append(DEFAULT_CLONE_PLUGINS.copy())
72
+ else:
73
+ all_plugins = DEFAULT_CLONE_PLUGINS
74
+
75
+ for cloner_plugin in all_plugins:
76
+ cloner = cloner_plugin(safe=safe, clone_plugins=all_plugins, base_cls=base_cls)
77
+ # we clone with the first plugin in the list that:
78
+ # 1. claims it is applicable, via check
79
+ # 2. does not produce an Exception when cloning
80
+ if cloner.check(obj=estimator):
81
+ return cloner.clone(obj=estimator)
82
+
83
+ raise RuntimeError(
84
+ "Error in skbase _clone, catch-all plugin did not catch all "
85
+ "remaining cases. This is likely due to custom modification of the module."
86
+ )
87
+
88
+
89
+ def _check_clone(original, clone):
90
+ """Check that clone is a valid clone of original.
91
+
92
+ Called from BaseObject.clone to validate the clone, if
93
+ the config flag check_clone is set to True.
94
+
95
+ Parameters
96
+ ----------
97
+ original : object
98
+ The original object.
99
+ clone : object
100
+ The cloned object.
101
+
102
+ Raises
103
+ ------
104
+ RuntimeError
105
+ If the clone is not a valid clone of the original.
106
+ """
107
+ from skbase.utils.deep_equals import deep_equals
108
+
109
+ self_params = original.get_params(deep=False)
110
+
111
+ # check that all attributes are written to the clone
112
+ for attrname in self_params.keys():
113
+ if not hasattr(clone, attrname):
114
+ raise RuntimeError(
115
+ f"error in {original}.clone, __init__ must write all arguments "
116
+ f"to self and not mutate them, but {attrname} was not found. "
117
+ f"Please check __init__ of {original}."
118
+ )
119
+
120
+ clone_attrs = {attr: getattr(clone, attr) for attr in self_params.keys()}
121
+
122
+ # check equality of parameters post-clone and pre-clone
123
+ clone_attrs_valid, msg = deep_equals(self_params, clone_attrs, return_msg=True)
124
+ if not clone_attrs_valid:
125
+ raise RuntimeError(
126
+ f"error in {original}.clone, __init__ must write all arguments "
127
+ f"to self and not mutate them, but this is not the case. "
128
+ f"Error on equality check of arguments (x) vs parameters (y): {msg}"
129
+ )
@@ -0,0 +1,215 @@
1
+ # -*- coding: utf-8 -*-
2
+ # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
3
+ # Elements of BaseObject reuse code developed in scikit-learn. These elements
4
+ # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
5
+ # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING
6
+ """Logic and plugins for cloning objects - default plugins.
7
+
8
+ This module contains default plugins for _clone, from _clone_base.
9
+
10
+ DEFAULT_CLONE_PLUGINS - list with default plugins for cloning
11
+
12
+ Each element of DEFAULT_CLONE_PLUGINS inherits from BaseCloner, with methods:
13
+
14
+ * check(obj) -> boolean - fast checker whether plugin applies
15
+ * clone(obj) -> type(obj) - method to clone obj
16
+ """
17
+ from functools import lru_cache
18
+ from inspect import isclass
19
+
20
+
21
+ # imports wrapped in functions to avoid exceptions on skbase init
22
+ # wrapped in _safe_import to avoid exceptions on skbase init
23
+ @lru_cache(maxsize=None)
24
+ def _is_sklearn_present():
25
+ """Check whether scikit-learn is present."""
26
+ from skbase.utils.dependencies import _check_soft_dependencies
27
+
28
+ return _check_soft_dependencies("scikit-learn")
29
+
30
+
31
+ @lru_cache(maxsize=None)
32
+ def _get_sklearn_clone():
33
+ """Get sklearn's clone function."""
34
+ from skbase.utils.dependencies._import import _safe_import
35
+
36
+ return _safe_import("sklearn.base:clone", condition=_is_sklearn_present())
37
+
38
+
39
+ class BaseCloner:
40
+ """Base class for clone plugins.
41
+
42
+ Concrete classes must inherit methods:
43
+
44
+ * check(obj) -> boolean - fast checker whether plugin applies
45
+ * clone(obj) -> type(obj) - method to clone obj
46
+ """
47
+
48
+ def __init__(self, safe, clone_plugins=None, base_cls=None):
49
+ self.safe = safe
50
+ self.clone_plugins = clone_plugins
51
+ self.base_cls = base_cls
52
+
53
+ def check(self, obj):
54
+ """Check whether the plugin applies to obj."""
55
+ try:
56
+ return self._check(obj)
57
+ except Exception:
58
+ return False
59
+
60
+ def clone(self, obj):
61
+ """Return a clone of obj."""
62
+ return self._clone(obj)
63
+
64
+ def recursive_clone(self, obj, **kwargs):
65
+ """Recursive call to _clone, for explicit code and to avoid circular imports."""
66
+ from skbase.base._clone_base import _clone
67
+
68
+ recursion_kwargs = {
69
+ "safe": self.safe,
70
+ "clone_plugins": self.clone_plugins,
71
+ "base_cls": self.base_cls,
72
+ }
73
+ recursion_kwargs.update(kwargs)
74
+ return _clone(obj, **recursion_kwargs)
75
+
76
+
77
+ class _CloneClass(BaseCloner):
78
+ """Clone plugin for classes. Returns the class."""
79
+
80
+ def _check(self, obj):
81
+ """Check whether the plugin applies to obj."""
82
+ return isclass(obj)
83
+
84
+ def _clone(self, obj):
85
+ """Return a clone of obj."""
86
+ return obj
87
+
88
+
89
+ class _CloneDict(BaseCloner):
90
+ """Clone plugin for dicts. Performs recursive cloning."""
91
+
92
+ def _check(self, obj):
93
+ """Check whether the plugin applies to obj."""
94
+ return isinstance(obj, dict)
95
+
96
+ def _clone(self, obj):
97
+ """Return a clone of obj."""
98
+ _clone = self.recursive_clone
99
+ return {k: _clone(v) for k, v in obj.items()}
100
+
101
+
102
+ class _CloneListTupleSet(BaseCloner):
103
+ """Clone plugin for lists, tuples, sets. Performs recursive cloning."""
104
+
105
+ def _check(self, obj):
106
+ """Check whether the plugin applies to obj."""
107
+ return isinstance(obj, (list, tuple, set, frozenset))
108
+
109
+ def _clone(self, obj):
110
+ """Return a clone of obj."""
111
+ _clone = self.recursive_clone
112
+ return type(obj)([_clone(e) for e in obj])
113
+
114
+
115
+ def _default_clone(estimator, recursive_clone):
116
+ """Clone estimator. Default used in skbase native and generic get_params clone."""
117
+ klass = estimator.__class__
118
+ new_object_params = estimator.get_params(deep=False)
119
+ for name, param in new_object_params.items():
120
+ new_object_params[name] = recursive_clone(param, safe=False)
121
+ new_object = klass(**new_object_params)
122
+ params_set = new_object.get_params(deep=False)
123
+
124
+ # quick sanity check of the parameters of the clone
125
+ for name in new_object_params:
126
+ param1 = new_object_params[name]
127
+ param2 = params_set[name]
128
+ if param1 is not param2:
129
+ raise RuntimeError(
130
+ "Cannot clone object %s, as the constructor "
131
+ "either does not set or modifies parameter %s" % (estimator, name)
132
+ )
133
+
134
+ return new_object
135
+
136
+
137
+ class _CloneSkbase(BaseCloner):
138
+ """Clone plugin for scikit-base BaseObject descendants."""
139
+
140
+ def _check(self, obj):
141
+ """Check whether the plugin applies to obj."""
142
+ return isinstance(obj, self.base_cls)
143
+
144
+ def _clone(self, obj):
145
+ """Return a clone of obj."""
146
+ new_object = _default_clone(estimator=obj, recursive_clone=self.recursive_clone)
147
+
148
+ # Ensure that configs are retained in the new object
149
+ if obj.get_config()["clone_config"]:
150
+ new_object.set_config(**obj.get_config())
151
+
152
+ return new_object
153
+
154
+
155
+ class _CloneSklearn(BaseCloner):
156
+ """Clone plugin for scikit-learn BaseEstimator descendants."""
157
+
158
+ def _check(self, obj):
159
+ """Check whether the plugin applies to obj."""
160
+ if not _is_sklearn_present():
161
+ return False
162
+
163
+ from sklearn.base import BaseEstimator
164
+
165
+ return isinstance(obj, BaseEstimator)
166
+
167
+ def _clone(self, obj):
168
+ """Return a clone of obj."""
169
+ _sklearn_clone = _get_sklearn_clone()
170
+ return _sklearn_clone(obj)
171
+
172
+
173
+ class _CloneGetParams(BaseCloner):
174
+ """Clone plugin for objects that implement get_params but are not the above."""
175
+
176
+ def _check(self, obj):
177
+ """Check whether the plugin applies to obj."""
178
+ return hasattr(obj, "get_params")
179
+
180
+ def _clone(self, obj):
181
+ """Return a clone of obj."""
182
+ return _default_clone(estimator=obj, recursive_clone=self.recursive_clone)
183
+
184
+
185
+ class _CloneCatchAll(BaseCloner):
186
+ """Catch-all plug-in to deal, catches all objects at the end of list."""
187
+
188
+ def _check(self, obj):
189
+ """Check whether the plugin applies to obj."""
190
+ return True
191
+
192
+ def _clone(self, obj):
193
+ """Return a clone of obj."""
194
+ from copy import deepcopy
195
+
196
+ if not self.safe:
197
+ return deepcopy(obj)
198
+ else:
199
+ raise TypeError(
200
+ "Cannot clone object '%s' (type %s): "
201
+ "it does not seem to be a scikit-base object or scikit-learn "
202
+ "estimator, as it does not implement a "
203
+ "'get_params' method." % (repr(obj), type(obj))
204
+ )
205
+
206
+
207
+ DEFAULT_CLONE_PLUGINS = [
208
+ _CloneClass,
209
+ _CloneDict,
210
+ _CloneListTupleSet,
211
+ _CloneSkbase,
212
+ _CloneSklearn,
213
+ _CloneGetParams,
214
+ _CloneCatchAll,
215
+ ]
@@ -22,6 +22,8 @@ SKBASE_MODULES = (
22
22
  "skbase._nopytest_tests",
23
23
  "skbase.base",
24
24
  "skbase.base._base",
25
+ "skbase.base._clone_base",
26
+ "skbase.base._clone_plugins",
25
27
  "skbase.base._meta",
26
28
  "skbase.base._pretty_printing",
27
29
  "skbase.base._pretty_printing._object_html_repr",
@@ -53,6 +55,7 @@ SKBASE_MODULES = (
53
55
  "skbase.utils.deep_equals._deep_equals",
54
56
  "skbase.utils.dependencies",
55
57
  "skbase.utils.dependencies._dependencies",
58
+ "skbase.utils.dependencies._import",
56
59
  "skbase.utils.random_state",
57
60
  "skbase.utils.stderr_mute",
58
61
  "skbase.utils.stdout_mute",
@@ -96,6 +99,7 @@ SKBASE_PUBLIC_CLASSES_BY_MODULE = {
96
99
  "BaseObject",
97
100
  ),
98
101
  "skbase.base._base": ("BaseEstimator", "BaseObject"),
102
+ "skbase.base._clone_plugins": ("BaseCloner",),
99
103
  "skbase.base._meta": (
100
104
  "BaseMetaObject",
101
105
  "BaseMetaObjectMixin",
@@ -116,6 +120,16 @@ SKBASE_PUBLIC_CLASSES_BY_MODULE = {
116
120
  SKBASE_CLASSES_BY_MODULE = SKBASE_PUBLIC_CLASSES_BY_MODULE.copy()
117
121
  SKBASE_CLASSES_BY_MODULE.update(
118
122
  {
123
+ "skbase.base._clone_plugins": (
124
+ "BaseCloner",
125
+ "_CloneClass",
126
+ "_CloneSkbase",
127
+ "_CloneSklearn",
128
+ "_CloneDict",
129
+ "_CloneListTupleSet",
130
+ "_CloneGetParams",
131
+ "_CloneCatchAll",
132
+ ),
119
133
  "skbase.base._meta": (
120
134
  "BaseMetaObject",
121
135
  "BaseMetaObjectMixin",
@@ -184,10 +198,8 @@ SKBASE_PUBLIC_FUNCTIONS_BY_MODULE = {
184
198
  SKBASE_FUNCTIONS_BY_MODULE = SKBASE_PUBLIC_FUNCTIONS_BY_MODULE.copy()
185
199
  SKBASE_FUNCTIONS_BY_MODULE.update(
186
200
  {
187
- "skbase.base._base": (
188
- "_clone",
189
- "_check_clone",
190
- ),
201
+ "skbase.base._clone_base": {"_check_clone", "_clone"},
202
+ "skbase.base._clone_plugins": ("_default_clone",),
191
203
  "skbase.base._pretty_printing._object_html_repr": (
192
204
  "_get_visual_block",
193
205
  "_object_html_repr",
@@ -218,6 +230,7 @@ SKBASE_FUNCTIONS_BY_MODULE.update(
218
230
  "_check_python_version",
219
231
  "_check_estimator_deps",
220
232
  ),
233
+ "skbase.utils.dependencies._import": ("_safe_import",),
221
234
  "skbase.utils._iter": (
222
235
  "_format_seq_to_str",
223
236
  "_remove_type_text",
@@ -1123,8 +1123,8 @@ def test_clone_class_rather_than_instance_raises_error(
1123
1123
  not _check_soft_dependencies("scikit-learn", severity="none"),
1124
1124
  reason="skip test if sklearn is not available",
1125
1125
  ) # sklearn is part of the dev dependency set, test should be executed with that
1126
- def test_clone_sklearn_composite(fixture_class_parent: Type[Parent]):
1127
- """Test clone with keyword parameter set to None."""
1126
+ def test_clone_sklearn_composite():
1127
+ """Test clone with a composite of sklearn and skbase."""
1128
1128
  from sklearn.ensemble import GradientBoostingRegressor
1129
1129
 
1130
1130
  sklearn_obj = GradientBoostingRegressor(random_state=5, learning_rate=0.02)
@@ -1134,6 +1134,23 @@ def test_clone_sklearn_composite(fixture_class_parent: Type[Parent]):
1134
1134
  assert composite_set.get_params()["a__random_state"] == 42
1135
1135
 
1136
1136
 
1137
+ @pytest.mark.skipif(
1138
+ not _check_soft_dependencies("scikit-learn", severity="none"),
1139
+ reason="skip test if sklearn is not available",
1140
+ ) # sklearn is part of the dev dependency set, test should be executed with that
1141
+ def test_clone_sklearn_composite_retains_config():
1142
+ """Test that clone retains sklearn config if inside skbase composite."""
1143
+ from sklearn.preprocessing import StandardScaler
1144
+
1145
+ sklearn_obj_w_config = StandardScaler().set_output(transform="pandas")
1146
+
1147
+ composite = ResetTester(a=sklearn_obj_w_config)
1148
+ composite_clone = composite.clone()
1149
+
1150
+ assert hasattr(composite_clone.a, "_sklearn_output_config")
1151
+ assert composite_clone.a._sklearn_output_config.get("transform", None) == "pandas"
1152
+
1153
+
1137
1154
  # Tests of BaseObject pretty printing representation inspired by sklearn
1138
1155
  def test_baseobject_repr(
1139
1156
  fixture_class_parent: Type[Parent],
@@ -0,0 +1,28 @@
1
+ # -*- coding: utf-8 -*-
2
+ """Utility for safe import."""
3
+ import importlib
4
+
5
+
6
+ def _safe_import(path, condition=True):
7
+ """Safely imports an object from a module given its string location.
8
+
9
+ Parameters
10
+ ----------
11
+ path: str
12
+ A string representing the module and object.
13
+ In the form ``"module.submodule:object"``.
14
+ condition: bool, default=True
15
+ If False, the import will not be attempted.
16
+
17
+ Returns
18
+ -------
19
+ Any: The imported object, or None if it could not be imported.
20
+ """
21
+ if not condition:
22
+ return None
23
+ try:
24
+ module_name, object_name = path.split(":")
25
+ module = importlib.import_module(module_name)
26
+ return getattr(module, object_name, None)
27
+ except (ImportError, AttributeError, ValueError):
28
+ return None
File without changes
File without changes