Merge pull request #1921 from littletomatodonkey/dyg/improve_doc

improve doc

configs/cls/cls_mv3.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [0, 1000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:
@@ -93,4 +92,4 @@ Eval:
     shuffle: False
     drop_last: False
     batch_size_per_card: 512
-    num_workers: 4
\ No newline at end of file
+    num_workers: 4

configs/det/ch_ppocr_v2.0/ch_det_mv3_db_v2.0.yml

@@ -7,7 +7,10 @@ Global:
   save_epoch_step: 1200
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [3000, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
+  # 1. If pretrained_model is saved in static mode, such as classification pretrained model
+  #    from static branch, load_static_weights must be set as True.
+  # 2. If you want to finetune the pretrained models we provide in the docs,
+  #    you should set load_static_weights as False.
   load_static_weights: True
   cal_metric_during_train: False
   pretrained_model: ./pretrain_models/MobileNetV3_large_x0_5_pretrained

configs/det/ch_ppocr_v2.0/ch_det_res18_db_v2.0.yml

@@ -7,7 +7,10 @@ Global:
   save_epoch_step: 1200
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [3000, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
+  # 1. If pretrained_model is saved in static mode, such as classification pretrained model
+  #    from static branch, load_static_weights must be set as True.
+  # 2. If you want to finetune the pretrained models we provide in the docs,
+  #    you should set load_static_weights as False.
   load_static_weights: True
   cal_metric_during_train: False
   pretrained_model: ./pretrain_models/ResNet18_vd_pretrained

configs/det/det_mv3_db.yml

@@ -7,7 +7,10 @@ Global:
   save_epoch_step: 1200
   # evaluation is run every 2000 iterations
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
+  # 1. If pretrained_model is saved in static mode, such as classification pretrained model
+  #    from static branch, load_static_weights must be set as True.
+  # 2. If you want to finetune the pretrained models we provide in the docs,
+  #    you should set load_static_weights as False.
   load_static_weights: True
   cal_metric_during_train: False
   pretrained_model: ./pretrain_models/MobileNetV3_large_x0_5_pretrained

configs/det/det_mv3_east.yml

@@ -7,7 +7,10 @@ Global:
   save_epoch_step: 1000
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [4000, 5000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
+  # 1. If pretrained_model is saved in static mode, such as classification pretrained model
+  #    from static branch, load_static_weights must be set as True.
+  # 2. If you want to finetune the pretrained models we provide in the docs,
+  #    you should set load_static_weights as False.
   load_static_weights: True
   cal_metric_during_train: False
   pretrained_model: ./pretrain_models/MobileNetV3_large_x0_5_pretrained

configs/det/det_r50_vd_db.yml

@@ -7,7 +7,10 @@ Global:
   save_epoch_step: 1200
   # evaluation is run every 2000 iterations
   eval_batch_step: [0,2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
+  # 1. If pretrained_model is saved in static mode, such as classification pretrained model
+  #    from static branch, load_static_weights must be set as True.
+  # 2. If you want to finetune the pretrained models we provide in the docs,
+  #    you should set load_static_weights as False.
   load_static_weights: True
   cal_metric_during_train: False
   pretrained_model: ./pretrain_models/ResNet50_vd_ssld_pretrained

configs/det/det_r50_vd_east.yml

@@ -7,7 +7,10 @@ Global:
   save_epoch_step: 1000
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [4000, 5000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
+  # 1. If pretrained_model is saved in static mode, such as classification pretrained model
+  #    from static branch, load_static_weights must be set as True.
+  # 2. If you want to finetune the pretrained models we provide in the docs,
+  #    you should set load_static_weights as False.
   load_static_weights: True
   cal_metric_during_train: False
   pretrained_model: ./pretrain_models/ResNet50_vd_pretrained/

configs/det/det_r50_vd_sast_icdar15.yml

@@ -7,7 +7,10 @@ Global:
   save_epoch_step: 1000
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [4000, 5000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
+  # 1. If pretrained_model is saved in static mode, such as classification pretrained model
+  #    from static branch, load_static_weights must be set as True.
+  # 2. If you want to finetune the pretrained models we provide in the docs,
+  #    you should set load_static_weights as False.
   load_static_weights: True
   cal_metric_during_train: False
   pretrained_model: ./pretrain_models/ResNet50_vd_ssld_pretrained/

configs/det/det_r50_vd_sast_totaltext.yml

@@ -7,7 +7,10 @@ Global:
   save_epoch_step: 1000
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [4000, 5000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
+  # 1. If pretrained_model is saved in static mode, such as classification pretrained model
+  #    from static branch, load_static_weights must be set as True.
+  # 2. If you want to finetune the pretrained models we provide in the docs,
+  #    you should set load_static_weights as False.
   load_static_weights: True
   cal_metric_during_train: False
   pretrained_model: ./pretrain_models/ResNet50_vd_ssld_pretrained/

configs/rec/ch_ppocr_v2.0/rec_chinese_common_train_v2.0.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/ch_ppocr_v2.0/rec_chinese_lite_train_v2.0.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints: 

configs/rec/rec_icdar15_train.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 2000 iterations
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/rec_mv3_none_bilstm_ctc.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 2000 iterations
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/rec_mv3_none_none_ctc.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 2000 iterations
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/rec_mv3_tps_bilstm_att.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/rec_mv3_tps_bilstm_ctc.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 2000 iterations
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/rec_r34_vd_none_bilstm_ctc.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 2000 iterations
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/rec_r34_vd_none_none_ctc.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 2000 iterations
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/rec_r34_vd_tps_bilstm_att.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 5000 iterations after the 4000th iteration
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints:

configs/rec/rec_r34_vd_tps_bilstm_ctc.yml

@@ -7,7 +7,6 @@ Global:
   save_epoch_step: 3
   # evaluation is run every 2000 iterations
   eval_batch_step: [0, 2000]
-  # if pretrained_model is saved in static mode, load_static_weights must set to True
   cal_metric_during_train: True
   pretrained_model:
   checkpoints: