MAINT - preparing changelog for 0.10 (#2205)

Author: rcap107

CHANGES.rst

@@ -11,15 +11,52 @@ Ongoing development
 
 New Features
 ------------
-- :func:`set_config` and :func:`config_context` now accept a
-  ``table_report_n_rows`` parameter to globally control the default number of
-  rows displayed in :class:`TableReport`.
-  :pr:`2193` by :user:`Mann <m4nn2609-dot>`.
+**Transformers**:
+
+- The :class:`SessionEncoder` is now available. This encoder adds a ``session_id``
+  column, which groups together events that occur within the given session gap.
+  Additionally, it is possible to provide a ``split_by`` column or list of columns
+  (e.g., user ID or (user ID, user device)) to compute sessions for each grouping
+  value.
+  :pr:`1930` by  :user:`Riccardo Cappuzzo <rcap107>`.
+- The :class:`DropSimilar` transformer has been added, for removing columns that
+  present high correlation with other columns in a dataframe . :pr:`2023` by
+  :user:`Eloi Massoulié <emassoulie>`.
+- :class:`ToFloat` now allows users to specify ``decimal`` and ``thousand``
+  separators to parse numerical columns that use formatting different from the default
+  formatting used in Python, such as ``1'234,5``.
+  Additionally, negative numbers indicated with parentheses can be converted to the
+  regular numeric format (``(432)`` becomes ``-432``). :pr:`1772` by :user:`Gabriela
+  Gómez Jiménez <gabrielapgomezji>`.
+- The transformer :class:`DurationToFloat` has been added. :pr:`2069` by
+  :user:`Riccardo Cappuzzo <rcap107>`.
+
+**TableReport**:
+
+- :meth:`TableReport.json` now includes histogram data for numeric and datetime
+  columns (the bin count and edges, and numbers of low and high outliers). Now
+  ``json()`` contains all the information shown in the report HTML rendering,
+  including the plots. The schema of the generated JSON is available at
+  :ref:`table_report_json_schema`.
+  :pr:`2164` by :user:`Jérôme Dockès <jeromedockes>`.
+- The :class:`TableReport` can now be exported in markdown format with
+  :func:`~skrub.TableReport.markdown`.
+  :pr:`2048` by :user:`Riccardo Cappuzzo <rcap107>`.
 - :meth:`TableReport.dict` now allows exporting the report data as a Python
   dictionary. :pr:`2188` by :user:`m4nn2609-dot <m4nn2609-dot>`.
-- New methods :meth:`SkrubLearner.get_named_params` and
-  :meth:`SkrubLearner.set_named_params` allow getting and setting the outcomes for
-  choices contained in the DataOp, keyed by choice name. It provides a more
+
+**Data Ops**:
+
+- :meth:`ParamSearch.plot_results` and :meth:`OptunaParamSearch.plot_results`
+  accept new parameters ``show_scores``, ``show_choices``, and ``show_times`` to
+  control respectively which scores, choices (params), and times (fit or score
+  durations) should be included in the figure. :pr:`2202` by :user:`Jérôme
+  Dockès <jeromedockes>`.
+- New :class:`SkrubLearner` methods
+  :meth:`SkrubLearner.get_named_params` and
+  :meth:`SkrubLearner.set_named_params` allow getting and
+  setting the outcomes for
+  choices contained in the DataOp, keyed by choice name. They provide a more
   robust way of transferring selected hyperparameters from one DataOp to a
   different one than :meth:`SkrubLearner.get_params` and
   :meth:`SkrubLearner.set_params`.
@@ -32,60 +69,30 @@ New Features
 - It is now possible to attach new preview values to the variables in a DataOp
   with :meth:`DataOp.skb.set_data`. :pr:`2081` by
   :user:`Jérôme Dockès <jeromedockes>`.
-- :class:`DataOp` objects have a new attribute :attr:`DataOp.skb.id` which
-  provides an alternative for referring to a node, in the environment passed to
+- :class:`DataOp` objects have a new attribute :attr:`DataOp.skb.id`.
+  :attr:`DataOp.skb.id`
+  provides an alternative for referring to a node in the environment passed to
   :meth:`DataOp.skb.eval`, :meth:`SkrubLearner.predict`, etc., or in
   :meth:`DataOp.skb.find` or :meth:`SkrubLearner.truncated_after`. :pr:`2062` by
   :user:`Jérôme Dockès <jeromedockes>`.
-- The :class:`SessionEncoder` is now available. This encoder adds a `session_id`
-  column, which groups together events that occur within the given session gap.
-  Additionally, it is possible to provide a ``split_by`` column or list of columns
-  (e.g., user ID or (user ID, user device)) to compute sessions for each grouping
-  value.
-  :pr:`1930` by  :user:`Riccardo Cappuzzo <rcap107>`.
--  A new synthetic dataset generator for timestamped data and session-based
+
+**Misc**:
+
+- A new synthetic dataset generator for timestamped data and session-based
   operations has been added: :meth:`~skrub.datasets.make_retail_events`.
   :pr:`1930` by  :user:`Riccardo Cappuzzo <rcap107>`.
-- The :class:`DropSimilar` transformer has been added, for removing columns in a
-  dataframe that present high correlation with other columns. :pr:`2023` by
-  :user:`Eloi Massoulié <emassoulie>`.
-- :class:`ToFloat32` now allows users to specify ``decimal`` and ``thousand``
-  separators to parse numerical columns that use formatting different from the default
-  formatting used in Python, such as ``1'234,5``.
-  Additionally, negative numbers indicated with parentheses can be converted to the
-  regular numeric format (``(432)`` becomes ``-432``). :pr:`1772` by :user:`Gabriela
-  Gómez Jiménez <gabrielapgomezji>`.
-- :meth:`TableReport.json` now includes histogram data for numeric and datetime
-  columns (the bin count and edges, and numbers of low and high outliers). Now
-  ``json()`` contains all the information shown in the report html rendering,
-  including the plots. :pr:`2164` by :user:`Jérôme Dockès <jeromedockes>`.
-- Added :func:`skrub.selectors.object` to select columns with the ``object``
-  (pandas) or ``pl.Object`` (polars) dtype. :pr:`2171` by :user:`Omkar Kabde
-  <omkar-334>`.
-- :meth:`ParamSearch.plot_results` and :meth:`OptunaParamSearch.plot_results`
-  accept new parameters ``show_scores``, ``show_choices``, and ``show_times`` to
-  control respectively which scores, choices (params), and times (fit or score
-  durations) should be included in the figure. :pr:`2202` by :user:`Jérôme
-  Dockès <jeromedockes>`.
+- Added the :func:`~skrub.selectors.object` selector to select columns with the
+  ``object`` (pandas) or ``pl.Object`` (polars) dtype. :pr:`2171` by
+  :user:`Omkar Kabde <omkar-334>`.
+- :func:`set_config` and :func:`config_context` now accept a
+  ``table_report_n_rows`` parameter to globally control the default number of
+  rows displayed in :class:`TableReport`.
+  :pr:`2193` by :user:`Mann <m4nn2609-dot>`.
 
 Changes
 -------
-- Grouped Examples into subject-specific sections. :pr:`2102` by
-  :user:`Maureen Githaiga <maureen-githaiga>`.
-- :meth:`choose_from` now transparently converts `outcomes` to a list when it is
-  another type of sequence. :pr:`2100` by :user:`aidbar <aidbar>`.
-- An unnecessary warning that was raised when passing a numpy array to the
-  TableVectorizer has been removed. :pr:`1908` by
-  :user:`Sandrine Henry <sandrineh>`.
-- Improving the association tab error message when only one column is present
-  :pr:`2094` by :user:`Alicja Kosak <AlicjaKo>`.
-- Added support for numpy arrays in :meth:`DataOp.skb.concat`.
-  :pr:`2096` by :user:`Ayesha Siddiqua <siddiqua-tamk>`.
-- The :class:`TableReport` can now be exported in markdown format with ``.markdown``.
-  :pr:`2048` by :user:`Riccardo Cappuzzo <rcap107>`.
-- The minimum required version of matplotlib has been increased from 3.4.3 to 3.6.1.
-  :pr:`2159` by :user:`Riccardo Cappuzzo <rcap107>`.
-- :meth:`SkrubLearner.score` has been enhanced when the DataOp used
+- :class:`SkrubLearner`'s :meth:`SkrubLearner.score`
+  has been enhanced when the DataOp used
   :meth:`DataOp.skb.with_scoring`. During scoring, predict(), predict_proba()
   etc. are cached to avoid recomputation when multiple scorers are used (or one
   scorer calls them several times). Moreover it is possible to pass
@@ -98,25 +105,39 @@ Changes
 - :meth:`SkrubLearner.find_fitted_estimator` now supports searching for the
   apply node by ID or callable predicate as alternatives to the node name.
   :pr:`2194` by :user:`Jérôme Dockès <jeromedockes>`.
+- The minimum required version of matplotlib has been increased from 3.4.3 to 3.6.1.
+  :pr:`2159` by :user:`Riccardo Cappuzzo <rcap107>`.
+- Gallery examples have been grouped into subject-specific sections. :pr:`2102` by
+  :user:`Maureen Githaiga <maureen-githaiga>`.
+- :meth:`choose_from` now transparently converts ``outcomes`` to a list when it is
+  another type of sequence. :pr:`2100` by :user:`aidbar <aidbar>`.
+- An unnecessary warning that was raised when passing a numpy array to the
+  TableVectorizer has been removed. :pr:`1908` by
+  :user:`Sandrine Henry <sandrineh>`.
+- The error message displayed in the Associations tab of the :class:`TableReport`
+  has been improved for reports where only one column is present.
+  :pr:`2094` by :user:`Alicja Kosak <AlicjaKo>`.
+- Added support for numpy arrays in :meth:`DataOp.skb.concat`.
+  :pr:`2096` by :user:`Ayesha Siddiqua <siddiqua-tamk>`.
 
 Bugfixes
 --------
-- :class:`MinHashEncoder` with the default ``hashing="fast"`` now uses every
-  n-gram size in ``ngram_range`` (the upper bound is inclusive, as documented
-  and as already done by ``hashing="murmur"``). Previously the largest size was
-  dropped, so the default ``ngram_range=(2, 4)`` ignored 4-grams and a
-  single-size range such as ``(3, 3)`` produced the same constant encoding for
-  every string. :pr:`2168` by :user:`José Maia <glitch-ux>`.
 - A bug in how the :class:`TableVectorizer` and :class:`Cleaner` treated columns
   duration columns in pandas and polars has been fixed. Now, both classes convert
   durations to the total number of seconds (with fractional part). This is done
   by the new transformer :class:`DurationToFloat`. :pr:`2069` by
   :user:`Riccardo Cappuzzo <rcap107>`.
-- An error that could arise when running ``TableReport`` on dataframes containing
+- An error that could arise when running :class:`TableReport` on dataframes containing
   double dollar (``$$``) signs has been fixed.
   :pr:`2154` by :user:`Katerina Michenina <Michenina-Lab>`,
   :user:`CecilyTS <CecilyTS>`, :user:`Eve Rabin <eve2705>`.
-- An error that happened when running ``TableReport`` or ``column_associations``
+- :class:`MinHashEncoder` with the default ``hashing="fast"`` now uses every
+  n-gram size in ``ngram_range`` (the upper bound is inclusive, as documented
+  and as already done by ``hashing="murmur"``). Previously the largest size was
+  dropped, so the default ``ngram_range=(2, 4)`` ignored 4-grams and a
+  single-size range such as ``(3, 3)`` produced the same constant encoding for
+  every string. :pr:`2168` by :user:`José Maia <glitch-ux>`.
+- An error that happened when running :class:`TableReport` or ``column_associations``
   on some dataframes with non-string column names has been fixed in :pr:`2179`
   by :user:`Jérôme Dockès <jeromedockes>`.
 - An error that could arise in histograms when running :class:`TableReport` on

README.rst

@@ -17,7 +17,7 @@ skrub
 .. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
 
 
-**skrub** (formerly *dirty_cat*) is a Python
+**skrub** is a Python
 library that facilitates machine learning with dataframes.
 
 If you like the package, spread the word and ⭐ this repository!

doc/api_reference.py

@@ -122,10 +122,12 @@
                 "description": None,
                 "autosummary": [
                     "SquashingScaler",
-                    "deduplicate",
                     "Cleaner",
                     "DropUninformative",
+                    "DropSimilar",
+                    "DurationToFloat",
                     "to_datetime",
+                    "deduplicate",
                 ],
             },
         ],