Skip to content
This repository was archived by the owner on Dec 6, 2023. It is now read-only.

Commit a27a6ac

Browse files
committed
Docstring for get_auto_step_size
1 parent 4f06d2f commit a27a6ac

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

lightning/impl/sag_fast.pyx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,12 +120,14 @@ def get_auto_step_size(RowDataset X, double alpha, loss, gamma=None, sample_weig
120120
+ alpha * 0.5 * ||w||^2_2
121121
Parameters
122122
----------
123-
X : ndarray
124-
Array of samples x_i.
123+
X : RowDataset
124+
Dataset.
125125
alpha : float
126126
Constant that multiplies the l2 penalty term.
127-
loss : string, in {"log", "squared"}
127+
loss : string, in {"log", "squared", "modified_huber", "smooth_hinge", "squared_hinge"a}
128128
The loss function used in SAG solver.
129+
sample_weight : array of size (n_samples,)
130+
relative weights of the samples
129131
130132
Returns
131133
-------

0 commit comments

Comments
 (0)