diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst index d1d64959..bc89eae4 100644 --- a/docs/source/changelog.rst +++ b/docs/source/changelog.rst @@ -20,40 +20,62 @@ For planned changes and upcoming releases, see roadmap in the ==================== Highlights ----------- +~~~~~~~~~~ Enhancements ~~~~~~~~~~~~ +Data types, checks, conversions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +* [ENH] Syncing datatypes module ``_check.py`` and ``_convert.py`` with ``sktime`` (:pr:`432`) :user:`julian-fong` + Probability distributions -~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ + +* [ENH] Inverse Gamma distribution (:pr:`415`) :user:`meraldoantonio` +* [ENH] Truncated Normal distribution (:pr:`421`) :user:`ShreeshaM07` Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ + +* [ENH] Multiclass classification reduction using Histograms (:pr:`410`) :user:`ShreeshaM07` +* [ENH] ``DummyProbaRegressor`` - probabilistic dummy regressor (:pr:`437`) :user:`julian-fong` Test framework -~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^ +* [ENH] differential testing for CI tests (:pr:`435`) :user:`fkiraly` Fixes ~~~~~ Probability distributions -~~~~~~~~~~~~~~~~~~~~~~~~~ - -Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ +* [BUG] Histogram Distribution: address ``np.broadcast_arrays`` deprecation of writable return in ``numpy 2.0.0`` (:pr:`414`) :user:`ShreeshaM07` Maintenance ~~~~~~~~~~~ -Documentation -~~~~~~~~~~~~~ +* [MNT] [Dependabot](deps): Update scikit-survival requirement from <0.23.0 to <0.24.0 (:pr:`419`) :user:`dependabot[bot]` +* [MNT] [Dependabot](deps): Update polars requirement from <0.21.0 to <1.1.0 (:pr:`418`) :user:`dependabot[bot]` +* [MNT] [Dependabot](deps): Update polars requirement from <1.1.0 to <1.2.0 (:pr:`420`) :user:`dependabot[bot]` +* [MNT] [Dependabot](deps): Update polars requirement from <1.2.0 to <1.3.0 (:pr:`425`) :user:`dependabot[bot]` +* [MNT] [Dependabot](deps): Update sphinx-gallery requirement from <0.17.0 to <0.18.0 (:pr:`431`) :user:`dependabot[bot]` +* [MNT] sync differential testing utilities with ``sktime`` (:pr:`434`) :user:`fkiraly` +* [MNT] fix ``numpy 2`` incompatibility of ``Pareto`` distribution (:pr:`436`) :user:`fkiraly` +* [MNT] [Dependabot](deps): Update sphinx requirement from !=7.2.0,<8.0.0 to !=7.2.0,<9.0.0 (:pr:`438`) :user:`dependabot[bot]` Contributors ~~~~~~~~~~~~ +:user:`fkiraly`, +:user:`julian-fong`, +:user:`meraldoantonio`, +:user:`ShreeshaM07` + + [2.4.1] - 2024-06-26 ==================== @@ -72,7 +94,7 @@ Dependency changes * ``numpy`` bounds have been updated to ``>=1.21.0,<2.1.0``. Contents --------- + * [MNT] increase ``numpy`` bound to ``numpy < 2.1``, ``numpy 2`` compatibility (:pr:`393`) :user:`fkiraly` @@ -83,7 +105,7 @@ Contents ==================== Highlights ----------- +~~~~~~~~~~ * ``GLM`` now supports multiple ``distributions`` and ``link`` function (:pr:`384`) :user:`ShreeshaM07` @@ -100,7 +122,7 @@ Enhancements ~~~~~~~~~~~~ Probability distributions -~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] mean-scale family of distributions, composite (:pr:`282`) :user:`fkiraly` * [ENH] Half Normal Distribution (:pr:`363`) :user:`SaiRevanth25` @@ -111,13 +133,13 @@ Probability distributions * [ENH] Pareto distribution (:pr:`396`) :user:`sukjingitsit` Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] ``GLM`` with multiple ``distributions`` and ``link`` function support (:pr:`384`) :user:`ShreeshaM07` * [ENH] interval width and area under calibration curve metrics (:pr:`391`) :user:`fkiraly` Test framework -~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^ * [ENH] Tests for polars support for estimators (:pr:`370`) :user:`julian-fong` @@ -125,13 +147,13 @@ Fixes ~~~~~ Probability distributions -~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ * [BUG] fix ``test_methods_p`` logic when ``shuffle`` is ``True`` (:pr:`381`) :user:`ShreeshaM07` * [BUG] ensure ``index`` and ``columns`` are taken into account in broadcasting if ``bc_params`` are set (:pr:`403`) :user:`fkiraly` Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * [BUG] bugfix when ``None`` was specified for ``max_iter`` parameter in sklearn regressors (:pr:`386`) :user:`julian-fong` @@ -239,7 +261,7 @@ Contributors ==================== Highlights ----------- +~~~~~~~~~~ * new tutorial notebooks for survival prediction and probability distributions (:pr:`303`, :pr:`305`) :user:`fkiraly` * interface to ``ngboost`` probabilistic regressor and survival predictor (:pr:`215`, :pr:`301`, :pr:`309`, :pr:`332`) :user:`ShreeshaM07` @@ -328,7 +350,7 @@ Enhancements ~~~~~~~~~~~~ Probability distributions -~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] probability distributions - boilerplate refactor (:pr:`265`) :user:`fkiraly` * [ENH] probability distributions: convenience feature to coerce ``index`` and ``columns`` to ``pd.Index`` (:pr:`276`) :user:`fkiraly` @@ -357,7 +379,7 @@ Probability distributions * [ENH] improved defaults for ``BaseDistribution`` ``_mean``, ``_var``, and ``_energy_x`` (:pr:`330`) :user:`fkiraly` Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] interface to ``ngboost`` (:pr:`215`) :user:`ShreeshaM07` * [ENH] interfacing Poisson regressor from sklearn (:pr:`213`) :user:`nilesh05apr` @@ -372,7 +394,7 @@ Survival and time-to-event prediction * [ENH] in ``ConditionUncensored`` reducer, ensure coercion to float of ``C`` (:pr:`318`) :user:`fkiraly` Test framework -~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^ * [MNT] faster collection of differential tests through caching, test if pyproject change (:pr:`296`) :user:`fkiraly` @@ -380,7 +402,7 @@ Fixes ~~~~~ Probability distributions -~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ * [BUG] bugfixes for distribution base class default methods (:pr:`281`) :user:`fkiraly` * [BUG] fix ``Empirical`` index to be ``pd.MultiIndex`` for hierarchical data index (:pr:`286`) :user:`fkiraly` @@ -439,7 +461,7 @@ Contributors ==================== Highlights ----------- +~~~~~~~~~~ * ``lifelines`` predictive survival regressors are available as ``skpro`` estimators: accelerated failure time (Fisk, Log-normal, Weibull), CoxPH variants, @@ -456,7 +478,7 @@ 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 @@ -465,10 +487,10 @@ Probability distributions 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` @@ -483,7 +505,7 @@ Probability distributions * [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` @@ -497,34 +519,34 @@ Survival and time-to-event prediction * [ENH] log-logistic/Fisk AFT model from ``lifelines`` (:pr:`260`) :user:`fkiraly` Test framework -~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^ * [ENH] refactor test scenario creation to be lazy rather than on module load (:pr:`245`) :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` 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`, @@ -539,7 +561,7 @@ Contributors Minor bugfix and maintenance release. Contents --------- +~~~~~~~~ * [ENH] migrate tests of distribution prediction metrics to ``skbase`` class (:pr:`208`) :user:`fkiraly` @@ -552,7 +574,7 @@ Contents ==================== Highlights ----------- +~~~~~~~~~~ * interface to ``cyclic_boosting`` package (:pr:`144`) :user:`setoguchi-naoki`, :user:`FelixWick` * framework support for probabilistic survival/time-to-event prediction with right censored data (:pr:`157`) :user:`fkiraly` @@ -581,7 +603,7 @@ BaseObject and base framework abstract parallelization backend in ``sktime``. Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * all probabilistic regressors now accept an argument ``C`` in ``fit``, to pass censoring information. This is for API compatibility with survival @@ -615,7 +637,7 @@ Survival and time-to-event prediction information. Enhancements ------------- +~~~~~~~~~~~~ BaseObject and base framework ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -624,13 +646,13 @@ BaseObject and base framework (:pr:`187`) :user:`fkiraly` Probability distributions -~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] Johnson Quantile-Parameterized Distributions (QPD) with bounded and unbounded mode (:pr:`144`) :user:`setoguchi-naoki`, :user:`FelixWick` Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] Cyclic boosting interface (:pr:`144`) :user:`setoguchi-naoki`, :user:`FelixWick` * [ENH] abstract parallelization backend, refactor of ``evaluate`` and tuners, @@ -647,10 +669,10 @@ Survival and time-to-event prediction (:pr:`198`) :user:`fkiraly` Fixes ------ +~~~~~ Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * [BUG] fix API non-compliance in ``sklearn`` variance prediction adapter (:pr:`192`) :user:`fkiraly` * [BUG] fix defaulting logic for ``_predict_interval`` and ``_predict_quantiles`` when only ``_predict_var`` is implemented (:pr:`191`) :user:`fkiraly` @@ -658,18 +680,18 @@ Probabilistic regression * [BUG] fix fallback for ``pdfnorm`` method, add metrics to tests (:pr:`204`) :user:`fkiraly` Test framework -~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^ * [BUG] fix lookup for specialized test classes (:pr:`189`) :user:`fkiraly` Documentation -------------- +~~~~~~~~~~~~~ * [DOC] API reference for performance metrics (:pr:`206`) :user:`fkiraly` * [DOC] README update for 2.2.0 (:pr:`207`) :user:`fkiraly` Maintenance ------------ +~~~~~~~~~~~ * [MNT] [Dependabot](deps): Bump styfle/cancel-workflow-action from ``0.12.0`` to ``0.12.1`` (:pr:`183`) :user:`dependabot` * [MNT] skip ``CyclicBoosting`` and QPD tests until #189 failures are resolved (:pr:`193`) :user:`fkiraly` @@ -678,7 +700,7 @@ Maintenance * [MNT] [Dependabot](deps): Bump pre-commit/action from ``3.0.0`` to ``3.0.1`` (:pr:`202`) :user:`dependabot` Contributors ------------- +~~~~~~~~~~~~ :user:`FelixWick`, :user:`fkiraly`, @@ -715,13 +737,13 @@ Probabilistic regression interface. Enhancements ------------- +~~~~~~~~~~~~ * [ENH] in ``BaseRegressorProba.fit``, use ``"feature_names"`` metadata field to store feature names and write to ``self`` in ``fit`` (:pr:`180`) :user:`dependabot` Maintenance ------------ +~~~~~~~~~~~ * [MNT] [Dependabot](deps): Bump ``actions/dependency-review-action`` from 3 to 4 (:pr:`178`) :user:`dependabot` @@ -737,7 +759,7 @@ Maintenance ==================== Highlights ----------- +~~~~~~~~~~ * ``sklearn`` based probabilistic regressors - Gaussian processes, Bayesian linear regression (:pr:`166`) :user:`fkiraly` * ``SklearnProbaReg`` - general interface adapter to ``sklearn`` regressors with variance prediction model (:pr:`163`) :user:`fkiraly` @@ -749,21 +771,21 @@ Dependency changes * ``polars`` (data container soft dependency) bounds have been updated to allow python 3.12. Enhancements ------------- +~~~~~~~~~~~~ Data types, checks, conversions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] ``n_features`` and ``feature_names`` metadata field for table mtypes (:pr:`150`) :user:`fkiraly` * [ENH] ``check_is_mtype`` dict type return, improved input check error messages in ``BaseRegressorProba`` (:pr:`151`) :user:`fkiraly` Probability distributions -~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] adapter from ``scipy`` ``rv_discrete`` to ``skpro`` ``Empirical`` (:pr:`155`) :user:`fkiraly` Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] ``sklearn`` wrappers to str-coerce columns of ``pd.DataFrame`` before passing (:pr:`148`) :user:`fkiraly` * [ENH] clean up copy-paste leftovers in ``BaseProbaRegressor`` (:pr:`156`) :user:`fkiraly` @@ -772,26 +794,26 @@ Probabilistic regression * [ENH] interfacing all concrete ``sklearn`` probabilistic regressors (:pr:`166`) :user:`fkiraly` Test framework -~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^ * [ENH] scenario tests for mixed ``pandas`` column index types (:pr:`145`) :user:`fkiraly` * [ENH] scitype inference utility, test class register, test class test condition (:pr:`159`) :user:`fkiraly` Fixes ------ +~~~~~ Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * [BUG] in probabilistic regressors, ensure correct index treatment if ``X: pd.DataFrame`` and ``y: np.ndarray`` are passed (:pr:`146`) :user:`fkiraly` Documentation -------------- +~~~~~~~~~~~~~ * [DOC] update ``AUTHORS.rst`` file (:pr:`147`) :user:`fkiraly` Maintenance ------------ +~~~~~~~~~~~ * [MNT] [Dependabot](deps): Bump ``actions/upload-artifact`` from 3 to 4 (:pr:`154`) :user:`dependabot` * [MNT] [Dependabot](deps): Bump ``actions/download-artifact`` from 3 to 4 (:pr:`153`) :user:`dependabot` @@ -807,7 +829,7 @@ Maintenance ==================== Highlights ----------- +~~~~~~~~~~ * probabilistic regressor: multiple quantile regression (:pr:`108`) :user:`Ram0nB` * probabilistic regressor: interface to ``MapieRegressor`` from ``mapie`` package @@ -815,15 +837,15 @@ Highlights * framework support for ``polars`` via mtypes (:pr:`130`) :user:`fkiraly` Enhancements ------------- +~~~~~~~~~~~~ Data types, checks, conversions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] ``polars`` mtypes for data tables (:pr:`130`) :user:`fkiraly` Probabilistic regression -~~~~~~~~~~~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^^^^^^^^^^^ * [ENH] probabilistic regressors - input checks and support for more input types (:pr:`129`) :user:`fkiraly` @@ -831,7 +853,7 @@ Probabilistic regression * [ENH] interface ``MapieRegressor`` from ``mapie`` (:pr:`136`) :user:`fkiraly` Test framework -~~~~~~~~~~~~~~ +^^^^^^^^^^^^^^ * [ENH] integrate ``check_estimator`` with ``TestAllEstimators`` and ``TestAllRegressors`` for python command line estimator testing @@ -839,7 +861,7 @@ Test framework * [ENH] improved conditional testing (:pr:`140`) :user:`fkiraly` Documentation -------------- +~~~~~~~~~~~~~ * [DOC] fix math in ``plotting`` docstrings (:pr:`121`) :user:`fkiraly` * [DOC] improved probabilistic tabular regressor extension template @@ -847,21 +869,21 @@ Documentation * [DOC] typo fixes in regression extension template (:pr:`139`) :user:`fkiraly` Maintenance ------------ +~~~~~~~~~~~ * [MNT] point readthedocs ``json`` switcher variable to GitHub (:pr:`125`) :user:`fkiraly` * [MNT] change test OS versions to latest (:pr:`126`) :user:`fkiraly` Fixes ------ +~~~~~ * [BUG] fix test fixture generation logic (:pr:`142`) :user:`fkiraly` * [BUG] fix retrieval in ``all_objects`` if ``filter_tags`` is provided (:pr:`141`) :user:`fkiraly` Contributors ------------- +~~~~~~~~~~~~ :user:`fkiraly`, :user:`Ram0nB` @@ -885,17 +907,17 @@ Contents Release with minor maintenance actions and enhancements. Enhancements ------------- +~~~~~~~~~~~~ * [ENH] basic "test all estimators" suite (:pr:`89`) :user:`fkiraly` Documentation -------------- +~~~~~~~~~~~~~ * [DOC] improvements to notebook 1 (:pr:`106`) :user:`fkiraly` Maintenance ------------ +~~~~~~~~~~~ * [MNT] address deprecation of ``skbase.testing.utils.deep_equals`` (:pr:`111`) :user:`fkiraly` @@ -925,7 +947,7 @@ Contributions, bug reports, and feature requests are welcome on the `issue track or on the `community Discord `_. Contributors ------------- +~~~~~~~~~~~~ :user:`Alex-JG3`, :user:`fkiraly`, :user:`frthjf`