From ec35c94b144a479242720aab1d903c647bf77fb5 Mon Sep 17 00:00:00 2001 From: tink2123 Date: Fri, 12 Jun 2020 12:09:55 +0800 Subject: [PATCH] update cosine_decay doc --- doc/doc_ch/config.md | 15 +++++++++++++++ doc/doc_en/config_en.md | 15 +++++++++++++++ 2 files changed, 30 insertions(+) diff --git a/doc/doc_ch/config.md b/doc/doc_ch/config.md index 644232b4..fae0c677 100644 --- a/doc/doc_ch/config.md +++ b/doc/doc_ch/config.md @@ -46,3 +46,18 @@ | img_set_dir | 数据集路径 | ./train_data | \ | | label_file_path | 数据标签路径 | ./train_data/rec_gt_train.txt| \ | | infer_img | 预测图像文件夹路径 | ./infer_img | \| + +## 配置文件 Optimizer 系列参数介绍 + +以 `rec_icdar15_train.yml` 为例 + +| 字段 | 用途 | 默认值 | 备注 | +| :---------------------: | :---------------------: | :--------------: | :--------------------: | +| function | 选择优化器 | pocr.optimizer,AdamDecay | 目前只支持Adam方式 | +| base_lr | 设置初始学习率 | 0.0005 | \ | +| beta1 | 设置一阶矩估计的指数衰减率 | 0.9 | \ | +| beta2 | 设置二阶矩估计的指数衰减率 | 0.999 | \ | +| decay | 是否使用decay | \ | \ | +| function(decay) | 设置decay方式 | cosine_decay | \ | +| step_each_epoch | 每个epoch包含多少次迭代 | 20 | 计算方式：total_image_num / (batch_size_per_card * card_size) | +| total_epoch | 总共迭代多少个epoch | 1000 | 与Global.epoch_num 一致 | diff --git a/doc/doc_en/config_en.md b/doc/doc_en/config_en.md index e995a629..80558e7a 100644 --- a/doc/doc_en/config_en.md +++ b/doc/doc_en/config_en.md @@ -46,3 +46,18 @@ Take `rec_chinese_reader.yml` as an example: | img_set_dir | Image folder path | ./train_data | \ | | label_file_path | Groundtruth file path | ./train_data/rec_gt_train.txt| \ | | infer_img | Result folder path | ./infer_img | \| + +## Introduction to Optimizer parameters of Configuration file + +Take `rec_icdar15_train.yml` as an example: + +| Parameter | Use | Default | None | +| :---------------------: | :---------------------: | :--------------: | :--------------------: | +| function | Select Optimizer function | pocr.optimizer,AdamDecay | Only support Adam | +| base_lr | Set the base lr | 0.0005 | \ | +| beta1 | Set the exponential decay rate for the 1st moment estimates | 0.9 | \ | +| beta2 | Set the exponential decay rate for the 2nd moment estimates | 0.999 | \ | +| decay | Whether to use decay | \ | \ | +| function(decay) | Set the decay function | cosine_decay | \ | +| step_each_epoch | The number of steps in an epoch. | 20 | Calculation ：total_image_num / (batch_size_per_card * card_size) | +| total_epoch | The number of epochs | 1000 | Consistent with Global.epoch_num | -- GitLab