sony · reuvenperetz · Mar 7, 2024 · Mar 7, 2024 · Mar 7, 2024 · Mar 7, 2024
diff --git a/...rimental_api_docs/classes/DefaultDict.rst → .../api/api_docs/classes/DefaultDict.rst.txt b/...rimental_api_docs/classes/DefaultDict.rst → .../api/api_docs/classes/DefaultDict.rst.txt
diff --git a/docs/_sources/api/api_docs/classes/FolderImageLoader.rst.txt b/docs/_sources/api/api_docs/classes/FolderImageLoader.rst.txt
@@ -0,0 +1,20 @@
+:orphan:
+
+.. _ug-FolderImageLoader:
+
+===============================
+Folder Image Loader API
+===============================
+
+**The following API can be used to load a folder of images to create a representative dataset for PTQ calibration**
+
+.. autoclass:: model_compression_toolkit.core.FolderImageLoader
+    :members:
+
+
+=================================
+Default file types to scan
+=================================
+
+.. autodata:: model_compression_toolkit.core.common.data_loader.FILETYPES
+
diff --git a/docs/_sources/api/api_docs/classes/FrameworkInfo.rst.txt b/docs/_sources/api/api_docs/classes/FrameworkInfo.rst.txt
@@ -0,0 +1,23 @@
+:orphan:
+
+.. _ug-FrameworkInfo:
+
+
+=================================
+FrameworkInfo Class
+=================================
+
+**The following API can be used to pass MCT framework-related information to use when optimizing the network**
+
+.. autoclass:: model_compression_toolkit.core.FrameworkInfo
+
+
+|
+
+
+ChannelAxis
+==========================
+**Enum to select the output channels format in the model:**
+
+.. autoclass:: model_compression_toolkit.core.ChannelAxis
+
diff --git a/docs/_sources/api/api_docs/classes/GradientPTQConfig.rst.txt b/docs/_sources/api/api_docs/classes/GradientPTQConfig.rst.txt
@@ -0,0 +1,24 @@
+:orphan:
+
+.. _ug-GradientPTQConfig:
+
+
+=================================
+GradientPTQConfig Class
+=================================
+
+
+**The following API can be used to create a GradientPTQConfig instance which can be used for post training quantization using knowledge distillation from a teacher (float Keras model) to a student (the quantized Keras model)**
+
+.. autoclass:: model_compression_toolkit.gptq.GradientPTQConfig
+    :members:
+
+=================================
+GPTQHessianScoresConfig Class
+=================================
+
+
+**The following API can be used to create a GPTQHessianScoresConfig instance which can be used to define necessary parameters for computing Hessian scores for the GPTQ loss function.**
+
+.. autoclass:: model_compression_toolkit.gptq.GPTQHessianScoresConfig
+    :members:
diff --git a/docs/_sources/api/api_docs/classes/PruningConfig.rst.txt b/docs/_sources/api/api_docs/classes/PruningConfig.rst.txt
@@ -0,0 +1,9 @@
+:orphan:
+
+.. _ug-PruningConfig:
+
+================================================
+Pruning Configuration
+================================================
+
+.. autofunction:: model_compression_toolkit.pruning.PruningConfig
diff --git a/docs/_sources/api/api_docs/classes/PruningInfo.rst.txt b/docs/_sources/api/api_docs/classes/PruningInfo.rst.txt
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-PruningInfo:
+
+================================================
+Pruning Information
+================================================
+
+.. autofunction:: model_compression_toolkit.pruning.PruningInfo
+
diff --git a/docs/_sources/api/api_docs/index.rst.txt b/docs/_sources/api/api_docs/index.rst.txt
@@ -7,8 +7,6 @@
 API Docs
 =========
 
-.. note:: This API will be removed in future releases. Please switch to the :ref:`new API<ug-experimental_api_docs>`
-
 **Init module for MCT API.**
 
 .. code-block:: python
@@ -17,30 +15,56 @@ API Docs
 
 |
 
+
 Functions
 =========
