Skip to content

Commit cb3c0d1

Browse files
fix review points.
1 parent 0c48a2a commit cb3c0d1

File tree

10 files changed

+44
-56
lines changed

10 files changed

+44
-56
lines changed

docs/_sources/guidelines/XQuant_Extension_Tool.rst.txt

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ The following are the main components of this tool.
1111

1212
* `XQuant Extension Tool <https://sonysemiconductorsolutions.github.io/mct-model-optimization/api/api_docs/methods/xquant_report_troubleshoot_pytorch_experimental.html>`_
1313

14-
The component of MCT detects degraded layers (layers having large quantization error) and judges the causes of degradation in those layers.
14+
This tool detects degraded layers (layers with large quantization errors) and identifies the causes of degradation within those layers.
1515

1616
* `Troubleshooting Manual <https://sonysemiconductorsolutions.github.io/mct-model-optimization/docs_troubleshoot/index.html>`_
1717

18-
The documents of MCT describe countermeasures for accuracy degradation based on the causes identified by the XQuant Extension Tool.
18+
This document describes countermeasures for accuracy degradation based on causes identified by the XQuant Extension Tool.
1919

2020
Overall Process Flow
2121
============================
@@ -27,19 +27,19 @@ The overall process follows the steps below:
2727
1. Input the float model, quantized model, and quantization log.
2828
2. Detect layers that have large difference between float and quantized models.
2929
3. Judge degradation causes on the detected layers.
30-
4. Based on the judge results, individual countermeasure procedures or general improvement measures are proposed from the troubleshooting manual.
31-
5. Recommend general troubleshoots additionally when accuracy does not improve after steps 1-4.
30+
4. [Judgeable Troubleshoots] Based on the judge results, individual countermeasure procedures from the troubleshooting manual.
31+
5. [General Troubleshoots] When accuracy does not improve after steps 1-4, general improvement measures from the troubleshooting manual.
3232

3333
Please refer to the `Troubleshooting Manual <https://sonysemiconductorsolutions.github.io/mct-model-optimization/docs_troubleshoot/index.html>`_ for the Judgeable Troubleshoots and General Troubleshoots in detail.
3434

3535
How to Run
3636
===============
3737

38-
This XQuant Extension Tool was created based on xquant, as shown in the link below.
39-
In addition to the conventional xquant functions, it judges degradation causes and links to a troubleshooting manual that provides appropriate countermeasures for each cause of degradation.
38+
This XQuant Extension Tool was created based on XQuant, as shown in the link below.
39+
In addition to the conventional XQuant functions, it judges degradation causes and links to the Troubleshooting Manual that provides appropriate countermeasures for each cause of degradation.
4040
It can suggest more specific countermeasures than conventional tools and provides manuals that are easy to understand even for users who are not familiar with quantization.
4141

42-
Please replace xquant_report_pytorch_experimental in `the XQuant tutorial <https://github.com/SonySemiconductorSolutions/mct-model-optimization/tree/main/tutorials/notebooks/mct_features_notebooks/pytorch/example_pytorch_xquant.ipynb>`_ with xquant_report_troubleshoot_pytorch_experimental.
42+
Please replace *xquant_report_pytorch_experimental* in `the XQuant tutorial <https://github.com/SonySemiconductorSolutions/mct-model-optimization/tree/main/tutorials/notebooks/mct_features_notebooks/pytorch/example_pytorch_xquant.ipynb>`_ with *xquant_report_troubleshoot_pytorch_experimental*.
4343

4444
.. code-block:: python
4545
@@ -154,14 +154,10 @@ The initial threshold value of 0.1 is set, and layers exceeding this threshold a
154154
* **Red dashed line**: Threshold for accuracy degradation as set in XQuantConfig
155155
* **Red circle**: Layers judged to have degraded accuracy
156156

157-
.. note::
158-
159-
You can define new calculation methods. For details, see the `API Document <https://sonysemiconductorsolutions.github.io/mct-model-optimization/api/api_docs/classes/XQuantConfig.html#ug-xquantconfig>`_.
160-
161-
Understanding the Judgment of Degradation Causes
157+
Understanding the Judgeable Troubleshoots
162158
=======================================================
163159

164-
For the identified degraded layers, judge if they fall into any of the following four causes.
160+
The following items are automatically identified by the XQuant Extension Tool.
165161

166162
Please refer to the respective Troubleshooting Manuals for details.
167163

docs/docs_troubleshoot/_sources/index.rst.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _ug-index:
22

33
========================================================================================
4-
TroubleShooting Documentation (MCT XQuant Extension Tool)
4+
TroubleShooting Manual (MCT XQuant Extension Tool)
55
========================================================================================
66

77

@@ -12,7 +12,7 @@ The Model Compression Toolkit (MCT) offers numerous functionalities to compress
1212

1313
Outlined below are a series of steps aimed at recovering lost accuracy resulting from compression with MCT. Some steps may be applicable to your model, while others may not.
1414

15-
For ovewview of Xquant Extension Tool, see `About XQuant Extension Tool <https://sonysemiconductorsolutions.github.io/mct-model-optimization/guidelines/XQuant_Extension_Tool.html>`_ [1].
15+
For overview of XQuant Extension Tool, see `About XQuant Extension Tool <https://sonysemiconductorsolutions.github.io/mct-model-optimization/guidelines/XQuant_Extension_Tool.html>`_ [1].
1616

