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

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 (60) hide show
  1. docs/source/conf.py +299 -299
  2. {scikit_base-0.4.6.dist-info → scikit_base-0.5.1.dist-info}/LICENSE +29 -29
  3. {scikit_base-0.4.6.dist-info → scikit_base-0.5.1.dist-info}/METADATA +160 -159
  4. scikit_base-0.5.1.dist-info/RECORD +58 -0
  5. {scikit_base-0.4.6.dist-info → scikit_base-0.5.1.dist-info}/WHEEL +1 -1
  6. scikit_base-0.5.1.dist-info/top_level.txt +5 -0
  7. {scikit_base-0.4.6.dist-info → scikit_base-0.5.1.dist-info}/zip-safe +1 -1
  8. skbase/__init__.py +14 -14
  9. skbase/_exceptions.py +31 -31
  10. skbase/_nopytest_tests.py +35 -35
  11. skbase/base/__init__.py +20 -20
  12. skbase/base/_base.py +1249 -1249
  13. skbase/base/_meta.py +883 -871
  14. skbase/base/_pretty_printing/__init__.py +11 -11
  15. skbase/base/_pretty_printing/_object_html_repr.py +392 -392
  16. skbase/base/_pretty_printing/_pprint.py +412 -412
  17. skbase/base/_tagmanager.py +217 -217
  18. skbase/lookup/__init__.py +31 -31
  19. skbase/lookup/_lookup.py +1009 -1009
  20. skbase/lookup/tests/__init__.py +2 -2
  21. skbase/lookup/tests/test_lookup.py +991 -991
  22. skbase/testing/__init__.py +12 -12
  23. skbase/testing/test_all_objects.py +852 -856
  24. skbase/testing/utils/__init__.py +5 -5
  25. skbase/testing/utils/_conditional_fixtures.py +209 -209
  26. skbase/testing/utils/_dependencies.py +15 -15
  27. skbase/testing/utils/deep_equals.py +15 -15
  28. skbase/testing/utils/inspect.py +30 -30
  29. skbase/testing/utils/tests/__init__.py +2 -2
  30. skbase/testing/utils/tests/test_check_dependencies.py +49 -49
  31. skbase/testing/utils/tests/test_deep_equals.py +66 -66
  32. skbase/tests/__init__.py +2 -2
  33. skbase/tests/conftest.py +273 -273
  34. skbase/tests/mock_package/__init__.py +5 -5
  35. skbase/tests/mock_package/test_mock_package.py +74 -74
  36. skbase/tests/test_base.py +1202 -1202
  37. skbase/tests/test_baseestimator.py +130 -130
  38. skbase/tests/test_exceptions.py +23 -23
  39. skbase/tests/test_meta.py +170 -131
  40. skbase/utils/__init__.py +21 -21
  41. skbase/utils/_check.py +53 -53
  42. skbase/utils/_iter.py +238 -238
  43. skbase/utils/_nested_iter.py +180 -180
  44. skbase/utils/_utils.py +91 -91
  45. skbase/utils/deep_equals.py +358 -358
  46. skbase/utils/dependencies/__init__.py +11 -11
  47. skbase/utils/dependencies/_dependencies.py +253 -253
  48. skbase/utils/tests/__init__.py +4 -4
  49. skbase/utils/tests/test_check.py +24 -24
  50. skbase/utils/tests/test_iter.py +127 -127
  51. skbase/utils/tests/test_nested_iter.py +84 -84
  52. skbase/utils/tests/test_utils.py +37 -37
  53. skbase/validate/__init__.py +22 -22
  54. skbase/validate/_named_objects.py +403 -403
  55. skbase/validate/_types.py +345 -345
  56. skbase/validate/tests/__init__.py +2 -2
  57. skbase/validate/tests/test_iterable_named_objects.py +200 -200
  58. skbase/validate/tests/test_type_validations.py +370 -370
  59. scikit_base-0.4.6.dist-info/RECORD +0 -58
  60. scikit_base-0.4.6.dist-info/top_level.txt +0 -2