-- :ref:`pytorch_post_training_quantization<ug-pytorch_post_training_quantization>`: Function to use for post training quantization of Pytorch models.
-- :ref:`pytorch_post_training_quantization_mixed_precision<ug-pytorch_post_training_quantization_mixed_precision>`: Function to use for mixed-precision post training quantization of Pytorch models (experimental).
-- :ref:`keras_post_training_quantization<ug-keras_post_training_quantization>`: Function to use for post training quantization of Keras models.
-- :ref:`keras_post_training_quantization_mixed_precision<ug-keras_post_training_quantization_mixed_precision>`: Function to use for mixed-precision post training quantization of Keras models (experimental).
-- :ref:`get_keras_gptq_config<ug-get_keras_gptq_config>`: Function to create a GradientPTQConfig instance to use for Keras models when using GPTQ (experimental).
-- :ref:`get_target_platform_capabilities<ug-get_target_platform_capabilities>`: Function to get a target platform model for Tensorflow and Pytorch.
-- :ref:`keras_kpi_data<ug-keras_kpi_data>`: Function to compute KPI data that can be used to calculate the desired target KPI for mixed-precision quantization of Keras models.
-- :ref:`pytorch_kpi_data<ug-pytorch_kpi_data>`: Function to compute KPI data that can be used to calculate the desired target KPI for mixed-precision quantization of PyTorch models.
+- :ref:`pytorch_post_training_quantization<ug-pytorch_post_training_quantization>`: A function to use for post training quantization of PyTorch models.
+- :ref:`keras_post_training_quantization<ug-keras_post_training_quantization>`: A function to use for post training quantization of Keras models.
+
+- :ref:`keras_gradient_post_training_quantization<ug-keras_gradient_post_training_quantization>`: A function to use for gradient-based post training quantization of Keras models.
+- :ref:`get_keras_gptq_config<ug-get_keras_gptq_config>`: A function to create a GradientPTQConfig instance to use for Keras models when using GPTQ.
+
+- :ref:`pytorch_gradient_post_training_quantization<ug-pytorch_gradient_post_training_quantization>`: A function to use for gradient-based post training quantization of Pytorch models.
+- :ref:`get_pytorch_gptq_config<ug-get_pytorch_gptq_config>`: A function to create a GradientPTQConfig instance to use for Pytorch models when using GPTQ.
+
+- :ref:`keras_quantization_aware_training_init<ug-keras_quantization_aware_training_init_experimental>`: A function to use for preparing a model for Quantization Aware Training (Experimental)
+- :ref:`keras_quantization_aware_training_finalize<ug-keras_quantization_aware_training_finalize_experimental>`: A function to finalize a model after Quantization Aware Training to a model without QuantizeWrappers (Experimental)
+
+- :ref:`keras_data_generation_experimental<ug-keras_data_generation_experimental>`: A function to generate data for a Keras model (experimental).
+- :ref:`get_keras_data_generation_config<ug-get_keras_data_generation_config>`: A function to generate a DataGenerationConfig for Tensorflow data generation(experimental).
+
+- :ref:`pytorch_data_generation_experimental<ug-pytorch_data_generation_experimental>`: A function to generate data for a Pytorch model (experimental).
+- :ref:`get_pytorch_data_generation_config<ug-get_pytorch_data_generation_config>`: A function to load a DataGenerationConfig for Pytorch data generation (experimental).
+
+- :ref:`keras_pruning_experimental<ug-keras_pruning_experimental>`: A function to apply structured pruning for Keras models (experimental).
+- :ref:`pytorch_pruning_experimental<ug-pytorch_pruning_experimental>`: A function to apply structured pruning for Pytorch models (experimental).
+
+- :ref:`keras_kpi_data<ug-keras_kpi_data>`: A function to compute KPI data that can be used to calculate the desired target KPI for mixed-precision quantization of Keras models.
+- :ref:`pytorch_kpi_data<ug-pytorch_kpi_data>`: A function to compute KPI data that can be used to calculate the desired target KPI for mixed-precision quantization of PyTorch models.
+
+- :ref:`get_target_platform_capabilities<ug-get_target_platform_capabilities>`: A function to get a target platform model for Tensorflow and Pytorch.
+- :ref:`keras_load_quantized_model<ug-keras_load_quantized_model>`: A function to load a quantized keras model.
 
 
 Modules
 =========
+- :ref:`core_config<ug-core_config>`: Module to contain configurations of the optimization process.
 - :ref:`quantization_config<ug-quantization_config>`: Module to configure the quantization process.
-- :ref:`mixed_precision_quantization_config<ug-mixed_precision_quantization_config>`: Module to configure the quantization process when using mixed-precision PTQ.
-- :ref:`network_editor<ug-network_editor>`: Module to edit your model during the quantization process.
+- :ref:`mixed_precision_quantization_config<ug-mixed_precision_quantization_config_v2>`: Module to configure the quantization process when using mixed-precision PTQ.
+- :ref:`debug_config<ug-debug_config>`: Module to configure options for debugging the optimization process.
 - :ref:`target_platform<ug-target_platform>`: 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:`qat_config<ug-qat_config>`: Module to create quantization configuration for Quantization-aware Training.
+- :ref:`exporter<ug-exporter>`: Module that enables to export a quantized model in different serialization formats.
+- :ref:`trainable_infrastructure<ug-trainable_infrastructure>`: Module that contains quantization abstraction and quantizers for hardware-oriented model optimization tools.
 
 Classes
 =========
