-
-
Notifications
You must be signed in to change notification settings - Fork 78
Description
Describe the bug 🐞
All gradients computed with ForwardDiff are zero when the underlying ODE is built with ModelingToolkit.
When a manual reimplementation is used, ForwardDiff returns gradients but differs from Zygote in a magnitude I would not expect. Zygote is consistent between the two cases.
Expected behavior
Consistency between MTK & Manual model using ForwardDiff. Possibly also between ForwardDiff and Zygote, but this could be within numerical accuracy.
Minimal Reproducible Example 👇
Without MRE, we would only be able to help you to a limited extent, and attention to the issue would be limited. to know more about MRE refer to wikipedia and stackoverflow.
# MWE
using ModelingToolkit
using OrdinaryDiffEq
using SciMLStructures
using SciMLSensitivity
using StableRNGs
using ForwardDiff
using Zygote
import ModelingToolkit: t_nounits as t, D_nounits as D
## Data Generator
@mtkmodel Lotka begin
@variables begin
x(t) = 1.0, [description = "Prey"]
y(t) = 1.0, [description = "Predator"]
end
@parameters begin
α = 1.5
β = 1.0
γ = 3.0
δ = 1.0
end
@equations begin
D(x) ~ (α - β * y) * x
D(y) ~ (δ * x - γ) * y
end
end
@mtkcompile lotka = Lotka()
problem = ODEProblem(lotka, [], (0.0, 10.0))
solution = solve(problem, Tsit5(), saveat=0.1)
rng = StableRNG(42)
data = (;
t=solution.t,
# [[y, x], :]
measurements=Array(solution)
)
data.measurements .+= 0.05 * randn(rng, size(data.measurements))
#Debug
#f = plot(solution)
#scatter!(data.t, data.measurements[1, :])
#scatter!(data.t, data.measurements[2, :])
#display(f)
p0, repack, _ = SciMLStructures.canonicalize(SciMLStructures.Tunable(), problem.p)
objective = let repack = repack, problem = problem
(p, data) -> begin
pnew = repack(p)
sol = solve(problem, Tsit5(), p = pnew, saveat = data.t)
sum(abs2, sol .- data.measurements) / size(data.t, 1)
end
end
# Check ≈ 0.005116418356342287
objective(p0, data)
# Zero
ForwardDiff.gradient(Base.Fix2(objective, data), p0)
# Not zero ([-0.21477822120509513, -0.00824858062706199, -0.13853338985792157, -0.03034598558542432],)
Zygote.gradient(Base.Fix2(objective, data), p0)
# Non MTK version
function lv(u, p, t)
[
p[1] * u[1] - p[2] * u[1] * u[2],
p[3] * u[1]*u[2] - p[4] * u[2]
]
end
problem = ODEProblem(lv, [1., 1.], (0., 10.), [1.5, 1.0, 1.0, 3.0])
solution = solve(problem, Tsit5(), saveat=0.1)
# Debug
#f = plot(solution)
#scatter!(data.t, data.measurements[2, :])
#scatter!(data.t, data.measurements[1, :])
#display(f)
# For consistency
p0, repack, _ = SciMLStructures.canonicalize(SciMLStructures.Tunable(), problem.p)
objective = let repack = repack, problem = problem
(p, data) -> begin
# Leaving this out changes nothing
pnew = repack(p)
# Switching to other Integrators, e.g. Vern7, does not improve
sol = solve(problem, Tsit5(), p = pnew, saveat = data.t)
sum(abs2, Array(sol) .- data.measurements[[2,1], :]) / size(data.t, 1)
end
end
# Check ≈ 0.005116418356341537
objective(p0, data)
# Not Zero [ -0.3699284859839662, -0.011463508689489492, -0.2398301997277094, -0.0477244292296241]
g1 = ForwardDiff.gradient(Base.Fix2(objective, data), p0)
# Not zero ([-0.21477822120392856, -0.008248580627071152, -0.13853338985723695, -0.03034598558526613],)
g2 = Zygote.gradient(Base.Fix2(objective, data), p0)
# Diff [ -0.15515026478003766, -0.00321492806241834, -0.10129680987047243, -0.017378443644357974]
g1 .- g2[1]
# MWE 2
using ModelingToolkit
using OrdinaryDiffEq
using SciMLStructures
using SciMLSensitivity
using StableRNGs
using ForwardDiff
using Zygote
import ModelingToolkit: t_nounits as t, D_nounits as D
## Data Generator
@mtkmodel Linear begin
@variables begin
x(t) = 1.0, [description = "Prey"]
end
@parameters begin
α = 1.5
end
@equations begin
D(x) ~ -α * x
end
end
@mtkcompile linear = Linear()
problem = ODEProblem(linear, [], (0.0, 1.0))
solution = solve(problem, Tsit5(), saveat=0.1)
rng = StableRNG(42)
data = (;
t=solution.t,
# [[y, x], :]
measurements=Array(solution)
)
data.measurements .+= 0.05 * randn(rng, size(data.measurements))
#Debug
#f = plot(solution)
#scatter!(data.t, data.measurements[1, :])
#scatter!(data.t, data.measurements[2, :])
#display(f)
p0, repack, _ = SciMLStructures.canonicalize(SciMLStructures.Tunable(), problem.p)
objective = let repack = repack, problem = problem
(p, data) -> begin
pnew = repack(p)
sol = solve(problem, Tsit5(), p = pnew, saveat = data.t)
sum(abs2, sol .- data.measurements) / size(data.t, 1)
end
end
# Check 0.0031677344878386607
objective(p0, data)
# Zero
ForwardDiff.gradient(Base.Fix2(objective, data), p0)
# Not zero ([0.005474983463028785],)
Zygote.gradient(Base.Fix2(objective, data), p0)
# Non MTK version
function linsys(u, p, t)
[
-p[1] * u[1]
]
end
problem = ODEProblem(linsys, [1.,], (0., 1.), [1.5])
solution = solve(problem, Tsit5(), saveat=0.1)
# Debug
#f = plot(solution)
#scatter!(data.t, data.measurements[2, :])
#scatter!(data.t, data.measurements[1, :])
#display(f)
# For consistency
p0, repack, _ = SciMLStructures.canonicalize(SciMLStructures.Tunable(), problem.p)
objective = let repack = repack, problem = problem
(p, data) -> begin
pnew = repack(p)
# Switching to other Integrators, e.g. Vern7, does not improve
sol = solve(problem, Tsit5(), p = pnew, saveat = data.t)
sum(abs2, Array(sol) .- data.measurements) / size(data.t, 1)
end
end
# Check ≈ 0.0031677344878386637
objective(p0, data)
# Not Zero [0.005474949348877295]
g1 = ForwardDiff.gradient(Base.Fix2(objective, data), p0)
# Not zero ([0.0054749834630287535],)
g2 = Zygote.gradient(Base.Fix2(objective, data), p0)
# Diff [-3.4114151458569664e-8]
g1 .- g2[1]
Error & Stacktrace
Not applicable.
Environment (please complete the following information):
- Output of
using Pkg; Pkg.status()
Status `~/MWEGradients/Project.toml`
⌅ [f6369f11] ForwardDiff v0.10.38
[961ee093] ModelingToolkit v10.2.0
[1dea7af3] OrdinaryDiffEq v6.98.0
[1ed8b502] SciMLSensitivity v7.84.0
[53ae85a6] SciMLStructures v1.7.0
[860ef19b] StableRNGs v1.0.3
[e88e6eb3] Zygote v0.7.9
Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated`
- Output of
using Pkg; Pkg.status(; mode = PKGMODE_MANIFEST)
Status `~/MWEGradients/Manifest.toml`
[47edcb42] ADTypes v1.14.0
[621f4979] AbstractFFTs v1.5.0
[1520ce14] AbstractTrees v0.4.5
[7d9f7c33] Accessors v0.1.42
[79e6a3ab] Adapt v4.3.0
[66dad0bd] AliasTables v1.1.3
[ec485272] ArnoldiMethod v0.4.0
[4fba245c] ArrayInterface v7.19.0
[4c555306] ArrayLayouts v1.11.1
[a9b6321e] Atomix v1.1.1
⌅ [e2ed5e7c] Bijections v0.1.10
[62783981] BitTwiddlingConvenienceFunctions v0.1.6
[8e7c35d0] BlockArrays v1.6.3
[70df07ce] BracketingNonlinearSolve v1.3.0
[fa961155] CEnum v0.5.0
[2a0fbf3d] CPUSummary v0.2.6
[7057c7e9] Cassette v0.3.14
[082447d4] ChainRules v1.72.4
[d360d2e6] ChainRulesCore v1.25.1
[fb6a15b2] CloseOpenIntervals v0.1.13
[861a8166] Combinatorics v1.0.3
[a80b9123] CommonMark v0.9.1
[38540f10] CommonSolve v0.2.4
[bbf7d656] CommonSubexpressions v0.3.1
[f70d9fcc] CommonWorldInvalidations v1.0.0
[34da2185] Compat v4.16.0
[b152e2b5] CompositeTypes v0.1.4
[a33af91c] CompositionsBase v0.1.2
[2569d6c7] ConcreteStructs v0.2.3
[187b0558] ConstructionBase v1.6.0
[adafc99b] CpuId v0.3.1
[a8cc5b0e] Crayons v4.1.1
[9a962f9c] DataAPI v1.16.0
[864edb3b] DataStructures v0.18.22
[e2d170a0] DataValueInterfaces v1.0.0
[2b5f629d] DiffEqBase v6.176.0
[459566f4] DiffEqCallbacks v4.6.0
[77a26b50] DiffEqNoiseProcess v5.24.1
[163ba53b] DiffResults v1.1.0
[b552c78f] DiffRules v1.15.1
⌅ [a0c0ee7d] DifferentiationInterface v0.6.54
[8d63f2c5] DispatchDoctor v0.4.19
[31c24e10] Distributions v0.25.120
[ffbed154] DocStringExtensions v0.9.5
[5b8099bc] DomainSets v0.7.15
[7c1d4256] DynamicPolynomials v0.6.2
[06fc5a27] DynamicQuantities v1.8.0
[4e289a0a] EnumX v1.0.5
[7da242da] Enzyme v0.13.49
[f151be2c] EnzymeCore v0.8.11
[d4d017d3] ExponentialUtilities v1.27.0
[e2ba6199] ExprTools v0.1.10
[55351af7] ExproniconLite v0.10.14
[7034ab61] FastBroadcast v0.3.5
[9aa1b823] FastClosures v0.3.2
[442a2c76] FastGaussQuadrature v1.0.2
[a4df4552] FastPower v1.1.2
[1a297f60] FillArrays v1.13.0
[64ca27bc] FindFirstFunctions v1.4.1
[6a86dc24] FiniteDiff v2.27.0
[1fa38f19] Format v1.3.7
⌅ [f6369f11] ForwardDiff v0.10.38
[f62d2435] FunctionProperties v0.1.2
[069b7b12] FunctionWrappers v1.1.3
[77dc65aa] FunctionWrappersWrappers v0.1.3
[d9f16b24] Functors v0.5.2
[46192b85] GPUArraysCore v0.2.0
[61eb1bfa] GPUCompiler v1.5.2
[c145ed77] GenericSchur v0.5.5
[c27321d9] Glob v1.3.1
[86223c79] Graphs v1.13.0
[076d061b] HashArrayMappedTries v0.2.0
[34004b35] HypergeometricFunctions v0.3.28
[7869d1d1] IRTools v0.4.14
[615f187c] IfElse v0.1.1
[3263718b] ImplicitDiscreteSolve v0.1.2
[d25df0c9] Inflate v0.1.5
[18e54dd8] IntegerMathUtils v0.1.2
[8197267c] IntervalSets v0.7.11
[3587e190] InverseFunctions v0.1.17
[92d709cd] IrrationalConstants v0.2.4
[82899510] IteratorInterfaceExtensions v1.0.0
[692b3bcd] JLLWrappers v1.7.0
[ae98c720] Jieko v0.2.1
[98e50ef6] JuliaFormatter v2.1.2
⌅ [70703baa] JuliaSyntax v0.4.10
[ccbc3e58] JumpProcesses v9.16.0
[63c18a36] KernelAbstractions v0.9.35
[ba0b0d4f] Krylov v0.10.1
[929cbde3] LLVM v9.4.0
[b964fa9f] LaTeXStrings v1.4.0
[23fbe1c1] Latexify v0.16.8
[10f19ff3] LayoutPointers v0.1.17
[5078a376] LazyArrays v2.6.1
[87fe0de2] LineSearch v0.1.4
[d3d80556] LineSearches v7.4.0
[7ed4a6bd] LinearSolve v3.17.0
[2ab3a3ac] LogExpFunctions v0.3.29
[d8e11817] MLStyle v0.4.17
[1914dd2f] MacroTools v0.5.16
[d125e4d3] ManualMemory v0.1.8
[bb5d69b7] MaybeInplace v0.1.4
[e1d29d7a] Missings v1.2.0
[961ee093] ModelingToolkit v10.2.0
[2e0e35c7] Moshi v0.3.5
[46d2c3a1] MuladdMacro v0.2.4
[102ac46a] MultivariatePolynomials v0.5.9
[d8a4904e] MutableArithmetics v1.6.4
[d41bc354] NLSolversBase v7.10.0
[872c559c] NNlib v0.9.30
[77ba4419] NaNMath v1.1.3
[8913a72c] NonlinearSolve v4.9.0
[be0214bd] NonlinearSolveBase v1.12.0
[5959db7a] NonlinearSolveFirstOrder v1.5.0
[9a2c21bd] NonlinearSolveQuasiNewton v1.6.0
[26075421] NonlinearSolveSpectralMethods v1.2.0
[d8793406] ObjectFile v0.4.4
[6fe1bfb0] OffsetArrays v1.17.0
[429524aa] Optim v1.13.2
[3bd65402] Optimisers v0.4.6
[bac558e1] OrderedCollections v1.8.1
[1dea7af3] OrdinaryDiffEq v6.98.0
[89bda076] OrdinaryDiffEqAdamsBashforthMoulton v1.2.0
[6ad6398a] OrdinaryDiffEqBDF v1.6.0
[bbf590c4] OrdinaryDiffEqCore v1.26.1
[50262376] OrdinaryDiffEqDefault v1.4.0
[4302a76b] OrdinaryDiffEqDifferentiation v1.10.0
[9286f039] OrdinaryDiffEqExplicitRK v1.1.0
[e0540318] OrdinaryDiffEqExponentialRK v1.4.0
[becaefa8] OrdinaryDiffEqExtrapolation v1.5.0
[5960d6e9] OrdinaryDiffEqFIRK v1.12.0
[101fe9f7] OrdinaryDiffEqFeagin v1.1.0
[d3585ca7] OrdinaryDiffEqFunctionMap v1.1.1
[d28bc4f8] OrdinaryDiffEqHighOrderRK v1.1.0
[9f002381] OrdinaryDiffEqIMEXMultistep v1.3.0
[521117fe] OrdinaryDiffEqLinear v1.3.0
[1344f307] OrdinaryDiffEqLowOrderRK v1.2.0
[b0944070] OrdinaryDiffEqLowStorageRK v1.3.0
[127b3ac7] OrdinaryDiffEqNonlinearSolve v1.10.0
[c9986a66] OrdinaryDiffEqNordsieck v1.1.0
[5dd0a6cf] OrdinaryDiffEqPDIRK v1.3.1
[5b33eab2] OrdinaryDiffEqPRK v1.1.0
[04162be5] OrdinaryDiffEqQPRK v1.1.0
[af6ede74] OrdinaryDiffEqRKN v1.1.0
[43230ef6] OrdinaryDiffEqRosenbrock v1.11.0
[2d112036] OrdinaryDiffEqSDIRK v1.3.0
[669c94d9] OrdinaryDiffEqSSPRK v1.3.0
[e3e12d00] OrdinaryDiffEqStabilizedIRK v1.3.0
[358294b1] OrdinaryDiffEqStabilizedRK v1.1.0
[fa646aed] OrdinaryDiffEqSymplecticRK v1.3.0
[b1df2697] OrdinaryDiffEqTsit5 v1.1.0
[79d7bb75] OrdinaryDiffEqVerner v1.2.0
[90014a1f] PDMats v0.11.35
[d96e819e] Parameters v0.12.3
[e409e4f3] PoissonRandom v0.4.4
[f517fe37] Polyester v0.7.18
[1d0040c9] PolyesterWeave v0.2.2
[85a6dd25] PositiveFactorizations v0.2.4
[d236fae5] PreallocationTools v0.4.27
⌅ [aea7be01] PrecompileTools v1.2.1
[21216c6a] Preferences v1.4.3
[08abe8d2] PrettyTables v2.4.0
[27ebfcd6] Primes v0.5.7
[43287f4e] PtrArrays v1.3.0
[1fd47b50] QuadGK v2.11.2
[74087812] Random123 v1.7.1
[e6cf234a] RandomNumbers v1.6.0
[c1ae055f] RealDot v0.1.0
[3cdcf5f2] RecipesBase v1.3.4
[731186ca] RecursiveArrayTools v3.33.0
[189a3867] Reexport v1.2.2
[ae029012] Requires v1.3.1
[ae5879a3] ResettableStacks v1.1.1
[37e2e3b7] ReverseDiff v1.16.1
[79098fc4] Rmath v0.8.0
[7e49a35a] RuntimeGeneratedFunctions v0.5.15
[9dfe8606] SCCNonlinearSolve v1.2.0
[94e857df] SIMDTypes v0.1.0
[0bca4576] SciMLBase v2.101.0
[19f34311] SciMLJacobianOperators v0.1.6
[c0aeaf25] SciMLOperators v1.3.1
[431bcebd] SciMLPublic v1.0.0
[1ed8b502] SciMLSensitivity v7.84.0
[53ae85a6] SciMLStructures v1.7.0
[7e506255] ScopedValues v1.3.0
[6c6a2e73] Scratch v1.2.1
[efcf1570] Setfield v1.1.2
[727e6d20] SimpleNonlinearSolve v2.5.0
[699a6c99] SimpleTraits v0.9.4
[ce78b400] SimpleUnPack v1.1.0
[a2af1166] SortingAlgorithms v1.2.1
[dc90abb0] SparseInverseSubset v0.1.2
[0a514795] SparseMatrixColorings v0.4.20
[276daf66] SpecialFunctions v2.5.1
[860ef19b] StableRNGs v1.0.3
[aedffcd0] Static v1.2.0
[0d7ed370] StaticArrayInterface v1.8.0
[90137ffa] StaticArrays v1.9.13
[1e83bf80] StaticArraysCore v1.4.3
[82ae8749] StatsAPI v1.7.1
[2913bbd2] StatsBase v0.34.5
[4c63d2b9] StatsFuns v1.5.0
[7792a7ef] StrideArraysCore v0.5.7
[892a3eda] StringManipulation v0.4.1
[09ab397b] StructArrays v0.7.1
[53d494c1] StructIO v0.3.1
[2efcf032] SymbolicIndexingInterface v0.3.40
[19f23fe9] SymbolicLimits v0.2.2
[d1185830] SymbolicUtils v3.29.0
[0c5d862f] Symbolics v6.40.0
[3783bdb8] TableTraits v1.0.1
[bd369af6] Tables v1.12.1
[ed4db957] TaskLocalValues v0.1.2
[8ea1fca8] TermInterface v2.0.0
[1c621080] TestItems v1.0.0
[8290d209] ThreadingUtilities v0.5.5
[a759f4b9] TimerOutputs v0.5.29
[9f7883ad] Tracker v0.2.38
[e689c965] Tracy v0.1.4
[410a4b4d] Tricks v0.1.10
[781d530d] TruncatedStacktraces v1.4.0
[5c2747f8] URIs v1.5.2
[3a884ed6] UnPack v1.0.2
[1986cc42] Unitful v1.23.1
[a7c27f48] Unityper v0.1.6
[013be700] UnsafeAtomics v0.3.0
[897b6980] WeakValueDicts v0.1.0
[e88e6eb3] Zygote v0.7.9
[700de1a5] ZygoteRules v0.2.7
⌅ [7cc45869] Enzyme_jll v0.0.181+0
[1d5cc7b8] IntelOpenMP_jll v2025.0.4+0
[dad2f222] LLVMExtra_jll v0.0.36+0
[ad6e5548] LibTracyClient_jll v0.9.1+6
[856f044c] MKL_jll v2025.0.1+1
[efe28fd5] OpenSpecFun_jll v0.5.6+0
[f50d1b31] Rmath_jll v0.5.1+0
[1317d2d5] oneTBB_jll v2022.0.0+0
[0dad84c5] ArgTools v1.1.1
[56f22d72] Artifacts
[2a0f44e3] Base64
[ade2ca70] Dates
[8ba89e20] Distributed
[f43a241f] Downloads v1.6.0
[7b1f6079] FileWatching
[9fa8497b] Future
[b77e0a4c] InteractiveUtils
[4af54fe1] LazyArtifacts
[b27032c2] LibCURL v0.6.4
[76f85450] LibGit2
[8f399da3] Libdl
[37e2e46d] LinearAlgebra
[56ddb016] Logging
[d6f4376e] Markdown
[a63ad114] Mmap
[ca575930] NetworkOptions v1.2.0
[44cfe95a] Pkg v1.10.0
[de0858da] Printf
[3fa0cd96] REPL
[9a3f8284] Random
[ea8e919c] SHA v0.7.0
[9e88b42a] Serialization
[1a1011a3] SharedArrays
[6462fe0b] Sockets
[2f01184e] SparseArrays v1.10.0
[10745b16] Statistics v1.10.0
[4607b0f0] SuiteSparse
[fa267f1f] TOML v1.0.3
[a4e569a6] Tar v1.10.0
[8dfed614] Test
[cf7118a7] UUIDs
[4ec0a83e] Unicode
[e66e0078] CompilerSupportLibraries_jll v1.1.1+0
[deac9b47] LibCURL_jll v8.4.0+0
[e37daf67] LibGit2_jll v1.6.4+0
[29816b5a] LibSSH2_jll v1.11.0+1
[c8ffd9c3] MbedTLS_jll v2.28.2+1
[14a3606d] MozillaCACerts_jll v2023.1.10
[4536629a] OpenBLAS_jll v0.3.23+4
[05823500] OpenLibm_jll v0.8.1+4
[bea87d4a] SuiteSparse_jll v7.2.1+1
[83775a58] Zlib_jll v1.2.13+1
[8e850b90] libblastrampoline_jll v5.11.0+0
[8e850ede] nghttp2_jll v1.52.0+1
[3f19e933] p7zip_jll v17.4.0+2
Info Packages marked with ⌅ have new versions available but compatibility constraints restrict them from upgrading. To see why use `status --outdated -m`
- Output of
versioninfo()
Julia Version 1.10.9
Commit 5595d20a287 (2025-03-10 12:51 UTC)
Build Info:
Official https://julialang.org/ release
Platform Info:
OS: macOS (arm64-apple-darwin24.0.0)
CPU: 11 × Apple M3 Pro
WORD_SIZE: 64
LIBM: libopenlibm
LLVM: libLLVM-15.0.7 (ORCJIT, apple-m1)
Threads: 1 default, 0 interactive, 1 GC (on 5 virtual cores)
Environment:
JULIA_EDITOR = nvim
**Additional context✱
Edit Added information for manual model with and without SciMLStructures.
Edit Added simpler MWE