From 3f74722385f5804432bc1424c79024b824a04404 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franz=20Kir=C3=A1ly?= Date: Sat, 3 Aug 2024 11:44:51 +0100 Subject: [PATCH] Release 2.5.0 (#444) Release PR for 2.5.0 * changelog * version bump --- README.md | 2 +- docs/source/_static/switcher.json | 7 +++- docs/source/changelog.rst | 60 +++++++++++++++++++++++++++++++ pyproject.toml | 2 +- skpro/__init__.py | 2 +- 5 files changed, 69 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2a7d2652..19284120 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -:rocket: **Version 2.4.2 out now!** [Read the release notes here.](https://skpro.readthedocs.io/en/latest/changelog.html). +:rocket: **Version 2.5.0 out now!** [Read the release notes here.](https://skpro.readthedocs.io/en/latest/changelog.html). `skpro` is a library for supervised probabilistic prediction in python. It provides `scikit-learn`-like, `scikit-base` compatible interfaces to: diff --git a/docs/source/_static/switcher.json b/docs/source/_static/switcher.json index 26f61a63..c420d8df 100644 --- a/docs/source/_static/switcher.json +++ b/docs/source/_static/switcher.json @@ -5,7 +5,12 @@ "url": "https://skpro.readthedocs.io/en/latest/" }, { - "name": "2.4.2 (stable)", + "name": "2.5.0 (stable)", + "version": "stable", + "url": "https://skpro.readthedocs.io/en/v2.5.0/" + }, + { + "name": "2.4.2", "version": "stable", "url": "https://skpro.readthedocs.io/en/v2.4.2/" }, diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index 9a8b2dca..28957158 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -16,6 +16,66 @@ For planned changes and upcoming releases, see roadmap in the `issue tracker `_. +[2.5.0] - 2024-08-02 +==================== + +Maintenance release with scheduled deprecations and updates. + +Kindly also note the python 3.8 End-of-life warning below. + +Dependency changes +~~~~~~~~~~~~~~~~~~ + +* ``polars`` (data container soft dependency) bounds have been updated to ``<1.5.0``. + +Deprecations and removals +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Python 3.8 End-of-life +^^^^^^^^^^^^^^^^^^^^^^ + +``skpro`` now requires Python version ``>=3.9``. +No errors will be raised on Python 3.8, but test coverage and support for +Python 3.8 has been dropped. + +Kindly note for context: python 3.8 will reach end of life +in October 2024, and multiple ``skpro`` core dependencies, +including ``scikit-learn``, have already dropped support for 3.8. + +Probability distributions +^^^^^^^^^^^^^^^^^^^^^^^^^ + +* In QPD distributions, deprecated parameters ``dist_shape``, ``version`` + have been removed entirely. Instead of ``version``, users should use + ``base_dist``. Instead of ``dist_shape``, users should pass an ``skpro`` + distribution to ``base_dist``, with the desired shape parameters. + +Probabilistic regression +^^^^^^^^^^^^^^^^^^^^^^^^ + +* in probabilistic regressor tuners ``GridSearchCV``, ``RandomizedSearchCV``, + use of ``joblib`` backend specific parameters ``n_jobs``, + ``pre_dispatch`` have been removed. + Users should pass backend parameters via the ``backend_params`` parameter instead. +* in ``GLMRegressor``, parameters have been reordered to be consistent with + the docstring, after a deprecation period. + +Contents +~~~~~~~~ + +* [MNT] python 3.8 end-of-life - remove 3.8 support and tags (:pr:`443`) :user:`fkiraly` +* [MNT] 2.5.0 deprecations and change actions (:pr:`443`) :user:`fkiraly` +* [MNT] ensure ``CyclicBoosting`` is consistent with deprecations in ``QPD_Johnson`` (:pr:`446`) :user:`fkiraly` +* [MNT] [Dependabot](deps): Update ``polars`` requirement from ``<1.3.0`` to ``<1.5.0``(:pr:`442`) :user:`dependabot[bot]` +* [MNT] release workflow: Upgrade deprecated pypa action parameter #6878 (:pr:`445`) :user:`szepeviktor` + +Contributors +~~~~~~~~~~~~ + +:user:`fkiraly`, +:user:`szepviktor` + + [2.4.2] - 2024-08-02 ==================== diff --git a/pyproject.toml b/pyproject.toml index 73a970c9..457297eb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "skpro" -version = "2.4.2" +version = "2.5.0" description = "A unified framework for probability distributions and probabilistic supervised regression" authors = [ {name = "skpro developers", email = "sktime.toolbox@gmail.com"}, diff --git a/skpro/__init__.py b/skpro/__init__.py index 31b4fcb2..3a89c9a8 100644 --- a/skpro/__init__.py +++ b/skpro/__init__.py @@ -1,6 +1,6 @@ """skpro.""" -__version__ = "2.4.2" +__version__ = "2.5.0" __all__ = ["show_versions"]