jaxopt icon indicating copy to clipboard operation
jaxopt copied to clipboard

some keywords undocumented in GradientDescent

Open fabianp opened this issue 3 years ago • 3 comments

jit and unroll don't seem to be documented in https://jaxopt.github.io/stable/_autosummary/jaxopt.GradientDescent.html#jaxopt-gradientdescent

fabianp avatar Feb 01 '22 19:02 fabianp

Note: ProjectedGradient does have these kwargs documented (https://jaxopt.github.io/stable/_autosummary/jaxopt.ProjectedGradient.html#jaxopt.ProjectedGradient), but I find there's room for improvement also here.

For example, the unroll one is "whether to unroll the optimization loop" , which ideally should describe very shortly what unrolls means and how this affects the runtime/memory of the algorithm.

fabianp avatar Feb 01 '22 19:02 fabianp

test accuracy not great ...

Figure_1

fabianp avatar Feb 01 '22 20:02 fabianp

which ideally should describe very shortly what unrolls means and how this affects the runtime/memory of the algorithm

I would explain this in the documentation and link from the docstring to the documentation.

mblondel avatar Jul 13 '22 08:07 mblondel