Create evaluate.rst

adtzlr · Jun 9, 2024 · 1d1452d · 1d1452d
1 parent b60b025
commit 1d1452d
Showing 1 changed file with 33 additions and 0 deletions.
diff --git a/docs/tensortrax/evaluate.rst b/docs/tensortrax/evaluate.rst
@@ -0,0 +1,33 @@
+.. _api-evaluate:
+
+Evaluate Functions
+~~~~~~~~~~~~~~~~~~
+This module provides evaluation methods for (the gradient, Hessian or Jacobian) of a
+function.
+
+**Core**
+
+.. currentmodule:: tensortrax
+
+.. autosummary::
+
+   function
+   gradient
+   hessian
+   jacobian
+
+
+**Detailed API Reference**
+
+.. autoclass:: tensortrax.Tensor
+   :members:
+   :undoc-members:
+   :inherited-members:
+
+.. autofunction:: tensortrax.function
+
+.. autofunction:: tensortrax.gradient
+
+.. autofunction:: tensortrax.hessian
+
+.. autofunction:: tensortrax.jacobian