Generating docs

Author: lapid92

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e8534f6a2f0b425ce862dbeb0800af00
+config: 0ea336ad60b6f25f2eb2c0bcb6e36019
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/api/api_docs/classes/MixedPrecisionQuantizationConfig.rst.txt

@@ -9,3 +9,19 @@ MixedPrecisionQuantizationConfig
 
 .. autoclass:: model_compression_toolkit.core.MixedPrecisionQuantizationConfig
 
+
+=================================
+MpDistanceWeighting
+=================================
+
+.. autoclass:: model_compression_toolkit.core.MpDistanceWeighting
+    :members:
+
+
+=================================
+MpMetricNormalization
+=================================
+
+.. autoclass:: model_compression_toolkit.core.MpMetricNormalization
+    :members:
+

docs/_sources/api/api_docs/classes/MpDistanceWeighting.rst.txt

@@ -51,7 +51,6 @@ core
 - :ref:`MixedPrecisionQuantizationConfig<ug-MixedPrecisionQuantizationConfig>`: Module to configure the quantization process when using mixed-precision PTQ.
 - :ref:`BitWidthConfig<ug-BitWidthConfig>`: Module to configure the bit-width manually.
 - :ref:`ResourceUtilization<ug-ResourceUtilization>`: Module to configure resources to use when searching for a configuration for the optimized model.
-- :ref:`MpDistanceWeighting<ug-MpDistanceWeighting>`: Mixed precision distance metric weighting methods.
 - :ref:`network_editor<ug-network_editor>`: Module to modify the optimization process for troubleshooting.
 - :ref:`pytorch_resource_utilization_data<ug-pytorch_resource_utilization_data>`: A function to compute Resource Utilization data that can be used to calculate the desired target resource utilization for PyTorch models.
 - :ref:`keras_resource_utilization_data<ug-keras_resource_utilization_data>`: A function to compute Resource Utilization data that can be used to calculate the desired target resource utilization for Keras models.

docs/_sources/api/api_docs/index.rst.txt

@@ -173,6 +173,22 @@ By default, the used ONNX opset version is 15, but this can be changed using `on
 
 |
 
++++++++++++++++++++++++++++
+ONNX model output names
++++++++++++++++++++++++++++
+
+To set the model output names the argument `output_names` can be used:
+
+.. code-block:: python
+
+    mct.exporter.pytorch_export_model(
+        model=quantized_exportable_model,
+        save_model_path=onnx_file_path,
+        repr_dataset=representative_data_gen,
+        output_names=['model_output'])
+
+|
+
 ++++++++++++++++++++++++++++++++++++
 Use exported model for inference
 ++++++++++++++++++++++++++++++++++++

docs/_sources/api/api_docs/modules/exporter.rst.txt

@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>BitWidthConfig &#8212; MCT Documentation: ver 2.3.0</title>
+    <title>BitWidthConfig &#8212; MCT Documentation: ver 2.4.2</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css" />
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">BitWidthConfig</a></li> 
       </ul>
     </div>  
@@ -45,19 +45,30 @@ <h3>Navigation</h3>
 <span id="ug-bitwidthconfig"></span><h1>BitWidthConfig<a class="headerlink" href="#bitwidthconfig" title="Permalink to this heading">¶</a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="model_compression_toolkit.core.BitWidthConfig">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">model_compression_toolkit.core.</span></span><span class="sig-name descname"><span class="pre">BitWidthConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manual_activation_bit_width_selection_list=&lt;factory&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#model_compression_toolkit.core.BitWidthConfig" title="Permalink to this definition">¶</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">model_compression_toolkit.core.</span></span><span class="sig-name descname"><span class="pre">BitWidthConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manual_activation_bit_width_selection_list=&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">manual_weights_bit_width_selection_list=&lt;factory&gt;</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#model_compression_toolkit.core.BitWidthConfig" title="Permalink to this definition">¶</a></dt>
 <dd><p>Class to manage manual bit-width configurations.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="model_compression_toolkit.core.BitWidthConfig.manual_activation_bit_width_selection_list">
 <span class="sig-name descname"><span class="pre">manual_activation_bit_width_selection_list</span></span><a class="headerlink" href="#model_compression_toolkit.core.BitWidthConfig.manual_activation_bit_width_selection_list" title="Permalink to this definition">¶</a></dt>
-<dd><p>A list of ManualBitWidthSelection objects defining manual bit-width configurations.</p>
+<dd><p>A list of ManualBitWidthSelection objects for activation defining manual bit-width configurations.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Type<span class="colon">:</span></dt>
 <dd class="field-odd"><p>List[<a class="reference internal" href="#model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection" title="model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection">ManualBitWidthSelection</a>]</p>
 </dd>
 </dl>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="model_compression_toolkit.core.BitWidthConfig.manual_weights_bit_width_selection_list">
+<span class="sig-name descname"><span class="pre">manual_weights_bit_width_selection_list</span></span><a class="headerlink" href="#model_compression_toolkit.core.BitWidthConfig.manual_weights_bit_width_selection_list" title="Permalink to this definition">¶</a></dt>
+<dd><p>A list of ManualWeightsBitWidthSelection for weights objects defining manual bit-width configurations.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>List[ManualWeightsBitWidthSelection]</p>
+</dd>
+</dl>
+</dd></dl>
+
 </dd></dl>
 
 </section>
@@ -128,7 +139,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">BitWidthConfig</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/BitWidthConfig.html

@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>Data Generation Configuration &#8212; MCT Documentation: ver 2.3.0</title>
+    <title>Data Generation Configuration &#8212; MCT Documentation: ver 2.4.2</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css" />
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Data Generation Configuration</a></li> 
       </ul>
     </div>  
@@ -211,7 +211,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Data Generation Configuration</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/DataGenerationConfig.html

@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>DefaultDict Class &#8212; MCT Documentation: ver 2.3.0</title>
+    <title>DefaultDict Class &#8212; MCT Documentation: ver 2.4.2</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css" />
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">DefaultDict Class</a></li> 
       </ul>
     </div>  
@@ -114,7 +114,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">DefaultDict Class</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/DefaultDict.html

@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>FrameworkInfo Class &#8212; MCT Documentation: ver 2.3.0</title>
+    <title>FrameworkInfo Class &#8212; MCT Documentation: ver 2.4.2</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css" />
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">FrameworkInfo Class</a></li> 
       </ul>
     </div>  
@@ -144,7 +144,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">FrameworkInfo Class</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/FrameworkInfo.html

@@ -7,7 +7,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-    <title>GradientPTQConfig Class &#8212; MCT Documentation: ver 2.3.0</title>
+    <title>GradientPTQConfig Class &#8212; MCT Documentation: ver 2.4.2</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css" />
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              accesskey="I">index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">GradientPTQConfig Class</a></li> 
       </ul>
     </div>  
@@ -180,7 +180,7 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="../../../genindex.html" title="General Index"
              >index</a></li>
-        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.3.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.4.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">GradientPTQConfig Class</a></li> 
       </ul>
     </div>