.. _f-gradhelper:

module ``training.grad_helper``
===============================





.. inheritance-diagram:: onnxcustom.training.grad_helper


Short summary
+++++++++++++

module ``onnxcustom.training.grad_helper``

ONNX and gradient.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------------+----------------------------------------------------------------+
| class                                                                          | truncated documentation                                        |
+================================================================================+================================================================+
| :class:`DerivativeOptions <onnxcustom.training.grad_helper.DerivativeOptions>` | Options defining how to build the onnx graph of the gradients. |
+--------------------------------------------------------------------------------+----------------------------------------------------------------+




Functions
+++++++++

+---------------------------------------------------------------------------------------+----------------------------------------------------------------+
| function                                                                              | truncated documentation                                        |
+=======================================================================================+================================================================+
| :func:`_default_inputs <onnxcustom.training.grad_helper._default_inputs>`             | Guesses default inputs (float ones) if not specified.          |
+---------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :func:`_onnx_derivative_fw <onnxcustom.training.grad_helper._onnx_derivative_fw>`     | Implements a gradient based on class `OrtModuleGraphBuilder`.  |
+---------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :func:`_onnx_derivative_loss <onnxcustom.training.grad_helper._onnx_derivative_loss>` | Implements a gradient based on class `PyGradientGraphBuilder`. |
+---------------------------------------------------------------------------------------+----------------------------------------------------------------+
| :func:`onnx_derivative <onnxcustom.training.grad_helper.onnx_derivative>`             | Builds the gradient for an onnx graph.                         |
+---------------------------------------------------------------------------------------+----------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: onnxcustom.training.grad_helper
    :members:
    :special-members: __init__
    :show-inheritance: