DOC - various fixes for the documentation (#1987)

Author: rcap107

CHANGES.rst

@@ -22,7 +22,7 @@ New Features
 - The reports produced by :meth:`DataOp.skb.full_report` and
   :meth:`SkrubLearner.report` now also display the values provided in the
   environment. :pr:`1920` by :user:`Jérôme Dockès <jeromedockes>`.
-- :class:`SkrubLearner`, :class:`ParamSearch` and :class:`OptunaSearch` expose
+- :class:`SkrubLearner`, :class:`ParamSearch` and :class:`OptunaParamSearch` expose
   some more attributes for inspection by scikit-learn: ``__sklearn_tags__``,
   ``classes_``, ``_estimator_type``. :pr:`1931` by :user:`Jérôme Dockès
   <jeromedockes>`.
@@ -54,10 +54,12 @@ Changes
   The default ``skrub_data`` folder can now be set in the skrub configuration and by setting
   the ``SKB_DATA_DIRECTORY`` environment variable. The environment variable ``SKRUB_DATA_DIRECTORY``
   is deprecated and will be removed in a future version of skrub.
-  :pr:`1852` by :user:`Riccardo Cappuzzo<rcap107>`.
-- :class:`core.SingleColumnTransformer` and associated exception :class:`core.RejectColumn` (used
-  internally by many skrub estimators) have been added to the public API, in the newly-created
-  :package:`skrub.core` module. :pr:`1851` by :user:`Eloi Massoulié <emassoulie>`.
+  :pr:`1852` by :user:`Riccardo Cappuzzo<rcap107>`. Examples in the gallery have
+  been updated accordingly in :pr:`1940` and :pr:`1964` by :user:`MuditAtrey <MuditAtrey>`.
+- :class:`~skrub.core.SingleColumnTransformer` and associated exception
+  :class:`~skrub.core.RejectColumn` (used internally by many skrub estimators) have
+  been added to the public API, in the newly-created ``skrub.core`` module.
+  :pr:`1851` by :user:`Eloi Massoulié <emassoulie>`.
 - Added the strings ``"None"`` and ``"none"`` to the list of null string values in
   :class:`Cleaner`. Also, exposed the list of null string values that will be set
   to null by the :class:`Cleaner` as the parameter ``null_strings``.
@@ -72,7 +74,7 @@ Changes
   or an instance of the :class:`Selector`.
   :pr:`1976` by :user:`Lisa McBride <lisaleemcb>`.
 - The overplotting of the counts atop the vertical histogram bars in the
-  :class:'TableReport' has been removed due to formatting issues.
+  :class:`TableReport` has been removed due to formatting issues.
   :pr:`1984` by :user:`Lisa McBride<lisaleemcb>`.
 
 Bug Fixes
@@ -87,18 +89,10 @@ Bug Fixes
   ``return_indices=True``. Now it returns the train and test indices of each
   fold in the ``train_indices`` and ``test_indices`` columns of the result
   dataframe. :pr:`1953` by :user:`Jérôme Dockès <jeromedockes>`.
-- :class:`CheckInputDataFrame` no longer collects Polars LazyFrames automatically;
-  a ``TypeError`` is now raised instead, consistent with the rest of the library.
+- Polars LazyFrames are no longer collected automatically anywhere in the library;
+  a ``TypeError`` is now raised instead.
   :pr:`1941` by :user:`Mudit Atrey <MuditAtrey>`.
-- :func:`fetch_employee_salaries` now correctly writes the train and test
-  split CSV files to their respective paths when ``split`` is specified.
-  :pr:`1964` by :user:`MuditAtrey <MuditAtrey>`.
 
-Documentation
--------------
-- Updated gallery examples to load datasets from their file paths using
-  ``pd.read_csv()``, following the pattern established in :pr:`1852`.
-  :pr:`1940` and :pr:`1964` by :user:`MuditAtrey <MuditAtrey>`.
 
 Release 0.7.2
 =============

doc/modules/column_level_featurizing/advanced_columnwise_operations.rst

@@ -3,6 +3,7 @@
 .. |ApplyToCols| replace:: :class:`ApplyToCols`
 .. |RejectColumn| replace:: :class:`core.RejectColumn`
 .. |SingleColumnTranformer| replace:: :class:`core.SingleColumnTranformer`
+.. |ToDatetime| replace:: :class:`ToDatetime`
 
 .. _user_guide_single_column_transformer:
 

doc/modules/configuration_and_utils/customizing_configuration.rst

@@ -59,7 +59,7 @@ These are the parameters currently available in the global configuration:
    * - ``table_report_verbosity``
      - ``1``
      - ``SKB_TABLE_REPORT_VERBOSITY``
-     - Set the verbosity of the :clas:`~skrub.TableReport`. If ``1``, print on screen the progress by column, if ``0`` print nothing.
+     - Set the verbosity of the :class:`~skrub.TableReport`. If ``1``, print on screen the progress by column, if ``0`` print nothing.
    * - ``max_plot_columns``
      - 30
      - ``SKB_MAX_PLOT_COLUMNS``

doc/modules/default_wrangling/apply_to_cols.rst

@@ -9,6 +9,7 @@
 .. |SingleColumnTransformer| replace:: :class:`~skrub.core.SingleColumnTransformer`
 .. |StandardScaler| replace:: :class:`~sklearn.preprocessing.StandardScaler`
 .. |OneHotEncoder| replace:: :class:`~sklearn.preprocessing.OneHotEncoder`
+.. |OrdinalEncoder| replace:: :class:`~sklearn.preprocessing.OrdinalEncoder`
 .. |make_pipeline| replace:: :class:`~sklearn.pipeline.make_pipeline`
 
 .. _user_guide_multiple_columns:

doc/modules/multi_column_operations/advanced_selectors.rst

@@ -1,6 +1,5 @@
 .. currentmodule:: skrub.selectors
 
-.. |ApplyToEachCol| replace:: :class:`~skrub.ApplyToEachCol`
 .. |StandardScaler| replace:: :class:`~sklearn.preprocessing.StandardScaler`
 .. |filter| replace:: :func:`filter`
 .. |filter_names| replace:: :func:`filter_names`
@@ -125,7 +124,3 @@ Select columns with at least 25% missing values:
 5             NaN       ...
 6             NaN       ...
 7           150.0       ...
-
-Example: Dropping columns with :func:`DropUninformative`
-..........................................................
-:ref:`user_guide_drop_uninformative`

examples/0000_getting_started.py

@@ -18,7 +18,7 @@
 .. |Joiner| replace:: :class:`~skrub.Joiner`
 .. |SquashingScaler| replace:: :class:`~skrub.SquashingScaler`
 .. |DatetimeEncoder| replace:: :class:`~skrub.DatetimeEncoder`
-.. |ApplyToEachCol| replace:: :class:`~skrub.ApplyToEachCol`
+.. |ApplyToCols| replace:: :class:`~skrub.ApplyToCols`
 .. |StringEncoder| replace:: :class:`~skrub.StringEncoder`
 .. |TextEncoder| replace:: :class:`~skrub.TextEncoder`
 """
@@ -158,7 +158,7 @@
 TableReport(data)
 # %%
 # Skrub transformers are applied column-by-column, but it's possible to use
-# the |ApplyToEachCol| meta-transformer to apply a transformer to
+# the |ApplyToCols| meta-transformer to apply a transformer to
 # multiple columns at once. Complex column selection is possible using
 # :ref:`skrub's column selectors <user_guide_selectors>`.
 

examples/0090_apply_to_cols.py

@@ -9,8 +9,6 @@
 and transforming dataframe columns using arbitrary logic.
 
 .. |ApplyToCols| replace:: :class:`~skrub.ApplyToCols`
-.. |ApplyToEachCol| replace:: :class:`~skrub.ApplyToEachCol`
-.. |ApplyToSubFrame| replace:: :class:`~skrub.ApplyToSubFrame`
 .. |StringEncoder| replace:: :class:`~skrub.StringEncoder`
 .. |SelectCols| replace:: :class:`~skrub.SelectCols`
 .. |DropCols| replace:: :class:`~skrub.DropCols`
@@ -106,7 +104,7 @@
 # .. admonition:: Under the hood of |ApplyToCols|
 #   :collapsible: closed
 #
-#   |ApplyToCols| is implemented using the |ApplyToEachCol| and |ApplyToSubFrame|
+#   |ApplyToCols| is implemented using the ``ApplyToEachCol`` and ``ApplyToSubFrame``
 #   classes.
 #   The former applies a transformer to each column independently, while the latter
 #   applies a transformer to a sub-dataframe.

skrub/_data_ops/_estimator.py

@@ -311,7 +311,8 @@ def find_fitted_estimator(self, name):
         -------
         scikit-learn estimator
             The fitted estimator. Depending on the nature of the estimator it
-            may be wrapped in a ``skrub.ApplyToEachCol`` or ``skrub.ApplyToSubFrame``,
+            may be wrapped in a ``skrub._apply_to_each_col.ApplyToEachCol``
+            or ``skrub._apply_to_sub_frame.ApplyToSubFrame``,
             see examples below.
 
         See also

skrub/_data_ops/_skrub_namespace.py

@@ -205,6 +205,7 @@ def apply(
         how : "auto", "cols", "frame" or "no_wrap", optional
             How the estimator is applied. In most cases the default "auto"
             is appropriate.
+
             - "cols" means `estimator` is wrapped in a :class:`ApplyToEachCol`
               transformer, which fits a separate clone of `estimator` each
               column in `cols`. `estimator` must be a transformer (have a
@@ -275,11 +276,8 @@ def apply(
         --------
         skrub.DataOp.skb.make_learner :
             Get a skrub learner for this DataOp.
-        skrub.ApplyToEachCol :
-            Transformer that applies a given transformer separately to each
-            selected column.
-        skrub.ApplyToSubFrame:
-            Transformer that applies a given transformer to part of a
+        skrub.ApplyToCols :
+            Transformer that applies a given estimator to selected columns of a
             dataframe.
 
         Examples

skrub/_similarity_encoder.py

@@ -177,7 +177,7 @@ class SimilarityEncoder(OneHotEncoder):
           column. The passed categories must be sorted and should not mix
           strings and numeric values.
 
-        The categories used can be found in the SimilarityEncoder.categories_
+        The categories used can be found in the :attr:`~skrub.SimilarityEncoder.categories_`
         attribute.
     dtype : number type, default=float64
         Desired dtype of output.