update docsrc

sony · Mar 10, 2024 · f840c90 · f840c90
1 parent b45b856
commit f840c90
Show file tree

Hide file tree

Showing 61 changed files with 476 additions and 635 deletions.
diff --git a/docsrc/Makefile b/docsrc/Makefile
@@ -6,11 +6,13 @@ github:
 	@cp -a ../docs/html/. ../docs
 	@rm -rf ../docs/html/
 	@rm -rf ../docs/doctrees/
+	@find ../docs -type f -exec sed -i 's|_images/|images/|g' {} +
+	@find ../docs -type f -exec sed -i 's|_static/|static/|g' {} +
+	@rm -rf ../docs/images
+	@rm -rf ../docs/static
+	@mv ../docs/_images/ ../docs/images
+	@mv ../docs/_static/ ../docs/static
 
-# rm -rf ../docs/images/
-# rm -rf ../docs/statis/
-# mv ../docs/_images/ ../docs/images
-# mv ../docs/_static/ ../docs/static
 
 
 # You can set these variables from the command line, and also

diff --git a/...rimental_api_docs/classes/DefaultDict.rst → ...urce/api/api_docs/classes/DefaultDict.rst b/...rimental_api_docs/classes/DefaultDict.rst → ...urce/api/api_docs/classes/DefaultDict.rst
diff --git a/...al_api_docs/classes/FolderImageLoader.rst → ...pi/api_docs/classes/FolderImageLoader.rst b/...al_api_docs/classes/FolderImageLoader.rst → ...pi/api_docs/classes/FolderImageLoader.rst
@@ -8,7 +8,7 @@ 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.FolderImageLoader
+.. autoclass:: model_compression_toolkit.core.FolderImageLoader
     :members:
 
 

diff --git a/...mental_api_docs/classes/FrameworkInfo.rst → ...ce/api/api_docs/classes/FrameworkInfo.rst b/...mental_api_docs/classes/FrameworkInfo.rst → ...ce/api/api_docs/classes/FrameworkInfo.rst
@@ -9,7 +9,7 @@ FrameworkInfo Class
 
 **The following API can be used to pass MCT framework-related information to use when optimizing the network**
 
-.. autoclass:: model_compression_toolkit.FrameworkInfo
+.. autoclass:: model_compression_toolkit.core.FrameworkInfo
 
 
 |
@@ -19,5 +19,5 @@ ChannelAxis
 ==========================
 **Enum to select the output channels format in the model:**
 
-.. autoclass:: model_compression_toolkit.ChannelAxis
+.. autoclass:: model_compression_toolkit.core.ChannelAxis
 
diff --git a/...al_api_docs/classes/GradientPTQConfig.rst → ...pi/api_docs/classes/GradientPTQConfig.rst b/...al_api_docs/classes/GradientPTQConfig.rst → ...pi/api_docs/classes/GradientPTQConfig.rst
@@ -2,15 +2,6 @@
 
 .. _ug-GradientPTQConfig:
 
-=================================
-GradientPTQConfigV2 Class
-=================================
-
-**The following API can be used to create a GradientPTQConfigV2 instance which can be used for post training quantization using knowledge distillation from a teacher (float model) to a student (the quantized model). This is experimental and subject to future changes.**
-
-.. autoclass:: model_compression_toolkit.gptq.GradientPTQConfigV2
-    :members:
-
 
 =================================
 GradientPTQConfig Class
@@ -31,3 +22,11 @@ GPTQHessianScoresConfig Class
 
 .. autoclass:: model_compression_toolkit.gptq.GPTQHessianScoresConfig
     :members:
