Skip to content

Commit 77a6c0a

Browse files
authored
DOC fix docs built for QuadraticGroup and WeightedGroupL2 (#31)
1 parent 9929e71 commit 77a6c0a

File tree

5 files changed

+7
-5
lines changed

5 files changed

+7
-5
lines changed

doc/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ Datafits
5151
.. autosummary::
5252
:toctree: generated/
5353

54-
GroupQuadratic
5554
Logistic
5655
Quadratic
56+
QuadraticGroup
5757
QuadraticSVC
5858

5959

skglm/datafits/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@
55
)
66

77
from .multi_task import QuadraticMultiTask # noqa F401
8+
9+
from .group import QuadraticGroup # noqa F401

skglm/datafits/group.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
@jitclass(spec_QuadraticGroup)
1717
class QuadraticGroup(BaseDatafit):
18-
"""Quadratic datafit used with group penalties.
18+
r"""Quadratic datafit used with group penalties.
1919
2020
The datafit reads::
2121
@@ -25,7 +25,7 @@ class QuadraticGroup(BaseDatafit):
2525
----------
2626
grp_indices : array, shape (n_features,)
2727
The group indices stacked contiguously
28-
(e.g. [grp1_indices, grp2_indices, ...]).
28+
([grp1_indices, grp2_indices, ...]).
2929
3030
grp_ptr : array, shape (n_groups + 1,)
3131
The group pointers such that two consecutive elements delimit

skglm/penalties/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
L1_plus_L2, L0_5, L1, L2_3, MCPenalty, WeightedL1, IndicatorBox, BasePenalty
55
)
66

7-
from .block_separable import L2_05, L2_1, BlockMCPenalty # noqa F401
7+
from .block_separable import L2_05, L2_1, BlockMCPenalty, WeightedGroupL2 # noqa F401

skglm/penalties/block_separable.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ class WeightedGroupL2(BasePenalty):
182182
183183
grp_indices : array, shape (n_features,)
184184
The group indices stacked contiguously
185-
(e.g. [grp1_indices, grp2_indices, ...]).
185+
([grp1_indices, grp2_indices, ...]).
186186
187187
grp_ptr : array, shape (n_groups + 1,)
188188
The group pointers such that two consecutive elements delimit

0 commit comments

Comments
 (0)