Skip to content

Commit

Permalink
Release 2.5.0 (#444)
Browse files Browse the repository at this point in the history
Release PR for 2.5.0

* changelog
* version bump
  • Loading branch information
fkiraly authored Aug 3, 2024
1 parent e7d1d38 commit 3f74722
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<a href="https://skpro.readthedocs.io/en/latest"><img src="https://github.com/sktime/skpro/blob/main/docs/source/images/skpro-banner.png" width="500" align="right" /></a>

: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:
Expand Down
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://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/"
},
Expand Down
60 changes: 60 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,66 @@ For planned changes and upcoming releases, see roadmap in the
`issue tracker <https://github.com/sktime/skpro/issues>`_.


[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
====================
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 = "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 = "[email protected]"},
Expand Down
2 changes: 1 addition & 1 deletion skpro/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""skpro."""

__version__ = "2.4.2"
__version__ = "2.5.0"

__all__ = ["show_versions"]

Expand Down

0 comments on commit 3f74722

Please sign in to comment.