Fix LM surrogate operator documentation#621
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #621 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 96 96
Lines 12574 12574
=========================================
Hits 12574 12574 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
kellertuer
reviewed
Jul 3, 2026
Member
|
Thanks! | Takk! | Vielen Dank! |
kellertuer
approved these changes
Jul 3, 2026
kellertuer
referenced
this pull request
Jul 4, 2026
* Fix a few typos in the random walk solver example. * Initial setup of Gradient Sampling. * Setup the boiler plate code for the high-level interface and create the documentation page. * Sketch the algorithm further. * add a bit of documentation. * Documentation and show/print for the gradient sampling state * Setup a first example and fix the firrst few bugs. * Add Changelog entry. * add Ole Gunnar to the about.md * Update Hajgs link on the about page. * Start testing. * bump version. * Apply suggestions from code review --------- Co-authored-by: Ole Gunnar Røsholt Hovland <73483154+elorannug@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes a small documentation typo in the Levenberg–Marquardt linear surrogate description based on the very reference https://arxiv.org/pdf/2606.23560.
The surrogate operator is defined as$\mathcal L : T_pM \to \mathbb R^n,$ so it should use the Jacobian action $\mathcal L(X) = C J_F(p)[X],$ rather than the adjoint Jacobian applied to the residual. The latter lives in the tangent space and is dimensionally inconsistent with the definition of $\mathcal L$ . I also updated the following explanatory sentence to describe $J_F(p)$ as the Jacobian linear operator.