SESR 项目使用教程

SESR 项目使用教程

1. 项目的目录结构及介绍

sesr/
├── models/
│   ├── sesr.py
│   ├── model_utils.py
│   └── quantize_utils.py
├── .gitignore
├── LICENSE.txt
├── README.md
├── SESR_results.png
├── collapsed_training.png
├── install_requirements.sh
├── train.py
└── utils.py

目录结构介绍

• models/: 包含项目的主要模型文件，包括 sesr.py（SESR 网络类）、model_utils.py（扩展和折叠线性块）和 quantize_utils.py（量化支持代码）。
• .gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。
• LICENSE.txt: 项目许可证文件，采用 Apache-2.0 许可证。
• README.md: 项目说明文件，包含项目的基本信息和使用说明。
• SESR_results.png: SESR 结果的示例图片。
• collapsed_training.png: 折叠训练的示例图片。
• install_requirements.sh: 安装项目依赖的脚本。
• train.py: 项目的启动文件，包含训练和评估循环。
• utils.py: 数据集工具和预处理代码。

2. 项目的启动文件介绍

train.py

train.py 是 SESR 项目的主要启动文件，负责训练和评估 SESR 网络。以下是该文件的主要功能：

• 训练循环: 包含训练和评估的循环，支持不同的训练配置。
• 量化感知训练 (QAT): 支持量化感知训练，生成 TFLITE 文件。
• 命令行参数: 通过命令行参数配置训练参数，如模型名称、量化选项、生成 TFLITE 文件等。

使用示例

python train.py --quant_W --quant_A --gen_tflite

3. 项目的配置文件介绍

install_requirements.sh

install_requirements.sh 是一个安装项目依赖的脚本。建议使用 conda 环境，并安装以下依赖：

• tensorflow-gpu>=2.3
• tensorflow_datasets>=4.1

使用示例

./install_requirements.sh

配置文件

项目中没有明确的配置文件，但可以通过命令行参数在 train.py 中配置训练参数。以下是一些常用的命令行参数：

• --epochs: 训练的 epoch 数量，默认值为 300。
• --batch_size: 训练时的批量大小，默认值为 32。
• --learning_rate: 学习率，默认值为 2e-4。
• --model_name: 模型名称，默认值为 'SESR'。
• --quant_W: 量化权重（8 位），默认值为 False。
• --quant_A: 量化激活（8 位），默认值为 False。
• --gen_tflite: 在量化感知训练完成后生成 int8 TFLITE 文件，默认值为 False。

使用示例

python train.py --epochs 500 --batch_size 64 --learning_rate 1e-3

通过以上配置，您可以根据需要调整训练参数，以适应不同的训练需求。