Skip to content

Commit

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

* changelog
* version bump
  • Loading branch information
fkiraly authored Apr 20, 2024
1 parent 9c99e10 commit f8b1f2c
Show file tree
Hide file tree
Showing 5 changed files with 107 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.2.1 out now!** [Read the release notes here.](https://skpro.readthedocs.io/en/latest/changelog.html).
:rocket: **Version 2.2.2 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.2.1 (stable)",
"name": "2.2.2 (stable)",
"version": "stable",
"url": "https://skpro.readthedocs.io/en/v2.2.2/"
},
{
"name": "2.2.1",
"version": "stable",
"url": "https://skpro.readthedocs.io/en/v2.2.1/"
},
Expand Down
98 changes: 98 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,104 @@ You can also subscribe to ``skpro``'s

For planned changes and upcoming releases, see our :ref:`roadmap`.

[2.2.2] - 2023-04-20
====================

Highlights
----------

* ``lifelines`` predictive survival regressors are available as ``skpro`` estimators:
accelerated failure time (Fisk, Log-normal, Weibull), CoxPH variants,
Aalen additive model (:pr:`247`, :pr:`258`, :pr:`260`) :user:`fkiraly`
* ``scikit-survival`` predictive survival regressors are available as ``skpro`` estimators:
CoxPH variants, CoxNet, survival tree and forest, survival gradient boosting (:pr:`237`) :user:`fkiraly`
* GLM regressor`` using ``statsmodels`` ``GLM``, with Gaussian link (:pr:`222`) :user:`julian-fong`
* various survival type distributions added: log-normal, logistic, Fisk (=log-logistic), Weibull
(:pr:`218`, :pr:`241`, :pr:`242`, :pr:`259`) :user:`bhavikar`, :user:`malikrafsan`, :user:`fkiraly`
* Poisson distribution added (:pr:`226`) :user:`fkiraly`


Core interface changes
~~~~~~~~~~~~~~~~~~~~~~

Probability distributions
~~~~~~~~~~~~~~~~~~~~~~~~~

* Probability distributions (``BaseDistribution``) now have a ``len`` method,
which returns the number of number of rows of the distribution, this is the same
as the ``len`` of a ``pd.DataFrame`` returned by ``sample``.
* the interface now supports discrete distributions and those with integer support.
Such distributions implement ``pmf`` and ``log_pmf`` methods.

Enhancements
------------

Probability distributions
~~~~~~~~~~~~~~~~~~~~~~~~~

* [ENH] Log-normal probability distribution (:pr:`218`) :user:`bhavikar`
* [ENH] Poisson distribution (:pr:`226`) :user:`fkiraly`
* [ENH] make ``Empirical`` distribution compatible with multi-index rows (:pr:`233`) :user:`fkiraly`
* [ENH] empirical quantile parameterized distribution (:pr:`236`) :user:`fkiraly`
* [ENH] add ``len`` of ``BaseDistribution``, test ``shape``, ``len``, indices (:pr:`239`) :user:`fkiraly`
* [ENH] Logistic distribution (:pr:`241`) :user:`malikrafsan`
* [ENH] Weibull distribution (:pr:`242`) :user:`malikrafsan`
* [ENH] delegator class for distributions (:pr:`252`) :user:`fkiraly`
* [ENH] Johnson QP-distributions - add some missing capability tags (:pr:`253`) :user:`fkiraly`
* [ENH] remove stray ``_get_bc_params`` from ``LogNormal`` (:pr:`256`) :user:`fkiraly`
* [ENH] Fisk distribution aka log-logistic distribution (:pr:`259`) :user:`fkiraly`

Probabilistic regression
~~~~~~~~~~~~~~~~~~~~~~~~

* [ENH] ``GLMRegressor`` using statsmodels ``GLM`` with Gaussian link (:pr:`222`) :user:`julian-fong`
* [ENH] added test parameters for probabilistic metrics (:pr:`234`) :user:`fkiraly`

Survival and time-to-event prediction
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* [ENH] adapter to ``scikit-survival``, all distributional survival regressors interfaced (:pr:`237`) :user:`fkiraly`
* [ENH] adapter to ``lifelines``, most distributional survival regressors interfaced (:pr:`247`) :user:`fkiraly`
* [ENH] log-normal AFT model from ``lifelines``(:pr:`258`) :user:`fkiraly`
* [ENH] log-logistic/Fisk AFT model from ``lifelines`` (:pr:`260`) :user:`fkiraly`

Fixes
-----

Probability distributions
~~~~~~~~~~~~~~~~~~~~~~~~~

* [BUG] bugfixes to QPD distributions - ``QPD_U``, ``QPD_S`` (:pr:`194`) :user:`fkiraly`
* [BUG] fixes to lognormal distribution (:pr:`261`) :user:`fkiraly`

Test framework
~~~~~~~~~~~~~~

* [ENH] refactor test scenario creation to be lazy rather than on module load (:pr:`245`) :user:`fkiraly`

Documentation
-------------

* [DOC] documentation improvement for probabilistic metrics (:pr:`234`) :user:`fkiraly`
* [DOC] add :user:`julian-fong` to ``all-contributorsrc`` (:pr:`238`) :user:`fkiraly`
* [DOC] docstring with mathematical description for ``QPD_Empirical`` (:pr:`253`) :user:`fkiraly`

Maintenance
-----------

* [MNT] fix version pointer in readthedocs ``json`` (:pr:`225`) :user:`fkiraly`
* [MNT] fix broken api source links in latest docs version (:pr:`243`) :user:`duydl`

Contributors
------------

:user:`bhavikar`,
:user:`duydl`,
:user:`fkiraly`,
:user:`julian-fong`,
:user:`malikrafsan`


[2.2.1] - 2023-03-03
====================

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.2.1"
version = "2.2.2"
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.2.1"
__version__ = "2.2.2"

__all__ = ["show_versions"]

Expand Down

0 comments on commit f8b1f2c

Please sign in to comment.