scikit-base 0.4.6__tar.gz → 0.5.1__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 (63) hide show
  1. {scikit-base-0.4.6 → scikit-base-0.5.1}/LICENSE +29 -29
  2. {scikit-base-0.4.6 → scikit-base-0.5.1}/PKG-INFO +120 -119
  3. {scikit-base-0.4.6 → scikit-base-0.5.1}/README.md +54 -52
  4. {scikit-base-0.4.6 → scikit-base-0.5.1}/docs/source/conf.py +299 -299
  5. {scikit-base-0.4.6 → scikit-base-0.5.1}/pyproject.toml +157 -158
  6. {scikit-base-0.4.6 → scikit-base-0.5.1}/scikit_base.egg-info/PKG-INFO +120 -119
  7. {scikit-base-0.4.6 → scikit-base-0.5.1}/scikit_base.egg-info/top_level.txt +1 -1
  8. {scikit-base-0.4.6 → scikit-base-0.5.1}/scikit_base.egg-info/zip-safe +1 -1
  9. {scikit-base-0.4.6 → scikit-base-0.5.1}/setup.cfg +21 -21
  10. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/__init__.py +14 -14
  11. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/_exceptions.py +31 -31
  12. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/_nopytest_tests.py +35 -35
  13. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/base/__init__.py +20 -20
  14. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/base/_base.py +1249 -1249
  15. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/base/_meta.py +883 -871
  16. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/base/_pretty_printing/__init__.py +11 -11
  17. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/base/_pretty_printing/_object_html_repr.py +392 -392
  18. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/base/_pretty_printing/_pprint.py +412 -412
  19. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/base/_tagmanager.py +217 -217
  20. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/lookup/__init__.py +31 -31
  21. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/lookup/_lookup.py +1009 -1009
  22. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/lookup/tests/__init__.py +2 -2
  23. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/lookup/tests/test_lookup.py +991 -991
  24. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/__init__.py +12 -12
  25. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/test_all_objects.py +852 -856
  26. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/utils/__init__.py +5 -5
  27. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/utils/_conditional_fixtures.py +209 -209
  28. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/utils/_dependencies.py +15 -15
  29. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/utils/deep_equals.py +15 -15
  30. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/utils/inspect.py +30 -30
  31. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/utils/tests/__init__.py +2 -2
  32. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/utils/tests/test_check_dependencies.py +49 -49
  33. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/testing/utils/tests/test_deep_equals.py +66 -66
  34. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/tests/__init__.py +2 -2
  35. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/tests/conftest.py +273 -273
  36. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/tests/mock_package/__init__.py +5 -5
  37. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/tests/mock_package/test_mock_package.py +74 -74
  38. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/tests/test_base.py +1202 -1202
  39. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/tests/test_baseestimator.py +130 -130
  40. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/tests/test_exceptions.py +23 -23
  41. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/tests/test_meta.py +170 -131
  42. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/__init__.py +21 -21
  43. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/_check.py +53 -53
  44. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/_iter.py +238 -238
  45. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/_nested_iter.py +180 -180
  46. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/_utils.py +91 -91
  47. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/deep_equals.py +358 -358
  48. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/dependencies/__init__.py +11 -11
  49. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/dependencies/_dependencies.py +253 -253
  50. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/tests/__init__.py +4 -4
  51. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/tests/test_check.py +24 -24
  52. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/tests/test_iter.py +127 -127
  53. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/tests/test_nested_iter.py +84 -84
  54. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/utils/tests/test_utils.py +37 -37
  55. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/validate/__init__.py +22 -22
  56. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/validate/_named_objects.py +403 -403
  57. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/validate/_types.py +345 -345
  58. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/validate/tests/__init__.py +2 -2
  59. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/validate/tests/test_iterable_named_objects.py +200 -200
  60. {scikit-base-0.4.6 → scikit-base-0.5.1}/skbase/validate/tests/test_type_validations.py +370 -370
  61. {scikit-base-0.4.6 → scikit-base-0.5.1}/scikit_base.egg-info/SOURCES.txt +0 -0
  62. {scikit-base-0.4.6 → scikit-base-0.5.1}/scikit_base.egg-info/dependency_links.txt +0 -0
  63. {scikit-base-0.4.6 → scikit-base-0.5.1}/scikit_base.egg-info/requires.txt +0 -0
