:orphan:

Proto Examples
==============

Examples demonstrating the proto features of onnx-light.


.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example benchmarks two ways to re-align tensor offsets in an ONNX model that stores its weights as external data:">

.. only:: html

  .. image:: /auto_examples_proto/images/thumb/sphx_glr_plot_align_external_data_streaming_thumb.png
    :alt:

  :doc:`/auto_examples_proto/plot_align_external_data_streaming`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Benchmark streaming vs in-memory alignment of external data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use onnx_light.onnx.ParseOptions.node_callback and onnx_light.onnx.SerializeOptions.node_callback to hook into every onnx_light.onnx.NodeProto of a model.">

.. only:: html

  .. image:: /auto_examples_proto/images/thumb/sphx_glr_plot_node_callback_thumb.png
    :alt:

  :doc:`/auto_examples_proto/plot_node_callback`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Inspect and edit nodes while parsing or serializing with a node callback</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to load and save ONNX models that store tensor weights in separate external data files.  The approach allows the graph structure to be inspected independently of the (potentially very large) weight payload and enables memory-mapping the weight file directly when the model is loaded back through onnx_light.onnx.load.">

.. only:: html

  .. image:: /auto_examples_proto/images/thumb/sphx_glr_plot_load_save_external_thumb.png
    :alt:

  :doc:`/auto_examples_proto/plot_load_save_external`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Load and save ONNX models with external data</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This script builds a small ONNX model and benchmarks the time to load and save it using onnx, onnx_light.onnx, and onnxruntime. When the standalone C++ example executables load_onnx_time, load_onnx_light_time, and save_onnx_light_time are available, it also includes their timing output. The model structure is identical in all cases.">

.. only:: html

  .. image:: /auto_examples_proto/images/thumb/sphx_glr_plot_onnx_time_thumb.png
    :alt:

  :doc:`/auto_examples_proto/plot_onnx_time`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Measures loading and saving time for an ONNX model</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example benchmarks onnx_light.onnx.load and onnx_light.onnx.save while varying the num_threads parameter across three on-disk layouts:">

.. only:: html

  .. image:: /auto_examples_proto/images/thumb/sphx_glr_plot_threads_load_save_thumb.png
    :alt:

  :doc:`/auto_examples_proto/plot_threads_load_save`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Number of threads used to load and save ONNX models</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example profiles how long it takes to save a model with external data using onnx and onnx_light.onnx.">

.. only:: html

  .. image:: /auto_examples_proto/images/thumb/sphx_glr_plot_save_external_data_time_thumb.png
    :alt:

  :doc:`/auto_examples_proto/plot_save_external_data_time`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Profiles ONNX external-data save time</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="onnxruntime defines a flatbuffer serialization (``.ort``) of an ONNX model. It is typically used in size-constrained deployments because it can be memory-mapped directly into the runtime and avoids a protobuf parsing step.">

.. only:: html

  .. image:: /auto_examples_proto/images/thumb/sphx_glr_plot_save_ort_flatbuffers_thumb.png
    :alt:

  :doc:`/auto_examples_proto/plot_save_ort_flatbuffers`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Save an ONNX model in the ORT flatbuffer format and compare sizes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use onnx_light.onnx.ParseOptions.raw_data_callback to hook into model parsing.  The callback is invoked for every onnx_light.onnx.TensorProto once its raw_data has been resolved (including external-data tensors, after their bytes have been loaded).">

.. only:: html

  .. image:: /auto_examples_proto/images/thumb/sphx_glr_plot_raw_data_callback_thumb.png
    :alt:

  :doc:`/auto_examples_proto/plot_raw_data_callback`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Track tensor weights while parsing with a raw_data callback</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples_proto/plot_align_external_data_streaming
   /auto_examples_proto/plot_node_callback
   /auto_examples_proto/plot_load_save_external
   /auto_examples_proto/plot_onnx_time
   /auto_examples_proto/plot_threads_load_save
   /auto_examples_proto/plot_save_external_data_time
   /auto_examples_proto/plot_save_ort_flatbuffers
   /auto_examples_proto/plot_raw_data_callback


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download all examples in Python source code: auto_examples_proto_python.zip </auto_examples_proto/auto_examples_proto_python.zip>`

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download all examples in Jupyter notebooks: auto_examples_proto_jupyter.zip </auto_examples_proto/auto_examples_proto_jupyter.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_