MindSpore Golden Stick 文档
=============================

MindSpore Golden Stick是华为诺亚团队和华为MindSpore团队联合设计开发的一个模型压缩算法集。MindSpore Golden Stick的架构图如下图所示，分为五个部分：

1. 底层的MindSpore Rewrite模块提供修改前端网络的能力，基于此模块提供的接口，算法开发者可以按照特定的规则对MindSpore的前端网络做节点和拓扑关系的增删查改；

2. 基于MindSpore Rewite这个基础能力，MindSpore Golden Stick会提供各种类型的算法，比如SimQAT算法、SLB量化算法、SCOP剪枝算法等；

3. 在算法的更上层，MindSpore Golden Stick还规划了如AMC（自动模型压缩技术）、NAS（网络结构搜索）、HAQ（硬件感知的自动量化）等高阶技术；

4. 为了方便开发者分析调试算法，MindSpore Golden Stick提供了一些工具，如Visualization工具（可视化工具）、Profiler工具（逐层分析工具）、Summary工具（算法压缩效果分析工具）等；

5. 在最外层，MindSpore Golden Stick封装了一套简洁的用户接口。

.. image:: ./images/golden-stick-arch.png

.. note::
    架构图是MindSpore Golden Stick的全貌，其中包含了当前已经实现的功能以及规划在RoadMap中能力。具体开放的功能可以参考对应版本的ReleaseNotes。


代码仓地址： <https://gitee.com/mindspore/golden-stick>

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 安装部署

   install

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 训练后量化

   ptq/overview
   ptq/ptq
   ptq/round_to_nearest

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 量化感知训练

   quantization/overview
   quantization/simulated_quantization
   quantization/slb

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: 剪枝

   pruner/overview
   pruner/scop

.. toctree::
   :maxdepth: 1
   :caption: API参考

   mindspore_gs
   mindspore_gs.common
   mindspore_gs.quantization
   mindspore_gs.ptq
   mindspore_gs.pruner

.. toctree::
   :glob:
   :maxdepth: 1
   :caption: RELEASE NOTES

   RELEASE