Merge pull request #1 from floriankozikowski/elasticnet

Docstring update for ElasticNet in SparseLogisticRegression (completes #244)

Author: floriankozikowski

doc/changes/0.4.rst

@@ -6,7 +6,7 @@ Version 0.4 (in progress)
 - Add support and tutorial for positive coefficients to :ref:`Group Lasso Penalty <skglm.penalties.WeightedGroupL2>` (PR: :gh:`221`)
 - Check compatibility with datafit and penalty in solver (PR :gh:`137`)
 - Add support to weight samples in the quadratic datafit :ref:`Weighted Quadratic Datafit <skglm.datafit.WeightedQuadratic>` (PR: :gh:`258`)
-
+- Add support for ElasticNet regularization (`penalty="l1_plus_l2"`) to :ref:`SparseLogisticRegression <skglm.SparseLogisticRegression>` (PR: :gh:`244`)
 
 Version 0.3.1 (2023/12/21)
 --------------------------

skglm/estimators.py

@@ -959,19 +959,28 @@ class SparseLogisticRegression(LinearClassifierMixin, SparseCoefMixin, BaseEstim
 
     The optimization objective for sparse Logistic regression is:
 
-    .. math:: 1 / n_"samples" sum_(i=1)^(n_"samples") log(1 + exp(-y_i x_i^T w))
-        + alpha ||w||_1
+    .. math:: 
+        \frac{1}{n_{\text{samples}}} \sum_{i=1}^{n_{\text{samples}}}
+        \log\left(1 + \exp(-y_i x_i^T w)\right)
+        + \alpha \cdot \left( \text{l1_ratio} \cdot \|w\|_1 +
+        (1 - \text{l1_ratio}) \cdot \|w\|_2^2 \right)
+    
+    By default, ``l1_ratio=1.0`` corresponds to Lasso (pure L1 penalty).
+    When ``0 < l1_ratio < 1``, the penalty is a convex combination of L1 and L2
+    (i.e., ElasticNet). ``l1_ratio=0.0`` corresponds to Ridge (pure L2), but note
+    that pure Ridge is not typically used with this class.
 
     Parameters
     ----------
     alpha : float, default=1.0
         Regularization strength; must be a positive float.
 
     l1_ratio : float, default=1.0
-        The ElasticNet mixing parameter, with ``0 <= l1_ratio <= 1``. For
-        ``l1_ratio = 0`` the penalty is an L2 penalty. ``For l1_ratio = 1`` it
-        is an L1 penalty.  For ``0 < l1_ratio < 1``, the penalty is a
-        combination of L1 and L2.
+        The ElasticNet mixing parameter, with ``0 <= l1_ratio <= 1``.
+        Only used when ``penalty="l1_plus_l2"``. 
+        For ``l1_ratio = 0`` the penalty is an L2 penalty. 
+        ``For l1_ratio = 1`` it is an L1 penalty.  
+        For ``0 < l1_ratio < 1``, the penalty is a combination of L1 and L2.
 
     tol : float, optional
         Stopping criterion for the optimization.