.. _f-dataloader:

module ``training.data_loader``
===============================





.. inheritance-diagram:: onnxcustom.training.data_loader


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

module ``onnxcustom.training.data_loader``

Manipulate data for training.


:githublink:`%|py|5`




Classes
+++++++

+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| class                                                                  | truncated documentation                                                                                                  |
+========================================================================+==========================================================================================================================+
| :class:`OrtDataLoader <onnxcustom.training.data_loader.OrtDataLoader>` | Draws consecutive random observations from a dataset by batch. It iterates over the datasets by drawing *batch_size* ... |
+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+---------------------------------------------------------------------------+------------------------------------------------------------+
| property                                                                  | truncated documentation                                    |
+===========================================================================+============================================================+
| :meth:`data_np <onnxcustom.training.data_loader.OrtDataLoader.data_np>`   | Returns a tuple of the datasets in numpy.                  |
+---------------------------------------------------------------------------+------------------------------------------------------------+
| :meth:`data_ort <onnxcustom.training.data_loader.OrtDataLoader.data_ort>` | Returns a tuple of the datasets in onnxruntime C_OrtValue. |
+---------------------------------------------------------------------------+------------------------------------------------------------+






Methods
+++++++

+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| method                                                                               | truncated documentation                                                                                      |
+======================================================================================+==============================================================================================================+
| :py:meth:`__getstate__ <onnxcustom.training.data_loader.OrtDataLoader.__getstate__>` | Removes any non pickable attribute.                                                                          |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.data_loader.OrtDataLoader.__init__>`         |                                                                                                              |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <onnxcustom.training.data_loader.OrtDataLoader.__len__>`           | Returns the number of observations.                                                                          |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <onnxcustom.training.data_loader.OrtDataLoader.__repr__>`         | usual                                                                                                        |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`__setstate__ <onnxcustom.training.data_loader.OrtDataLoader.__setstate__>` | Restores any non pickable attribute.                                                                         |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`_next_iter <onnxcustom.training.data_loader.OrtDataLoader._next_iter>`     |                                                                                                              |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`iter_bind <onnxcustom.training.data_loader.OrtDataLoader.iter_bind>`          | Iterates over the datasets by drawing *batch_size* consecutive observations. Modifies a bind structure.      |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`iter_numpy <onnxcustom.training.data_loader.OrtDataLoader.iter_numpy>`        | Iterates over the datasets by drawing *batch_size* consecutive observations. This iterator is slow as it ... |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`iter_ortvalue <onnxcustom.training.data_loader.OrtDataLoader.iter_ortvalue>`  | Iterates over the datasets by drawing *batch_size* consecutive observations. This iterator is slow as it ... |
+--------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+


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

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