@@ -1,159 +1,160 @@
1
- Metadata-Version: 2.1
2
- Name: scikit-base
3
- Version: 0.4.6
4
- Summary: Base classes for sklearn-like parametric objects
5
- Author-email: sktime developers <sktime.toolbox@gmail.com>
6
- Maintainer: Franz Király
7
- Maintainer-email: sktime developers <sktime.toolbox@gmail.com>
8
- License: BSD 3-Clause License
9
-
10
- Copyright (c) 2022, skbase Developers
11
- All rights reserved.
12
-
13
- Redistribution and use in source and binary forms, with or without
14
- modification, are permitted provided that the following conditions are met:
15
-
16
- 1. Redistributions of source code must retain the above copyright notice, this
17
- list of conditions and the following disclaimer.
18
-
19
- 2. Redistributions in binary form must reproduce the above copyright notice,
20
- this list of conditions and the following disclaimer in the documentation
21
- and/or other materials provided with the distribution.
22
-
23
- 3. Neither the name of the copyright holder nor the names of its
24
- contributors may be used to endorse or promote products derived from
25
- this software without specific prior written permission.
26
-
27
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
30
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
31
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
33
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
34
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
35
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37
-
38
- Project-URL: homepage, https://github.com/sktime/skbase
39
- Project-URL: repository, https://github.com/sktime/skbase
40
- Project-URL: documentation, https://github.com/sktime/skbase
41
- Project-URL: download, https://pypi.org/project/skbase/#files
42
- Keywords: data-science,machine-learning,scikit-learn
43
- Classifier: Intended Audience :: Science/Research
44
- Classifier: Intended Audience :: Developers
45
- Classifier: License :: OSI Approved :: BSD License
46
- Classifier: Programming Language :: Python
47
- Classifier: Topic :: Software Development
48
- Classifier: Topic :: Scientific/Engineering
49
- Classifier: Operating System :: Microsoft :: Windows
50
- Classifier: Operating System :: POSIX
51
- Classifier: Operating System :: Unix
52
- Classifier: Operating System :: MacOS
53
- Classifier: Programming Language :: Python :: 3.7
54
- Classifier: Programming Language :: Python :: 3.8
55
- Classifier: Programming Language :: Python :: 3.9
56
- Classifier: Programming Language :: Python :: 3.10
57
- Classifier: Programming Language :: Python :: 3.11
58
- Requires-Python: <3.12,>=3.7
59
- Description-Content-Type: text/markdown
60
- License-File: LICENSE
61
- Provides-Extra: all_extras
62
- Requires-Dist: numpy ; extra == 'all_extras'
63
- Requires-Dist: pandas ; extra == 'all_extras'
64
- Provides-Extra: binder
65
- Requires-Dist: jupyter ; extra == 'binder'
66
- Provides-Extra: dev
67
- Requires-Dist: scikit-learn (>=0.24.0) ; extra == 'dev'
68
- Requires-Dist: pre-commit ; extra == 'dev'
69
- Requires-Dist: pytest ; extra == 'dev'
70
- Requires-Dist: pytest-cov ; extra == 'dev'
71
- Provides-Extra: docs
72
- Requires-Dist: jupyter ; extra == 'docs'
73
- Requires-Dist: myst-parser ; extra == 'docs'
74
- Requires-Dist: nbsphinx (>=0.8.6) ; extra == 'docs'
75
- Requires-Dist: numpydoc ; extra == 'docs'
76
- Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
77
- Requires-Dist: sphinx-issues (==1.2.0) ; extra == 'docs'
78
- Requires-Dist: sphinx-gallery (==0.6.0) ; extra == 'docs'
79
- Requires-Dist: sphinx-panels ; extra == 'docs'
80
- Requires-Dist: sphinx-design (==0.3.0) ; extra == 'docs'
81
- Requires-Dist: sphinx (==4.1.1) ; extra == 'docs'
82
- Requires-Dist: tabulate ; extra == 'docs'
83
- Provides-Extra: linters
84
- Requires-Dist: mypy ; extra == 'linters'
85
- Requires-Dist: isort ; extra == 'linters'
86
- Requires-Dist: flake8 ; extra == 'linters'
87
- Requires-Dist: black ; extra == 'linters'
88
- Requires-Dist: pydocstyle ; extra == 'linters'
89
- Requires-Dist: nbqa ; extra == 'linters'
90
- Requires-Dist: flake8-bugbear ; extra == 'linters'
91
- Requires-Dist: flake8-builtins ; extra == 'linters'
92
- Requires-Dist: flake8-quotes ; extra == 'linters'
93
- Requires-Dist: flake8-comprehensions ; extra == 'linters'
94
- Requires-Dist: pandas-vet ; extra == 'linters'
95
- Requires-Dist: flake8-print ; extra == 'linters'
96
- Requires-Dist: pep8-naming ; extra == 'linters'
97
- Requires-Dist: doc8 ; extra == 'linters'
98
- Provides-Extra: test
99
- Requires-Dist: pytest ; extra == 'test'
100
- Requires-Dist: coverage ; extra == 'test'
101
- Requires-Dist: pytest-cov ; extra == 'test'
102
- Requires-Dist: safety ; extra == 'test'
103
- Requires-Dist: numpy ; extra == 'test'
104
- Requires-Dist: scipy ; extra == 'test'
105
- Requires-Dist: pandas ; extra == 'test'
106
- Requires-Dist: scikit-learn (>=0.24.0) ; extra == 'test'
107
-
108
- <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>
109
-
110
- # Welcome to skbase
111
-
112
- > A base class for scikit-learn-like and sktime-like parametric objects
113
-
114
- `skbase` provides base classes for creating scikit-learn-like parametric objects,
115
- along with tools to make it easier to build your own packages that follow these
116
- design patterns.
117
-
118
- :rocket: Version 0.4.6 is now available. Checkout our
119
- [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
120
-
121
- | Overview | |
122
- |---|---|
123
- | **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) |
124
- | **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) |
125
- | **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) |
126
-
127
- <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
128
- [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
129
- <!-- ALL-CONTRIBUTORS-BADGE:END -->
130
-
131
- ## Documentation
132
-
133
- To learn more about the package checkout our [documentation](https://skbase.readthedocs.io/en/latest/).
134
-
135
- ## :hourglass_flowing_sand: Install skbase
136
- For trouble shooting or more information, see our
137
- [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
138
-
139
- - **Operating system**: macOS X · Linux · Windows 8.1 or higher
140
- - **Python version**: Python 3.7, 3.8, 3.9, 3.10 and 3.11
141
- - **Package managers**: [pip]
142
-
143
- [pip]: https://pip.pypa.io/en/stable/
144
-
145
- ### pip
146
- skbase releases are available as source packages and binary wheels via PyPI
147
- and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).
148
-
149
- To install the core package use:
150
-
151
- ```bash
152
- pip install scikit-base
153
- ```
154
-
155
- or, if you want to install with the maximum set of dependencies, use:
156
-
157
- ```bash
158
- pip install scikit-base[all_extras]
159
- ```
1
+ Metadata-Version: 2.1
2
+ Name: scikit-base
3
+ Version: 0.5.1
4
+ Summary: Base classes for sklearn-like parametric objects
5
+ Author-email: sktime developers <sktime.toolbox@gmail.com>
6
+ Maintainer: Franz Király
7
+ Maintainer-email: sktime developers <sktime.toolbox@gmail.com>
8
+ License: BSD 3-Clause License
9
+
10
+ Copyright (c) 2022, skbase Developers
11
+ All rights reserved.
12
+
13
+ Redistribution and use in source and binary forms, with or without
14
+ modification, are permitted provided that the following conditions are met:
15
+
16
+ 1. Redistributions of source code must retain the above copyright notice, this
17
+ list of conditions and the following disclaimer.
18
+
19
+ 2. Redistributions in binary form must reproduce the above copyright notice,
20
+ this list of conditions and the following disclaimer in the documentation
21
+ and/or other materials provided with the distribution.
22
+
23
+ 3. Neither the name of the copyright holder nor the names of its
24
+ contributors may be used to endorse or promote products derived from
25
+ this software without specific prior written permission.
26
+
27
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
30
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
31
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
33
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
34
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
35
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37
+
38
+ Project-URL: homepage, https://github.com/sktime/skbase
39
+ Project-URL: repository, https://github.com/sktime/skbase
40
+ Project-URL: documentation, https://github.com/sktime/skbase
41
+ Project-URL: download, https://pypi.org/project/skbase/#files
42
+ Keywords: data-science,machine-learning,scikit-learn
43
+ Classifier: Intended Audience :: Science/Research
44
+ Classifier: Intended Audience :: Developers
45
+ Classifier: License :: OSI Approved :: BSD License
46
+ Classifier: Programming Language :: Python
47
+ Classifier: Topic :: Software Development
48
+ Classifier: Topic :: Scientific/Engineering
49
+ Classifier: Operating System :: Microsoft :: Windows
50
+ Classifier: Operating System :: POSIX
51
+ Classifier: Operating System :: Unix
52
+ Classifier: Operating System :: MacOS
53
+ Classifier: Programming Language :: Python :: 3.8
54
+ Classifier: Programming Language :: Python :: 3.9
55
+ Classifier: Programming Language :: Python :: 3.10
56
+ Classifier: Programming Language :: Python :: 3.11
57
+ Requires-Python: <3.12,>=3.8
58
+ Description-Content-Type: text/markdown
59
+ License-File: LICENSE
60
+ Provides-Extra: all_extras
61
+ Requires-Dist: numpy ; extra == 'all_extras'
62
+ Requires-Dist: pandas ; extra == 'all_extras'
63
+ Provides-Extra: binder
64
+ Requires-Dist: jupyter ; extra == 'binder'
65
+ Provides-Extra: dev
66
+ Requires-Dist: scikit-learn >=0.24.0 ; extra == 'dev'
67
+ Requires-Dist: pre-commit ; extra == 'dev'
68
+ Requires-Dist: pytest ; extra == 'dev'
69
+ Requires-Dist: pytest-cov ; extra == 'dev'
70
+ Provides-Extra: docs
71
+ Requires-Dist: jupyter ; extra == 'docs'
72
+ Requires-Dist: myst-parser ; extra == 'docs'
73
+ Requires-Dist: nbsphinx >=0.8.6 ; extra == 'docs'
74
+ Requires-Dist: numpydoc ; extra == 'docs'
75
+ Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
76
+ Requires-Dist: sphinx-issues ==1.2.0 ; extra == 'docs'
77
+ Requires-Dist: sphinx-gallery ==0.6.0 ; extra == 'docs'
78
+ Requires-Dist: sphinx-panels ; extra == 'docs'
79
+ Requires-Dist: sphinx-design ==0.3.0 ; extra == 'docs'
80
+ Requires-Dist: sphinx ==4.1.1 ; extra == 'docs'
81
+ Requires-Dist: tabulate ; extra == 'docs'
82
+ Provides-Extra: linters
83
+ Requires-Dist: mypy ; extra == 'linters'
84
+ Requires-Dist: isort ; extra == 'linters'
85
+ Requires-Dist: flake8 ; extra == 'linters'
86
+ Requires-Dist: black ; extra == 'linters'
87
+ Requires-Dist: pydocstyle ; extra == 'linters'
88
+ Requires-Dist: nbqa ; extra == 'linters'
89
+ Requires-Dist: flake8-bugbear ; extra == 'linters'
90
+ Requires-Dist: flake8-builtins ; extra == 'linters'
91
+ Requires-Dist: flake8-quotes ; extra == 'linters'
92
+ Requires-Dist: flake8-comprehensions ; extra == 'linters'
93
+ Requires-Dist: pandas-vet ; extra == 'linters'
94
+ Requires-Dist: flake8-print ; extra == 'linters'
95
+ Requires-Dist: pep8-naming ; extra == 'linters'
96
+ Requires-Dist: doc8 ; extra == 'linters'
97
+ Provides-Extra: test
98
+ Requires-Dist: pytest ; extra == 'test'
99
+ Requires-Dist: coverage ; extra == 'test'
100
+ Requires-Dist: pytest-cov ; extra == 'test'
101
+ Requires-Dist: safety ; extra == 'test'
102
+ Requires-Dist: numpy ; extra == 'test'
103
+ Requires-Dist: scipy ; extra == 'test'
104
+ Requires-Dist: pandas ; extra == 'test'
105
+ Requires-Dist: scikit-learn >=0.24.0 ; extra == 'test'
106
+
107
+ <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>
108
+
109
+ # Welcome to skbase
110
+
111
+ > A framework factory for scikit-learn-like and sktime-like parametric objects
112
+
113
+ `skbase` provides base classes for creating scikit-learn-like parametric objects,
114
+ along with tools to make it easier to build your own packages that follow these design patterns.
115
+
116
+ :rocket: Version 0.5.1 is now available. Checkout our
117
+ [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
118
+
119
+ | Overview | |
120
+ |---|---|
121
+ | **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) |
122
+ | **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) |
123
+ | **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) |
124
+
125
+ <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
126
+ [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
127
+ <!-- ALL-CONTRIBUTORS-BADGE:END -->
128
+
129
+ ## Documentation and Tutorials
130
+
131
+ To learn more about the package check out:
132
+
133
+ * our [documentation](https://skbase.readthedocs.io/en/latest/)
134
+ * our [introductory tutorial](https://github.com/sktime/sktime-tutorial-pydata-seattle-2023) (jupyter notebooks and video presentation)
135
+
136
+ ## :hourglass_flowing_sand: Install skbase
137
+ For trouble shooting or more information, see our
138
+ [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
139
+
140
+ - **Operating system**: macOS X · Linux · Windows 8.1 or higher
141
+ - **Python version**: Python 3.8, 3.9, 3.10 and 3.11
142
+ - **Package managers**: [pip]
143
+
144
+ [pip]: https://pip.pypa.io/en/stable/
145
+
146
+ ### pip
147
+ skbase releases are available as source packages and binary wheels via PyPI
148
+ and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).
149
+
150
+ To install the core package use:
151
+
152
+ ```bash
153
+ pip install scikit-base
154
+ ```
155
+
156
+ or, if you want to install with the maximum set of dependencies, use:
157
+
158
+ ```bash
159
+ pip install scikit-base[all_extras]
160
+ ```
@@ -0,0 +1,58 @@
1
+ docs/source/conf.py,sha256=Ob6dAIWxgemP0kwSzuO7wWknKcnybs3HyfPcuwhyNIc,9845
2
+ skbase/__init__.py,sha256=WZe3oBlNkMLhyqABTvFoT7nJhb8toJSIHTX_tYJLj1A,454
3
+ skbase/_exceptions.py,sha256=xoucRFDeUnPhMBEWRCMyP-r2hUF8ZippKxJyi_8oAKI,1113
4
+ skbase/_nopytest_tests.py,sha256=npL5pibSgCpulEGw0NqLKcG0majh6xcdW5A4Zibf78s,1077
5
+ skbase/base/__init__.py,sha256=QZLPb8_XOOhV1Y6KQuIjBvnNE9Rc09TkSfqkN5SiqLc,629
6
+ skbase/base/_base.py,sha256=czFUqCbl69MwRZvJI2ytJE34p_odgV8rKmveafBp_Sk,46750
7
+ skbase/base/_meta.py,sha256=SQ3geft8wzciN4XQLiUWT7E9RF_r06mCFsp9It7Ev6w,36329
8
+ skbase/base/_tagmanager.py,sha256=mcKrME8kl300ev2WxgtWkbMj_ikfF7FFTLMSa0O1OU0,7290
9
+ skbase/base/_pretty_printing/__init__.py,sha256=bVuKnwafn8c2q2AGJ9BOu9cmu-xBjiOxHf1hxjm8K2A,492
10
+ skbase/base/_pretty_printing/_object_html_repr.py,sha256=wU2pMg3XmpNWoJaPXUzLpoMG5vLfAF83OeI6KftYXlg,11539
11
+ skbase/base/_pretty_printing/_pprint.py,sha256=VVnw-cywGxArfiFfVWfFSV5VMJvsxpDsJJ4RplcndqA,15634
12
+ skbase/lookup/__init__.py,sha256=RNw1mx8nXFHsn-HgnjHzWPn9AG45jSMEKl-Z0pEH7jE,1089
13
+ skbase/lookup/_lookup.py,sha256=ITzLugUeUO6IyTth5l31UZI_Hkv1_3mQrEQW7nyi7Rw,39140
14
+ skbase/lookup/tests/__init__.py,sha256=MVqGlWsUV-gQ4qzW_TqE3UmKO9IQ9mwdDlsIHaGt3bc,68
15
+ skbase/lookup/tests/test_lookup.py,sha256=BZdRuUUl6gZC943wiTTV5hnjXbU2rEe-Gbmu8-hXajQ,36924
16
+ skbase/testing/__init__.py,sha256=OdwR-aEU2KzGrU-O0gtNSMNGmF2mtgBmjAnMzcgwe6w,351
17
+ skbase/testing/test_all_objects.py,sha256=jJHSMGWDIruKq2rTdUl9QoLMlOxH8E6oZd82NuPDYt4,36178
18
+ skbase/testing/utils/__init__.py,sha256=kaLuqQwJsCunRWsUb1JwTVG-iqXbzdUobuYHNHsBlQQ,113
19
+ skbase/testing/utils/_conditional_fixtures.py,sha256=QwI7K28Lsy6RAkDP94goo8uWWvMzKKNOmXRFtc9RNtI,9890
20
+ skbase/testing/utils/_dependencies.py,sha256=WgoHKRT6bxvJqG7lK_r9dKG3TCAHFxhjyjwE1cPEjdk,469
21
+ skbase/testing/utils/deep_equals.py,sha256=AHXZNlNiGi5wdAFJOFLlcz_7gDTrSXnPjNpNHwtwAlg,335
22
+ skbase/testing/utils/inspect.py,sha256=XcPdm1-J3YXCTxsrqeJlStPvbC0vH1cgaApN5lzRI2c,741
23
+ skbase/testing/utils/tests/__init__.py,sha256=YX0qfeekfOXxVOdiHHRQTEi7hRb3TeeVysWq2abowd8,71
24
+ skbase/testing/utils/tests/test_check_dependencies.py,sha256=KrGjctKAWpiK7THdeSzpXmIUCLLybIVtrEPnCh2J6RM,2233
25
+ skbase/testing/utils/tests/test_deep_equals.py,sha256=RvT6xyUB20WCx9HRwZREvjsqLgKAxLpo5w4mz-KR6bc,1705
26
+ skbase/tests/__init__.py,sha256=d2_OTTnt0GX5otQsBuNAb1evg8C5Fi0JjqK2VsfMtXU,37
27
+ skbase/tests/conftest.py,sha256=g4pfthiTxU8iSWcHHVhxAd4JCBx2Lf6V9lk6A0zikKA,8398
28
+ skbase/tests/test_base.py,sha256=LxSgtI8zJ3sulgGTPA_fgvHmACqqrW1vBXeP-YEl4v0,42582
29
+ skbase/tests/test_baseestimator.py,sha256=6Jna9Sdecg9kwhXmTumBTBPNT_Hb9-o345RHVEMWWOI,4730
30
+ skbase/tests/test_exceptions.py,sha256=wOdk7Gp8pvbhucna3_9FxTk9xFLjC9XNsGsVabQLYEE,629
31
+ skbase/tests/test_meta.py,sha256=mjfa7QrSxzc1DEJ51OGgnmr9iawKsYtUjBmNrZTnUrc,5661
32
+ skbase/tests/mock_package/__init__.py,sha256=9HanT3M2_OCF1uhdLbYNyDDo5m3djsjOkbsxxbx-TPo,135
33
+ skbase/tests/mock_package/test_mock_package.py,sha256=qX777HIJ0-BU_K4l5q5oYbEXk-b0cpg6gkzeET8WZbQ,2021
34
+ skbase/utils/__init__.py,sha256=z0jI3ncO4xurEUHE0eJqYxxY6TD4SDFVCiVH71gtqyU,633
35
+ skbase/utils/_check.py,sha256=mLfqYMCT-4ro5PFJXyx4QNfjbAecHuZQGl_CVM3GoqE,1395
36
+ skbase/utils/_iter.py,sha256=Um1rq79tl7PtWAq1VMHVf-pt9vQj5C0zuvyF49ob9G0,8037
37
+ skbase/utils/_nested_iter.py,sha256=omDI2Y75ajWTSV9d59iJTj1RcCk5YFbc7cZNQjz8AC8,4566
38
+ skbase/utils/_utils.py,sha256=A6sTIUEscEy9TjBmCvXEuhk9q8ROBPyfJGhrjlSA4LY,3134
39
+ skbase/utils/deep_equals.py,sha256=aeTZVkYq_gJ3gB64F1rJDHe-YrxqHetHX4yNXD7mqI4,11303
40
+ skbase/utils/dependencies/__init__.py,sha256=89TNnES--f1PeoPm-_h6a2mCtoGXt6mAd-n89FdusMM,352
41
+ skbase/utils/dependencies/_dependencies.py,sha256=zmlWZ10HtiHE2PK2T7AzsFNKIA95O8hmIySlz2t4Mrs,10359
42
+ skbase/utils/tests/__init__.py,sha256=YfvP5lpCrTC_6SIakU7jBBdqYyuqE07nZ56ZYKTs3f0,165
43
+ skbase/utils/tests/test_check.py,sha256=I-9PGTrTJGu0HeFF2mejeeDckpVhGRIudnsSQGgkcWA,750
44
+ skbase/utils/tests/test_iter.py,sha256=EJw_t2uWcpUBVkpDDI1TLncdJ3iMhbYfSnIHumvkrVI,4918
45
+ skbase/utils/tests/test_nested_iter.py,sha256=3ytT_qqZKBr90uNDTK6pzCjDv6EpnJOmzkyAnejyKYc,2230
46
+ skbase/utils/tests/test_utils.py,sha256=13P1zYpsyNoX9Ugj37lHZAQm4hIORvsKEo1pF3tTIP0,1182
47
+ skbase/validate/__init__.py,sha256=76hnzzoLYhyGXh8mEtQeLjQnP8ZztMaWtvLB3VeOHF8,676
48
+ skbase/validate/_named_objects.py,sha256=kdvI24hj7qLJAJ6jokvja-I3XMgn3pdbz0ZX585wswg,14777
49
+ skbase/validate/_types.py,sha256=TIoqmfhwW_kMHEhfiBtUpmN56t1trWBVtC03sAkrUjk,12121
50
+ skbase/validate/tests/__init__.py,sha256=wunQBy6rajyrDymKvuFVajsBjj90VP5IFey5b6ZIRCk,70
51
+ skbase/validate/tests/test_iterable_named_objects.py,sha256=Pb3Y7lPo7zcuulKqJ6z9M5DkCqW-S3KZ4rR-jC5lM8w,7438
52
+ skbase/validate/tests/test_type_validations.py,sha256=G-qwFjXk-8WvXoeOvo2omfFKKjbpWhP-sPf6hsw8q30,14131
53
+ scikit_base-0.5.1.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
54
+ scikit_base-0.5.1.dist-info/METADATA,sha256=53135HaAwhlh0oRkBBODC-i2-lI1r6-EA6gk7yf5S7U,8641
55
+ scikit_base-0.5.1.dist-info/WHEEL,sha256=5sUXSg9e4bi7lTLOHcm6QEYwO5TIF1TNbTSVFVjcJcc,92
56
+ scikit_base-0.5.1.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
57
+ scikit_base-0.5.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
58
+ scikit_base-0.5.1.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: bdist_wheel (0.40.0)
2
+ Generator: bdist_wheel (0.41.1)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
@@ -0,0 +1,5 @@
1
+ build_tools
2
+ docs
3
+ enhancement_proposals
4
+ skbase
5
+ wheelhouse
skbase/__init__.py CHANGED
@@ -1,14 +1,14 @@
1
- #!/usr/bin/env python3 -u
2
- # -*- coding: utf-8 -*-
3
- # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
4
- """:mod:`skbase` contains tools for creating and working with parametric objects.
5
-
6
- The included functionality makes it easy to re-use scikit-learn and
7
- sktime design principles in your project.
8
- """
9
- from typing import List
10
-
11
- __version__: str = "0.4.6"
12
-
13
- __author__: List[str] = ["fkiraly", "RNKuhns", "mloning"]
14
- __all__: List[str] = []
1
+ #!/usr/bin/env python3 -u
2
+ # -*- coding: utf-8 -*-
3
+ # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
4
+ """:mod:`skbase` contains tools for creating and working with parametric objects.
5
+
6
+ The included functionality makes it easy to re-use scikit-learn and
7
+ sktime design principles in your project.
8
+ """
9
+ from typing import List
10
+
11
+ __version__: str = "0.5.1"
12
+
13
+ __author__: List[str] = ["fkiraly", "RNKuhns", "mloning"]
14
+ __all__: List[str] = []
skbase/_exceptions.py CHANGED
@@ -1,31 +1,31 @@
1
- # -*- coding: utf-8 -*-
2
- # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
3
- # NotFittedError re-use 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
- """Custom exceptions used in ``skbase``."""
7
- from typing import List
8
-
9
- __author__: List[str] = ["fkiraly", "mloning", "rnkuhns"]
10
- __all__: List[str] = ["FixtureGenerationError", "NotFittedError"]
11
-
12
-
13
- class FixtureGenerationError(Exception):
14
- """Raised when a fixture fails to generate."""
15
-
16
- def __init__(self, fixture_name="", err=None):
17
- self.fixture_name = fixture_name
18
- super().__init__(f"fixture {fixture_name} failed to generate. {err}")
19
-
20
-
21
- class NotFittedError(ValueError, AttributeError):
22
- """Exception class to raise if estimator is used before fitting.
23
-
24
- This class inherits from both ValueError and AttributeError to help with
25
- exception handling.
26
-
27
- References
28
- ----------
29
- [1] scikit-learn's NotFittedError
30
- [2] sktime's NotFittedError
31
- """
1
+ # -*- coding: utf-8 -*-
2
+ # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
3
+ # NotFittedError re-use 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
+ """Custom exceptions used in ``skbase``."""
7
+ from typing import List
8
+
9
+ __author__: List[str] = ["fkiraly", "mloning", "rnkuhns"]
10
+ __all__: List[str] = ["FixtureGenerationError", "NotFittedError"]
11
+
12
+
13
+ class FixtureGenerationError(Exception):
14
+ """Raised when a fixture fails to generate."""
15
+
16
+ def __init__(self, fixture_name="", err=None):
17
+ self.fixture_name = fixture_name
18
+ super().__init__(f"fixture {fixture_name} failed to generate. {err}")
19
+
20
+
21
+ class NotFittedError(ValueError, AttributeError):
22
+ """Exception class to raise if estimator is used before fitting.
23
+
24
+ This class inherits from both ValueError and AttributeError to help with
25
+ exception handling.
26
+
27
+ References
28
+ ----------
29
+ [1] scikit-learn's NotFittedError
30
+ [2] sktime's NotFittedError
31
+ """
skbase/_nopytest_tests.py CHANGED
@@ -1,35 +1,35 @@
1
- # -*- coding: utf-8 -*-
2
- """Tests to run without pytest, to check pytest isolation."""
3
- # copyright: sktime developers, BSD-3-Clause License (see LICENSE file)
4
-
5
- from skbase.base import BaseObject
6
- from skbase.lookup import all_objects
7
-
8
- MODULES_TO_IGNORE = ("tests", "testing", "dependencies", "all")
9
-
10
- # all_objectscrawls all modules excepting pytest test files
11
- # if it encounters an unisolated import, it will throw an exception
12
- results = all_objects(modules_to_ignore=MODULES_TO_IGNORE)
13
-
14
- # try to run all methods of BaseObject without arguments
15
- # very basic test, but needs to run without pytest
16
- METHODS = {
17
- "clone": {},
18
- "get_params": {},
19
- "reset": {},
20
- "get_param_names": {},
21
- "get_param_defaults": {},
22
- "get_class_tags": {},
23
- "get_tags": {},
24
- "get_config": {},
25
- "get_test_params": {},
26
- "create_test_instance": {},
27
- "create_test_instances_and_names": {},
28
- "is_composite": {},
29
- "set_tags": {"foo": "bar"},
30
- "set_config": {"bar": "foo"},
31
- }
32
-
33
- mybo = BaseObject()
34
- for method, params in METHODS.items():
35
- getattr(mybo, method)(**params)
1
+ # -*- coding: utf-8 -*-
2
+ """Tests to run without pytest, to check pytest isolation."""
3
+ # copyright: sktime developers, BSD-3-Clause License (see LICENSE file)
4
+
5
+ from skbase.base import BaseObject
6
+ from skbase.lookup import all_objects
7
+
8
+ MODULES_TO_IGNORE = ("tests", "testing", "dependencies", "all")
9
+
10
+ # all_objectscrawls all modules excepting pytest test files
11
+ # if it encounters an unisolated import, it will throw an exception
12
+ results = all_objects(modules_to_ignore=MODULES_TO_IGNORE)
13
+
14
+ # try to run all methods of BaseObject without arguments
15
+ # very basic test, but needs to run without pytest
16
+ METHODS = {
17
+ "clone": {},
18
+ "get_params": {},
19
+ "reset": {},
20
+ "get_param_names": {},
21
+ "get_param_defaults": {},
22
+ "get_class_tags": {},
23
+ "get_tags": {},
24
+ "get_config": {},
25
+ "get_test_params": {},
26
+ "create_test_instance": {},
27
+ "create_test_instances_and_names": {},
28
+ "is_composite": {},
29
+ "set_tags": {"foo": "bar"},
30
+ "set_config": {"bar": "foo"},
31
+ }
32
+
33
+ mybo = BaseObject()
34
+ for method, params in METHODS.items():
35
+ getattr(mybo, method)(**params)
skbase/base/__init__.py CHANGED
@@ -1,20 +1,20 @@
1
- #!/usr/bin/env python3 -u
2
- # -*- coding: utf-8 -*-
3
- # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
4
- """:mod:`skbase.base` contains base classes for creating parametric objects.
5
-
6
- The included functionality makes it easy to re-use scikit-learn and
7
- sktime design principles in your project.
8
- """
9
- from typing import List
10
-
11
- from skbase.base._base import BaseEstimator, BaseObject
12
- from skbase.base._meta import BaseMetaEstimator, BaseMetaObject
13
-
14
- __author__: List[str] = ["mloning", "RNKuhns", "fkiraly"]
15
- __all__: List[str] = [
16
- "BaseObject",
17
- "BaseEstimator",
18
- "BaseMetaEstimator",
19
- "BaseMetaObject",
20
- ]
1
+ #!/usr/bin/env python3 -u
2
+ # -*- coding: utf-8 -*-
3
+ # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
4
+ """:mod:`skbase.base` contains base classes for creating parametric objects.
5
+
6
+ The included functionality makes it easy to re-use scikit-learn and
7
+ sktime design principles in your project.
8
+ """
9
+ from typing import List
10
+
11
+ from skbase.base._base import BaseEstimator, BaseObject
12
+ from skbase.base._meta import BaseMetaEstimator, BaseMetaObject
13
+
14
+ __author__: List[str] = ["mloning", "RNKuhns", "fkiraly"]
15
+ __all__: List[str] = [
16
+ "BaseObject",
17
+ "BaseEstimator",
18
+ "BaseMetaEstimator",
19
+ "BaseMetaObject",
20
+ ]