-- :ref:`GradientPTQConfig<ug-GradientPTQConfig>`: Class to configure GradientPTQC options for gradient based post training quantization.
+- :ref:`GradientPTQConfig<ug-GradientPTQConfig>`: Class to configure GradientPTQ options for gradient based post training quantization.
 - :ref:`FolderImageLoader<ug-FolderImageLoader>`: Class to use an images directory as a representative dataset.
 - :ref:`FrameworkInfo<ug-FrameworkInfo>`: Class to wrap framework information to be used by MCT when optimizing models.
+- :ref:`PruningConfig<ug-PruningConfig>`: PruningConfig
+- :ref:`PruningInfo<ug-PruningInfo>`: PruningInfo
+
 
 Indices and tables
 ==================

diff --git a/...hods/get_keras_data_generation_config.rst → .../get_keras_data_generation_config.rst.txt b/...hods/get_keras_data_generation_config.rst → .../get_keras_data_generation_config.rst.txt
diff --git a/...pi_docs/methods/get_keras_gptq_config.rst → ...ocs/methods/get_keras_gptq_config.rst.txt b/...pi_docs/methods/get_keras_gptq_config.rst → ...ocs/methods/get_keras_gptq_config.rst.txt
diff --git a/...ds/get_pytorch_data_generation_config.rst → ...et_pytorch_data_generation_config.rst.txt b/...ds/get_pytorch_data_generation_config.rst → ...et_pytorch_data_generation_config.rst.txt
diff --git a/..._docs/methods/get_pytroch_gptq_config.rst → ...s/methods/get_pytroch_gptq_config.rst.txt b/..._docs/methods/get_pytroch_gptq_config.rst → ...s/methods/get_pytroch_gptq_config.rst.txt
diff --git a/...hods/get_target_platform_capabilities.rst → .../get_target_platform_capabilities.rst.txt b/...hods/get_target_platform_capabilities.rst → .../get_target_platform_capabilities.rst.txt
diff --git a/docs/_sources/api/api_docs/methods/keras_data_generation_experimental.rst.txt b/docs/_sources/api/api_docs/methods/keras_data_generation_experimental.rst.txt
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-keras_data_generation_experimental:
+
+
+=====================================
+Keras Data Generation
+=====================================
+
+.. autofunction:: model_compression_toolkit.data_generation.keras_data_generation_experimental
diff --git a/...api_docs/methods/keras_gradient_post_training_quantization_experimental.rst.txt b/...api_docs/methods/keras_gradient_post_training_quantization_experimental.rst.txt
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-keras_gradient_post_training_quantization:
+
+
+================================================
+Keras Gradient Based Post Training Quantization
+================================================
+
+.. autofunction:: model_compression_toolkit.gptq.keras_gradient_post_training_quantization
diff --git a/...e/api/api_docs/methods/keras_kpi_data.rst → ...thods/keras_kpi_data_experimental.rst.txt b/...e/api/api_docs/methods/keras_kpi_data.rst → ...thods/keras_kpi_data_experimental.rst.txt
@@ -7,4 +7,4 @@
 Get KPI information for Keras Models
 =======================================
 
-.. autofunction:: model_compression_toolkit.keras_kpi_data
+.. autofunction:: model_compression_toolkit.core.keras_kpi_data
diff --git a/...cs/methods/keras_load_quantizad_model.rst → ...ethods/keras_load_quantizad_model.rst.txt b/...cs/methods/keras_load_quantizad_model.rst → ...ethods/keras_load_quantizad_model.rst.txt
diff --git a/...hods/keras_post_training_quantization.rst → ...raining_quantization_experimental.rst.txt b/...hods/keras_post_training_quantization.rst → ...raining_quantization_experimental.rst.txt
@@ -7,4 +7,4 @@
 Keras Post Training Quantization
 =================================
 
