Update API document for TPC

docs/.buildinfo

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

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

@@ -109,7 +109,8 @@ keras_load_quantized_model
 target_platform_capabilities
 ==============================
 - :ref:`target_platform_capabilities<ug-target_platform_capabilities>`: Module to create and model hardware-related settings to optimize the model according to, by the hardware the optimized model will use during inference.
-- :ref:`get_target_platform_capabilities<ug-get_target_platform_capabilities>`: A function to get a target platform model for Tensorflow and Pytorch.
+- :ref:`get_target_platform_capabilities<ug-get_target_platform_capabilities>`: A function to get a TargetPlatformCapabilities for tpc version and device type.
+- :ref:`get_target_platform_capabilities_sdsp<ug-get_target_platform_capabilities_sdsp>`: A function to get a TargetPlatformCapabilities for sdsp converter version.
 - :ref:`DefaultDict<ug-DefaultDict>`: Util class for creating a TargetPlatformCapabilities.
 
 wrapper

docs/_sources/api/api_docs/methods/get_target_platform_capabilities.rst.txt

@@ -3,9 +3,9 @@
 .. _ug-get_target_platform_capabilities:
 
 
-=======================================
-Get FrameworkQuantizationCapabilities
-=======================================
+=====================================================
+Get TargetPlatformCapabilities for tpc version
+=====================================================
 
 .. autofunction:: model_compression_toolkit.get_target_platform_capabilities
 

docs/_sources/api/api_docs/methods/get_target_platform_capabilities_sdsp.rst.txt

@@ -0,0 +1,13 @@
+:orphan:
+
+.. _ug-get_target_platform_capabilities_sdsp:
+
+
+=============================================================
+Get TargetPlatformCapabilities for sdsp converter version
+=============================================================
+
+.. autofunction:: model_compression_toolkit.get_target_platform_capabilities_sdsp
+
+
+.. include:: ../notes/tpc_note.rst

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

@@ -16,7 +16,8 @@ Conv2D <https://www.tensorflow.org/lite/performance/quantization_spec#per-axis_v
 
 This can be addressed in MCT by using the target_platform_capabilities module, that can configure different
 parameters that are hardware-related, and the optimization process will use this to optimize the model accordingly.
-Models for IMX500, TFLite and qnnpack can be observed `here <https://github.com/SonySemiconductorSolutions/mct-model-optimization/tree/main/model_compression_toolkit/target_platform_capabilities>`_, and can be used using :ref:`get_target_platform_capabilities function<ug-get_target_platform_capabilities>`.
+Models for IMX500, TFLite and qnnpack can be observed `here <https://github.com/SonySemiconductorSolutions/mct-model-optimization/tree/main/model_compression_toolkit/target_platform_capabilities>`_, and can be retrieved using :ref:`get_target_platform_capabilities function<ug-get_target_platform_capabilities>`.
+You can also get the model for IMX500 using :ref:`get_target_platform_capabilities_sdsp function<ug-get_target_platform_capabilities_sdsp>` that specifies the sdsp converter version.
 
 |
 

docs/api/api_docs/classes/BitWidthConfig.html

@@ -6,12 +6,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>BitWidthConfig &#8212; MCT Documentation: ver 2.5.0</title>
+    <title>BitWidthConfig &#8212; MCT Documentation: ver 2.5.1</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css?v=5283bb3d" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css?v=01243f34" />
 
-    <script src="../../../static/documentation_options.js?v=3c4615cf"></script>
+    <script src="../../../static/documentation_options.js?v=983e91d6"></script>
     <script src="../../../static/doctools.js?v=9bcbadda"></script>
     <script src="../../../static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../static/bizstyle.js"></script>
@@ -28,7 +28,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">BitWidthConfig</a></li> 
       </ul>
     </div>  
@@ -150,7 +150,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">BitWidthConfig</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/DataGenerationConfig.html

@@ -6,12 +6,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Data Generation Configuration &#8212; MCT Documentation: ver 2.5.0</title>
+    <title>Data Generation Configuration &#8212; MCT Documentation: ver 2.5.1</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css?v=5283bb3d" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css?v=01243f34" />
 
-    <script src="../../../static/documentation_options.js?v=3c4615cf"></script>
+    <script src="../../../static/documentation_options.js?v=983e91d6"></script>
     <script src="../../../static/doctools.js?v=9bcbadda"></script>
     <script src="../../../static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../static/bizstyle.js"></script>
@@ -28,7 +28,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Data Generation Configuration</a></li> 
       </ul>
     </div>  
@@ -233,7 +233,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Data Generation Configuration</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/DefaultDict.html

@@ -6,12 +6,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>DefaultDict Class &#8212; MCT Documentation: ver 2.5.0</title>
+    <title>DefaultDict Class &#8212; MCT Documentation: ver 2.5.1</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css?v=5283bb3d" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css?v=01243f34" />
 