@@ -1,29 +1,29 @@
1
- BSD 3-Clause License
2
-
3
- Copyright (c) 2022, skbase Developers
4
- All rights reserved.
5
-
6
- Redistribution and use in source and binary forms, with or without
7
- modification, are permitted provided that the following conditions are met:
8
-
9
- 1. Redistributions of source code must retain the above copyright notice, this
10
- list of conditions and the following disclaimer.
11
-
12
- 2. Redistributions in binary form must reproduce the above copyright notice,
13
- this list of conditions and the following disclaimer in the documentation
14
- and/or other materials provided with the distribution.
15
-
16
- 3. Neither the name of the copyright holder nor the names of its
17
- contributors may be used to endorse or promote products derived from
18
- this software without specific prior written permission.
19
-
20
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24
- FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25
- DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26
- SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27
- CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28
- OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2022, skbase Developers
4
+ All rights reserved.
5
+
6
+ Redistribution and use in source and binary forms, with or without
7
+ modification, are permitted provided that the following conditions are met:
8
+
9
+ 1. Redistributions of source code must retain the above copyright notice, this
10
+ list of conditions and the following disclaimer.
11
+
12
+ 2. Redistributions in binary form must reproduce the above copyright notice,
13
+ this list of conditions and the following disclaimer in the documentation
14
+ and/or other materials provided with the distribution.
15
+
16
+ 3. Neither the name of the copyright holder nor the names of its
17
+ contributors may be used to endorse or promote products derived from
18
+ this software without specific prior written permission.
19
+
20
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -1,119 +1,120 @@
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
- Provides-Extra: all_extras
61
- Provides-Extra: dev
62
- Provides-Extra: linters
63
- Provides-Extra: binder
64
- Provides-Extra: docs
65
- Provides-Extra: test
66
- License-File: LICENSE
67
-
68
- <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>
69
-
70
- # Welcome to skbase
71
-
72
- > A base class for scikit-learn-like and sktime-like parametric objects
73
-
74
- `skbase` provides base classes for creating scikit-learn-like parametric objects,
75
- along with tools to make it easier to build your own packages that follow these
76
- design patterns.
77
-
78
- :rocket: Version 0.4.6 is now available. Checkout our
79
- [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
80
-
81
- | Overview | |
82
- |---|---|
83
- | **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) |
84
- | **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) |
85
- | **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) |
86
-
87
- <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
88
- [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
89
- <!-- ALL-CONTRIBUTORS-BADGE:END -->
90
-
91
- ## Documentation
92
-
93
- To learn more about the package checkout our [documentation](https://skbase.readthedocs.io/en/latest/).
94
-
95
- ## :hourglass_flowing_sand: Install skbase
96
- For trouble shooting or more information, see our
97
- [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
98
-
99
- - **Operating system**: macOS X · Linux · Windows 8.1 or higher
100
- - **Python version**: Python 3.7, 3.8, 3.9, 3.10 and 3.11
101
- - **Package managers**: [pip]
102
-
103
- [pip]: https://pip.pypa.io/en/stable/
104
-
105
- ### pip
106
- skbase releases are available as source packages and binary wheels via PyPI
107
- and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).
108
-
109
- To install the core package use:
110
-
111
- ```bash
112
- pip install scikit-base
113
- ```
114
-
115
- or, if you want to install with the maximum set of dependencies, use:
116
-
117
- ```bash
118
- pip install scikit-base[all_extras]
119
- ```
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
+ Provides-Extra: all_extras
60
+ Provides-Extra: dev
61
+ Provides-Extra: linters
62
+ Provides-Extra: binder
63
+ Provides-Extra: docs
64
+ Provides-Extra: test
65
+ License-File: LICENSE
66
+
67
+ <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>
68
+
69
+ # Welcome to skbase
70
+
71
+ > A framework factory for scikit-learn-like and sktime-like parametric objects
72
+
73
+ `skbase` provides base classes for creating scikit-learn-like parametric objects,
74
+ along with tools to make it easier to build your own packages that follow these design patterns.
75
+
76
+ :rocket: Version 0.5.1 is now available. Checkout our
77
+ [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
78
+
79
+ | Overview | |
80
+ |---|---|
81
+ | **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) |
82
+ | **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) |
83
+ | **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) |
84
+
85
+ <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
86
+ [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
87
+ <!-- ALL-CONTRIBUTORS-BADGE:END -->
88
+
89
+ ## Documentation and Tutorials
90
+
91
+ To learn more about the package check out:
92
+
93
+ * our [documentation](https://skbase.readthedocs.io/en/latest/)
94
+ * our [introductory tutorial](https://github.com/sktime/sktime-tutorial-pydata-seattle-2023) (jupyter notebooks and video presentation)
95
+
96
+ ## :hourglass_flowing_sand: Install skbase
97
+ For trouble shooting or more information, see our
98
+ [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
99
+
100
+ - **Operating system**: macOS X · Linux · Windows 8.1 or higher
101
+ - **Python version**: Python 3.8, 3.9, 3.10 and 3.11
102
+ - **Package managers**: [pip]
103
+
104
+ [pip]: https://pip.pypa.io/en/stable/
105
+
106
+ ### pip
107
+ skbase releases are available as source packages and binary wheels via PyPI
108
+ and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).
109
+
110
+ To install the core package use:
111
+
112
+ ```bash
113
+ pip install scikit-base
114
+ ```
115
+
116
+ or, if you want to install with the maximum set of dependencies, use:
117
+
118
+ ```bash
119
+ pip install scikit-base[all_extras]
120
+ ```
@@ -1,52 +1,54 @@
1
- <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>
2
-
3
- # Welcome to skbase
4
-
5
- > A base class for scikit-learn-like and sktime-like parametric objects
6
-
7
- `skbase` provides base classes for creating scikit-learn-like parametric objects,
8
- along with tools to make it easier to build your own packages that follow these
9
- design patterns.
10
-
11
- :rocket: Version 0.4.6 is now available. Checkout our
12
- [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
13
-
14
- | Overview | |
15
- |---|---|
16
- | **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) |
17
- | **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) |
18
- | **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) |
19
-
20
- <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
21
- [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
22
- <!-- ALL-CONTRIBUTORS-BADGE:END -->
23
-
24
- ## Documentation
25
-
26
- To learn more about the package checkout our [documentation](https://skbase.readthedocs.io/en/latest/).
27
-
28
- ## :hourglass_flowing_sand: Install skbase
29
- For trouble shooting or more information, see our
30
- [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
31
-
32
- - **Operating system**: macOS X · Linux · Windows 8.1 or higher
33
- - **Python version**: Python 3.7, 3.8, 3.9, 3.10 and 3.11
34
- - **Package managers**: [pip]
35
-
36
- [pip]: https://pip.pypa.io/en/stable/
37
-
38
- ### pip
39
- skbase releases are available as source packages and binary wheels via PyPI
40
- and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).
41
-
42
- To install the core package use:
43
-
44
- ```bash
45
- pip install scikit-base
46
- ```
47
-
48
- or, if you want to install with the maximum set of dependencies, use:
49
-
50
- ```bash
51
- pip install scikit-base[all_extras]
52
- ```
1
+ <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>
2
+
3
+ # Welcome to skbase
4
+
5
+ > A framework factory for scikit-learn-like and sktime-like parametric objects
6
+
7
+ `skbase` provides base classes for creating scikit-learn-like parametric objects,
8
+ along with tools to make it easier to build your own packages that follow these design patterns.
9
+
10
+ :rocket: Version 0.5.1 is now available. Checkout our
11
+ [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
12
+
13
+ | Overview | |
14
+ |---|---|
15
+ | **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) |
16
+ | **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) |
17
+ | **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) |
18
+
19
+ <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
20
+ [![All Contributors](https://img.shields.io/badge/all_contributors-13-orange.svg?style=flat-square)](#contributors)
21
+ <!-- ALL-CONTRIBUTORS-BADGE:END -->
22
+
23
+ ## Documentation and Tutorials
24
+
25
+ To learn more about the package check out:
26
+
27
+ * our [documentation](https://skbase.readthedocs.io/en/latest/)
28
+ * our [introductory tutorial](https://github.com/sktime/sktime-tutorial-pydata-seattle-2023) (jupyter notebooks and video presentation)
29
+
30
+ ## :hourglass_flowing_sand: Install skbase
31
+ For trouble shooting or more information, see our
32
+ [detailed installation instructions](https://skbase.readthedocs.io/en/latest/user_documentation/installation.html).
33
+
34
+ - **Operating system**: macOS X · Linux · Windows 8.1 or higher
35
+ - **Python version**: Python 3.8, 3.9, 3.10 and 3.11
36
+ - **Package managers**: [pip]
37
+
38
+ [pip]: https://pip.pypa.io/en/stable/
39
+
40
+ ### pip
41
+ skbase releases are available as source packages and binary wheels via PyPI
42
+ and can be installed using pip. Checkout the full list of pre-compiled [wheels on PyPi](https://pypi.org/simple/skbase/).
43
+
44
+ To install the core package use:
45
+
46
+ ```bash
47
+ pip install scikit-base
48
+ ```
49
+
50
+ or, if you want to install with the maximum set of dependencies, use:
51
+
52
+ ```bash
53
+ pip install scikit-base[all_extras]
54
+ ```