update docs

sony · Nov 10, 2024 · 163e1af · 163e1af
1 parent 48b60aa
commit 163e1af
Show file tree

Hide file tree

Showing 56 changed files with 345 additions and 351 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: 2fb2cc6e5f3aae6532950b8870c49f86
+config: cafb66332a4a1e08746ff7b8a5153f88
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/api/api_docs/classes/BitWidthConfig.html b/docs/api/api_docs/classes/BitWidthConfig.html
@@ -5,9 +5,9 @@
 <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/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>BitWidthConfig &#8212; MCT Documentation: ver 2.2.1</title>
+    <title>BitWidthConfig &#8212; MCT Documentation: ver 2.2.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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">BitWidthConfig</a></li> 
       </ul>
     </div>  
@@ -52,7 +52,7 @@ <h3>Navigation</h3>
 <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>
+<dt class="field-odd">Type</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>
@@ -72,7 +72,7 @@ <h1>ManualBitWidthSelection<a class="headerlink" href="#manualbitwidthselection"
 <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>
+<dt class="field-odd">Type</dt>
 <dd class="field-odd"><p>BaseNodeMatcher</p>
 </dd>
 </dl>
@@ -83,7 +83,7 @@ <h1>ManualBitWidthSelection<a class="headerlink" href="#manualbitwidthselection"
 <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>
+<dt class="field-odd">Type</dt>
 <dd class="field-odd"><p>int</p>
 </dd>
 </dl>
@@ -128,7 +128,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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">BitWidthConfig</a></li> 
       </ul>
     </div>

diff --git a/docs/api/api_docs/classes/DataGenerationConfig.html b/docs/api/api_docs/classes/DataGenerationConfig.html
@@ -5,9 +5,9 @@
 <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/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Data Generation Configuration &#8212; MCT Documentation: ver 2.2.1</title>
+    <title>Data Generation Configuration &#8212; MCT Documentation: ver 2.2.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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Data Generation Configuration</a></li> 
       </ul>
     </div>  
@@ -49,7 +49,7 @@ <h3>Navigation</h3>
 <dd><p>Configuration class for data generation.</p>
 <p>Initialize the DataGenerationConfig.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>n_iter</strong> (<em>int</em>) – Number of iterations for data generation.</p></li>
 <li><p><strong>optimizer</strong> (<em>Any</em>) – The optimizer used for data generation.</p></li>
@@ -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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Data Generation Configuration</a></li> 
       </ul>
     </div>

diff --git a/docs/api/api_docs/classes/DefaultDict.html b/docs/api/api_docs/classes/DefaultDict.html
@@ -5,9 +5,9 @@
 <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/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>DefaultDict Class &#8212; MCT Documentation: ver 2.2.1</title>
+    <title>DefaultDict Class &#8212; MCT Documentation: ver 2.2.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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">DefaultDict Class</a></li> 
       </ul>
     </div>  
@@ -50,7 +50,7 @@ <h3>Navigation</h3>
 values when requested. If the requested key is not presented at initial dictionary,
 it returns the returned value a default value (that is passed at initialization) generates.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>known_dict</strong> – Dictionary to wrap. If None is provided, initializes an empty dictionary.</p></li>
 <li><p><strong>default_value</strong> – default value when requested key is not in known_dict.</p></li>
@@ -63,14 +63,14 @@ <h3>Navigation</h3>
 <dd><p>Get the value of the inner dictionary by the given key, If key is not in dictionary,
 it uses the default_factory to return a default value.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><p><strong>key</strong> – Key to use in inner dictionary.</p>
 </dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dt class="field-even">Returns</dt>
 <dd class="field-even"><p>Value of the inner dictionary by the given key, or a default value if not exist.
 If default_factory was not passed at initialization, it returns None.</p>
 </dd>
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dt class="field-odd">Return type</dt>
 <dd class="field-odd"><p><code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code></p>
 </dd>
 </dl>
@@ -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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">DefaultDict Class</a></li> 
       </ul>
     </div>

diff --git a/docs/api/api_docs/classes/FrameworkInfo.html b/docs/api/api_docs/classes/FrameworkInfo.html
@@ -5,9 +5,9 @@
 <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/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>FrameworkInfo Class &#8212; MCT Documentation: ver 2.2.1</title>
+    <title>FrameworkInfo Class &#8212; MCT Documentation: ver 2.2.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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">FrameworkInfo Class</a></li> 
       </ul>
     </div>  
@@ -55,7 +55,7 @@ <h3>Navigation</h3>
 activation_ops: Layers that their outputs should get quantized (e.g., Add, ReLU, etc.)
 no_quantization_ops:Layers that should not get quantized (e.g., Reshape, Transpose, etc.)</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>activation_quantizer_mapping</strong> (<em>Dict</em><em>[</em><a class="reference internal" href="../modules/target_platform.html#model_compression_toolkit.target_platform.QuantizationMethod" title="model_compression_toolkit.target_platform.QuantizationMethod"><em>QuantizationMethod</em></a><em>, </em><em>Callable</em><em>]</em>) – A dictionary mapping from QuantizationMethod to a quantization function.</p></li>
 <li><p><strong>kernel_channels_mapping</strong> (<a class="reference internal" href="DefaultDict.html#model_compression_toolkit.DefaultDict" title="model_compression_toolkit.DefaultDict"><em>DefaultDict</em></a>) – Dictionary from a layer to a tuple of its kernel in/out channels indices.</p></li>
@@ -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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">FrameworkInfo Class</a></li> 
       </ul>
     </div>

diff --git a/docs/api/api_docs/classes/GradientPTQConfig.html b/docs/api/api_docs/classes/GradientPTQConfig.html
@@ -5,9 +5,9 @@
 <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/" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>GradientPTQConfig Class &#8212; MCT Documentation: ver 2.2.1</title>
+    <title>GradientPTQConfig Class &#8212; MCT Documentation: ver 2.2.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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">GradientPTQConfig Class</a></li> 
       </ul>
     </div>  
@@ -50,7 +50,7 @@ <h3>Navigation</h3>
 <dd><p>Configuration to use for quantization with GradientPTQ.</p>
 <p>Initialize a GradientPTQConfig.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>n_epochs</strong> (<em>int</em>) – Number of representative dataset epochs to train.</p></li>
 <li><p><strong>optimizer</strong> (<em>Any</em>) – Optimizer to use.</p></li>
@@ -82,7 +82,7 @@ <h1>GPTQHessianScoresConfig Class<a class="headerlink" href="#gptqhessianscoresc
 <dd><p>Configuration to use for computing the Hessian-based scores for GPTQ loss metric.</p>
 <p>Initialize a GPTQHessianWeightsConfig.</p>
 <dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>hessians_num_samples</strong> (<em>int</em>) – Number of samples to use for computing the Hessian-based scores.</p></li>
 <li><p><strong>norm_scores</strong> (<em>bool</em>) – Whether to normalize the returned scores of the weighted loss function (to get values between 0 and 1).</p></li>
@@ -143,7 +143,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.2.1</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.2.2</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">GradientPTQConfig Class</a></li> 
       </ul>
     </div>