From 49497435faf9872db04b9d703407a588e2c99af7 Mon Sep 17 00:00:00 2001
From: Leif <4603009@qq.com>
Date: Mon, 6 Sep 2021 11:08:07 +0800
Subject: [PATCH] Add the overview of PaddleOCR
---
doc/doc_ch/environment.md | 95 ++++++++++++++++++++++------
doc/doc_ch/paddleOCR_overview.md | 31 +++++++++
doc/doc_ch/quickstart.md | 30 +--------
doc/doc_en/paddleOCR_overview_en.md | 39 ++++++++++++
doc/overview.png | Bin 0 -> 146186 bytes
doc/overview_en.png | Bin 0 -> 147823 bytes
6 files changed, 150 insertions(+), 45 deletions(-)
create mode 100644 doc/overview.png
create mode 100644 doc/overview_en.png
diff --git a/doc/doc_ch/environment.md b/doc/doc_ch/environment.md
index b53f5542..b1067730 100644
--- a/doc/doc_ch/environment.md
+++ b/doc/doc_ch/environment.md
@@ -1,8 +1,22 @@
-# 零基础Python环境搭建
+# 运行环境准备
-## Windows
+[运行环境准备](#paddleocr)
-### 第1步：安装Anaconda
+* [1. Python环境搭建](#1)
+ + [1.1 Windows](#1.1)
+ + [1.2 Mac](#1.2)
+ + [1.3 Linux](#1.3)
+* [2. 安装PaddlePaddle](#2)
+
+
+
+## 1. Python环境搭建
+
+
+
+### 1.1 Windows
+
+#### 1.1.1 安装Anaconda
- 说明：使用paddlepaddle需要先安装python环境，这里我们选择python集成环境Anaconda工具包
- Anaconda是1个常用的python包管理程序
@@ -20,7 +34,7 @@
-### 第2步：打开终端并创建conda环境
+#### 1.1.2 打开终端并创建conda环境
- 打开Anaconda Prompt终端：左下角Windows Start Menu -> Anaconda3 -> Anaconda Prompt启动控制台
@@ -60,11 +74,11 @@
以上anaconda环境和python环境安装完毕
+
+### 1.2 Mac
-## Mac
-
-### 第1步：安装Anaconda
+#### 1.2.1 安装Anaconda
- 说明：使用paddlepaddle需要先安装python环境，这里我们选择python集成环境Anaconda工具包
- Anaconda是1个常用的python包管理程序
@@ -79,7 +93,7 @@
- 按默认设置即可，安装需要花费一段时间
- 建议安装vscode或pycharm等代码编辑器
-### 第2步：打开终端并创建conda环境
+#### 1.2.2 打开终端并创建conda环境
- 打开终端
@@ -157,11 +171,13 @@
以上anaconda环境和python环境安装完毕
+
+### 1.3 Linux
-## Linux
+Linux用户可选择Anaconda或Docker两种方式运行。如果你熟悉Docker且需要训练PaddleOCR模型，推荐使用Docker环境，PaddleOCR的开发流程均在Docker环境下运行。如果你不熟悉Docker，也可以使用Anaconda来运行项目。
-### 第1步：安装Anaconda
+#### 1.3.1 Anaconda环境配置
- 说明：使用paddlepaddle需要先安装python环境，这里我们选择python集成环境Anaconda工具包
- Anaconda是1个常用的python包管理程序
@@ -262,14 +278,12 @@
- 在终端中输入`source ~/.bash_profile`以更新环境变量
- 再在终端输入`conda info --envs`，若能显示当前有base环境，则conda已加入环境变量
-### 第2步：创建conda环境
-
- 创建新的conda环境
```shell
- # 在命令行输入以下命令，创建名为paddle_env的环境
- # 此处为加速下载，使用清华源
- conda create --name paddle_env python=3.8 --channel https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/free/
+ # 在命令行输入以下命令，创建名为paddle_env的环境
+ # 此处为加速下载，使用清华源
+ conda create --name paddle_env python=3.8 --channel https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/free/
```
- 该命令会创建1个名为paddle_env、python版本为3.8的可执行环境，根据网络状态，需要花费一段时间
@@ -281,9 +295,54 @@
- 激活刚创建的conda环境，在命令行中输入以下命令：
```shell
- # 激活paddle_env环境
- conda activate paddle_env
+ # 激活paddle_env环境
+ conda activate paddle_env
```
-以上anaconda环境和python环境安装完毕
\ No newline at end of file
+以上anaconda环境和python环境安装完毕
+
+#### 1.3.2 Docker环境配置
+
+**注意：第一次使用这个镜像，会自动下载该镜像，请耐心等待。**
+
+```
+# 切换到工作目录下
+cd /home/Projects
+# 首次运行需创建一个docker容器，再次运行时不需要运行当前命令
+# 创建一个名字为ppocr的docker容器，并将当前目录映射到容器的/paddle目录下
+
+如果您希望在CPU环境下使用docker，使用docker而不是nvidia-docker创建docker
+sudo docker run --name ppocr -v $PWD:/paddle --network=host -it paddlepaddle/paddle:latest-dev-cuda10.1-cudnn7-gcc82 /bin/bash
+
+如果使用CUDA10，请运行以下命令创建容器，设置docker容器共享内存shm-size为64G，建议设置32G以上
+sudo nvidia-docker run --name ppocr -v $PWD:/paddle --shm-size=64G --network=host -it paddlepaddle/paddle:latest-dev-cuda10.1-cudnn7-gcc82 /bin/bash
+
+您也可以访问[DockerHub](https://hub.docker.com/r/paddlepaddle/paddle/tags/)获取与您机器适配的镜像。
+
+# ctrl+P+Q可退出docker 容器，重新进入docker 容器使用如下命令
+sudo docker container exec -it ppocr /bin/bash
+```
+
+
+
+## 2. 安装PaddlePaddle
+
+- 如果您的机器安装的是CUDA9或CUDA10，请运行以下命令安装
+
+```bash
+python3 -m pip install paddlepaddle-gpu -i https://mirror.baidu.com/pypi/simple
+```
+
+- 如果您的机器是CPU，请运行以下命令安装
+
+```bash
+python3 -m pip install paddlepaddle -i https://mirror.baidu.com/pypi/simple
+```
+
+更多的版本需求，请参照[飞桨官网安装文档](https://www.paddlepaddle.org.cn/install/quick)中的说明进行操作。
+
+
+
+
+
diff --git a/doc/doc_ch/paddleOCR_overview.md b/doc/doc_ch/paddleOCR_overview.md
index 9c16f8f6..f49c1ae3 100644
--- a/doc/doc_ch/paddleOCR_overview.md
+++ b/doc/doc_ch/paddleOCR_overview.md
@@ -1,2 +1,33 @@
# PaddleOCR全景图与项目克隆
+## 1. PaddleOCR全景图
+
+PaddleOCR包含丰富的文本检测、文本识别以及端到端算法。结合实际测试与产业经验，PaddleOCR选择DB和CRNN作为基础的检测和识别模型，经过一系列优化策略提出面向产业应用的PP-OCR模型。PP-OCR模型针对通用场景，根据不同语种形成了PP-OCR模型库。基于PP-OCR的能力，PaddleOCR针对文档场景任务发布PP-Structure工具库，包含版面分析和表格识别两大任务。为了打通产业落地的全流程，PaddleOCR提供了规模化的数据生产工具和多种预测部署工具，助力开发者快速落地。
+
+
+
+
+
+
o8BB6)qFR;
zmx|<`5*XNKRp^}Boz?0TBevb>{tWtdEq(OezA+2@q_fz(L1gW>y|a0zYLVFUIHfu2
zqWDqT-=r%mPX*ksvrpH*=x9ded1mQn)uY@f`uGCtLUt5=j3Sh>cb`5wM>LE4LQf%}
zl3DjXdcVN5@WAlHPYxYVBuUgNT)|gvBsDY_s6&L7INMvs%~WovHKZ4Ot>_67AC@^J
z>O?7)hX5K7^l?f}2ZP(jE}yl>_pK;Z(@u9ycwHbh`f8Ae*BLqNwH8(G)f4IP#TGvk
zxSkTxvs0@>H^=17;$OG(_THZN!fq&oo%=Yq+eBXlF$zN6y!#dAl_&9mRXbN%j@o%F
z>O4{!iav^qvYozZfhT-$hoAwIO3o}&lJ&(~tQ719f*mT$Z6%rm&js37n3u$h5Bx-N
z_s|e{xY(72`N%C=zJWfsL}CPub4)R;%;YQaSJfu$XJbJz5@`>M>?W#Xgh57HUkaX{
z3ijZI#4$l}C#rI}iLO~NF0;X0QC|%xi?-##7IPo&TatGvPa2JTEN*FxB8?K6ZKu~|!lJuf~LET15{xYpeh?YK&H&(4ZyX=}9<3kB*{(3~PK(yezpzJ3T)r4Y=
z>=i*bs}fSTR)?v!HLb41Z3RA$twV1y@VR{m8#|E9ctnosg(LJ(-g_BBIT^Om^{C8q
z2N?s^3N;3cQ=&o}*;+X==jTKccixe%ygrcU8{LN+by^vh^(Kmg`yyO|o?e&(BOn=T
zV%q@js2j;u-8qO@xi?i0f+bOV+W=9gQyEb<-@NY#wfBz2j*+-RUGPhZ26F>R=7~VI
zr>6vqQ){z}4>HQBI*EOVvHg~W(U7;VeQdB$W~txJE*A$E6J;$})cWvJ3Q;{l6;~CE
zPsUQitzDU%%^Emo>-H`Sq35Ap*^U
zc;?$Pc9G9nQecp;?8A9