Skip to content

Commit 18db9b1

Browse files
authored
fix return section in cd_solver docstring (#27)
1 parent 832a57a commit 18db9b1

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

skglm/solvers/cd_solver.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -214,14 +214,14 @@ def cd_solver(
214214
215215
Returns
216216
-------
217-
alphas : array, shape (n_alphas,)
218-
The alphas along the path where models are computed.
219-
220217
coefs : array, shape (n_features, n_alphas)
221218
Coefficients along the path.
222219
223-
stop_crit : array, shape (n_alphas,)
224-
Value of stopping criterion at convergence along the path.
220+
obj_out : array, shape (n_iter,)
221+
The objective values at every outer iteration.
222+
223+
stop_crit : float
224+
Value of stopping criterion at convergence.
225225
"""
226226
if ws_strategy not in ("subdiff", "fixpoint"):
227227
raise ValueError(f'Unsupported value for ws_strategy: {ws_strategy}')

skglm/solvers/multitask_bcd_solver.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -194,14 +194,14 @@ def bcd_solver(
194194
195195
Returns
196196
-------
197-
alphas : array, shape (n_alphas,)
198-
The alphas along the path where models are computed.
199-
200197
coefs : array, shape (n_features, n_tasks, n_alphas)
201198
Coefficients along the path.
202199
203-
stop_crit : array, shape (n_alphas,)
204-
Value of stopping criterion at convergence along the path.
200+
obj_out : array, shape (n_iter,)
201+
The objective values at every outer iteration.
202+
203+
stop_crit : float
204+
Value of stopping criterion at convergence.
205205
"""
206206
n_tasks = Y.shape[1]
207207
n_features = X.shape[1]

0 commit comments

Comments
 (0)