Skip to content

Commit edde7c7

Browse files
authored
DOC add IterativeReweightedL1 to doc + few cosmetic backticks (#140)
1 parent 4cf5976 commit edde7c7

File tree

3 files changed

+12
-10
lines changed

3 files changed

+12
-10
lines changed

doc/api.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,5 @@ Experimental
9090
:toctree: generated/
9191

9292
SqrtLasso
93-
PDCD_WS
93+
PDCD_WS
94+
IterativeReweightedL1

skglm/estimators.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -163,15 +163,15 @@ class GeneralizedLinearEstimator(LinearModel):
163163
Parameters
164164
----------
165165
datafit : instance of BaseDatafit, optional
166-
Datafit. If None, `datafit` is initialized as a `Quadratic` datafit.
167-
`datafit` is replaced by a JIT-compiled instance when calling fit.
166+
Datafit. If None, `datafit` is initialized as a ``Quadratic`` datafit.
167+
``datafit`` is replaced by a JIT-compiled instance when calling fit.
168168
169169
penalty : instance of BasePenalty, optional
170-
Penalty. If None, `penalty` is initialized as a `L1` penalty.
171-
`penalty` is replaced by a JIT-compiled instance when calling fit.
170+
Penalty. If None, `penalty` is initialized as a ``L1`` penalty.
171+
``penalty`` is replaced by a JIT-compiled instance when calling fit.
172172
173173
solver : instance of BaseSolver, optional
174-
Solver. If None, `solver` is initialized as an `AndersonCD` solver.
174+
Solver. If None, ``solver`` is initialized as an ``AndersonCD`` solver.
175175
176176
Attributes
177177
----------

skglm/experimental/reweighted.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,16 @@ class IterativeReweightedL1(GeneralizedLinearEstimator):
1313
1414
Parameters
1515
----------
16-
alpha : float, optional
17-
Penalty strength.
18-
1916
datafit : instance of BaseDatafit, optional
2017
Datafit. If None, ``datafit`` is initialized as a ``Quadratic`` datafit.
2118
``datafit`` is replaced by a JIT-compiled instance when calling fit.
2219
20+
penalty : instance of BasePenalty, optional
21+
Penalty. If None, `penalty` is initialized as a ``L0_5`` penalty.
22+
`penalty` is replaced by a JIT-compiled instance when calling fit.
23+
2324
solver : instance of BaseSolver, optional
24-
Solver. If None, `solver` is initialized as an `AndersonCD` solver.
25+
Solver. If None, ``solver`` is initialized as an ``AndersonCD`` solver.
2526
2627
n_reweights : int, optional
2728
Number of reweighting performed (convex surrogates solved).

0 commit comments

Comments
 (0)