jaxopt
jaxopt copied to clipboard
some keywords undocumented in GradientDescent
jit and unroll don't seem to be documented in https://jaxopt.github.io/stable/_autosummary/jaxopt.GradientDescent.html#jaxopt-gradientdescent
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.
test accuracy not great ...

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.