Skip to content

Add :no-index: roles to onnx and tensorflow api reference. #3941

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Docs/apiref/onnx/adaround.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ aimet_onnx.adaround
**Top-level API**

.. autofunction:: aimet_onnx.adaround.adaround_weight.Adaround.apply_adaround
:no-index:

**Adaround Parameters**

.. autoclass:: aimet_onnx.adaround.adaround_weight.AdaroundParameters
:members:
:no-index:

5 changes: 4 additions & 1 deletion Docs/apiref/onnx/amp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aimet_onnx.mixed_precision
**Top-level API**

.. autofunction:: aimet_onnx.mixed_precision.choose_mixed_precision

:no-index:

.. note::

Expand All @@ -21,14 +21,17 @@ aimet_onnx.mixed_precision

.. autoclass:: aimet_onnx.amp.quantizer_groups.QuantizerGroup
:members:
:no-index:

**CallbackFunc Definition**

.. autoclass:: aimet_common.defs.CallbackFunc
:members:
:no-index:

.. autoclass:: aimet_onnx.amp.mixed_precision_algo.EvalCallbackFactory
:members:
:no-index:

..
# end-before
1 change: 1 addition & 0 deletions Docs/apiref/onnx/bnf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ aimet_onnx.batch_norm_fold
**Top-level API**

.. autofunction:: aimet_onnx.batch_norm_fold.fold_all_batch_norms_to_weight
:no-index:
1 change: 1 addition & 0 deletions Docs/apiref/onnx/cle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ aimet_onnx.cross_layer_equalization
**Top-level API**

.. autofunction:: aimet_onnx.cross_layer_equalization.equalize_model
:no-index:
3 changes: 2 additions & 1 deletion Docs/apiref/onnx/layer_output_generation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ aimet_onnx.layer_output_utils
# start-after

.. autoclass:: aimet_onnx.layer_output_utils.LayerOutputUtil

:no-index:

**The following API can be used to Generate Layer Outputs**

.. automethod:: aimet_onnx.layer_output_utils.LayerOutputUtil.generate_layer_outputs
:no-index:

..
# end-before
3 changes: 3 additions & 0 deletions Docs/apiref/onnx/quant_analyzer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,13 @@ aimet_onnx.quant_analyzer
It is recommended to use onnx-simplifier before applying quant-analyzer.

.. autoclass:: aimet_onnx.quant_analyzer.QuantAnalyzer
:no-index:

.. automethod:: aimet_onnx.quant_analyzer.QuantAnalyzer.enable_per_layer_mse_loss
:no-index:

.. automethod:: aimet_onnx.quant_analyzer.QuantAnalyzer.analyze
:no-index:

**Alternatively, you can run specific utility**

Expand Down
4 changes: 4 additions & 0 deletions Docs/apiref/onnx/quantsim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,17 @@ aimet_onnx.quantsim
It is recommended to use onnx-simplifier before creating quantsim model.

.. autoclass:: aimet_onnx.quantsim.QuantizationSimModel
:no-index:

**The following API can be used to compute encodings for calibration.**

.. automethod:: aimet_onnx.quantsim.QuantizationSimModel.compute_encodings
:no-index:

**The following API can be used to export the quantized model to target.**

.. automethod:: aimet_onnx.quantsim.QuantizationSimModel.export
:no-index:

Enum Definition
===============
Expand All @@ -27,3 +30,4 @@ Enum Definition

.. autoclass:: aimet_common.defs.QuantScheme
:members:
:no-index:
2 changes: 2 additions & 0 deletions Docs/apiref/onnx/seq_mse.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ aimet_onnx.seq_mse
**Top level APIs**

.. autofunction:: aimet_onnx.sequential_mse.seq_mse.SequentialMse.apply_seq_mse
:no-index:

**Sequential MSE parameters**

.. autoclass:: aimet_onnx.sequential_mse.seq_mse.SeqMseParams
:members:
:no-index:

..
# end-before
2 changes: 2 additions & 0 deletions Docs/apiref/tensorflow/adaround.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ aimet_tensorflow.adaround
**Top-level API**

.. autofunction:: aimet_tensorflow.keras.adaround_weight.Adaround.apply_adaround
:no-index:

**Adaround Parameters**

