Release version 2.2.0 (#1172)

Update version to 2.2 Add docsrc for missing parts (BitWidthConfig and xquant APIs).
sony · Aug 20, 2024 · df0dbc1 · df0dbc1
1 parent 08f55ae
commit df0dbc1
Show file tree

Hide file tree

Showing 67 changed files with 799 additions and 177 deletions.
diff --git a/docs/.buildinfo b/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: 5cc6500fd7d8a78cea89aef3268de5c5
+config: 463b5d411b812fb296a8f7bff970d1cf
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_sources/api/api_docs/classes/BitWidthConfig.rst.txt b/docs/_sources/api/api_docs/classes/BitWidthConfig.rst.txt
@@ -0,0 +1,14 @@
+:orphan:
+
+.. _ug-BitWidthConfig:
+
+
+BitWidthConfig
+==========================
+
+.. autoclass:: model_compression_toolkit.core.BitWidthConfig
+
+ManualBitWidthSelection
+==========================
+
+.. autoclass:: model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection
diff --git a/docs/_sources/api/api_docs/classes/XQuantConfig.rst.txt b/docs/_sources/api/api_docs/classes/XQuantConfig.rst.txt
@@ -0,0 +1,14 @@
+:orphan:
+
+.. _ug-XQuantConfig:
+
+================================================
+XQuant Configuration
+================================================
+
+.. autoclass:: model_compression_toolkit.xquant.common.xquant_config.XQuantConfig
+    :members:
+
+
+
+
diff --git a/docs/_sources/api/api_docs/index.rst.txt b/docs/_sources/api/api_docs/index.rst.txt
@@ -49,6 +49,7 @@ core
 - :ref:`QuantizationConfig<ug-QuantizationConfig>`: Module to configure the quantization process.
 - :ref:`QuantizationErrorMethod<ug-QuantizationErrorMethod>`: Select a method for quantization parameters' selection.
 - :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.
@@ -75,6 +76,13 @@ pruning
 - :ref:`PruningConfig<ug-PruningConfig>`: Configuration for the pruning process (experimental).
 - :ref:`PruningInfo<ug-PruningInfo>`: Information about the pruned model such as pruned channel indices, etc. (experimental).
 
+xquant
+===========
+
+- :ref:`xquant_report_pytorch_experimental<ug-xquant_report_pytorch_experimental>`: A function to generate an explainable quantization report for a quantized Pytorch model (experimental).
+- :ref:`xquant_report_keras_experimental<ug-xquant_report_keras_experimental>`: A function to generate an explainable quantization report for a quantized Keras model (experimental).
+
+- :ref:`XQuantConfig<ug-XQuantConfig>`: Configuration for the XQuant report (experimental).
 
 exporter
 =========

diff --git a/docs/_sources/api/api_docs/methods/xquant_report_keras_experimental.rst.txt b/docs/_sources/api/api_docs/methods/xquant_report_keras_experimental.rst.txt
@@ -0,0 +1,12 @@
+:orphan:
+
+.. _ug-xquant_report_keras_experimental:
+
+
+================================================
+XQuant Report Keras
+================================================
+
+.. autofunction:: model_compression_toolkit.xquant.keras.facade_xquant_report.xquant_report_keras_experimental
+
+
diff --git a/docs/_sources/api/api_docs/methods/xquant_report_pytorch_experimental.rst.txt b/docs/_sources/api/api_docs/methods/xquant_report_pytorch_experimental.rst.txt
@@ -0,0 +1,15 @@
+:orphan:
+
+.. _ug-xquant_report_pytorch_experimental:
+
+
+================================================
+XQuant Report Pytorch
+================================================
+
+.. autofunction:: model_compression_toolkit.xquant.pytorch.facade_xquant_report.xquant_report_pytorch_experimental
+
+
+
+
+
diff --git a/docs/api/api_docs/classes/BitWidthConfig.html b/docs/api/api_docs/classes/BitWidthConfig.html
@@ -0,0 +1,140 @@
+
+
+<!doctype html>
+
+<html lang="en">
+  <head>
+    <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.2.0</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" />
+
+    <script data-url_root="../../../" id="documentation_options" src="../../../static/documentation_options.js"></script>
+    <script src="../../../static/jquery.js"></script>
+    <script src="../../../static/underscore.js"></script>
+    <script src="../../../static/_sphinx_javascript_frameworks_compat.js"></script>
+    <script src="../../../static/doctools.js"></script>
+    <script src="../../../static/bizstyle.js"></script>
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <!--[if lt IE 9]>
+    <script src="static/css3-mediaqueries.js"></script>
+    <![endif]-->
+  </head><body>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <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.2.0</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">BitWidthConfig</a></li> 
+      </ul>
+    </div>  
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <section id="bitwidthconfig">
+<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</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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>
+<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>
+
+</dd></dl>
+
+</section>
+<section id="manualbitwidthselection">
+<h1>ManualBitWidthSelection<a class="headerlink" href="#manualbitwidthselection" title="Permalink to this heading">¶</a></h1>
+<dl class="py class">
+<dt class="sig sig-object py" id="model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection">
+<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.common.quantization.bit_width_config.</span></span><span class="sig-name descname"><span class="pre">ManualBitWidthSelection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bit_width</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection" title="Permalink to this definition">¶</a></dt>
+<dd><p>Class to encapsulate the manual bit width selection configuration for a specific filter.</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection.filter">
+<span class="sig-name descname"><span class="pre">filter</span></span><a class="headerlink" href="#model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection.filter" title="Permalink to this definition">¶</a></dt>
+<dd><p>The filter used to select nodes for bit width manipulation.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>BaseNodeMatcher</p>
+</dd>
+</dl>
+</dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection.bit_width">
+<span class="sig-name descname"><span class="pre">bit_width</span></span><a class="headerlink" href="#model_compression_toolkit.core.common.quantization.bit_width_config.ManualBitWidthSelection.bit_width" title="Permalink to this definition">¶</a></dt>
+<dd><p>The bit width to be applied to the selected nodes.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>int</p>
+</dd>
+</dl>
+</dd></dl>
+
+</dd></dl>
+
+</section>
+
+
+            <div class="clearer"></div>
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+  <div>
+    <h3><a href="../../../index.html">Table of Contents</a></h3>
+    <ul>
+<li><a class="reference internal" href="#">BitWidthConfig</a></li>
+<li><a class="reference internal" href="#manualbitwidthselection">ManualBitWidthSelection</a></li>
+</ul>
+
+  </div>
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../../../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>document.getElementById('searchbox').style.display = "block"</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related" role="navigation" aria-label="related navigation">
+      <h3>Navigation</h3>
+      <ul>
+        <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.2.0</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">BitWidthConfig</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+        &#169; Copyright 2022, Sony Semiconductor Israel.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
+    </div>
+  </body>
+</html>