Skip to content

Commit

Permalink
Add warning
Browse files Browse the repository at this point in the history
  • Loading branch information
gdalle committed Jun 24, 2024
1 parent f5b94d3 commit 828a656
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/tracers.jl
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,13 @@ $(TYPEDEF)
For a higher-level interface, refer to [`hessian_pattern`](@ref).
The last type parameter `shared` is a `Bool` indicating whether the Hessian should be shared among all intermediate scalar quantities.
## Fields
$(TYPEDFIELDS)
## Internals
The last type parameter `shared` is a `Bool` indicating whether the `hessian` field of this object should be shared among all intermediate scalar quantities involved in a function.
It is not yet part of the public API, and users should always set it to `false`.
"""
struct HessianTracer{G,H,shared} <: AbstractTracer
"Sparse representation of non-zero entries in the gradient and the Hessian."
Expand Down

0 comments on commit 828a656

Please sign in to comment.