Update ProximalAlgorithms.jl

JuliaFirstOrder · Jan 6, 2024 · e79ec2b · e79ec2b
1 parent b402024
commit e79ec2b
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/ProximalAlgorithms.jl b/src/ProximalAlgorithms.jl
@@ -7,6 +7,13 @@ using ProximalCore: prox, prox!
 const RealOrComplex{R} = Union{R,Complex{R}}
 const Maybe{T} = Union{T,Nothing}
 
+"""
+    Autodifferentiable(f, backend)
+
+Construct a function from `f` to be auto-differentiated via `backend`.
+
+The backend can be any from AbstractDifferentiation.jl.
+"""
 struct AutoDifferentiable{F, B}
     f::F
     backend::B