接口调用流程

图1 组合压缩接口调用流程
点击放大

蓝色部分为用户实现，灰色部分为用户调用AMCT提供的API实现：

用户构造Pytorch的原始模型，调用create_compressed_retrain_model接口对原始模型进行修改，修改后的模型包含了稀疏和量化相关的算子。
对修改后的模型进行训练，如果训练未中断，将训练后的模型进行推理，在推理的过程中，会将量化因子写出到record文件中，然后调用save_compressed_retrain_model接口保存精度仿真模型以及部署模型；如果训练过程中断，则可基于保存的pth模型参数，重新调用restore_compressed_retrain_model接口，输出根据稀疏关系稀疏好并插入了量化算子的模型，并且重新加载中断前保存模型的权重，继续进行训练，然后进行推理，最后调用save_compressed_retrain_model接口保存量化后的模型。

调用示例

如下示例标有“由用户补充处理”的步骤，需要用户根据自己的模型和数据集进行补充处理，示例中仅为示例代码。
调用AMCT的部分，函数入参可以根据实际情况进行调整。组合压缩基于用户的训练过程，请确保已经有基于PyTorch环境进行训练的脚本，并且训练后的精度正常。

导入AMCT包，并通过安装后处理中的环境变量设置日志级别。
```
import amct_pytorch as amct
```
（可选，由用户补充处理）建议使用原始待量化的模型和测试集，在PyTorch环境下推理，验证环境、推理脚本是否正常。
推荐执行该步骤，请确保原始模型可以完成推理且精度正常；执行该步骤时，可以使用部分测试集，减少运行时间。
```
ori_model.load() 
# 测试模型 
user_test_model(ori_model, test_data, test_iterations)
```

调用AMCT，执行组合压缩流程。

修改模型，对模型ori_model进行稀疏并插入量化相关的算子，保存成新的训练模型retrain_model。

实现该步骤前，应先恢复训练好的参数，如2中的ori_model.load()。

simple_cfg = './compressed.cfg'
record_file = './tmp/record.txt'
compressed_retrain_model = amct.create_compressed_retrain_model(
                                model=ori_model,
                                input_data=ori_model_input_data,
                                config_defination=simple_cfg,
                                record_file=record_file)

（由用户补充处理）使用修改后的图，创建反向梯度，在训练集上做训练，训练量化因子。
1. 使用修改后的图，创建反向梯度。
  该步骤需要在3.a后执行。
```
optimizer = user_create_optimizer(compressed_retrain_model)
```
2. 从训练好的checkpoint恢复模型，并训练模型。
  注意：从训练好的checkpoint恢复模型参数后再训练；训练中保存的参数应该包括量化因子。
```
compressed_pth = './ckpt/user_model' 
user_train_model(optimizer, compressed_retrain_model, train_data)
```
3. 训练完成后，执行推理，计算量化因子并保存。
```
user_infer_graph(compressed_retrain_model)
```

保存模型。

save_path = '/.result/user_model'
amct.save_compressed_retrain_model(
     model=compressed_retrain_model,
     record_file=record_file,
     save_path=save_path,
     input_data=ori_model_input_data)

（可选，由用户补充处理）基于ONNX Runtime的环境，使用组合压缩后模型（compressed_model）在测试集（test_data）上做推理，测试组合压缩后仿真模型的精度。使用组合压缩后仿真模型精度与2中的原始精度做对比，可以观察组合压缩对精度的影响。
```
compressed_model = './results/user_model_fake_quant_model.onnx' 
user_do_inference_onnx(compressed_model, test_data, test_iterations)
```

如果训练过程中断，需要从ckpt中恢复数据，继续训练，则调用流程为：

导入AMCT包，并通过安装后处理中的环境变量设置日志级别。
```
import amct_pytorch as amct
```
准备原始模型。
```
ori_model = user_create_model()
```

调用AMCT，执行组合压缩流程。

修改模型，对模型ori_model进行稀疏并插入量化相关的算子，加载权重参数，保存成新的训练模型retrain_model。

simple_cfg = './compressed.cfg'
record_file = './tmp/record.txt'
compressed_pth_file = './ckpt/user_model_newest.ckpt'
compressed_retrain_model = amct.restore_compressed_retrain_model(
                                model=ori_model,
                                input_data=ori_model_input_data,
                                config_defination=simple_cfg,
                                record_file=record_file,
                                pth_file=compressed_pth_file)

（由用户补充处理）使用修改后的图，创建反向梯度，在训练集上做训练，训练量化因子。
1. 使用修改后的图，创建反向梯度。
  该步骤需要在3.a后执行。
```
optimizer = user_create_optimizer(compressed_retrain_model)
```
2. 从训练好的checkpoint恢复模型，并训练模型。
  注意：从训练好的checkpoint恢复模型参数后再训练；训练中保存的参数应该包括量化因子。
```
compressed_pth = './ckpt/user_model' 
user_train_model(optimizer, compressed_retrain_model, train_data)
```
3. 训练完成后，执行推理，计算量化因子并保存。
```
user_infer_graph(compressed_retrain_model)
```

保存模型。

save_path = '/.result/user_model'
amct.save_compressed_retrain_model(
     model=compressed_retrain_model,
     record_file=record_file,
     save_path=save_path,
     input_data=ori_model_input_data)

（可选，由用户补充处理）基于ONNX Runtime的环境，使用组合压缩后模型（compressed_model）在测试集（test_data）上做推理，测试组合压缩后仿真模型的精度。使用组合压缩后仿真模型精度与2中的原始精度做对比，可以观察组合压缩对精度的影响。
```
compressed_model = './results/user_model_fake_quant_model.onnx' 
user_do_inference_onnx(compressed_model, test_data, test_iterations)
```