Update aimet_torch QuantizationSimModel API reference (#3760)

* Use :members: instead of :automethod: Signed-off-by: Kyunggeun Lee <[email protected]> * Update warning message Signed-off-by: Kyunggeun Lee <[email protected]> --------- Signed-off-by: Kyunggeun Lee <[email protected]>
quic · Jan 29, 2025 · 623f639 · 623f639
1 parent 2a6948a
commit 623f639
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 11 deletions.
diff --git a/Docs/apiref/torch/quantsim.rst b/Docs/apiref/torch/quantsim.rst
@@ -7,22 +7,15 @@ aimet_torch.quantsim
 ..
   # start-after
 
-.. autoclass:: aimet_torch.quantsim.QuantizationSimModel
-
-**The following API can be used to Compute encodings for calibration:**
-
-.. automethod:: aimet_torch.quantsim.QuantizationSimModel.compute_encodings
+.. autoclass:: aimet_torch.QuantizationSimModel
+   :members: compute_encodings, export
 
 **The following APIs can be used to save and restore the quantized model**
 
 .. automethod:: aimet_torch.quantsim.save_checkpoint
 
 .. automethod:: aimet_torch.quantsim.load_checkpoint
 
-**The following API can be used to export the quantized model to target:**
-
-.. automethod:: aimet_torch.quantsim.QuantizationSimModel.export
-
 **Quant Scheme Enum**
 
 .. autoclass:: aimet_common.defs.QuantScheme

diff --git a/TrainingExtensions/torch/src/python/aimet_torch/v2/quantsim/quantsim.py b/TrainingExtensions/torch/src/python/aimet_torch/v2/quantsim/quantsim.py
@@ -181,9 +181,9 @@ def __init__(self, # pylint: disable=too-many-arguments, too-many-locals, too-ma
            Passing `rounding_mode` will throw runtime error in >=1.35.
 
         .. warning::
-           The default value of `quant_scheme` will change
+           The default value of `quant_scheme` has changed
            from `QuantScheme.post_training_tf_enhanced` to `QuantScheme.training_range_learning_with_tf_init`
-           in the future versions, and will be deprecated in the longer term.
+           since 2.0.0, and will be deprecated in the longer term.
 
         Args:
             model (torch.nn.Module): Model to simulate the quantized execution of