From 6a8798ef88119c2b50feefe0544be3505b64770c Mon Sep 17 00:00:00 2001 From: Leif <4603009@qq.com> Date: Thu, 30 Dec 2021 21:30:37 +0800 Subject: [PATCH] Update docs Update docs --- README.md | 6 +++--- README_ch.md | 2 +- doc/doc_ch/algorithm_overview.md | 2 +- doc/doc_ch/code_and_doc.md | 14 +++++++------- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 6c5fe06f..0a018078 100644 --- a/README.md +++ b/README.md @@ -102,11 +102,11 @@ For a new language request, please refer to [Guideline for new language_requests ## Tutorials - [Environment Preparation](./doc/doc_en/environment_en.md) - [Quick Start](./doc/doc_en/quickstart_en.md) -- [PaddleOCR Overview and Installation](./doc/doc_en/paddleOCR_overview_en.md) +- [PaddleOCR Overview and Project Clone](./doc/doc_en/paddleOCR_overview_en.md) - PP-OCR Industry Landing: from Training to Deployment - - [PP-OCR Model and Configuration](./doc/doc_en/models_and_config_en.md) + - [PP-OCR Model Zoo](./doc/doc_en/models_en.md) - [PP-OCR Model Download](./doc/doc_en/models_list_en.md) - - [Python Inference for PP-OCR Model Library](./doc/doc_en/inference_ppocr_en.md) + - [Python Inference for PP-OCR Model Zoo](./doc/doc_en/inference_ppocr_en.md) - [PP-OCR Training](./doc/doc_en/training_en.md) - [Text Detection](./doc/doc_en/detection_en.md) - [Text Recognition](./doc/doc_en/recognition_en.md) diff --git a/README_ch.md b/README_ch.md index 77da6121..d16b9c0e 100755 --- a/README_ch.md +++ b/README_ch.md @@ -82,7 +82,7 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力 - [快速开始（中英文/多语言/文档分析）](./doc/doc_ch/quickstart.md) - [PaddleOCR全景图与项目克隆](./doc/doc_ch/paddleOCR_overview.md) - PP-OCR产业落地：从训练到部署 - - [PP-OCR模型与配置文件](./doc/doc_ch/models_and_config.md) + - [PP-OCR模型库](./doc/doc_ch/models.md) - [PP-OCR模型下载](./doc/doc_ch/models_list.md) - [PP-OCR模型库快速推理](./doc/doc_ch/inference_ppocr.md) - [PP-OCR模型训练](./doc/doc_ch/training.md) diff --git a/doc/doc_ch/algorithm_overview.md b/doc/doc_ch/algorithm_overview.md index f0c16618..8cc5bab8 100755 --- a/doc/doc_ch/algorithm_overview.md +++ b/doc/doc_ch/algorithm_overview.md @@ -57,7 +57,7 @@ PaddleOCR基于动态图开源的文本识别算法列表： - [x] SAR([paper](https://arxiv.org/abs/1811.00751v2)) - [x] SEED([paper](https://arxiv.org/pdf/2005.10977.pdf)) -参考[DTRB][3](https://arxiv.org/abs/1904.01906)文字识别训练和评估流程，使用MJSynth和SynthText两个文字识别数据集训练，在IIIT, SVT, IC03, IC13, IC15, SVTP, CUTE数据集上进行评估，算法效果如下： +参考[DTRB](https://arxiv.org/abs/1904.01906)[3]文字识别训练和评估流程，使用MJSynth和SynthText两个文字识别数据集训练，在IIIT, SVT, IC03, IC13, IC15, SVTP, CUTE数据集上进行评估，算法效果如下： |模型|骨干网络|Avg Accuracy|模型存储命名|下载链接| |---|---|---|---|---| diff --git a/doc/doc_ch/code_and_doc.md b/doc/doc_ch/code_and_doc.md index ebf5c03c..e5cf653e 100644 --- a/doc/doc_ch/code_and_doc.md +++ b/doc/doc_ch/code_and_doc.md @@ -146,7 +146,7 @@ PaddleOCR欢迎大家向repo中积极贡献代码，下面给出一些贡献代 - 将 `远程仓库` Clone到本地 ``` -# 拉取develop分支的代码 +# 拉取dygraph分支的代码 git clone https://github.com/{your_name}/PaddleOCR.git -b dygraph cd PaddleOCR ``` @@ -191,11 +191,11 @@ git checkout -b new_branch 也可以基于远程或者上游的分支创建新的分支，命令如下。 ``` -# 基于用户远程仓库(origin)的develop创建new_branch分支 -git checkout -b new_branch origin/develop -# 基于上游远程仓库(upstream)的develop创建new_branch分支 +# 基于用户远程仓库(origin)的dygraph创建new_branch分支 +git checkout -b new_branch origin/dygraph +# 基于上游远程仓库(upstream)的dygraph创建new_branch分支 # 如果需要从upstream创建新的分支，需要首先使用git fetch upstream获取上游代码 -git checkout -b new_branch upstream/develop +git checkout -b new_branch upstream/dygraph ``` 最终会显示切换到新的分支，输出信息如下 @@ -246,8 +246,8 @@ git commit -m "your commit info" ``` git fetch upstream -# 如果是希望提交到其他分支，则需要从upstream的其他分支pull代码，这里是develop -git pull upstream develop +# 如果是希望提交到其他分支，则需要从upstream的其他分支pull代码，这里是dygraph +git pull upstream dygraph ``` #### 3.2.7 push到远程仓库 -- GitLab