Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.7.0 #261

Merged
merged 3 commits into from
Jan 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/source/_static/switcher.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@
"url": "https://skbase.readthedocs.io/en/latest/"
},
{
"name": "0.6.2 (stable)",
"name": "0.7.0 (stable)",
"version": "stable",
"url": "https://skbase.readthedocs.io/en/v0.7.0/"
},
{
"name": "0.6.2",
"version": "stable",
"url": "https://skbase.readthedocs.io/en/v0.6.2/"
},
Expand Down
37 changes: 37 additions & 0 deletions docs/source/user_documentation/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,43 @@ You can also subscribe to ``skbase``'s
For planned changes and upcoming releases, see our :ref:`roadmap`.


[0.7.0] - 2023-01-03
====================

Bugfix release with potentially breaking changes related to
``set_config``, ``get_config`` (:pr:`257`, :pr:`259`, :user:`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`` (:pr:`260`) :user:`fkiraly`
* [BUG] retain config at ``reset``, add tests for ``set_config``, ``get_config``
(:pr:`259`) :user:`fkiraly`
* [BUG] retain config after ``clone``, add config to configure whether to clone config
(:pr:`257`) :user:`fkiraly`


[0.6.2] - 2023-12-30
====================

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "scikit-base"
version = "0.6.2"
version = "0.7.0"
description = "Base classes for sklearn-like parametric objects"
authors = [
{name = "sktime developers", email = "sktime.toolbox@gmail.com"},
Expand Down
2 changes: 1 addition & 1 deletion skbase/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
The included functionality makes it easy to reuse scikit-learn and
sktime design principles in your project.
"""
__version__: str = "0.6.2"
__version__: str = "0.7.0"
Loading