Merge pull request #782 from tink2123/update_doc_new

update doc for install and angle_class

README.md

@@ -69,6 +69,7 @@ For more model downloads (including multiple languages), please refer to [PP-OCR
 - Model training/evaluation
     - [Text Detection](./doc/doc_en/detection_en.md)
     - [Text Recognition](./doc/doc_en/recognition_en.md)
+    - [Direction Classification](./doc/doc_en/angle_class_en.md)
     - [Yml Configuration](./doc/doc_en/config_en.md)
 - Inference and Deployment
     - [Quick inference based on pip](./doc/doc_en/whl_en.md)

README_ch.md

@@ -67,6 +67,7 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力
 - 模型训练/评估
     - [文本检测](./doc/doc_ch/detection.md)
     - [文本识别](./doc/doc_ch/recognition.md)
+    - [方向分类器](./doc/doc_ch/angle_class.md)
     - [yml参数配置文件介绍](./doc/doc_ch/config.md)
 - 预测部署
     - [基于pip安装whl包快速推理](./doc/doc_ch/whl.md)

doc/doc_ch/config.md

@@ -10,7 +10,7 @@
 
 ## 配置文件 Global 参数介绍
 
-以 `rec_chinese_lite_train.yml` 为例
+以 `rec_chinese_lite_train_v1.1.yml ` 为例
 
 
 |         字段             |            用途                |      默认值       |            备注            |
@@ -32,6 +32,7 @@
 |      loss_type           |    设置 loss 类型              |       ctc         |    支持两种loss： ctc / attention |
 |       distort            |    设置是否使用数据增强          |       false       |  设置为true时，将在训练时随机进行扰动，支持的扰动操作可阅读[img_tools.py](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/ppocr/data/rec/img_tools.py)                 |
 |       use_space_char     |    设置是否识别空格             |        false      |          仅在 character_type=ch 时支持空格                 |
+|      label_list          |    设置方向分类器支持的角度       |    ['0','180']    |     仅在方向分类器中生效 |
 |      average_window      |    ModelAverage优化器中的窗口长度计算比例 |  0.15       |       目前仅应用与SRN |
 |      max_average_window  |    平均值计算窗口长度的最大值   |   15625              | 推荐设置为一轮训练中mini-batchs的数目|
 |      min_average_window  |    平均值计算窗口长度的最小值  |    10000              |      \          |

doc/doc_ch/installation.md

@@ -2,7 +2,7 @@
 
 经测试PaddleOCR可在glibc 2.23上运行，您也可以测试其他glibc版本或安装glic 2.23
 PaddleOCR 工作环境
-- PaddlePaddle 1.7+
+- PaddlePaddle 1.8+ ，推荐使用 PaddlePaddle 2.0.0.beta
 - python3.7
 - glibc 2.23
 - cuDNN 7.6+ (GPU)
@@ -47,19 +47,16 @@ docker images
 hub.baidubce.com/paddlepaddle/paddle   latest-gpu-cuda9.0-cudnn7-dev    f56310dcc829
 ```
 
-**2. 安装PaddlePaddle Fluid v1.7**
+**2. 安装PaddlePaddle Fluid v2.0**
 ```
 pip3 install --upgrade pip
 
-如果您的机器安装的是CUDA9，请运行以下命令安装
-python3 -m pip install paddlepaddle-gpu==1.7.2.post97 -i https://pypi.tuna.tsinghua.edu.cn/simple
-
-如果您的机器安装的是CUDA10，请运行以下命令安装
-python3 -m pip install paddlepaddle-gpu==1.7.2.post107 -i https://pypi.tuna.tsinghua.edu.cn/simple
+如果您的机器安装的是CUDA9或CUDA10，请运行以下命令安装
+python3 -m pip install paddlepaddle-gpu==2.0.0b0 -i https://mirror.baidu.com/pypi/simple
 
 如果您的机器是CPU，请运行以下命令安装
 
-python3 -m pip install paddlepaddle==1.7.2 -i https://pypi.tuna.tsinghua.edu.cn/simple
+python3 -m pip install paddlepaddle==2.0.0b0 -i https://mirror.baidu.com/pypi/simple
 
 更多的版本需求，请参照[安装文档](https://www.paddlepaddle.org.cn/install/quick)中的说明进行操作。
 ```

doc/doc_en/config_en.md

@@ -10,7 +10,7 @@ The following list can be viewed via `--help`
 
 ## INTRODUCTION TO GLOBAL PARAMETERS OF CONFIGURATION FILE
 
-Take `rec_chinese_lite_train.yml` as an example
+Take `rec_chinese_lite_train_v1.1.yml` as an example
 
 
 |         Parameter             |            Use                |      Default       |            Note            |
@@ -32,6 +32,7 @@ Take `rec_chinese_lite_train.yml` as an example
 |      loss_type           |    Set loss type              |       ctc         |    Supports two types of loss: ctc / attention |
 |       distort            |    Set use distort          |       false       |  Support distort type ,read [img_tools.py](https://github.com/PaddlePaddle/PaddleOCR/blob/develop/ppocr/data/rec/img_tools.py)                 |
 |      use_space_char          |    Wether to recognize space             |        false      |         Only support in character_type=ch mode                 |
+     label_list          | Set the angle supported by the direction classifier | ['0','180'] | Only valid in the direction classifier |
 |      reader_yml          |    Set the reader configuration file          |  ./configs/rec/rec_icdar15_reader.yml  |  \          |
 |      pretrain_weights    |    Load pre-trained model path      |  ./pretrain_models/CRNN/best_accuracy  |  \          |
 |      checkpoints         |    Load saved model path            |       None        |    Used to load saved parameters to continue training after interruption |

doc/doc_en/installation_en.md

@@ -3,7 +3,7 @@
 After testing, paddleocr can run on glibc 2.23. You can also test other glibc versions or install glic 2.23 for the best compatibility.
 
 PaddleOCR working environment:
-- PaddlePaddle1.7
+- PaddlePaddle1.8+, Recommend PaddlePaddle 2.0.0.beta
 - python3.7
 - glibc 2.23
 
@@ -49,18 +49,15 @@ docker images
 hub.baidubce.com/paddlepaddle/paddle   latest-gpu-cuda9.0-cudnn7-dev    f56310dcc829
 ```
 
-**2. Install PaddlePaddle Fluid v1.7 (the higher version is not supported yet, the adaptation work is in progress)**
+**2. Install PaddlePaddle Fluid v2.0 **
 ```
 pip3 install --upgrade pip
 
-# If you have cuda9 installed on your machine, please run the following command to install
-python3 -m pip install paddlepaddle-gpu==1.7.2.post97 -i https://pypi.tuna.tsinghua.edu.cn/simple
-
-# If you have cuda10 installed on your machine, please run the following command to install
-python3 -m pip install paddlepaddle-gpu==1.7.2.post107 -i https://pypi.tuna.tsinghua.edu.cn/simple
+# If you have cuda9 or cuda10 installed on your machine, please run the following command to install
+python3 -m pip install paddlepaddle-gpu==2.0.0b0 -i https://mirror.baidu.com/pypi/simple
 
 # If you only have cpu on your machine, please run the following command to install
-python3 -m pip install paddlepaddle==1.7.2 -i https://pypi.tuna.tsinghua.edu.cn/simple
+python3 -m pip install paddlepaddle==2.0.0b0 -i https://mirror.baidu.com/pypi/simple
 ```
 For more software version requirements, please refer to the instructions in [Installation Document](https://www.paddlepaddle.org.cn/install/quick) for operation.