JuliaManifolds / Manopt.jl

🏔️Manopt. jl – Optimization on Manifolds in Julia
http://manoptjl.org
Other
314 stars 40 forks source link

A Tutorial when starting with a new manifold #314

Closed kellertuer closed 10 months ago

kellertuer commented 10 months ago

This is an approach to resolve #305.

Maybe it is also a good idea on this PR to first have a few more “Technical Details” pages per solver similar to https://manoptjl.org/stable/solvers/gradient_descent.html#Technical-Details.

codecov[bot] commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (c1fc4a5) 99.74% compared to head (77d8768) 99.74%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #314 +/- ## ======================================= Coverage 99.74% 99.74% ======================================= Files 79 79 Lines 7353 7353 ======================================= Hits 7334 7334 Misses 19 19 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

kellertuer commented 10 months ago

@blegat before continuing with more technical details sections (they take a bit of time not to miss a function) – can you check whether a tutorial like https://manoptjl.org/previews/PR314/tutorials/ImplementOwnManifold.html is what you would have liked to have?

blegat commented 10 months ago

Yes, it's exactly what I had in mind!

kellertuer commented 10 months ago

Great! Then I will carefully add the technical details sections for the other solvers as well; probably also for step sizes and debugs.

kellertuer commented 10 months ago

While a few might still be challenging (Chambolle-Pock), I think most (CG, SGD, EPM,...) will just be copies of gradient descent in the technical details. Still good to check them.

And since I am redoing the docs a bit anyways, I will also try to minimise Vale warnings along the way (we at least do not have Vale errors any longer by now).

kellertuer commented 10 months ago

I now added a technical section to all solvers that lists (and currently also explains a bit) which functions are required what for. One could maybe shorten that to just listing functions.

Besides that I will maybe wait a day or two whether vale will get Julia code/docstring support and reiterate here again then. If they are not that fast I might just merge this for now.