PaperEdge 开源项目使用教程

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

PaperEdge 项目的目录结构如下：

PaperEdge/
├── configs/
├── data/
├── eval/
├── images/
├── networks/
├── utils/
├── .gitignore
├── LICENSE
├── README.md
├── demo.py
├── eval.py
├── eval.sh
├── requirements.txt
├── train.py
└── train.sh

目录结构介绍

• configs/: 存放项目的配置文件。
• data/: 存放数据集文件。
• eval/: 存放评估脚本和相关文件。
• images/: 存放示例图像文件。
• networks/: 存放神经网络模型的定义文件。
• utils/: 存放工具函数和辅助文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• demo.py: 项目的演示脚本。
• eval.py: 项目的评估脚本。
• eval.sh: 评估脚本的 shell 脚本。
• requirements.txt: 项目依赖的 Python 包列表。
• train.py: 项目的训练脚本。
• train.sh: 训练脚本的 shell 脚本。

2. 项目的启动文件介绍

demo.py

demo.py 是 PaperEdge 项目的主要启动文件之一，用于演示如何使用预训练模型对单张图像进行文档矫正。

使用方法

$ python demo.py --Enet_ckpt 'models/G_w_checkpoint_13820.pt' \
                 --Tnet_ckpt 'models/L_w_checkpoint_27640.pt' \
                 --img_path 'images/1.jpg' \
                 --out_dir 'output'

• --Enet_ckpt: 指定 Enet 模型的检查点文件路径。
• --Tnet_ckpt: 指定 Tnet 模型的检查点文件路径。
• --img_path: 指定输入图像的路径。
• --out_dir: 指定输出结果的目录。

train.py

train.py 是用于训练 PaperEdge 模型的脚本。

使用方法

$ python train.py --config 'configs/your_config.yaml'

• --config: 指定训练配置文件的路径。

3. 项目的配置文件介绍

configs/ 目录

configs/ 目录下存放了项目的配置文件，通常以 .yaml 或 .json 格式存储。配置文件中包含了训练和评估过程中所需的参数设置。

示例配置文件

# configs/your_config.yaml

train:
  batch_size: 32
  learning_rate: 0.001
  num_epochs: 100

eval:
  batch_size: 16
  metrics: ['AD', 'MS-SSIM', 'LD']

• train: 训练相关的配置参数。
  • batch_size: 训练时的批量大小。
  • learning_rate: 学习率。
  • num_epochs: 训练的总轮数。
• eval: 评估相关的配置参数。
  • batch_size: 评估时的批量大小。
  • metrics: 评估时使用的指标。

通过配置文件，用户可以灵活地调整训练和评估过程中的参数，以适应不同的需求和数据集。