+
+
+=================================
+RoundingType
+=================================
+
+.. autoclass:: model_compression_toolkit.gptq.RoundingType
+    :members:
diff --git a/docsrc/source/api/api_docs/classes/PruningConfig.rst b/docsrc/source/api/api_docs/classes/PruningConfig.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+.. _ug-PruningConfig:
+
+================================================
+Pruning Configuration
+================================================
+
+.. autofunction:: model_compression_toolkit.pruning.PruningConfig
diff --git a/docsrc/source/api/api_docs/classes/PruningInfo.rst b/docsrc/source/api/api_docs/classes/PruningInfo.rst
@@ -0,0 +1,10 @@
+:orphan:
+
+.. _ug-PruningInfo:
+
+================================================
+Pruning Information
+================================================
+
+.. autofunction:: model_compression_toolkit.pruning.PruningInfo
+
diff --git a/docsrc/source/api/api_docs/index.rst b/docsrc/source/api/api_docs/index.rst
@@ -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,91 @@ 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.
 
+ptq
+====
 
-Modules
-=========
+- :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.
+
+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_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:`GradientPTQConfig<ug-GradientPTQConfig>`: Class to configure GradientPTQ options for gradient based post training quantization.
+
+qat
+====
+
+- :ref:`pytorch_quantization_aware_training_init<ug-pytorch_quantization_aware_training_init_experimental>`: A function to use for preparing a Pytorch model for Quantization Aware Training (Experimental)
+- :ref:`pytorch_quantization_aware_training_finalize<ug-pytorch_quantization_aware_training_finalize_experimental>`: A function to finalize a Pytorch model after Quantization Aware Training to a model without QuantizeWrappers (Experimental)
+- :ref:`keras_quantization_aware_training_init<ug-keras_quantization_aware_training_init_experimental>`: A function to use for preparing a Keras model for Quantization Aware Training (Experimental)
+- :ref:`keras_quantization_aware_training_finalize<ug-keras_quantization_aware_training_finalize_experimental>`: A function to finalize a Keras model after Quantization Aware Training to a model without QuantizeWrappers (Experimental)
+- :ref:`qat_config<ug-qat_config>`: Module to create quantization configuration for Quantization-aware Training.
+
+core
+=====
+
+- :ref:`CoreConfig<ug-CoreConfig>`: 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:`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:`network_editor<ug-network_editor>`: Module to modify the optimization process for troubleshooting.
+- :ref:`FolderImageLoader<ug-FolderImageLoader>`: Class to use an images directory as a representative dataset.
+- :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 PyTorch models.
+- :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 Keras models.
+
+
+data_generation
+=================
+
+- :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_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).
+
+pruning
+===========
 
-Classes
+- :ref:`pytorch_pruning_experimental<ug-pytorch_pruning_experimental>`: A function to apply structured pruning for Pytorch models (experimental).
+- :ref:`keras_pruning_experimental<ug-keras_pruning_experimental>`: A function to apply structured pruning for Keras models (experimental).
+
+- :ref:`PruningConfig<ug-PruningConfig>`: Configuration for the pruning process.
+- :ref:`PruningInfo<ug-PruningInfo>`: Information about the pruned model such as pruned channel indices, etc.
+
+
+exporter
 =========
-- :ref:`GradientPTQConfig<ug-GradientPTQConfig>`: Class to configure GradientPTQC 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:`exporter<ug-exporter>`: Module that enables to export a quantized model in different serialization formats.
+
+
+trainable_infrastructure
+=========================
+
+- :ref:`trainable_infrastructure<ug-trainable_infrastructure>`: Module that contains quantization abstraction and quantizers for hardware-oriented model optimization tools.
+
+
+
+set_log_folder
+================
+- :ref:`set_log_folder<ug-set_log_folder>`: Function to set the logger path directory and to enable logging.
+
+keras_load_quantized_model
+============================
+- :ref:`keras_load_quantized_model<ug-keras_load_quantized_model>`: A function to load a quantized keras model.
+
+
+target_platform
+================
+- :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:`get_target_platform_capabilities<ug-get_target_platform_capabilities>`: A function to get a target platform model for Tensorflow and Pytorch.
+- :ref:`DefaultDict<ug-DefaultDict>`: Util class for creating a TargetPlatformCapabilities.
+
 
 Indices and tables
 ==================

diff --git a/...hods/get_keras_data_generation_config.rst → ...hods/get_keras_data_generation_config.rst b/...hods/get_keras_data_generation_config.rst → ...hods/get_keras_data_generation_config.rst
diff --git a/...pi_docs/methods/get_keras_gptq_config.rst → ...pi_docs/methods/get_keras_gptq_config.rst b/...pi_docs/methods/get_keras_gptq_config.rst → ...pi_docs/methods/get_keras_gptq_config.rst
diff --git a/...ds/get_pytorch_data_generation_config.rst → ...ds/get_pytorch_data_generation_config.rst b/...ds/get_pytorch_data_generation_config.rst → ...ds/get_pytorch_data_generation_config.rst
diff --git a/..._docs/methods/get_pytroch_gptq_config.rst → ..._docs/methods/get_pytroch_gptq_config.rst b/..._docs/methods/get_pytroch_gptq_config.rst → ..._docs/methods/get_pytroch_gptq_config.rst
diff --git a/...hods/get_target_platform_capabilities.rst → ...hods/get_target_platform_capabilities.rst b/...hods/get_target_platform_capabilities.rst → ...hods/get_target_platform_capabilities.rst
diff --git a/docsrc/source/api/api_docs/methods/keras_data_generation_experimental.rst b/docsrc/source/api/api_docs/methods/keras_data_generation_experimental.rst
@@ -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/...st_training_quantization_experimental.rst → ...st_training_quantization_experimental.rst b/...st_training_quantization_experimental.rst → ...st_training_quantization_experimental.rst
@@ -1,10 +1,10 @@
 :orphan:
 
-.. _ug-keras_gradient_post_training_quantization_experimental:
+.. _ug-keras_gradient_post_training_quantization:
 
 
 ================================================
 Keras Gradient Based Post Training Quantization
 ================================================
 
-.. autofunction:: model_compression_toolkit.gptq.keras_gradient_post_training_quantization_experimental
+.. autofunction:: model_compression_toolkit.gptq.keras_gradient_post_training_quantization
diff --git a/...e/api/api_docs/methods/keras_kpi_data.rst → ...s/methods/keras_kpi_data_experimental.rst b/...e/api/api_docs/methods/keras_kpi_data.rst → ...s/methods/keras_kpi_data_experimental.rst
@@ -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 → ...cs/methods/keras_load_quantizad_model.rst b/...cs/methods/keras_load_quantizad_model.rst → ...cs/methods/keras_load_quantizad_model.rst
diff --git a/docsrc/source/api/api_docs/methods/keras_post_training_quantization.rst b/docsrc/source/api/api_docs/methods/keras_post_training_quantization.rst
diff --git a/...st_training_quantization_experimental.rst → ...st_training_quantization_experimental.rst b/...st_training_quantization_experimental.rst → ...st_training_quantization_experimental.rst
@@ -1,10 +1,10 @@
 :orphan:
 
-.. _ug-keras_post_training_quantization_experimental:
+.. _ug-keras_post_training_quantization:
 
 
 =================================
 Keras Post Training Quantization
 =================================
 
-.. autofunction:: model_compression_toolkit.ptq.keras_post_training_quantization_experimental
+.. autofunction:: model_compression_toolkit.ptq.keras_post_training_quantization
diff --git a/...ource/api/api_docs/methods/keras_post_training_quantization_mixed_precision.rst b/...ource/api/api_docs/methods/keras_post_training_quantization_mixed_precision.rst
diff --git a/docsrc/source/api/api_docs/methods/keras_pruning_experimental.rst b/docsrc/source/api/api_docs/methods/keras_pruning_experimental.rst
@@ -0,0 +1,12 @@
+:orphan:
+
+.. _ug-keras_pruning_experimental:
+
+
+================================================
+Keras Structured Pruning
+================================================
+
+.. autofunction:: model_compression_toolkit.pruning.keras_pruning_experimental
+
+
diff --git a/..._quantization_aware_training_finalize.rst → ..._quantization_aware_training_finalize.rst b/..._quantization_aware_training_finalize.rst → ..._quantization_aware_training_finalize.rst
@@ -1,10 +1,10 @@
 :orphan:
 
-.. _ug-keras_quantization_aware_training_finalize:
+.. _ug-keras_quantization_aware_training_finalize_experimental:
 
 
 ================================================
 Keras Quantization Aware Training Model Finalize
 ================================================
 
-.. autofunction:: model_compression_toolkit.qat.keras_quantization_aware_training_finalize
+.. autofunction:: model_compression_toolkit.qat.keras_quantization_aware_training_finalize_experimental
diff --git a/...eras_quantization_aware_training_init.rst → ...eras_quantization_aware_training_init.rst b/...eras_quantization_aware_training_init.rst → ...eras_quantization_aware_training_init.rst
@@ -1,10 +1,10 @@
 :orphan:
 
-.. _ug-keras_quantization_aware_training_init:
+.. _ug-keras_quantization_aware_training_init_experimental:
 
 
 ================================================
 Keras Quantization Aware Training Model Init
 ================================================
 
-.. autofunction:: model_compression_toolkit.qat.keras_quantization_aware_training_init
+.. autofunction:: model_compression_toolkit.qat.keras_quantization_aware_training_init_experimental
diff --git a/.../pytorch_data_generation_experimental.rst → .../pytorch_data_generation_experimental.rst b/.../pytorch_data_generation_experimental.rst → .../pytorch_data_generation_experimental.rst
diff --git a/...st_training_quantization_experimental.rst → ...st_training_quantization_experimental.rst b/...st_training_quantization_experimental.rst → ...st_training_quantization_experimental.rst
@@ -1,10 +1,10 @@
 :orphan:
 
-.. _ug-pytorch_gradient_post_training_quantization_experimental:
+.. _ug-pytorch_gradient_post_training_quantization:
 
 
 ====================================================
 Pytorch Gradient Based Post Training Quantization
 ====================================================
 
-.. autofunction:: model_compression_toolkit.gptq.pytorch_gradient_post_training_quantization_experimental
+.. autofunction:: model_compression_toolkit.gptq.pytorch_gradient_post_training_quantization
diff --git a/docsrc/source/api/api_docs/methods/pytorch_kpi_data.rst b/docsrc/source/api/api_docs/methods/pytorch_kpi_data.rst
diff --git a/...methods/pytorch_kpi_data_experimental.rst → ...methods/pytorch_kpi_data_experimental.rst b/...methods/pytorch_kpi_data_experimental.rst → ...methods/pytorch_kpi_data_experimental.rst
@@ -1,10 +1,10 @@
 :orphan:
 
-.. _ug-pytorch_kpi_data_experimental:
+.. _ug-pytorch_kpi_data:
 
 
 =======================================
 Get KPI information for PyTorch Models
 =======================================
 
-.. autofunction:: model_compression_toolkit.core.pytorch_kpi_data_experimental
+.. autofunction:: model_compression_toolkit.core.pytorch_kpi_data
diff --git a/docsrc/source/api/api_docs/methods/pytorch_post_training_quantization.rst b/docsrc/source/api/api_docs/methods/pytorch_post_training_quantization.rst
diff --git a/...st_training_quantization_experimental.rst → ...st_training_quantization_experimental.rst b/...st_training_quantization_experimental.rst → ...st_training_quantization_experimental.rst
@@ -1,10 +1,10 @@
 :orphan:
 
-.. _ug-pytorch_post_training_quantization_experimental:
+.. _ug-pytorch_post_training_quantization:
 
 
 =====================================
 Pytorch Post Training Quantization
 =====================================
 
-.. autofunction:: model_compression_toolkit.ptq.pytorch_post_training_quantization_experimental
+.. autofunction:: model_compression_toolkit.ptq.pytorch_post_training_quantization
diff --git a/...rce/api/api_docs/methods/pytorch_post_training_quantization_mixed_precision.rst b/...rce/api/api_docs/methods/pytorch_post_training_quantization_mixed_precision.rst