.. autoclass:: aimet_tensorflow.keras.adaround_weight.AdaroundParameters
:members:
:no-index:
4 changes: 4 additions & 0 deletions Docs/apiref/tensorflow/amp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ aimet_tensorflow.mixed_precision
**Top-level API for Regular AMP**

.. autofunction:: aimet_tensorflow.keras.mixed_precision.choose_mixed_precision
:no-index:


**Top-level API for Fast AMP (AMP 2.0)**

.. autofunction:: aimet_tensorflow.keras.mixed_precision.choose_fast_mixed_precision
:no-index:

.. note::

Expand All @@ -26,11 +28,13 @@ Currently only two candidates are supported - ((8,int), (8,int)) & ((16,int), (8

.. autoclass:: aimet_tensorflow.keras.amp.quantizer_groups.QuantizerGroup
:members:
:no-index:

**CallbackFunc Definition**

.. autoclass:: aimet_common.defs.CallbackFunc
:members:
:no-index:

..
# end-before
1 change: 1 addition & 0 deletions Docs/apiref/tensorflow/autoquant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ aimet_tensorflow.auto_quant_v2
.. autoclass:: aimet_tensorflow.keras.auto_quant_v2.AutoQuantWithAutoMixedPrecision
:members:
:member-order: bysource
:no-index:
2 changes: 2 additions & 0 deletions Docs/apiref/tensorflow/bn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,7 @@ aimet_tensorflow.keras.bn_reestimation
**Top-level API**

.. autofunction:: aimet_tensorflow.keras.bn_reestimation.reestimate_bn_stats
:no-index:

.. autofunction:: aimet_tensorflow.keras.batch_norm_fold.fold_all_batch_norms_to_scale
:no-index:
1 change: 1 addition & 0 deletions Docs/apiref/tensorflow/bnf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ aimet_tensorflow.batch_norm_fold
**Top-level API**

.. autofunction:: aimet_tensorflow.keras.batch_norm_fold.fold_all_batch_norms
:no-index:
1 change: 1 addition & 0 deletions Docs/apiref/tensorflow/cle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ aimet_tensorflow.cross_layer_equalization
**Top-level API**

.. autofunction:: aimet_tensorflow.keras.cross_layer_equalization.equalize_model
:no-index:
4 changes: 4 additions & 0 deletions Docs/apiref/tensorflow/compress.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,19 @@ aimet_tensorflow.compress
**Top-level API for Compression**

.. autoclass:: aimet_tensorflow.keras.compress.ModelCompressor
:no-index:

.. automethod:: aimet_tensorflow.keras.compress.ModelCompressor.compress_model
:no-index:

**Greedy Selection Parameters**

.. autoclass:: aimet_common.defs.GreedySelectionParameters
:members:
:no-index:

**Spatial SVD Configuration**

.. autoclass:: aimet_tensorflow.keras.defs.SpatialSvdParameters
:members:
:no-index:
2 changes: 2 additions & 0 deletions Docs/apiref/tensorflow/layer_output_generation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ aimet_tensorflow.layer_output_utils
# start-after

.. autoclass:: aimet_tensorflow.keras.layer_output_utils.LayerOutputUtil
:no-index:


**The following API can be used to Generate Layer Outputs**

.. automethod:: aimet_tensorflow.keras.layer_output_utils.LayerOutputUtil.generate_layer_outputs
:no-index:

..
# end-before
1 change: 1 addition & 0 deletions Docs/apiref/tensorflow/model_preparer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,3 +165,4 @@ API
===

.. autofunction:: aimet_tensorflow.keras.model_preparer.prepare_model
:no-index:
4 changes: 4 additions & 0 deletions Docs/apiref/tensorflow/quantsim.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@ aimet_tensorflow.quantsim
# start-after

.. autoclass:: aimet_tensorflow.keras.quantsim.QuantizationSimModel
:no-index:

**The following API can be used to Compute Encodings for Model**

.. automethod:: aimet_tensorflow.keras.quantsim.QuantizationSimModel.compute_encodings
:no-index:

**The following API can be used to Export the Model to target**

.. automethod:: aimet_tensorflow.keras.quantsim.QuantizationSimModel.export
:no-index:

Enum Definition
===============
Expand All @@ -24,3 +27,4 @@ Enum Definition

.. autoclass:: aimet_common.defs.QuantScheme
:members:
:no-index:
Loading