diff --git a/README.md b/README.md index 723712e4..7c227074 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ `skbase` provides base classes for creating scikit-learn-like parametric objects, along with tools to make it easier to build your own packages that follow these design patterns. -:rocket: Version 0.7.8 is now available. Check out our +:rocket: Version 0.8.0 is now available. Check out our [release notes](https://skbase.readthedocs.io/en/latest/changelog.html). | Overview | | diff --git a/docs/source/_static/switcher.json b/docs/source/_static/switcher.json index 9e02cfd0..644090a5 100644 --- a/docs/source/_static/switcher.json +++ b/docs/source/_static/switcher.json @@ -5,7 +5,12 @@ "url": "https://skbase.readthedocs.io/en/latest/" }, { - "name": "0.7.8 (stable)", + "name": "0.8.0 (stable)", + "version": "stable", + "url": "https://skbase.readthedocs.io/en/v0.8.0/" + }, + { + "name": "0.7.8", "version": "stable", "url": "https://skbase.readthedocs.io/en/v0.7.8/" }, diff --git a/docs/source/user_documentation/changelog.rst b/docs/source/user_documentation/changelog.rst index 24874a03..bb755164 100644 --- a/docs/source/user_documentation/changelog.rst +++ b/docs/source/user_documentation/changelog.rst @@ -14,6 +14,47 @@ You can also subscribe to ``skbase``'s For planned changes and upcoming releases, see our :ref:`roadmap`. +[0.8.0] - 2024-05-25 +==================== + +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 ot 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 + (:pr:`328`) :user:`fkiraly` +* [ENH] refactor - simplify ``all_objects`` logic and add cache for efficient lookup + (:pr:`331`) :user:`fkiraly` +* [ENH] ``all_objects`` retrieval filtered by regex applied to tag values, deprecation + of "has tag" condition in favour of "tag is True" (:pr:`329`) :user:`fkiraly` +* [MNT] [Dependabot](deps): Update ``sphinx-design`` requirement + from ``<0.6.0`` to ``<0.7.0`` (:pr:`332`) :user:`dependabot` + + [0.7.8] - 2024-05-10 ==================== diff --git a/pyproject.toml b/pyproject.toml index ae239073..b6d78ed1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "scikit-base" -version = "0.7.8" +version = "0.8.0" description = "Base classes for sklearn-like parametric objects" authors = [ {name = "sktime developers", email = "sktime.toolbox@gmail.com"}, diff --git a/skbase/__init__.py b/skbase/__init__.py index 11eac574..4a5b95b3 100644 --- a/skbase/__init__.py +++ b/skbase/__init__.py @@ -6,4 +6,4 @@ The included functionality makes it easy to reuse scikit-learn and sktime design principles in your project. """ -__version__: str = "0.7.8" +__version__: str = "0.8.0"