-
-
Notifications
You must be signed in to change notification settings - Fork 396
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] clarify section on automatic differentiation in nonlinear.md #3683
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #3683 +/- ##
=======================================
Coverage 98.33% 98.33%
=======================================
Files 43 43
Lines 5696 5696
=======================================
Hits 5601 5601
Misses 95 95 ☔ View full report in Codecov by Sentry. |
How about this now. I don't really know where the trade-off is between providing lots of information one the details for expert users, and trying to hide irrelevant information for new users. |
@@ -161,6 +161,14 @@ julia> sin(sin(1.0)) | |||
0.7456241416655579 | |||
``` | |||
|
|||
## Automatic differentiation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is a second section about AD at the bottom, I would move this down with the rest
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I kept the section. I wanted to distinguish general AD from the AD specific to operators. The bottom section was ##
instead of ###
by mistake, so it looked more prominent than I intended.
x-ref https://discourse.julialang.org/t/nonlinear-optimization-with-many-constraints-autodifferentiation-which-julia-solution/110678/20
Thoughts @gdalle
Preview: https://jump.dev/JuMP.jl/previews/PR3683/manual/nonlinear/#jump_user_defined_operators