.. _l-modules:

Modules
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| module                                             | truncated documentation                                                                                                                                                                  |
+====================================================+==========================================================================================================================================================================================+
| :ref:`__init__ <f-init>`                           | module ``onnxcustom``    Experimentation with ONNX, examples.      :githublink:`%|py|8`                                                                                                  |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initz>`                          | module ``onnxcustom.cli``    Shortcuts to *cli*.      :githublink:`%|py|5`                                                                                                               |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzz>`                         | module ``onnxcustom.plotting``    Shortcuts to plotting.      :githublink:`%|py|6`                                                                                                       |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzz>`                        | module ``onnxcustom.training``    Shortcuts to *training*.      :githublink:`%|py|5`                                                                                                     |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__init__ <f-initzzzz>`                       | module ``onnxcustom.utils``    Shortcuts to *utils*.      :githublink:`%|py|5`                                                                                                           |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`__main__ <f-main>`                           | module ``onnxcustom.__main__``    Implements command line ``python -m onnxcustom <command> <args>``.      :githublink:`%|py|6`                                                           |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`_base <f-base>`                              | module ``onnxcustom.training._base``    Base class for :class:`BaseEstimator` and :class:`BaseOnnxFunction`.      :githublink:`%|py|5`                                                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`_base_estimator <f-baseestimator>`           | module ``onnxcustom.training._base_estimator``    Optimizer with :epkg:`onnxruntime-training`.      :githublink:`%|py|5`                                                                 |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`_base_onnx_function <f-baseonnxfunction>`    | module ``onnxcustom.training._base_onnx_function``    Helper for :epkg:`onnxruntime-training`.      :githublink:`%|py|6`                                                                 |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`benchmark <f-benchmark>`                     | module ``onnxcustom.utils.benchmark``    Tools to help benchmarking.      :githublink:`%|py|5`                                                                                           |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`data_loader <f-dataloader>`                  | module ``onnxcustom.training.data_loader``    Manipulate data for training.      :githublink:`%|py|5`                                                                                    |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`doc_helper <f-dochelper>`                    | module ``onnxcustom.utils.doc_helper``    Helpers to improve documentation rendering.      :githublink:`%|py|5`                                                                          |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`excs <f-excs>`                               | module ``onnxcustom.training.excs``    Exceptions.      :githublink:`%|py|5`                                                                                                             |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`grad_helper <f-gradhelper>`                  | module ``onnxcustom.training.grad_helper``    ONNX and gradient.      :githublink:`%|py|6`                                                                                               |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`imagenet_classes <f-imagenetclasses>`        | module ``onnxcustom.utils.imagenet_classes``    Informations related to the :epkg:`ImageNet` competition.      :githublink:`%|py|5`                                                      |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`nvprof2json <f-nvprof2json>`                 | module ``onnxcustom.utils.nvprof2json``    Converts traces from :epkg:`nvprof`.  The source comes from `nvprof2json <https://github.com/ezyang/nvprof2json>`_.      :githublink:`%|py|6` |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnx_function <f-onnxfunction>`              | module ``onnxcustom.utils.onnx_function``    Onnx helper.      :githublink:`%|py|6`                                                                                                      |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnx_helper <f-onnxhelper>`                  | module ``onnxcustom.utils.onnx_helper``    Onnx implementation of common functions used to train a model.      :githublink:`%|py|6`                                                      |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnx_rewriter <f-onnxrewriter>`              | module ``onnxcustom.utils.onnx_rewriter``    Rewrites operator in ONNX graph.      :githublink:`%|py|5`                                                                                  |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnx_split <f-onnxsplit>`                    | module ``onnxcustom.utils.onnx_split``    Helpers to split an ONNX models.      :githublink:`%|py|5`                                                                                     |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`onnxruntime_helper <f-onnxruntimehelper>`    | module ``onnxcustom.utils.onnxruntime_helper``    Onnxruntime helper.      :githublink:`%|py|5`                                                                                          |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`optimizers <f-optimizers>`                   | module ``onnxcustom.training.optimizers``    Optimizer with :epkg:`onnxruntime-training`.      :githublink:`%|py|5`                                                                      |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`optimizers_partial <f-optimizerspartial>`    | module ``onnxcustom.training.optimizers_partial``    Optimizer with :epkg:`onnxruntime-training` forward backward training.      :githublink:`%|py|5`                                    |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`ortgradient <f-ortgradient>`                 | module ``onnxcustom.training.ortgradient``    Gradient with :epkg:`onnxruntime-training` forward backward.      :githublink:`%|py|6`                                                     |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`orttraining_helper <f-orttraininghelper>`    | module ``onnxcustom.utils.orttraining_helper``    ONNX manipulations to help build ONNX gradient graphs.      :githublink:`%|py|6`                                                       |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`plotting_onnx <f-plottingonnx>`              | module ``onnxcustom.plotting.plotting_onnx``    Shortcuts to plotting.      :githublink:`%|py|6`                                                                                         |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`print_helper <f-printhelper>`                | module ``onnxcustom.utils.print_helper``    Helpers to display internal structures.      :githublink:`%|py|5`                                                                            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`profiling <f-profiling>`                     | module ``onnxcustom.cli.profiling``    Command lines for profiling.      :githublink:`%|py|5`                                                                                            |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sgd_learning_loss <f-sgdlearningloss>`       | module ``onnxcustom.training.sgd_learning_loss``    Helper for :epkg:`onnxruntime-training`.      :githublink:`%|py|6`                                                                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sgd_learning_penalty <f-sgdlearningpenalty>` | module ``onnxcustom.training.sgd_learning_penalty``    Helper for :epkg:`onnxruntime-training`.      :githublink:`%|py|6`                                                                |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`sgd_learning_rate <f-sgdlearningrate>`       | module ``onnxcustom.training.sgd_learning_rate``    Helper for :epkg:`onnxruntime-training`.      :githublink:`%|py|6`                                                                   |
+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


.. toctree::
    :maxdepth: 1

    onnxcustom/__init__
    onnxcustom/__main__
    onnxcustom/cli/__init__
    onnxcustom/cli/profiling
    onnxcustom/plotting/__init__
    onnxcustom/plotting/plotting_onnx
    onnxcustom/training/__init__
    onnxcustom/training/_base
    onnxcustom/training/_base_estimator
    onnxcustom/training/_base_onnx_function
    onnxcustom/training/data_loader
    onnxcustom/training/excs
    onnxcustom/training/grad_helper
    onnxcustom/training/optimizers
    onnxcustom/training/optimizers_partial
    onnxcustom/training/ortgradient
    onnxcustom/training/sgd_learning_loss
    onnxcustom/training/sgd_learning_penalty
    onnxcustom/training/sgd_learning_rate
    onnxcustom/utils/__init__
    onnxcustom/utils/benchmark
    onnxcustom/utils/doc_helper
    onnxcustom/utils/imagenet_classes
    onnxcustom/utils/nvprof2json
    onnxcustom/utils/onnx_function
    onnxcustom/utils/onnx_helper
    onnxcustom/utils/onnx_rewriter
    onnxcustom/utils/onnx_split
    onnxcustom/utils/onnxruntime_helper
    onnxcustom/utils/orttraining_helper
    onnxcustom/utils/print_helper