api.md

API

CollapsedDocStrings = true

DifferentiationInterface

Argument wrappers

Context
Constant
Cache
ConstantOrCache

First order

Pushforward

prepare_pushforward
prepare_pushforward_same_point
pushforward
pushforward!
value_and_pushforward
value_and_pushforward!

Pullback

prepare_pullback
prepare_pullback_same_point
pullback
pullback!
value_and_pullback
value_and_pullback!

Derivative

prepare_derivative
derivative
derivative!
value_and_derivative
value_and_derivative!

Gradient

prepare_gradient
gradient
gradient!
value_and_gradient
value_and_gradient!

Jacobian

prepare_jacobian
jacobian
jacobian!
value_and_jacobian
value_and_jacobian!

Second order

SecondOrder

Second derivative

prepare_second_derivative
second_derivative
second_derivative!
value_derivative_and_second_derivative
value_derivative_and_second_derivative!

Hessian-vector product

prepare_hvp
prepare_hvp_same_point
hvp
hvp!
gradient_and_hvp
gradient_and_hvp!

Hessian

prepare_hessian
hessian
hessian!
value_gradient_and_hessian
value_gradient_and_hessian!

Utilities

Backend queries

check_available
check_inplace
DifferentiationInterface.outer
DifferentiationInterface.inner

Backend switch

DifferentiateWith

Sparsity tools

MixedMode
DenseSparsityDetector

From primitive

DifferentiationInterface.AutoForwardFromPrimitive
DifferentiationInterface.AutoReverseFromPrimitive

Preparation type

DifferentiationInterface.Prep

Reactant

AutoReactant
DifferentiationInterface.to_reactant