-.. autofunction:: model_compression_toolkit.keras_post_training_quantization
+.. autofunction:: model_compression_toolkit.ptq.keras_post_training_quantization
diff --git a/docs/_sources/api/api_docs/methods/keras_pruning_experimental.rst.txt b/docs/_sources/api/api_docs/methods/keras_pruning_experimental.rst.txt
@@ -0,0 +1,12 @@
+:orphan:
+
+.. _ug-keras_pruning_experimental:
+
+
+================================================
+Keras Structured Pruning
+================================================
+
+.. autofunction:: model_compression_toolkit.pruning.keras_pruning_experimental
+
+
diff --git a/...sources/api/api_docs/methods/keras_quantization_aware_training_finalize.rst.txt b/...sources/api/api_docs/methods/keras_quantization_aware_training_finalize.rst.txt
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-keras_quantization_aware_training_finalize_experimental:
+
+
+================================================
+Keras Quantization Aware Training Model Finalize
+================================================
+
+.. autofunction:: model_compression_toolkit.qat.keras_quantization_aware_training_finalize_experimental
diff --git a/docs/_sources/api/api_docs/methods/keras_quantization_aware_training_init.rst.txt b/docs/_sources/api/api_docs/methods/keras_quantization_aware_training_init.rst.txt
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-keras_quantization_aware_training_init_experimental:
+
+
+================================================
+Keras Quantization Aware Training Model Init
+================================================
+
+.. autofunction:: model_compression_toolkit.qat.keras_quantization_aware_training_init_experimental
diff --git a/.../pytorch_data_generation_experimental.rst → ...orch_data_generation_experimental.rst.txt b/.../pytorch_data_generation_experimental.rst → ...orch_data_generation_experimental.rst.txt
diff --git a/...i_docs/methods/pytorch_gradient_post_training_quantization_experimental.rst.txt b/...i_docs/methods/pytorch_gradient_post_training_quantization_experimental.rst.txt
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-pytorch_gradient_post_training_quantization:
+
+
+====================================================
+Pytorch Gradient Based Post Training Quantization
+====================================================
+
+.. autofunction:: model_compression_toolkit.gptq.pytorch_gradient_post_training_quantization
diff --git a/...api/api_docs/methods/pytorch_kpi_data.rst → ...ods/pytorch_kpi_data_experimental.rst.txt b/...api/api_docs/methods/pytorch_kpi_data.rst → ...ods/pytorch_kpi_data_experimental.rst.txt
@@ -7,4 +7,4 @@
 Get KPI information for PyTorch Models
 =======================================
 
-.. autofunction:: model_compression_toolkit.pytorch_kpi_data
+.. autofunction:: model_compression_toolkit.core.pytorch_kpi_data
diff --git a/...ds/pytorch_post_training_quantization.rst → ...raining_quantization_experimental.rst.txt b/...ds/pytorch_post_training_quantization.rst → ...raining_quantization_experimental.rst.txt
@@ -7,4 +7,4 @@
 Pytorch Post Training Quantization
 =====================================
 
-.. autofunction:: model_compression_toolkit.pytorch_post_training_quantization
+.. autofunction:: model_compression_toolkit.ptq.pytorch_post_training_quantization
diff --git a/docs/_sources/api/api_docs/methods/pytorch_pruning_experimental.rst.txt b/docs/_sources/api/api_docs/methods/pytorch_pruning_experimental.rst.txt
@@ -0,0 +1,15 @@
+:orphan:
+
+.. _ug-pytorch_pruning_experimental:
+
+
+================================================
+Pytorch Structured Pruning
+================================================
+
+.. autofunction:: model_compression_toolkit.pruning.pytorch_pruning_experimental
+
+
+
+
+
diff --git a/...urces/api/api_docs/methods/pytorch_quantization_aware_training_finalize.rst.txt b/...urces/api/api_docs/methods/pytorch_quantization_aware_training_finalize.rst.txt
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-pytorch_quantization_aware_training_finalize_experimental:
+
+
+===================================================
+PyTorch Quantization Aware Training Model Finalize
+===================================================
+
+.. autofunction:: model_compression_toolkit.qat.pytorch_quantization_aware_training_finalize_experimental
diff --git a/.../_sources/api/api_docs/methods/pytorch_quantization_aware_training_init.rst.txt b/.../_sources/api/api_docs/methods/pytorch_quantization_aware_training_init.rst.txt
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-pytorch_quantization_aware_training_init_experimental:
+
+
+================================================
+PyTorch Quantization Aware Training Model Init
+================================================
+
+.. autofunction:: model_compression_toolkit.qat.pytorch_quantization_aware_training_init_experimental
diff --git a/...ntal_api_docs/methods/set_logger_path.rst → .../api_docs/methods/set_logger_path.rst.txt b/...ntal_api_docs/methods/set_logger_path.rst → .../api_docs/methods/set_logger_path.rst.txt
diff --git a/...rimental_api_docs/modules/core_config.rst → .../api/api_docs/modules/core_config.rst.txt b/...rimental_api_docs/modules/core_config.rst → .../api/api_docs/modules/core_config.rst.txt
diff --git a/docs/_sources/api/api_docs/modules/debug_config.rst.txt b/docs/_sources/api/api_docs/modules/debug_config.rst.txt
@@ -0,0 +1,17 @@
+:orphan:
+
+.. _ug-debug_config:
+
+
+=================================
+debug_config Module
+=================================
+
+
+DebugConfig
+==========================
+**Class to configure params for debugging purposes:**
+
+.. autoclass:: model_compression_toolkit.core.DebugConfig
+
+