1717
Quantization Troubleshooting for MCT
1818
============================================

docs/docs_troubleshoot/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
88

9-
<title>TroubleShooting Documentation (MCT XQuant Extension Tool) &#8212; TroubleShooting Documentation (MCT XQuant Extension Tool): ver 1.0</title>
9+
<title>TroubleShooting Manual (MCT XQuant Extension Tool) &#8212; TroubleShooting Documentation (MCT XQuant Extension Tool): ver 1.0</title>
1010
<link rel="stylesheet" type="text/css" href="static/pygments.css?v=03e43079" />
1111
<link rel="stylesheet" type="text/css" href="static/bizstyle.css?v=5283bb3d" />
1212
<link rel="stylesheet" type="text/css" href="static/css/custom.css?v=01243f34" />
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
2929
<a href="genindex.html" title="General Index"
3030
accesskey="I">index</a></li>
3131
<li class="nav-item nav-item-0"><a href="#">TroubleShooting Documentation (MCT XQuant Extension Tool): ver 1.0</a> &#187;</li>
32-
<li class="nav-item nav-item-this"><a href="">TroubleShooting Documentation (MCT XQuant Extension Tool)</a></li>
32+
<li class="nav-item nav-item-this"><a href="">TroubleShooting Manual (MCT XQuant Extension Tool)</a></li>
3333
</ul>
3434
</div>
3535

@@ -38,13 +38,13 @@ <h3>Navigation</h3>
3838
<div class="bodywrapper">
3939
<div class="body" role="main">
4040

41-
<section id="troubleshooting-documentation-mct-xquant-extension-tool">
42-
<span id="ug-index"></span><h1>TroubleShooting Documentation (MCT XQuant Extension Tool)<a class="headerlink" href="#troubleshooting-documentation-mct-xquant-extension-tool" title="Link to this heading"></a></h1>
41+
<section id="troubleshooting-manual-mct-xquant-extension-tool">
42+
<span id="ug-index"></span><h1>TroubleShooting Manual (MCT XQuant Extension Tool)<a class="headerlink" href="#troubleshooting-manual-mct-xquant-extension-tool" title="Link to this heading"></a></h1>
4343
<section id="overview">
4444
<h2>Overview<a class="headerlink" href="#overview" title="Link to this heading"></a></h2>
4545
<p>The Model Compression Toolkit (MCT) offers numerous functionalities to compress neural networks with minimal accuracy lost. However, in some cases, the compressed model may experience a significant decrease in accuracy. Fear not, as this lost accuracy can often be reclaimed by adjusting the quantization configuration or setup.</p>
4646
<p>Outlined below are a series of steps aimed at recovering lost accuracy resulting from compression with MCT. Some steps may be applicable to your model, while others may not.</p>
47-
<p>For ovewview of Xquant Extension Tool, see <a class="reference external" href="https://sonysemiconductorsolutions.github.io/mct-model-optimization/guidelines/XQuant_Extension_Tool.html">About XQuant Extension Tool</a> [1].</p>
47+
<p>For overview of XQuant Extension Tool, see <a class="reference external" href="https://sonysemiconductorsolutions.github.io/mct-model-optimization/guidelines/XQuant_Extension_Tool.html">About XQuant Extension Tool</a> [1].</p>
4848
</section>
4949
<section id="quantization-troubleshooting-for-mct">
5050
<h2>Quantization Troubleshooting for MCT<a class="headerlink" href="#quantization-troubleshooting-for-mct" title="Link to this heading"></a></h2>
@@ -91,7 +91,7 @@ <h2>References<a class="headerlink" href="#references" title="Link to this headi
9191
<div>
9292
<h3><a href="#">Table of Contents</a></h3>
9393
<ul>
94-
<li><a class="reference internal" href="#">TroubleShooting Documentation (MCT XQuant Extension Tool)</a><ul>
94+
<li><a class="reference internal" href="#">TroubleShooting Manual (MCT XQuant Extension Tool)</a><ul>
9595
<li><a class="reference internal" href="#overview">Overview</a></li>
9696
<li><a class="reference internal" href="#quantization-troubleshooting-for-mct">Quantization Troubleshooting for MCT</a></li>
9797
<li><a class="reference internal" href="#references">References</a></li>
@@ -121,7 +121,7 @@ <h3>Navigation</h3>
121121
<a href="genindex.html" title="General Index"
122122
>index</a></li>
123123
<li class="nav-item nav-item-0"><a href="#">TroubleShooting Documentation (MCT XQuant Extension Tool): ver 1.0</a> &#187;</li>
124-
<li class="nav-item nav-item-this"><a href="">TroubleShooting Documentation (MCT XQuant Extension Tool)</a></li>
124+
<li class="nav-item nav-item-this"><a href="">TroubleShooting Manual (MCT XQuant Extension Tool)</a></li>
125125
</ul>
126126
</div>
127127
<div class="footer" role="contentinfo">

docs/docs_troubleshoot/objects.inv

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)