-    <script src="../../../static/documentation_options.js?v=3c4615cf"></script>
+    <script src="../../../static/documentation_options.js?v=983e91d6"></script>
     <script src="../../../static/doctools.js?v=9bcbadda"></script>
     <script src="../../../static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../static/bizstyle.js"></script>
@@ -28,7 +28,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">DefaultDict Class</a></li> 
       </ul>
     </div>  
@@ -125,7 +125,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">DefaultDict Class</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/FrameworkInfo.html

@@ -6,12 +6,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>FrameworkInfo Class &#8212; MCT Documentation: ver 2.5.0</title>
+    <title>FrameworkInfo Class &#8212; MCT Documentation: ver 2.5.1</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css?v=5283bb3d" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css?v=01243f34" />
 
-    <script src="../../../static/documentation_options.js?v=3c4615cf"></script>
+    <script src="../../../static/documentation_options.js?v=983e91d6"></script>
     <script src="../../../static/doctools.js?v=9bcbadda"></script>
     <script src="../../../static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../static/bizstyle.js"></script>
@@ -28,7 +28,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">FrameworkInfo Class</a></li> 
       </ul>
     </div>  
@@ -145,7 +145,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">FrameworkInfo Class</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/GradientPTQConfig.html

@@ -6,12 +6,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>GradientPTQConfig Class &#8212; MCT Documentation: ver 2.5.0</title>
+    <title>GradientPTQConfig Class &#8212; MCT Documentation: ver 2.5.1</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css?v=5283bb3d" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css?v=01243f34" />
 
-    <script src="../../../static/documentation_options.js?v=3c4615cf"></script>
+    <script src="../../../static/documentation_options.js?v=983e91d6"></script>
     <script src="../../../static/doctools.js?v=9bcbadda"></script>
     <script src="../../../static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../static/bizstyle.js"></script>
@@ -28,7 +28,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">GradientPTQConfig Class</a></li> 
       </ul>
     </div>  
@@ -192,7 +192,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">GradientPTQConfig Class</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/MixedPrecisionQuantizationConfig.html

@@ -6,12 +6,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>MixedPrecisionQuantizationConfig &#8212; MCT Documentation: ver 2.5.0</title>
+    <title>MixedPrecisionQuantizationConfig &#8212; MCT Documentation: ver 2.5.1</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css?v=5283bb3d" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css?v=01243f34" />
 
-    <script src="../../../static/documentation_options.js?v=3c4615cf"></script>
+    <script src="../../../static/documentation_options.js?v=983e91d6"></script>
     <script src="../../../static/doctools.js?v=9bcbadda"></script>
     <script src="../../../static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../static/bizstyle.js"></script>
@@ -28,7 +28,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">MixedPrecisionQuantizationConfig</a></li> 
       </ul>
     </div>  
@@ -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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">MixedPrecisionQuantizationConfig</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/PruningConfig.html

@@ -6,12 +6,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Pruning Configuration &#8212; MCT Documentation: ver 2.5.0</title>
+    <title>Pruning Configuration &#8212; MCT Documentation: ver 2.5.1</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css?v=5283bb3d" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css?v=01243f34" />
 
-    <script src="../../../static/documentation_options.js?v=3c4615cf"></script>
+    <script src="../../../static/documentation_options.js?v=983e91d6"></script>
     <script src="../../../static/doctools.js?v=9bcbadda"></script>
     <script src="../../../static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../static/bizstyle.js"></script>
@@ -28,7 +28,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Pruning Configuration</a></li> 
       </ul>
     </div>  
@@ -168,7 +168,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Pruning Configuration</a></li> 
       </ul>
     </div>

docs/api/api_docs/classes/PruningInfo.html

@@ -6,12 +6,12 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Pruning Information &#8212; MCT Documentation: ver 2.5.0</title>
+    <title>Pruning Information &#8212; MCT Documentation: ver 2.5.1</title>
     <link rel="stylesheet" type="text/css" href="../../../static/pygments.css?v=03e43079" />
     <link rel="stylesheet" type="text/css" href="../../../static/bizstyle.css?v=5283bb3d" />
     <link rel="stylesheet" type="text/css" href="../../../static/css/custom.css?v=01243f34" />
 
-    <script src="../../../static/documentation_options.js?v=3c4615cf"></script>
+    <script src="../../../static/documentation_options.js?v=983e91d6"></script>
     <script src="../../../static/doctools.js?v=9bcbadda"></script>
     <script src="../../../static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../static/bizstyle.js"></script>
@@ -28,7 +28,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Pruning Information</a></li> 
       </ul>
     </div>  
@@ -127,7 +127,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.5.0</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../index.html">MCT Documentation: ver 2.5.1</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Pruning Information</a></li> 
       </ul>
     </div>