diff --git a/fluid/ocr_recognition/README.md b/fluid/ocr_recognition/README.md index 96543ac831fdbe3fc105074faec0498eb5ea93d0..57b4cba374e2cd88a42df9f8993f8777f66fa458 100644 --- a/fluid/ocr_recognition/README.md +++ b/fluid/ocr_recognition/README.md @@ -13,12 +13,12 @@ 本路径下各个文件的作用如下: -- **ctc_reader.py : ** 下载、读取、处理数据。提供方法`train()` 和 `test()` 分别产生训练集和测试集的数据迭代器。 -- **crnn_ctc_model.py : ** 在该脚本中定义了训练网络、预测网络和evaluate网络。 -- **ctc_train.py : ** 用于模型的训练,可通过命令`python train.py --help` 获得使用方法。 -- **inference.py : ** 加载训练好的模型文件,对新数据进行预测。可通过命令`python inference.py --help` 获得使用方法。 -- **eval.py : ** 评估模型在指定数据集上的效果。可通过命令`python inference.py --help` 获得使用方法。 -- **utility.py : ** 实现的一些通用方法,包括参数配置、tensor的构造等。 +- **ctc_reader.py :** 下载、读取、处理数据。提供方法`train()` 和 `test()` 分别产生训练集和测试集的数据迭代器。 +- **crnn_ctc_model.py :** 在该脚本中定义了训练网络、预测网络和evaluate网络。 +- **ctc_train.py :** 用于模型的训练,可通过命令`python train.py --help` 获得使用方法。 +- **inference.py :** 加载训练好的模型文件,对新数据进行预测。可通过命令`python inference.py --help` 获得使用方法。 +- **eval.py :** 评估模型在指定数据集上的效果。可通过命令`python inference.py --help` 获得使用方法。 +- **utility.py :** 实现的一些通用方法,包括参数配置、tensor的构造等。 ### 1.1 数据 @@ -107,50 +107,50 @@ python ctc_train.py [options] 其中,options支持配置以下训练相关的参数: -**- -batch_size : ** Minibatch 大小,默认为32. +**- -batch_size :** Minibatch 大小,默认为32. -**- -pass_num : ** 训练多少个pass。默认为100。 +**- -pass_num :** 训练多少个pass。默认为100。 -**- -log_period : ** 每隔多少个minibatch打印一次训练日志, 默认为1000. +**- -log_period :** 每隔多少个minibatch打印一次训练日志, 默认为1000. -**- -save_model_period : ** 每隔多少个minibatch保存一次模型。默认为15000。 +**- -save_model_period :** 每隔多少个minibatch保存一次模型。默认为15000。 如果设置为-1,则永不保存模型。 -**- -eval_period : ** 每隔多少个minibatch用测试集测试一次模型。默认为15000。如果设置为-1,则永不进行测试。 +**- -eval_period :** 每隔多少个minibatch用测试集测试一次模型。默认为15000。如果设置为-1,则永不进行测试。 -**- -save_model_dir : ** 保存模型文件的路径,默认为“./models”,如果指定路径不存在,则会自动创建路径。 +**- -save_model_dir :** 保存模型文件的路径,默认为“./models”,如果指定路径不存在,则会自动创建路径。 -**- -init_model : ** 初始化模型的路径。如果模型是以单个文件存储的,这里需要指定具体文件的路径;如果模型是以多个文件存储的,这里只需指定多个文件所在文件夹的路径。该选项默认为 None,意思是不用预训练模型做初始化。 +**- -init_model :** 初始化模型的路径。如果模型是以单个文件存储的,这里需要指定具体文件的路径;如果模型是以多个文件存储的,这里只需指定多个文件所在文件夹的路径。该选项默认为 None,意思是不用预训练模型做初始化。 -**- -learning_rate : ** 全局learning rate. 默认为 0.001. +**- -learning_rate :** 全局learning rate. 默认为 0.001. -**- -l2 : ** L2 regularizer. 默认为0.0004. +**- -l2 :** L2 regularizer. 默认为0.0004. -**- -max_clip : ** Max gradient clipping threshold. 默认为10.0. +**- -max_clip :** Max gradient clipping threshold. 默认为10.0. -**- -momentum : ** Momentum. 默认为0.9. +**- -momentum :** Momentum. 默认为0.9. -**- -rnn_hidden_size: ** RNN 隐藏层大小。 默认为200。 +**- -rnn_hidden_size :** RNN 隐藏层大小。 默认为200。 -**- -device DEVICE : ** 设备ID。设置为-1,训练在CPU执行;设置为0,训练在GPU上执行。默认为0。 +**- -device DEVICE :** 设备ID。设置为-1,训练在CPU执行;设置为0,训练在GPU上执行。默认为0。 -**- -min_average_window : ** Min average window. 默认为10000. +**- -min_average_window :** Min average window. 默认为10000. -**- -max_average_window : ** Max average window. 建议大小设置为一个pass内minibatch的数量。默认为15625. +**- -max_average_window :** Max average window. 建议大小设置为一个pass内minibatch的数量。默认为15625. -**- -average_window : ** Average window. 默认为0.15. +**- -average_window :** Average window. 默认为0.15. -**- -parallel : ** 是否使用多卡进行训练。默认为True. +**- -parallel :** 是否使用多卡进行训练。默认为True. -**- -train_images : ** 存放训练集图片的路径,如果设置为None,ctc_reader会自动下载使用默认数据集。如果使用自己的数据进行训练,需要修改该选项。默认为None。 +**- -train_images :** 存放训练集图片的路径,如果设置为None,ctc_reader会自动下载使用默认数据集。如果使用自己的数据进行训练,需要修改该选项。默认为None。 -**- -train_list : ** 存放训练集图片信息的list文件,如果设置为None,ctc_reader会自动下载使用默认数据集。如果使用自己的数据进行训练,需要修改该选项。默认为None。 +**- -train_list :** 存放训练集图片信息的list文件,如果设置为None,ctc_reader会自动下载使用默认数据集。如果使用自己的数据进行训练,需要修改该选项。默认为None。 -**- -test_images : ** 存放测试集图片的路径,如果设置为None,ctc_reader会自动下载使用默认数据集。如果使用自己的数据进行测试,需要修改该选项。默认为None。 +**- -test_images :** 存放测试集图片的路径,如果设置为None,ctc_reader会自动下载使用默认数据集。如果使用自己的数据进行测试,需要修改该选项。默认为None。 -**- -test_list : ** 存放测试集图片信息的list文件,如果设置为None,ctc_reader会自动下载使用默认数据集。如果使用自己的数据进行测试,需要修改该选项。默认为None。 +**- -test_list :** 存放测试集图片信息的list文件,如果设置为None,ctc_reader会自动下载使用默认数据集。如果使用自己的数据进行测试,需要修改该选项。默认为None。 -**- -num_classes : ** 字符集的大小。如果设置为None, 则使用ctc_reader提供的字符集大小。如果使用自己的数据进行训练,需要修改该选项。默认为None. +**- -num_classes :** 字符集的大小。如果设置为None, 则使用ctc_reader提供的字符集大小。如果使用自己的数据进行训练,需要修改该选项。默认为None. ### 1.3 Inference @@ -163,13 +163,13 @@ python inference.py [options] 其中,options支持配置以下预测相关的参数: -**--model_path : ** 用来做预测的模型文件。如果模型是以单个文件存储的,这里需要指定具体文件的路径;如果模型是以多个文件存储的,这里只需指定多个文件所在文件夹的路径。为必设置选项。 +**--model_path :** 用来做预测的模型文件。如果模型是以单个文件存储的,这里需要指定具体文件的路径;如果模型是以多个文件存储的,这里只需指定多个文件所在文件夹的路径。为必设置选项。 -**--input_images_dir : ** 存放待预测图片的文件夹路径。如果设置为None, 则使用ctc_reader提供的默认数据。默认为None. +**--input_images_dir :** 存放待预测图片的文件夹路径。如果设置为None, 则使用ctc_reader提供的默认数据。默认为None. -**--input_images_list : ** 存放待预测图片信息的list文件的路径。如果设置为None, 则使用ctc_reader提供的默认数据。默认为None. +**--input_images_list :** 存放待预测图片信息的list文件的路径。如果设置为None, 则使用ctc_reader提供的默认数据。默认为None. -**--device DEVICE :** 设备ID。设置为-1,运行在CPU上;设置为0,运行在GPU上。默认为0。 +**--device DEVICE :** 设备ID。设置为-1,运行在CPU上;设置为0,运行在GPU上。默认为0。 预测结果会print到标准输出。 @@ -183,10 +183,10 @@ python eval.py [options] 其中,options支持配置以下评估相关的参数: -**--model_path : ** 待评估模型的文件路径。如果模型是以单个文件存储的,这里需要指定具体文件的路径;如果模型是以多个文件存储的,这里只需指定多个文件所在文件夹的路径。为必设置选项。 +**--model_path :** 待评估模型的文件路径。如果模型是以单个文件存储的,这里需要指定具体文件的路径;如果模型是以多个文件存储的,这里只需指定多个文件所在文件夹的路径。为必设置选项。 -**--input_images_dir : ** 存放待评估图片的文件夹路径。如果设置为None, 则使用ctc_reader提供的默认数据。默认为None. +**--input_images_dir :** 存放待评估图片的文件夹路径。如果设置为None, 则使用ctc_reader提供的默认数据。默认为None. -**--input_images_list : ** 存放待评估图片信息的list文件的路径。如果设置为None, 则使用ctc_reader提供的默认数据。默认为None. +**--input_images_list :** 存放待评估图片信息的list文件的路径。如果设置为None, 则使用ctc_reader提供的默认数据。默认为None. -**--device DEVICE :** 设备ID。设置为-1,运行在CPU上;设置为0,运行在GPU上。默认为0。 +**--device DEVICE :** 设备ID。设置为-1,运行在CPU上;设置为0,运行在GPU上。默认为0。