Skip to content

fix: add rrule for getproperty(::NonlinearProblem to avoid mutable accumulation #1066

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 15, 2025
Merged

fix: add rrule for getproperty(::NonlinearProblem to avoid mutable accumulation #1066

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aced3e8
fix: add `rrule` for `getproperty(::NonlinearProblem` to avoid mutabl…
AayushSabharwal Jul 15, 2025
82238a2
docs: add comment explaining added `rrule`
AayushSabharwal Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions ext/SciMLBaseChainRulesCoreExt.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,21 @@ function ChainRulesCore.rrule(
SciMLBase.IntervalNonlinearProblem(args...; kwargs...), IntervalNonlinearProblemAdjoint
end

# This is a workaround for the fact `NonlinearProblem` is a mutable struct. In SciMLSensitivity, we call
# `back` explicitly while already in a reverse pass causing a nested gradient call. The mutable struct
# causes accumulation anytime `getfield/property` is called, accumulating multiple times. This tries to treat
# AbstractDEProblem as immutable for the purposes of reverse mode AD.
Comment on lines +142 to +143
Copy link
Member

@ChrisRackauckas ChrisRackauckas Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But it's only on NonlinearProblem?

function ChainRulesCore.rrule(::ChainRulesCore.RuleConfig{>:ChainRulesCore.HasReverseMode}, ::typeof(Base.getproperty), x::NonlinearProblem, f::Symbol)
val = getfield(x, f)
function back(der)
dx = if der === nothing
ChainRulesCore.zero_tangent(x)
else
NamedTuple{(f,)}((der,))
end
return (ChainRulesCore.NoTangent(), ChainRulesCore.ProjectTo(x)(dx), ChainRulesCore.NoTangent())
end
return val, back
end

end
Loading