scikit-base

Bugfix and maintenance release.

Fixes

• [BUG] mute stderr in QuickTester.run_tests, and fix np.all generator checks (586) yash-sangwan

Maintenance

• [MNT] [Dependabot](deps): Bump github/codeql-action from 4.37.3 to 4.37.4 (579) dependabot[bot]

• [MNT] [Dependabot](deps): Bump github/codeql-action from 4.37.4 to 4.37.6 (581) dependabot[bot]

• [MNT] [Dependabot](deps): Bump github/codeql-action from 4.37.6 to 4.37.7 (583) dependabot[bot]

• [MNT] [Dependabot](deps): Bump github/codeql-action from 4.37.7 to 4.37.8 (585) dependabot[bot]

• [pre-commit.ci] pre-commit autoupdate (580) pre-commit-ci[bot]

• [pre-commit.ci] pre-commit autoupdate (584) pre-commit-ci[bot]

• [MNT] remove extraneous material from package wheel (588) fkiraly

Contributors

fkiraly, yash-sangwan

Feature and maintenance release.

Enhancements

[ENH] Cache _get_init_signature and _collect_class_flags to improve performance in repeated tag inspection ( #576 ) @benheid

Maintenance

[MNT] fix broken .readthedocs.yaml ( #570 ) @fkiraly

[MNT] Dependabot: Bump actions/setup-node from 6 to 7 ( #573 ) @dependabot[bot]

[pre-commit.ci] pre-commit autoupdate ( #572 ) @pre-commit-ci[bot]

[MNT] Dependabot: Bump actions/setup-python from 6 to 7 ( #575 ) @dependabot[bot]

[MNT] Dependabot: Bump github/codeql-action from 4 to 4.37.3 ( #577 ) @dependabot[bot]

Contributors

@benheid , @fkiraly

Feature and maintenance release.

Enhancements

• [ENH] Cache _get_init_signature and _collect_class_flags to improve performance in repeated tag inspection (576) benheid

Maintenance

• [MNT] fix broken .readthedocs.yaml (570) fkiraly

• [MNT] [Dependabot](deps): Bump actions/setup-node from 6 to 7 (573) dependabot[bot]

• [pre-commit.ci] pre-commit autoupdate (572) pre-commit-ci[bot]

• [MNT] [Dependabot](deps): Bump actions/setup-python from 6 to 7 (575) dependabot[bot]

• [MNT] [Dependabot](deps): Bump github/codeql-action from 4 to 4.37.3 (577) dependabot[bot]

Contributors

benheid, fkiraly

Feature and maintenance release.

Enhancements

[ENH] early return for deep_equals in case of object identity ( #568 ) @CloseChoice

Maintenance

[MNT] add integration testing for pandas 3 ( #563 ) @fkiraly

[MNT] Dependabot: Bump codecov/codecov-action from 6 to 7 ( #566 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/checkout from 6 to 7 ( #567 ) @dependabot[bot]

Contributors

@CloseChoice , @fkiraly

Feature and maintenance release.

Enhancements

• [ENH] early return for deep_equals in case of object identity (568) CloseChoice

Maintenance

• [MNT] add integration testing for pandas 3 (563) fkiraly

• [MNT] [Dependabot](deps): Bump codecov/codecov-action from 6 to 7 (566) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/checkout from 6 to 7 (567) dependabot[bot]

Contributors

CloseChoice, fkiraly

Feature, bugfix and maintenance release.

Enhancements

[ENH] safer get_params(deep=True) nesting ( #562 ) @fkiraly

Fixes

[BUG] Fix get_params(deep=True) for BaseObject class parameters ( #559 ) @patelchaitany

[BUG] Fix deep_equals failing on string-dtype numpy arrays ( numpy < 2.0 ) ( #519 ) @shourya1419-netizen

[BUG] Fix in-place mutation in make_strings_unique ( #553 ) @SHIVANSH-ux-ys

Maintenance

[MNT] Dependabot: Bump astral-sh/setup-uv from 4 to 7 ( #546 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/setup-python from 5 to 6 ( #547 ) @dependabot[bot]

[MNT] Dependabot: Update sphinx-gallery requirement from <0.21.0 to <0.22.0 ( #548 ) @dependabot[bot]

[MNT] update release workflow to simplified setup ( #550 ) @fkiraly

[MNT] Dependabot: Bump actions/dependency-review-action from 4 to 5 ( #556 ) @dependabot[bot]

[pre-commit.ci] pre-commit autoupdate ( #552 ) @pre-commit-ci[bot]

[pre-commit.ci] pre-commit autoupdate ( #557 ) @pre-commit-ci[bot]

Contributors

@fkiraly , @SHIVANSH-ux-ys , @shourya1419-netizen , @patelchaitany

Feature, bugfix and maintenance release.

Enhancements

• [ENH] safer get_params(deep=True) nesting (562) fkiraly

Fixes

• [BUG] Fix get_params(deep=True) for BaseObject class parameters (559) patelchaitany

• [BUG] Fix deep_equals failing on string-dtype numpy arrays (numpy < 2.0) (519) shourya1419-netizen

• [BUG] Fix in-place mutation in make_strings_unique (553) SHIVANSH-ux-ys

Maintenance

• [MNT] [Dependabot](deps): Bump astral-sh/setup-uv from 4 to 7 (546) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/setup-python from 5 to 6 (547) dependabot[bot]

• [MNT] [Dependabot](deps-dev): Update sphinx-gallery requirement from <0.21.0 to <0.22.0 (548) dependabot[bot]

• [MNT] update release workflow to simplified setup (550) fkiraly

• [MNT] [Dependabot](deps): Bump actions/dependency-review-action from 4 to 5 (556) dependabot[bot]

• [pre-commit.ci] pre-commit autoupdate (552) pre-commit-ci[bot]

• [pre-commit.ci] pre-commit autoupdate (557) pre-commit-ci[bot]

Contributors

fkiraly, SHIVANSH-ux-ys, shourya1419-netizen, patelchaitany

Increment version to 1.0.0 to mark long-term API stable releases of skbase .

Minor feature release.

Tag inheritance resolution have changed to encompass diamond inheritance and mixed base class situations, see below for details.

Core interface changes

Tag inheritance resolution in get_tags and get_class_tags now uses all parent classes in MRO, and resolves diamond inheritance the same way as Python proper.

scikit-base no longer expects BaseObject to be the top level base class for all objects in the ecosystem, allowing mixin and other base classes to be used without API non-compliance.

Enhancements

[ENH] change _MetaObjectMixin._check_objects default for attr_name to auto-detect ( #466 ) @SimonBlanke

[ENH] change tag resolution in _get_class_flags to use all parent classes in MRO, and check for tag in class dict instead of using getattr ( #540 ) @vedant21-oss

Fixes

[BUG] normalize package names in _check_soft_dependencies following PEP 503 ( #544 ) @fkiraly

[BUG] Fix incorrect tag resolution in _get_class_flags with diamond inheritance ( #511 ) @WHOIM1205

Maintenance

[MNT] downwards compatibility testing for deep_equals ( #537 ) @sid200727

Contributors

@fkiraly , @sid200727 , @SimonBlanke , @WHOIM1205 , @vedant21-oss

Increment version to 1.0.0 to mark long-term API stable releases of skbase.

Minor feature release.

Tag inheritance resolution have changed to encompass diamond inheritance and mixed base class situations, see below for details.

Core interface changes

Tag inheritance resolution in get_tags and get_class_tags now uses all parent classes in MRO, and resolves diamond inheritance the same way as Python proper.

scikit-base no longer expects BaseObject to be the top level base class for all objects in the ecosystem, allowing mixin and other base classes to be used without API non-compliance.

Enhancements

• [ENH] change _MetaObjectMixin._check_objects default for attr_name to auto-detect (466) SimonBlanke

• [ENH] change tag resolution in _get_class_flags to use all parent classes in MRO, and check for tag in class dict instead of using getattr (540) vedant21-oss

Fixes

• [BUG] normalize package names in _check_soft_dependencies following PEP 503 (544) fkiraly

• [BUG] Fix incorrect tag resolution in _get_class_flags with diamond inheritance (511) WHOIM1205

Maintenance

• [MNT] downwards compatibility testing for deep_equals (537) sid200727

Contributors

fkiraly, sid200727, SimonBlanke, WHOIM1205, vedant21-oss

Feature, bugfix, and maintenance release.

Enhancements

[ENH] Added catch all exceptions block instead of just catching ImportError & AttributeError in _safe_import ( #494 ) @RecreationalMath

[ENH] Catch expected FutureWarnings in test_tag_aliaser ( #498 ) @Dreamstick9

[ENH] Fix SparseEfficiencyWarning when comparing sparse matrices in test_base.py ( #496 ) @Dreamstick9

Fixes

[BUG] Fix eq missing class type check ( #507 ) @WHOIM1205

Maintenance

[MNT] Update legacy black dependency in pre-commit hook ( #500 ) @Dreamstick9

[MNT] Dependabot: Bump actions/download-artifact from 7 to 8 ( #505 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/upload-artifact from 6 to 7 ( #506 ) @dependabot[bot]

[MNT] Dependabot: Update sphinx-issues requirement from <6.0.0 to <7.0.0 ( #534 ) @dependabot[bot]

[MNT] Dependabot: Bump codecov/codecov-action from 5 to 6 ( #538 ) @dependabot[bot]

Contributors

@Dreamstick9 , @RecreationalMath , @WHOIM1205

Feature, bugfix, and maintenance release.

Enhancements

• [ENH] Added catch all exceptions block instead of just catching ImportError & AttributeError in _safe_import (494) RecreationalMath

• [ENH] Catch expected FutureWarnings in test_tag_aliaser (498) Dreamstick9

• [ENH] Fix SparseEfficiencyWarning when comparing sparse matrices in test_base.py (496) Dreamstick9

Fixes

• [BUG] Fix __eq__ missing class type check (507) WHOIM1205

Maintenance

• [MNT] Update legacy black dependency in pre-commit hook (500) Dreamstick9

• [MNT] [Dependabot](deps): Bump actions/download-artifact from 7 to 8 (505) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/upload-artifact from 6 to 7 (506) dependabot[bot]

• [MNT] [Dependabot](deps-dev): Update sphinx-issues requirement from <6.0.0 to <7.0.0 (534) dependabot[bot]

• [MNT] [Dependabot](deps): Bump codecov/codecov-action from 5 to 6 (538) dependabot[bot]

Contributors

Dreamstick9, RecreationalMath, WHOIM1205

Feature, bugfix, and maintenance release.

Enhancements

[ENH] ensure _get_installed_packages does not break in case of empty package metadata ( #461 ) @auderson

[ENH] deep_equals plugin for jax arrays ( #477 ) @SimonBlanke

[ENH] regression test for HTML repr of meta-objects ( #473 ) @arnavk23

[ENH] move git_diff utility from sktime to skbase ( #471 ) @ParamThakkar123

Fixes

[BUG] regression test certifying for fix 115 ( #460 ) @SimonBlanke

[BUG] fix case_sensitive argument in _check_soft_dependencies ( #464 ) @fkiraly

[BUG] exceptions - fix B042 pre-commit issue ( #465 ) @fkiraly

[BUG] Fix Metaclass lookup ( #457 ) @SimonBlanke

[BUG] fix #483 , change .append() to .extend() ( #484 ) @SimonBlanke

[BUG] ensure BaseMetaObject resets at set_params ; add test_set_params_resets_fitted_state test to trigger error ( #467 ) @SimonBlanke

Maintenance

[MNT] add precommit skip for delattr use in test ( #485 ) @fkiraly

[MNT] Delete unused cancel.yml workflow ( #489 ) @fkiraly

[MNT] Dependabot: Bump actions/setup-node from 5 to 6 ( #459 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/download-artifact from 5 to 6 ( #462 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/upload-artifact from 4 to 5 ( #463 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/checkout from 5 to 6 ( #475 ) @dependabot[bot]

[MNT] Dependabot: Update sphinx-gallery requirement from <0.20.0 to <0.21.0 ( #479 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/download-artifact from 6 to 7 ( #481 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/upload-artifact from 5 to 6 ( #482 ) @dependabot[bot]

[MNT] Dependabot: Bump styfle/cancel-workflow-action from 0.12.1 to 0.13.0 ( #487 ) @dependabot[bot]

[MNT] Dependabot: Update sphinx requirement from !=7.2.0,<9.0.0 to !=7.2.0,<10.0.0 ( #486 ) @dependabot[bot]

[pre-commit.ci] pre-commit autoupdates ( #458 , #468 , #470 , #480 , #488 ) @pre-commit-ci[bot]

Contributors

@auderson , @arnavk23 , @fkiraly , @ParamThakkar123 , @SimonBlanke

Feature, bugfix, and maintenance release.

Enhancements

• [ENH] ensure _get_installed_packages does not break in case of empty package metadata (461) auderson

• [ENH] deep_equals plugin for jax arrays (477) SimonBlanke

• [ENH] regression test for HTML repr of meta-objects (473) arnavk23

• [ENH] move git_diff utility from sktime to skbase (471) ParamThakkar123

Fixes

• [BUG] regression test certifying for fix 115 (460) SimonBlanke

• [BUG] fix case_sensitive argument in _check_soft_dependencies (464) fkiraly

• [BUG] exceptions - fix B042 pre-commit issue (465) fkiraly

• [BUG] Fix Metaclass lookup (457) SimonBlanke

• [BUG] fix #483, change .append() to .extend() (484) SimonBlanke

• [BUG] ensure BaseMetaObject resets at set_params; add test_set_params_resets_fitted_state test to trigger error (467) SimonBlanke

Maintenance

• [MNT] add precommit skip for delattr use in test (485) fkiraly

• [MNT] Delete unused cancel.yml workflow (489) fkiraly

• [MNT] [Dependabot](deps): Bump actions/setup-node from 5 to 6 (459) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/download-artifact from 5 to 6 (462) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/upload-artifact from 4 to 5 (463) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/checkout from 5 to 6 (475) dependabot[bot]

• [MNT] [Dependabot](deps-dev): Update sphinx-gallery requirement from <0.20.0 to <0.21.0 (479) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/download-artifact from 6 to 7 (481) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/upload-artifact from 5 to 6 (482) dependabot[bot]

• [MNT] [Dependabot](deps): Bump styfle/cancel-workflow-action from 0.12.1 to 0.13.0 (487) dependabot[bot]

• [MNT] [Dependabot](deps-dev): Update sphinx requirement from !=7.2.0,<9.0.0 to !=7.2.0,<10.0.0 (486) dependabot[bot]

• [pre-commit.ci] pre-commit autoupdates (458, 468, 470, 480, 488) pre-commit-ci[bot]

Contributors

auderson, arnavk23, fkiraly, ParamThakkar123, SimonBlanke

Python 3.14 compatibility and Python 3.9 End-of-Life update.

Contents

[ENH] TagAliaserMixin updated to sktime state, added tests ( #454 ) @fkiraly

[DOC] Fix typos ( #449 ) @szepeviktor

[MNT] Dependabot: Bump github/codeql-action from 3 to 4 ( #452 ) @dependabot[bot]

[MNT] python 3.14 compatibility and python 3.9 end-of-life ( #453 ) @fkiraly

[pre-commit.ci] pre-commit autoupdate ( #450 ) @pre-commit-ci[bot]

[pre-commit.ci] pre-commit autoupdate ( #451 ) @pre-commit-ci[bot]

Contributors

@fkiraly , @szepeviktor

Python 3.14 compatibility and Python 3.9 End-of-Life update.

Contents

• [ENH] TagAliaserMixin updated to sktime state, added tests (454) fkiraly

• [DOC] Fix typos (449) szepeviktor

• [MNT] [Dependabot](deps): Bump github/codeql-action from 3 to 4 (452) dependabot[bot]

• [MNT] python 3.14 compatibility and python 3.9 end-of-life (453) fkiraly

• [pre-commit.ci] pre-commit autoupdate (450) pre-commit-ci[bot]

• [pre-commit.ci] pre-commit autoupdate (451) pre-commit-ci[bot]

Contributors

fkiraly, szepeviktor

Minor release with feature, bugfix, and maintenance updates.

Contents

[ENH] update _safe_import to state in sktime and pytorch_forecasting ( #441 ) @fkiraly

[ENH] improved QuickTester : verbosity levels, plugin structure for fixture generation handling ( #446 ) @fkiraly

[BUG] fix TagAliaserMixin get_tag and get_class_tag ( #445 ) @fkiraly

[MNT] Check versions in wheels workflow ( #440 ) @szepeviktor

[MNT] Dependabot: Bump actions/setup-node from 4 to 5 ( #443 ) @dependabot[bot]

[MNT] Dependabot: Bump actions/setup-python from 5 to 6 ( #444 ) @dependabot[bot]

[pre-commit.ci] pre-commit autoupdate ( #447 ) @pre-commit-ci[bot]

Contributors

@fkiraly , @szepeviktor

Minor release with feature, bugfix, and maintenance updates.

Contents

• [ENH] update _safe_import to state in sktime and pytorch_forecasting (441) fkiraly

• [ENH] improved QuickTester: verbosity levels, plugin structure for fixture generation handling (446) fkiraly

• [BUG] fix TagAliaserMixin get_tag and get_class_tag (445) fkiraly

• [MNT] Check versions in wheels workflow (440) szepeviktor

• [MNT] [Dependabot](deps): Bump actions/setup-node from 4 to 5 (443) dependabot[bot]

• [MNT] [Dependabot](deps): Bump actions/setup-python from 5 to 6 (444) dependabot[bot]

• [pre-commit.ci] pre-commit autoupdate (447) pre-commit-ci[bot]

Contributors

fkiraly, szepeviktor

Minor release with maintenance updates.

Contents

[ENH] ensure _get_installed_packages does not break in case of incomplete or corrupted package metadata ( #433 ) @fkiraly

[MNT] remove deprecated fix-encoding-pragma hook from pre-commit ( #438 ) @fkiraly

• [MNT] Dependabot: Bump actions/download-artifact from 4 to 5 ( #434 ) @dependabot

[MNT] Dependabot: Bump actions/checkout from 4 to 5 ( #436 ) @dependabot

[pre-commit.ci] pre-commit autoupdate ( #435 ) @pre-commit-ci[bot]

Minor release with maintenance updates.

Contents

• [ENH] ensure _get_installed_packages does not break in case of incomplete or corrupted package metadata (433) fkiraly

• [MNT] remove deprecated fix-encoding-pragma hook from pre-commit (438) fkiraly

• [MNT] [Dependabot](deps): Bump actions/download-artifact

  from 4 to 5 (434) dependabot

• [MNT] [Dependabot](deps): Bump actions/checkout from 4 to 5 (436) dependabot

• [pre-commit.ci] pre-commit autoupdate (435) pre-commit-ci[bot]

Minor release with maintenance updates, features, and bugfixes.

Contents

[ENH] QuickTester verbose output on passed and failed tests if raise_exceptions=True ( #428 ) @fkiraly

[MNT] remove stefanzweifel/git-auto-commit-action from all-contributors workflow ( #426 ) @fkiraly

[pre-commit.ci] pre-commit autoupdate ( #425 ) @pre-commit-ci[bot]

[pre-commit.ci] pre-commit autoupdate ( #429 ) @pre-commit-ci[bot]

[DOC] correct macOS reference in README ( #421 ) @fkiraly

[DOC] add missing docstring argument for QuickTester.run_tests ( #430 ) @fkiraly

[BUG] fix _check_soft_dependencies error message if version is wrong ( #427 ) @fkiraly

Minor release with maintenance updates, features, and bugfixes.

Contents

• [ENH] QuickTester verbose output on passed and failed tests if raise_exceptions=True (428) fkiraly

• [MNT] remove stefanzweifel/git-auto-commit-action from all-contributors workflow (426) fkiraly

• [pre-commit.ci] pre-commit autoupdate (425) pre-commit-ci[bot]

• [pre-commit.ci] pre-commit autoupdate (429) pre-commit-ci[bot]

• [DOC] correct macOS reference in README (421) fkiraly

• [DOC] add missing docstring argument for QuickTester.run_tests (430) fkiraly

• [BUG] fix _check_soft_dependencies error message if version is wrong (427) fkiraly

Minor release with maintenance updates, features, and bugfixes.

Contents

[ENH] doctest run utility ( #415 ) @fkiraly

[ENH] improved _check_soft_dependencies utility: case sensitivity, disjunction ( #417 ) @fkiraly

[MNT] use macos-latest and ubuntu-latest in release workflow ( #411 , #420 ) @fkiraly

[MNT] update nodevdeps runner to latest ubuntu ( #416 ) @fkiraly

[MNT] replace deprecated windows-2019 runner with windows-latest in wheels release workflow ( #432 ) @fkiraly

[BUG] ensure all_objects handles decorators properly ( #418 ) @fkiraly

[BUG] fix TagAliaserMixin missing warnings ( #414 ) @fkiraly

Minor release with maintenance updates, features, and bugfixes.

Contents

• [ENH] doctest run utility (415) fkiraly

• [ENH] improved _check_soft_dependencies utility: case sensitivity, disjunction (417) fkiraly

• [MNT] use macos-latest and ubuntu-latest in release workflow (411, 420) fkiraly

• [MNT] update nodevdeps runner to latest ubuntu (416) fkiraly

• [MNT] replace deprecated windows-2019 runner with windows-latest in wheels release workflow (432) fkiraly

• [BUG] ensure all_objects handles decorators properly (418) fkiraly

• [BUG] fix TagAliaserMixin missing warnings (414) fkiraly

Minor release with maintenance updates, features, and bugfixes.

Contents

[ENH] refactor repetitive clone tests with pytest.mark.parametrize, fixes #170 ( #392 ) @JahnaviDhanaSri

[pre-commit.ci] pre-commit autoupdate ( #393 , #397 , #398 , #401 , #403 , #408 ) @pre-commit-ci

[MNT] Dependabot: Update sphinx-gallery requirement from <0.19.0 to <0.20.0 ( #400 ) @dependabot

[MNT] Add CI for updating contributors ( #395 ) @Spinachboul

[MNT] remove tj-actions from CI ( #404 ) @fkiraly

[DOC] Update Contributors List and Badge ( #394 , #399 ) @Spinachboul

[DOC] minor typo fix in code comment ( #402 ) @fkiraly

[DOC] minor documentation fixes ( #405 ) @fkiraly

[BUG] fix deep_equals for pandas.Index ( #407 ) @XinyuWuu

Contributors

@fkiraly , @JahnaviDhanaSri , @Spinachboul , @XinyuWuu

Minor release with maintenance updates, features, and bugfixes.

Contents

• [ENH] refactor repetitive clone tests with pytest.mark.parametrize, fixes #170 (392) JahnaviDhanaSri

• [pre-commit.ci] pre-commit autoupdate (393, 397, 398, 401, 403, 408) pre-commit-ci

• [MNT] [Dependabot](deps): Update sphinx-gallery requirement from <0.19.0 to <0.20.0 (400) dependabot

• [MNT] Add CI for updating contributors (395) Spinachboul

• [MNT] remove tj-actions from CI (404) fkiraly

• [DOC] Update Contributors List and Badge (394, 399) Spinachboul

• [DOC] minor typo fix in code comment (402) fkiraly

• [DOC] minor documentation fixes (405) fkiraly

• [BUG] fix deep_equals for pandas.Index (407) XinyuWuu

Contributors

fkiraly, JahnaviDhanaSri, Spinachboul, XinyuWuu

Feature release, and python 3.8 End-of-Life update.

Core interface changes

the logic of clone has been refactored to a type-based plugin architecture, with plugins inheriting from BaseCloner . The default behaviour of clone remains unchanged, and a new plugin for scikit-learn estimators has been added, dispatching to sklearn clone . This change is not breaking, and it fixes some reported bugs around sklearn config handling.

clone plugins can be customized by extenders by overriding the _get_clone_plugins method, which can return a list of BaseCloner classes, functioning as plugins.

Enhancements

[ENH] refactor _clone to a plugin structure ( #381 ) @fkiraly

[ENH] add _get_clone_plugins to allow packages to customize clone plugins ( #383 ) @fkiraly

Maintenance

[MNT] manage python 3.8 end-of-life ( #378 ) @fkiraly

[MNT] fix failing code-quality CI step ( #377 ) @fkiraly

[MNT] Dependabot: Update sphinx-gallery requirement from <0.18.0 to <0.19.0 ( #375 ) @dependabot

[MNT] Dependabot: Update sphinx-issues requirement from <5.0.0 to <6.0.0 ( #376 ) @dependabot

[pre-commit.ci] pre-commit autoupdate ( #379 ) @pre-commit-ci

[pre-commit.ci] pre-commit autoupdate ( #382 ) @pre-commit-ci

Feature release, and python 3.8 End-of-Life update.

Core interface changes

• the logic of clone has been refactored to a type-based plugin architecture, with plugins inheriting from BaseCloner. The default behaviour of clone remains unchanged, and a new plugin for scikit-learn estimators has been added, dispatching to sklearn clone. This change is not breaking, and it fixes some reported bugs around sklearn config handling.

• clone plugins can be customized by extenders by overriding the _get_clone_plugins method, which can return a list of BaseCloner classes, functioning as plugins.

Enhancements

• [ENH] refactor _clone to a plugin structure (381) fkiraly

• [ENH] add _get_clone_plugins to allow packages to customize clone plugins (383) fkiraly

Maintenance

• [MNT] manage python 3.8 end-of-life (378) fkiraly

• [MNT] fix failing code-quality CI step (377) fkiraly

• [MNT] [Dependabot](deps): Update sphinx-gallery requirement from <0.18.0 to <0.19.0 (375) dependabot

• [MNT] [Dependabot](deps): Update sphinx-issues requirement from <5.0.0 to <6.0.0 (376) dependabot

• [pre-commit.ci] pre-commit autoupdate (379) pre-commit-ci

• [pre-commit.ci] pre-commit autoupdate (382) pre-commit-ci

Maintenance release with full support for python 3.13 , and other minor improvements.

Contents

[MNT] full support for python 3.13 ( #372 ) @fkiraly

[DOC] improved docstrings for BaseObject ( #369 ) @fkiraly

[DOC] merge docstring of NotFittedError with sktime ( #371 ) @fkiraly

[ENH] merge sktime BaseEstimator` into ``skbase BaseEstimator ( #370 ) @fkiraly

[pre-commit.ci] pre-commit autoupdate ( #374 ) @pre-commit-ci

Maintenance release with full support for python 3.13, and other minor improvements.

Contents

• [MNT] full support for python 3.13 (372) fkiraly

• [DOC] improved docstrings for BaseObject (369) fkiraly

• [DOC] merge docstring of NotFittedError with sktime (371) fkiraly

• [ENH] merge sktime BaseEstimator` into ``skbase BaseEstimator (370) fkiraly

• [pre-commit.ci] pre-commit autoupdate (374) pre-commit-ci

Maintenance release with experimental python 3.13 wheels. Full 3.13 support will be added with scikit-base 0.11.0 .

Contents

[pre-commit.ci] pre-commit autoupdate ( #364 ) @pre-commit-ci

[MNT] updates scikit-learn soft dependency checks to use PEP 440 name ( #366 ) @fkiraly

[MNT] experimental python 3.13 wheels and 3.13-rc.2 testing ( #365 ) @fkiraly

Maintenance release with experimental python 3.13 wheels. Full 3.13 support will be added with scikit-base 0.11.0.

Contents

• [pre-commit.ci] pre-commit autoupdate (364) pre-commit-ci

• [MNT] updates scikit-learn soft dependency checks to use PEP 440 name (366) fkiraly

• [MNT] experimental python 3.13 wheels and 3.13-rc.2 testing (365) fkiraly

Maintenance release with scheduled changes and deprecations.

Contents

[pre-commit.ci] pre-commit autoupdate ( #358 ) @pre-commit-ci

[ENH] add test that html repr of objects does not crash ( #359 ) @fkiraly

[ENH] clone method to handle nested dict ( #362 ) @fkiraly

[DOC] Replace use of “estimator” term in base object interfaces with more general references ( #293 ) @tpvasconcelos

[MNT] 0.10.0 deprecations and change actions ( #360 ) @fkiraly

Contributors

@fkiraly , @tpvasconcelos

Maintenance release with scheduled changes and deprecations.

Contents

• [pre-commit.ci] pre-commit autoupdate (358) pre-commit-ci

• [ENH] add test that html repr of objects does not crash (359) fkiraly

• [ENH] clone method to handle nested dict (362) fkiraly

• [DOC] Replace use of "estimator" term in base object interfaces with more general references (293) tpvasconcelos

• [MNT] 0.10.0 deprecations and change actions (360) fkiraly

Contributors

fkiraly, tpvasconcelos

Maintenance release with scheduled changes and deprecations.

Deprecations and removals

In all_objects , the meaning of filter_tags arguments of type str , and iterable of str , has changed as scheduled. Prior to 0.9.0, str or iterable of str arguments selected objects that possess the tag(s) with the specified name, of any value. From 0.9.0 onwards, str or iterable of str will select objects that possess the tag with the specified name, with the value True (boolean). See scikit-base issue #326 for the rationale behind this change. To retain previous behaviour, that is, to select objects that possess the tag with the specified name, of any value, use a dict with the tag name as key, and re.Pattern('?') as value. That is, from re import Pattern , and pass {tag_name: Pattern('?')} as filter_tags , and similarly with multiple tag names.

Contents

[MNT] 0.9.0 deprecations and change actions ( #355 ) @fkiraly

Regular maintenance release.

Contents

[MNT] release workflow: Upgrade deprecated pypa action parameter ( #349 ) @szepeviktor

[MNT] pre-commit autoupdate by ( #353 ) @pre-commit-ci

[ENH] StderrMute context manager ( #350 ) @XinyuWuu

[BUG] fix dependency checkers in case of multiple distributions available in environment, e.g., on databricks ( #352 ) @fkiraly , @toandaominh1997

[ENH] safer get_fitted_params default functionality to avoid exception on getattr ( #353 ) @fkiraly

Contributors

@fkiraly , @szepeviktor , @toandaominh1997 , @yarnabrina

Regular maintenance release.

Contents

• [MNT] release workflow: Upgrade deprecated pypa action parameter (349) szepeviktor

• [MNT] pre-commit autoupdate by (353) pre-commit-ci

• [ENH] StderrMute context manager (350) XinyuWuu

• [BUG] fix dependency checkers in case of multiple distributions available in environment, e.g., on databricks (352) fkiraly, toandaominh1997

• [ENH] safer get_fitted_params default functionality to avoid exception on getattr (353) fkiraly

Contributors

fkiraly, szepeviktor, toandaominh1997, yarnabrina

Regular maintenance release.

Contents

[ENH] prevent imports in _check_soft_dependencies ( #340 ) @fkiraly , @yarnabrina

[ENH] sync dependency checkers with sktime ( #345 ) @fkiraly

[pre-commit.ci] pre-commit autoupdate ( #342 ) @pre-commit-ci

[MNT] Dependabot: Update sphinx-gallery requirement from <0.17.0 to <0.18.0 ( #343 ) @dependabot

[MNT] Dependabot: Update sphinx requirement from !=7.2.0,<8.0.0 to !=7.2.0,<9.0.0 ( #344 ) @dependabot

[MNT] Move release CI to macos-12 image ( #347 ) @szepeviktor

Contributors

@fkiraly , @szepeviktor , @yarnabrina

Regular maintenance release.

Contents

• [ENH] prevent imports in _check_soft_dependencies (340) fkiraly, yarnabrina

• [ENH] sync dependency checkers with sktime (345) fkiraly

• [pre-commit.ci] pre-commit autoupdate (342) pre-commit-ci

• [MNT] [Dependabot](deps): Update sphinx-gallery requirement from <0.17.0 to <0.18.0 (343) dependabot

• [MNT] [Dependabot](deps): Update sphinx requirement from !=7.2.0,<8.0.0 to !=7.2.0,<9.0.0 (344) dependabot

• [MNT] Move release CI to macos-12 image (347) szepeviktor

Contributors

fkiraly, szepeviktor, yarnabrina

Regular bugfix and maintenance release.

Core interface changes

get_param_names now allows users to return the parameter names in the same order as in the`` init method, by passing the argument sort=False .

Contents

[ENH] option to return BaseObject.get_param_names in the same order as in the init ( #335 ) @fkiraly

[ENH] refactor - move StdoutMute context manager to utils ( #338 ) @fkiraly

[MNT] numpy 2 compatibility of some tests ( #337 ) @fkiraly

[pre-commit.ci] pre-commit autoupdate ( #336 ) @pre-commit-ci

Regular bugfix and maintenance release.

Core interface changes

• get_param_names now allows users to return the parameter names in the same order as in the`` __init__ method, by passing the argument sort=False.

Contents

• [ENH] option to return BaseObject.get_param_names in the same order as in the __init__ (335) fkiraly

• [ENH] refactor - move StdoutMute context manager to utils (338) fkiraly

• [MNT] numpy 2 compatibility of some tests (337) fkiraly

• [pre-commit.ci] pre-commit autoupdate (336) pre-commit-ci

Feature update for all_objects , bugfix and maintenance release.

Core interface changes

all_objects now allows filtering tag values by re.Pattern regular expressions passed as query values via filter_tags .

Deprecations and removals

In all_objects , the meaning of filter_tags arguments of type str , and iterable of str , will change from scikit-base 0.9.0 . Currently, str or iterable of str arguments select objects that possess the tag(s) with the specified name, of any value. From 0.9.0 onwards, str or iterable of str will select objects that possess the tag with the specified name, with the value True (boolean). See scikit-base issue #326 for the rationale behind this change. To retain previous behaviour, that is, to select objects that possess the tag with the specified name, of any value, use a dict with the tag name as key, and re.Pattern('?') as value. That is, from re import Pattern , and pass {tag_name: Pattern('?')} as filter_tags , and similarly with multiple tag names.

Contents

[BUG] fix permanently muted stdout after all_objects call ( #328 ) @fkiraly

[ENH] refactor - simplify all_objects logic and add cache for efficient lookup ( #331 ) @fkiraly

[ENH] all_objects retrieval filtered by regex applied to tag values, deprecation of “has tag” condition in favour of “tag is True” ( #329 ) @fkiraly

[MNT] Dependabot: Update sphinx-design requirement from <0.6.0 to <0.7.0 ( #332 ) @dependabot

Regular bugfix and maintenance release.

Contents

[BUG] safer comparison in deep_equals if np.any(x != y) does not result in boolean ( #323 ) @fkiraly

[pre-commit.ci] pre-commit autoupdate ( #322 ) @dependabot

[MNT] Dependabot: Update sphinx-gallery requirement from <0.16.0 to <0.17.0 ( #321 ) @dependabot

Regular bugfix and maintenance release.

Contents

• [BUG] safer comparison in deep_equals if np.any(x != y) does not result in boolean (323) fkiraly

• [pre-commit.ci] pre-commit autoupdate (322) dependabot

• [MNT] [Dependabot](deps): Update sphinx-gallery requirement from <0.16.0 to <0.17.0 (321) dependabot

Small hotfix release.

Contents

Revert “[MNT] rename testing.utils.inspect to avoid shadowing of inspect ” ( #319 ) @fkiraly

Minor feature and bugfix release.

Contents

[ENH] deep_equals support for nested np.ndarray ( #314 ) @fkiraly

[BUG] fix sklearn compatibility of _VisualBlock ( #310 ) @fkiraly

[pre-commit.ci] pre-commit autoupdates ( #306 , #307 , #308 , #312 , #315 ) @pre-commit-ci

[MNT] rename testing.utils.inspect to avoid shadowing of inspect ( #316 ) @fkiraly

Minor feature and bugfix release.

Contents

• [ENH] deep_equals support for nested np.ndarray (314) fkiraly

• [BUG] fix sklearn compatibility of _VisualBlock (310) fkiraly

• [pre-commit.ci] pre-commit autoupdates (306, 307, 308, 312, 315) pre-commit-ci

• [MNT] rename testing.utils.inspect to avoid shadowing of inspect (316) fkiraly

Small hotfix release.

Contents

[BUG] fix deep_equals on objects which have len but len(obj) causes exception ( #303 ) @fkiraly

Small hotfix release.

Contents

[BUG] preserve exception type raised by get_test_params ( #300 ) @fkiraly

Feature and bugfix release.

Core interface changes

all_objects now allows filtering for arbitrary parent classes, not just classes inheriting from BaseObject . This is useful for looking up objects in a third party package that are not part of the skbase hierarchy.

Enhancements

[ENH] allow arbitrary base class in all_objects ( #284 ) @fkiraly

[ENH] improved exception feedback for test instance generation methods of BaseObject ( #286 ) @fkiraly

[ENH] estimator soft dependency check utilities ( #285 ) @fkiraly

[ENH] Refactor BaseObject.clone ( #281 ) @tpvasconcelos

Fixes

[BUG] Fix deep_equals for pandas.Index of different length ( #290 ) @MBristle

Documentation

[DOC] remove accidental duplicated section in get_test_params docstring ( #292 ) @fkiraly

[DOC] add yarnabrina to all-contributorsrc ( #294 ) @fkiraly

Maintenance

[MNT] add codecov` config ``yml , remove CI failure condition ( #296 ) @fkiraly

[MNT] remove unnecessary CI triggers for release branches ( #298 ) @fkiraly

[pre-commit.ci] pre-commit autoupdate by ( #289 ) @pre-commit-ci

[MNT] Dependabot: Bump codecov/codecov-action from 3 to 4 ( #283 ) @dependabot

[MNT] Dependabot: Bump pre-commit/action from 3.0.0 to 3.0.1 ( #287 ) @dependabot

Contributors

@fkiraly , @MBristle , @tpvasconcelos

Feature and bugfix release.

Core interface changes

• all_objects now allows filtering for arbitrary parent classes, not just classes inheriting from BaseObject. This is useful for looking up objects in a third party package that are not part of the skbase hierarchy.

Enhancements

• [ENH] allow arbitrary base class in all_objects (284) fkiraly

• [ENH] improved exception feedback for test instance generation methods of BaseObject (286) fkiraly

• [ENH] estimator soft dependency check utilities (285) fkiraly

• [ENH] Refactor BaseObject.clone (281) tpvasconcelos

Fixes

• [BUG] Fix deep_equals for pandas.Index of different length (290) MBristle

Documentation

• [DOC] remove accidental duplicated section in get_test_params docstring (292) fkiraly

• [DOC] add yarnabrina to all-contributorsrc (294) fkiraly

Maintenance

• [MNT] add codecov` config ``yml, remove CI failure condition (296) fkiraly

• [MNT] remove unnecessary CI triggers for release branches (298) fkiraly

• [pre-commit.ci] pre-commit autoupdate by (289) @pre-commit-ci

• [MNT] [Dependabot](deps): Bump codecov/codecov-action from 3 to 4 (283) dependabot

• [MNT] [Dependabot](deps): Bump pre-commit/action from 3.0.0 to 3.0.1 (287) dependabot

Contributors

fkiraly, MBristle, tpvasconcelos

Feature and bugfix release.

Core interface changes

all BaseObject descendants now possess a method set_random_state . This can be used for nested setting of random_state variables, and is useful for ensuring reproducibility in nested estimators. ( #268 ) @fkiraly

all_objects now supports filtering for list-valued tags in filter_tags as a convenience feature. When the query value is a single value or a list, the filter condition is that the tag value and the query value have at least one element in common. ( #273 ) @fkiraly

Enhancements

[ENH] all_objects filter_tags to function with list-of tags ( #273 ) @fkiraly

[ENH] Random state handling, set_random_state method ( #268 ) @fkiraly

Fixes

[BUG] Fix cloning of config for nested objects ( #276 ) @tpvasconcelos

Documentation

[DOC] lint changelog ( #267 ) @fkiraly

Maintenance

[pre-commit.ci] pre-commit autoupdate ( #274 ) @precommit-ci

[MNT] Dependabot: Bump actions/dependency-review-action from 3 to 4 ( #269 ) @dependabot

[MNT] Dependabot: Update sphinx-issues requirement from <4.0.0 to <5.0.0 ( #271 ) @dependabot

[MNT] Dependabot: Bump styfle/cancel-workflow-action from 0.12.0 to 0.12.1 ( #272 ) @dependabot

[MNT] Add common IDE files to .gitignore ( #277 ) @tpvasconcelos

Contributors

@fkiraly , @tpvasconcelos

Feature and bugfix release.

Core interface changes

• all BaseObject descendants now possess a method set_random_state. This can be used for nested setting of random_state variables, and is useful for ensuring reproducibility in nested estimators. (268) fkiraly

• all_objects now supports filtering for list-valued tags in filter_tags as a convenience feature. When the query value is a single value or a list, the filter condition is that the tag value and the query value have at least one element in common. (273) fkiraly

Enhancements

• [ENH] all_objects filter_tags to function with list-of tags (273) fkiraly

• [ENH] Random state handling, set_random_state method (268) fkiraly

Fixes

• [BUG] Fix cloning of config for nested objects (276) tpvasconcelos

Documentation

• [DOC] lint changelog (267) fkiraly

Maintenance

• [pre-commit.ci] pre-commit autoupdate (274) precommit-ci

• [MNT] [Dependabot](deps): Bump actions/dependency-review-action from 3 to 4 (269) dependabot

• [MNT] [Dependabot](deps-dev): Update sphinx-issues requirement from <4.0.0 to <5.0.0 (271) dependabot

• [MNT] [Dependabot](deps): Bump styfle/cancel-workflow-action from 0.12.0 to 0.12.1 (272) dependabot

• [MNT] Add common IDE files to .gitignore (277) tpvasconcelos

Contributors

fkiraly, tpvasconcelos

Minor bugfix and maintenance release.

Contents

[BUG] fix deep_equals for np.array with dtype="object" ( #263 ) @fkiraly

[pre-commit.ci] pre-commit autoupdate ( #264 ) @precommit-ci

Minor bugfix and maintenance release.

Contents

• [BUG] fix deep_equals for np.array with dtype="object" (263) fkiraly

• [pre-commit.ci] pre-commit autoupdate (264) precommit-ci

Bugfix release with potentially breaking changes related to set_config , get_config ( #257 , #259 , @fkiraly ) due to masking of third party bugs, please consult the changelog for details in case of breakage.

Core interface changes

configuration values - set via set_config and inspectable via get_config - are now retained through clone and reset . Previous behaviour was to reset configuration values to default, which is considered a bug. However, this change may break existing code if two errors cancel out, e.g., if a breaking (without bug) configuration was set, the reset through the bug. In this case, the bug masked the breaking configuration, which should be addressed. Most breakages over 0.6.2 should be addressable by removing set_config calls, i.e., removing the genuinely breaking configuration.

A configuration field clone_config was added that allows to configure whether clone should clone the configuration. This is useful for meta-estimators that should not clone the configuration of their components. This change is not breaking - considered in difference to the above - as the default behaviour is to clone the configuration.

Fixes

[BUG] fix deep_equals plugin for pd.Index ( #260 ) @fkiraly

[BUG] retain config at reset , add tests for set_config , get_config ( #259 ) @fkiraly

[BUG] retain config after clone , add config to configure whether to clone config ( #257 ) @fkiraly

Release with minor improvements and bugfixes.

Enhancements

[ENH] deep_equals - clearer return on diffs from dtypes and index , relaxation of MultiIndex equality check ( #246 ) @fkiraly

Fixes

[BUG] ensure deep_equals plugins are passed on to all recursions ( #243 ) @fkiraly

Documentation

[DOC] Fixed spelling mistakes as identified by codespell and typos ( #245 ) @yarnabrina

Maintenance

[MNT] Dependabot: Update sphinx-gallery requirement from <0.15.0 to <0.16.0 ( #247 ) @dependabot

[MNT] Dependabot: Bump actions/setup-python from 4 to 5 ( #250 ) @dependabot

[MNT] Dependabot: Bump conda-incubator/setup-miniconda from 2 to 3 ( #249 ) @dependabot

[MNT] Dependabot: Bump github/codeql-action from 2 to 3 ( #252 ) @dependabot

[MNT] Dependabot: Bump actions/download-artifact from 3 to 4 ( #253 ) @dependabot

[MNT] Dependabot: Bump actions/upload-artifact from 3 to 4 ( #254 ) @dependabot

Release with minor improvements and bugfixes.

Enhancements

• [ENH] deep_equals - clearer return on diffs from dtypes and index, relaxation of MultiIndex equality check (246) fkiraly

Fixes

• [BUG] ensure deep_equals plugins are passed on to all recursions (243) fkiraly

Documentation

• [DOC] Fixed spelling mistakes as identified by codespell and typos (245) yarnabrina

Maintenance

• [MNT] [Dependabot](deps-dev): Update sphinx-gallery requirement from <0.15.0 to <0.16.0 (247) dependabot

• [MNT] [Dependabot](deps): Bump actions/setup-python from 4 to 5 (250) dependabot

• [MNT] [Dependabot](deps): Bump conda-incubator/setup-miniconda from 2 to 3 (249) dependabot

• [MNT] [Dependabot](deps): Bump github/codeql-action from 2 to 3 (252) dependabot

• [MNT] [Dependabot](deps): Bump actions/download-artifact from 3 to 4 (253) dependabot

• [MNT] [Dependabot](deps): Bump actions/upload-artifact from 3 to 4 (254) dependabot

Highlights

set_params now recognizes unique suffixes as aliases for full parameter strings, e.g., foo instead of estimator__component__foo ( #229 ) @fkiraly

the deep_equals utility now admits custom plugins with dependency isolation, e.g., for data types such as dask or polars ( #238 ) @fkiraly

dependabot is now enabled for the skbase repository ( #228 ) @fkiraly

Core interface changes

set_params now recognizes unique suffixes as aliases for full parameter strings. This change is not breaking as behaviour changes only in cases where previously exceptions were raised.

Enhancements

[ENH] set_params to recognize unique suffixes as aliases for full parameter string ( #229 ) @fkiraly

[ENH] refactor string coercions and return logic in deep_equals utility ( #237 ) @fkiraly

[ENH] improved deep_equals utility - plugins for custom types ( #238 ) @fkiraly

[ENH] informative failure message in test_get_package_metadata_returns_expected_results ( #239 ) @fkiraly

Maintenance

[MNT] activate dependabot for version updates and maintenance ( #228 ) @fkiraly

[MNT] Dependabot: Bump actions/upload-artifact from 2 to 3 ( #230 ) @dependabot

[MNT] Dependabot: Bump actions/dependency-review-action from 1 to 3 ( #231 ) @dependabot

[MNT] Dependabot: Bump actions/checkout from 3 to 4 ( #232 ) @dependabot

[MNT] Dependabot: Bump actions/download-artifact from 2 to 3 ( #233 ) @dependabot

[MNT] Dependabot: Bump styfle/cancel-workflow-action from 0.9.1 to 0.12.0 ( #234 ) @dependabot

Fixes

[BUG] correct parameter name in TestAllObjects all_objects call ( #236 ) @fkiraly

Highlights

• set_params now recognizes unique suffixes as aliases for full parameter strings, e.g., foo instead of estimator__component__foo (229) fkiraly

• the deep_equals utility now admits custom plugins with dependency isolation, e.g., for data types such as dask or polars (238) fkiraly

• dependabot is now enabled for the skbase repository (228) fkiraly

Core interface changes

• set_params now recognizes unique suffixes as aliases for full parameter strings. This change is not breaking as behaviour changes only in cases where previously exceptions were raised.

Enhancements

• [ENH] set_params to recognize unique suffixes as aliases for full parameter string (229) fkiraly

• [ENH] refactor string coercions and return logic in deep_equals utility (237) fkiraly

• [ENH] improved deep_equals utility - plugins for custom types (238) fkiraly

• [ENH] informative failure message in test_get_package_metadata_returns_expected_results (239) fkiraly

Maintenance

• [MNT] activate dependabot for version updates and maintenance (228) fkiraly

• [MNT] [Dependabot](deps): Bump actions/upload-artifact from 2 to 3 (230) dependabot

• [MNT] [Dependabot](deps): Bump actions/dependency-review-action from 1 to 3 (231) dependabot

• [MNT] [Dependabot](deps): Bump actions/checkout from 3 to 4 (232) dependabot

• [MNT] [Dependabot](deps): Bump actions/download-artifact from 2 to 3 (233) dependabot

• [MNT] [Dependabot](deps): Bump styfle/cancel-workflow-action from 0.9.1 to 0.12.0 (234) dependabot

Fixes

• [BUG] correct parameter name in TestAllObjects all_objects call (236) fkiraly

Maintenance release at python 3.12 release.

Adds support for python 3.12.

Dependency changes

skbase now supports python 3.12.

Deprecations and removals

the deep_equals utility has moved to skbase.utils.deep_equals . The old location in skbase.testing.utils.deep_equals has now been removed.

Contents

[MNT] address deprecation of load_module in python 3.12 ( #190 ) @fkiraly

[MNT] simplify test CI and remove conda ( #224 ) @fkiraly

[MNT] update dependency versions in doc dependency set and set upper bounds ( #226 , #227 ) @fkiraly

[MNT] update python version to 3.12 ( #221 ) @fkiraly

[MNT] 0.6.0 deprecation actions ( #225 ) @fkiraly

Maintenance release at python 3.12 release.

Adds support for python 3.12.

Dependency changes

• skbase now supports python 3.12.

Deprecations and removals

• the deep_equals utility has moved to skbase.utils.deep_equals. The old location in skbase.testing.utils.deep_equals has now been removed.

Contents

• [MNT] address deprecation of load_module in python 3.12 (190) fkiraly

• [MNT] simplify test CI and remove conda (224) fkiraly

• [MNT] update dependency versions in doc dependency set and set upper bounds (226, 227) fkiraly

• [MNT] update python version to 3.12 (221) fkiraly

• [MNT] 0.6.0 deprecation actions (225) fkiraly

Release with minor improvements.

[ENH] move tests for dependency checks and deep_equals to utils module ( #217 ) @fkiraly

[ENH] meta-object mixins ( #216 ) @fkiraly

[DOC] update sktime links ( #219 ) @fkiraly

Release with minor improvements.

• [ENH] move tests for dependency checks and deep_equals to utils module (217) fkiraly

• [ENH] meta-object mixins (216) fkiraly

• [DOC] update sktime links (219) fkiraly

Release with minor improvements and bugfixes.

Enhancements

[ENH] remove sklearn dependency in test_get_params ( #212 ) @fkiraly

Documentation

[DOC] landing page updates ( #188 ) @fkiraly

Maintenance

[MNT] separate windows CI element from unix based CI ( #209 ) @fkiraly

[MNT] convert black extend-exclude parameter to single string ( #207 ) @fkiraly

[MNT] update init version ( #210 ) @fkiraly

[MNT] fix linting issue from newest pre-commit versions ( #211 ) @fkiraly

Fixes

[BUG] fix for get_fitted_params in _HeterogenousMetaEstimator ( #191 ) @fkiraly

Release with minor improvements and bugfixes.

Enhancements

• [ENH] remove sklearn dependency in test_get_params (212) fkiraly

Documentation

• [DOC] landing page updates (188) fkiraly

Maintenance

• [MNT] separate windows CI element from unix based CI (209) fkiraly

• [MNT] convert black extend-exclude parameter to single string (207) fkiraly

• [MNT] update __init__ version (210) fkiraly

• [MNT] fix linting issue from newest pre-commit versions (211) fkiraly

Fixes

• [BUG] fix for get_fitted_params in _HeterogenousMetaEstimator (191) fkiraly

Bugfix release:

[BUG] fix clone for nested sklearn estimators ( #195 ) @fkiraly , @hazrulakmal

[BUG] fix faulty suppress_import_stdout in all_objects ( #193 ) @fkiraly

Bugfix release:

• [BUG] fix clone for nested sklearn estimators (195) fkiraly, hazrulakmal

• [BUG] fix faulty suppress_import_stdout in all_objects (193) fkiraly

Regular maintenance release.

Deprecations and removals

The deep_equals utility has moved to skbase.utils.deep_equals . The old location in skbase.testing.utils.deep_equals will be removed in skbase 0.6.0, until then it can still be imported from there, with a warning.

Maintenance

[MNT] move deep_equals and dependency checkers from testing to utilities to remove accidental coupling to pytest ( #178 ) @fkiraly , @yarnabrina

[MNT] test for isolation of developer dependencies, and basic pytest -less test for BaseObject ( #179 , #183 ) @fkiraly

Contributors

@fkiraly , @yarnabrina

Hotfix for accidental import of pytest through BaseObject.clone , including test for pytest dependency isolation.

Contents

[BUG] turn off check in BaseObject.clone ( #176 ) @fkiraly

[MNT] test for isolation of developer dependencies, and basic pytest -less test for BaseObject ( #179 ) @fkiraly

[DOC] fix some broken doc links, linting ( #175 ) @fkiraly

Hotfix for accidental import of pytest through BaseObject.clone, including test for pytest dependency isolation.

Contents

• [BUG] turn off check in BaseObject.clone (176) fkiraly

• [MNT] test for isolation of developer dependencies, and basic pytest-less test for BaseObject (179) fkiraly

• [DOC] fix some broken doc links, linting (175) fkiraly

Maintenance update that cleans up dependencies.

Notably, scikit-base no longer has any core dependencies.

This is as per usage intention as a base module, therefore this removal is not accompanied by deprecation.

Dependency changes

scikit-learn , typing-extensions , and pytest are no longer core dependencies. pytest remains a dependency in dev and test dependency sets.

scikit-learn is now part of the dev and test dependency sets, as it is required to test compatibility with scikit-learn

a dependency conflict has been resolved in the docs dependency set for the docs build, by pinning versions

Maintenance

[MNT] remove dependency on typing-extensions ( #167 ) @fkiraly

[MNT] remove dependency on pytest ( #168 ) @fkiraly

[MNT] remove dependency on scikit-learn ( #171 ) @fkiraly

[MNT] add scikit-learn to test dependency set ( #172 ) @fkiraly

[MNT] remove fail-fast flag in CI ( #169 ) @fkiraly

[MNT] resolve dependency conflict in docs dependency set ( #173 ) @fkiraly

Maintenance update that cleans up dependencies.

Notably, scikit-base no longer has any core dependencies.

This is as per usage intention as a base module, therefore this removal is not accompanied by deprecation.

Dependency changes

• scikit-learn, typing-extensions, and pytest are no longer core dependencies. pytest remains a dependency in dev and test dependency sets.

• scikit-learn is now part of the dev and test dependency sets, as it is required to test compatibility with scikit-learn

• a dependency conflict has been resolved in the docs dependency set for the docs build, by pinning versions

Maintenance

• [MNT] remove dependency on typing-extensions (167) fkiraly

• [MNT] remove dependency on pytest (168) fkiraly

• [MNT] remove dependency on scikit-learn (171) fkiraly

• [MNT] add scikit-learn to test dependency set (172) fkiraly

• [MNT] remove fail-fast flag in CI (169) fkiraly

• [MNT] resolve dependency conflict in docs dependency set (173) fkiraly

Small bugfix patch for pydata 2023 Seattle notebooks.

Fixes

[BUG] fix html display for meta-objects ( #160 ) @fkiraly

[BUG] Fix all_objects lookup, broken tag filter ( #161 ) @fkiraly

Small bugfix patch for pydata 2023 Seattle notebooks.

Fixes

• [BUG] fix html display for meta-objects (160) fkiraly

• [BUG] Fix all_objects lookup, broken tag filter (161) fkiraly

Highlights

classes for heterogeneous collections aka meta-objects: BaseMetaObject and BaseMetaEstimator , based on sklearn and sktime ( #107 , #155 )

skbase native get_params and get_fitted_params interface, both with deep argument ( #115 , #117 ) @fkiraly

tag and config manager for objects, with get_tag , set_tag , get_config , set_config , etc ( #138 , #140 , #155 ) @fkiraly

sklearn style pretty printing, configurable via tags ( #156 ) @fkiraly , @RNKuhns

Enhancements

[ENH] Update meta classes and add unit tests ( #107 ) @RNKuhns

[ENH] skbase native get_params ( #115 ) @fkiraly

[ENH] ensure that all_objects always returns (class name/class) pairs ( #115 ) @fkiraly

[ENH] Initial type and named object validator code ( #122 ) @RNKuhns

[ENH] deep argument for get_fitted_params ( #117 ) @fkiraly

[ENH] Improve skbase.utils module structure ( #126 ) @RNKuhns

[ENH] Add object_type param to named object check ( #136 ) @RNKuhns

[ENH] tag manager mixin ( #138 ) @fkiraly

[ENH] sync TestAllObjects with sktime ( #139 ) @fkiraly

[ENH] object config interface ( #140 ) @fkiraly

[ENH] tag logic mixin for meta-estimators ( #155 ) @fkiraly

[ENH] sklearn style pretty printing ( #156 ) @fkiraly , @RNKuhns

Fixes

[BUG] fix faulty BaseObject.eq and deep_equals if an attribute or nested structure contains np.nan ( #111 ) @fkiraly

[BUG] Fix type error bug ( #130 ) @RNKuhns

[BUG] fix unreported return type bug of BaseFixtureGenerator.is_excluded ( #142 ) @fkiraly

Documentation

[DOC] Update installation guide to build skbase in a virtual env ( #157 ) @achieveordie

[DOC] fix odd author formatting on pypi ( #157 ) @fkiraly

Maintenance

[MNT] Create Issue and PR Templates ( #157 ) @RNKuhns

[MNT] Update pydocstyle in pre-commit config ( #108 ) @RNKuhns

[MNT] Handle updates to pre-commit linters ( #120 ) @RNKuhns

[MNT] numpy as a soft dependency ( #121 ) @RNKuhns

[MNT] Add stacklevel to warnings.warn calls ( #137 ) @RNKuhns

[MNT] Add vs code settings and auto generated api area to .gitignore ( #143 ) @RNKuhns

[MNT] Update slack to point to skbase workspace ( #148 ) @RNKuhns

Contributors

@achieveordie , @fkiraly , @rnkuhns

Highlights

• classes for heterogeneous collections aka meta-objects: BaseMetaObject and BaseMetaEstimator, based on sklearn and sktime (107, 155)

• skbase native get_params and get_fitted_params interface, both with deep argument (115, 117) fkiraly

• tag and config manager for objects, with get_tag, set_tag, get_config, set_config, etc (138, 140, 155) fkiraly

• sklearn style pretty printing, configurable via tags (156) fkiraly, RNKuhns

Enhancements

• [ENH] Update meta classes and add unit tests (107) RNKuhns

• [ENH] skbase native get_params (115) fkiraly

• [ENH] ensure that all_objects always returns (class name/class) pairs (115) fkiraly

• [ENH] Initial type and named object validator code (122) RNKuhns

• [ENH] deep argument for get_fitted_params (117) fkiraly

• [ENH] Improve skbase.utils module structure (126) RNKuhns

• [ENH] Add object_type param to named object check (136) RNKuhns

• [ENH] tag manager mixin (138) fkiraly

• [ENH] sync TestAllObjects with sktime (139) fkiraly

• [ENH] object config interface (140) fkiraly

• [ENH] tag logic mixin for meta-estimators (155) fkiraly

• [ENH] sklearn style pretty printing (156) fkiraly, RNKuhns

Fixes

• [BUG] fix faulty BaseObject.__eq__ and deep_equals if an attribute or nested structure contains np.nan (111) fkiraly

• [BUG] Fix type error bug (130) RNKuhns

• [BUG] fix unreported return type bug of BaseFixtureGenerator.is_excluded (142) fkiraly

Documentation

• [DOC] Update installation guide to build skbase in a virtual env (157) achieveordie

• [DOC] fix odd author formatting on pypi (157) fkiraly

Maintenance

• [MNT] Create Issue and PR Templates (157) RNKuhns

• [MNT] Update pydocstyle in pre-commit config (108) RNKuhns

• [MNT] Handle updates to pre-commit linters (120) RNKuhns

• [MNT] numpy as a soft dependency (121) RNKuhns

• [MNT] Add stacklevel to warnings.warn calls (137) RNKuhns

• [MNT] Add vs code settings and auto generated api area to .gitignore (143) RNKuhns

• [MNT] Update slack to point to skbase workspace (148) RNKuhns

Contributors

achieveordie, fkiraly, rnkuhns

Highlights

Reorganized package functionality into submodules focused on specific functionality ( #78 ):

skbase.base for BaseObject , BaseEstimator and other base classes

skbase.testing for functionality to test BaseObject -s

skbase.lookup for retrieving metadata and all BaseObject -s from a package

skbase.validate for comparing and validating BaseObject -s

Expanded test coverage of skbase.base and skbase.lookup modules and skbase exceptions ( #62 , #80 , #91 ) @rnkuhns

Add equality dunder to BaseObject to allow BaseObject -s to be compared based on parameter equality ( #86 ) @fkiraly

Add sktime -like interface for retrieving fitted parameters to BaseEstimator ( #87 ) @fkiraly

Enhancements

Reorganized package functionality into submodules focused on specific functionality ( #78 ) @rnkuhns

Add equality dunder to BaseObject to allow BaseObject -s to be compared based on parameter equality ( #86 ) @fkiraly

Add sktime -like interface for retrieving fitted parameters to BaseEstimator ( #87 ) @fkiraly

Rename QuickTester.run_tests parameter return_exceptions to raise_exceptions ( #95 ) @fkiraly

Fixes

Fix all_objects retrieval functionality ( #69 ) @fkiraly

Fix issues identified by CodeQL scanning ( #79 ) @rnkuhns

Documentation

Switch from use of sphinx-panels to sphinx-design ( #93 ) @rnkuhns

Updated installation instructions, added release instructions and made other minor documentation improvements ( #100 ) @rnkuhns

Maintenance

Updated GitHub Action versions ( #60 ) @rnkuhns

Migrate from use of lgtm.com to CodeQL scanning built-in to GitHub ( #68 )

Update config files and remove use of setup.py ( #75 ) @rnkuhns

Add support for Python 3.11 ( #77 ) @rnkuhns

Update sklearns version upper bounds to <1.3 ( #89 ) @fkiraly

Contributors

@fkiraly , @rnkuhns

Highlights

• Reorganized package functionality into submodules focused on specific functionality (78):

  • skbase.base for BaseObject, BaseEstimator and other base classes

  • skbase.testing for functionality to test BaseObject-s

  • skbase.lookup for retrieving metadata and all BaseObject-s from a package

  • skbase.validate for comparing and validating BaseObject-s

• Expanded test coverage of skbase.base and skbase.lookup modules and skbase exceptions (62, 80, 91) rnkuhns

• Add equality dunder to BaseObject to allow BaseObject-s to be compared based on parameter equality (86) fkiraly

• Add sktime-like interface for retrieving fitted parameters to BaseEstimator (87) fkiraly

Enhancements

• Reorganized package functionality into submodules focused on specific functionality (78) rnkuhns

• Add equality dunder to BaseObject to allow BaseObject-s to be compared based on parameter equality (86) fkiraly

• Add sktime-like interface for retrieving fitted parameters to BaseEstimator (87) fkiraly

• Rename QuickTester.run_tests parameter return_exceptions to raise_exceptions (95) fkiraly

Fixes

• Fix all_objects retrieval functionality (69) fkiraly

• Fix issues identified by CodeQL scanning (79) rnkuhns

Documentation

• Switch from use of sphinx-panels to sphinx-design (93) rnkuhns

• Updated installation instructions, added release instructions and made other minor documentation improvements (100) rnkuhns

Maintenance

• Updated GitHub Action versions (60) rnkuhns

• Migrate from use of lgtm.com to CodeQL scanning built-in to GitHub (68)

• Update config files and remove use of setup.py (75) rnkuhns

• Add support for Python 3.11 (77) rnkuhns

• Update sklearn``s version upper bounds to ``<1.3 (89) fkiraly

Contributors

fkiraly, rnkuhns