JuliaDiff / AbstractDifferentiation.jl

An abstract interface for automatic differentiation.
https://juliadiff.org/AbstractDifferentiation.jl/
MIT License
135 stars 18 forks source link

API Docs for end-users #92

Closed oxinabox closed 11 months ago

oxinabox commented 1 year ago

We don't seem to have API docs?

gdalle commented 1 year ago

There's the README, but do you mean an actual documentation website à la Documenter.jl?

oxinabox commented 1 year ago

Yes

Right now nothing explains what eg gradient or hessian is. What it's return types are etc

gdalle commented 1 year ago

Related issues:

oxinabox commented 1 year ago

those are related. But in particular I want API docs for gradient, hessian, jacobian etc etc.

gdalle commented 11 months ago

This is solved in the main branch and corresponding dev docs