Aidge quantization API
======================

.. contents::
   :depth: 2
   :local:

Post-Training Quantization (PTQ)
--------------------------------

High-level methods
~~~~~~~~~~~~~~~~~~

.. autofunction:: aidge_quantization.auto_assign_node_precision

.. autofunction:: aidge_quantization.quantize_network

:class:`aidge_quantization.quantize_network` performs the following operations in order:

#. :class:`aidge_quantization.check_architecture`
#. :class:`aidge_quantization.prepare_network`
#. :class:`aidge_quantization.insert_scaling_nodes`
#. :class:`aidge_quantization.cross_layer_equalization`
#. :class:`aidge_quantization.normalize_parameters`
#. ``ranges`` = :class:`aidge_quantization.compute_ranges`
#. :class:`aidge_quantization.adjust_ranges` (``ranges``)
#. :class:`aidge_quantization.normalize_activations` (``ranges``)
#. :class:`aidge_quantization.quantize_normalized_network`
#. (``if`` **dequantize**) :class:`aidge_quantization.perform_dequantization`
#. (``if`` **single_shift**) :class:`aidge_quantization.insert_compensation_nodes`
#. (``if`` **single_shift**) :class:`aidge_quantization.perform_single_shift_approximation`
#. (``if`` ``not`` **fake_quantize**) :class:`aidge_quantization.cast_quantized_network`
#. (``if`` **fold_graph**) :class:`aidge_quantization.fold_producer_quantizers`


Low-level methods
~~~~~~~~~~~~~~~~~

.. autofunction:: aidge_quantization.check_architecture

.. autofunction:: aidge_quantization.prepare_network

.. autofunction:: aidge_quantization.insert_scaling_nodes

.. autofunction:: aidge_quantization.cross_layer_equalization

.. autofunction:: aidge_quantization.normalize_parameters

.. autofunction:: aidge_quantization.compute_ranges

.. autofunction:: aidge_quantization.adjust_ranges

.. autofunction:: aidge_quantization.normalize_activations

.. autofunction:: aidge_quantization.quantize_normalized_network

.. .. autofunction:: aidge_quantization.perform_dequantization

.. autofunction:: aidge_quantization.insert_compensation_nodes

.. autofunction:: aidge_quantization.perform_single_shift_approximation

.. autofunction:: aidge_quantization.cast_quantized_network

.. autofunction:: aidge_quantization.fold_producer_quantizers


Quantization Aware training (QAT)
---------------------------------

LSQ method
~~~~~~~~~~

.. autofunction:: aidge_quantization.lsq.setup_quantizers

.. autofunction:: aidge_quantization.lsq.post_training_transform

SAT method
~~~~~~~~~~

.. autofunction:: aidge_quantization.sat.insert_param_clamping

.. autofunction:: aidge_quantization.sat.insert_param_scaling_adjust

.. autofunction:: aidge_quantization.sat.insert_sat_nodes

.. autofunction:: aidge_quantization.sat.insert_param_quantizers

.. autofunction:: aidge_quantization.sat.insert_activ_quantizers

.. autofunction:: aidge_quantization.sat.post_training_transform


Predefined operators
--------------------

.. jinja:: quantization
   :file: jinja/predefined_ops.jinja
   :header_char: -