From 2b53c6c8bd8d5f251aa45fd372e6866cc34b936a Mon Sep 17 00:00:00 2001 From: tink2123 Date: Thu, 14 May 2020 18:41:52 +0800 Subject: [PATCH] update config readme --- configs/rec/rec_icdar15_reader.yml | 4 ++-- doc/config.md | 20 +++++++++++++++++--- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/configs/rec/rec_icdar15_reader.yml b/configs/rec/rec_icdar15_reader.yml index fd6227d5..12facda1 100755 --- a/configs/rec/rec_icdar15_reader.yml +++ b/configs/rec/rec_icdar15_reader.yml @@ -1,12 +1,12 @@ TrainReader: reader_function: ppocr.data.rec.dataset_traversal,SimpleReader num_workers: 8 - img_set_dir: ./train_data + img_set_dir: ./train_data/ic15_data label_file_path: ./train_data/ic15_data/rec_gt_train.txt EvalReader: reader_function: ppocr.data.rec.dataset_traversal,SimpleReader - img_set_dir: ./train_data + img_set_dir: ./train_data/ic15_data label_file_path: ./train_data/ic15_data/rec_gt_test.txt TestReader: diff --git a/doc/config.md b/doc/config.md index 1626bb96..94186bda 100644 --- a/doc/config.md +++ b/doc/config.md @@ -10,14 +10,17 @@ ## 配置文件 Global 参数介绍 +以 `rec_chinese_lite_train.yml` 为例 + + | 字段 | 用途 | 默认值 | 备注 | | :----------------------: | :---------------------: | :--------------: | :--------------------: | -| algorithm | 设置算法 | CRNN | 选择模型，支持模型请参考[简介](../../README.md) | +| algorithm | 设置算法 | 与配置文件同步 | 选择模型，支持模型请参考[简介](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/README.md) | | use_gpu | 设置代码运行场所 | true | \ | | epoch_num | 最大训练epoch数 | 3000 | \ | | log_smooth_window | 滑动窗口大小 | 20 | \ | | print_batch_step | 设置打印log间隔 | 10 | \ | -| save_model_dir | 设置模型保存路径 | output/rec_CRNN | \ | +| save_model_dir | 设置模型保存路径 | output/{算法名称} | \ | | save_epoch_step | 设置模型保存间隔 | 3 | \ | | eval_batch_step | 设置模型评估间隔 | 2000 | \ | |train_batch_size_per_card | 设置训练时单卡batch size | 256 | \ | @@ -29,7 +32,18 @@ | loss_type | 设置 loss 类型 | ctc | 支持两种loss： ctc / attention | | reader_yml | 设置reader配置文件 | ./configs/rec/rec_icdar15_reader.yml | \ | | pretrain_weights | 加载预训练模型路径 | ./pretrain_models/CRNN/best_accuracy | \ | -| checkpoints | 加载模型参数路径 | None | 用于中断后重新训练 | +| checkpoints | 加载模型参数路径 | None | 用于中断后加载参数继续训练 | | save_inference_dir | inference model 保存路径 | None | 用于保存inference model | +## 配置文件 Reader 系列参数介绍 + +以 `rec_chinese_reader.yml` 为例 + +| 字段 | 用途 | 默认值 | 备注 | +| :----------------------: | :---------------------: | :--------------: | :--------------------: | +| reader_function | 选择数据读取方式 | ppocr.data.rec.dataset_traversal,SimpleReader | 支持SimpleReader / LMDBReader 两种数据读取方式 | +| num_workers | 设置数据读取线程数 | 8 | \ | +| img_set_dir | 数据集路径 | ./train_data | \ | +| label_file_path | 数据标签路径 | ./train_data/rec_gt_train.txt| \ | +| infer_img | 预测图像文件夹路径 | ./infer_img | \| -- GitLab