.. _f-baseonnxfunction: module ``training._base_onnx_function`` ======================================= .. inheritance-diagram:: onnxcustom.training._base_onnx_function Short summary +++++++++++++ module ``onnxcustom.training._base_onnx_function`` Helper for :epkg:`onnxruntime-training`. :githublink:`%|py|6` Classes +++++++ +--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ | class | truncated documentation | +======================================================================================+==================================================================================================================================+ | :class:`BaseLearningOnnx ` | Class handling ONNX function to manipulate OrtValue. Base class for :class:`BaseLearningRate` and :class:`BaseLearningLoss`. ... | +--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ Static Methods ++++++++++++++ +---------------------------------------------------------------------------------------------------------+-------------------------+ | staticmethod | truncated documentation | +=========================================================================================================+=========================+ | :py:meth:`_bio_cache ` | | +---------------------------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`_bio_do_bind_in ` | | +---------------------------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`_bio_do_bind_out ` | | +---------------------------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`_bio_ptr ` | | +---------------------------------------------------------------------------------------------------------+-------------------------+ | :py:meth:`_cache_in_clear ` | | +---------------------------------------------------------------------------------------------------------+-------------------------+ Methods +++++++ +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | method | truncated documentation | +===================================================================================================================+===============================================================================================================+ | :py:meth:`__getstate__ ` | Overwrites getstate to get rid of InferenceSession. | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :py:meth:`__init__ ` | | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr__ ` | Usual | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :py:meth:`__repr_extended__ ` | | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :py:meth:`__setstate__ ` | Overwrites getstate to get rid of InferenceSession. | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :py:meth:`_bind_input_ortvalue ` | Binds :epkg:`C_OrtValue` to the structure used by :epkg:`InferenceSession` to run inference. | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :py:meth:`_bind_output_ortvalue ` | Binds :epkg:`C_OrtValue` to the structure used by :epkg:`InferenceSession` to run inference. | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :meth:`build_onnx_function ` | This class computes a function represented as an ONNX graph. This method builds it. This function creates ... | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ | :meth:`clear_binding_inputs ` | Clears binding and empty cache. | +-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+ Documentation +++++++++++++ .. automodule:: onnxcustom.training._base_onnx_function :members: :special-members: __init__ :show-inheritance: