File tree Expand file tree Collapse file tree 1 file changed +4
-0
lines changed Expand file tree Collapse file tree 1 file changed +4
-0
lines changed Original file line number Diff line number Diff line change @@ -48,8 +48,10 @@ sensitivity(y) = error("Output should be scalar; gradients are not defined for o
4848
4949"""
5050 gradient(f, args...)
51+
5152Returns a tuple containing `∂f/∂x` for each argument `x`,
5253the derivative (for scalar x) or the gradient.
54+
5355`f(args...)` must be a real number, see [`jacobian`](@ref) for array output.
5456"""
5557function gradient (f, args... )
144146"""
145147 copy!(ps::Params, x::AbstractVector)
146148 copy!(x::AbstractVector, ps::Params)
149+
147150Copies the content of array `x` into the parameters `ps` or viceversa.
148151The length of `x` has to be equal to the sum of the lengths
149152of all parameters.
202205"""
203206 copy!(gs::Grads, x::AbstractVector)
204207 copy!(x::AbstractVector, gs::Grads)
208+
205209Copies the content of array `x` into the gradient object `gs` or vice versa. The
206210length of `x` has to be equal to the sum of the lengths of all gradients.
207211"""
You can’t perform that action at this time.
0 commit comments