From c6bd5ed9e1e2f600acf96f9cb1ec6f80f3a16384 Mon Sep 17 00:00:00 2001 From: Leif <4603009@qq.com> Date: Wed, 8 Sep 2021 15:02:38 +0800 Subject: [PATCH] Add add_new_algorithm.md Add add_new_algorithm.md --- README.md | 3 ++- README_ch.md | 5 +++-- doc/doc_ch/inference_ppocr.md | 2 +- doc/doc_en/add_new_algorithm_en.md | 4 ++-- doc/doc_en/environment_en.md | 2 ++ 5 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5e2734d6..4fa721d9 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,7 @@ For a new language request, please refer to [Guideline for new language_requests - [Two-stage Algorithm](./doc/doc_en/algorithm_overview_en.md) - [PGNet Algorithm](./doc/doc_en/algorithm_overview_en.md) - [Python Inference](./doc/doc_en/inference_en.md) + - [Use PaddleOCR Architecture to Add New Algorithms](./doc/doc_en/add_new_algorithm_en.md) - Data Annotation and Synthesis - [Semi-automatic Annotation Tool: PPOCRLabel](./PPOCRLabel/README.md) - [Data Synthesis Tool: Style-Text](./StyleText/README.md) @@ -127,7 +128,7 @@ For a new language request, please refer to [Guideline for new language_requests - [Other Data Synthesis Tools](./doc/doc_en/data_synthesis_en.md) - Datasets - [General OCR Datasets(Chinese/English)](./doc/doc_en/datasets_en.md) - - [HandWritten_OCR_Datasets(Chinese)](./doc/doc_en/handwritten_datasets_en.md) + - [Handwritten OCR Datasets(Chinese)](./doc/doc_en/handwritten_datasets_en.md) - [Various OCR Datasets(multilingual)](./doc/doc_en/vertical_and_multilingual_datasets_en.md) - [Visualization](#Visualization) - [New language requests](#language_requests) diff --git a/README_ch.md b/README_ch.md index 5cd675ed..f6f273e0 100755 --- a/README_ch.md +++ b/README_ch.md @@ -94,7 +94,7 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力 - PP-OCR产业落地：从训练到部署 - [PP-OCR模型库](./doc/doc_ch/models.md) - [PP-OCR模型下载](./doc/doc_ch/models_list.md) - - [PP-OCR模型库Python推理](./doc/doc_ch/inference_ppocr.md) + - [基于Python引擎的PP-OCR模型库推理](./doc/doc_ch/inference_ppocr.md) - [PP-OCR模型训练](./doc/doc_ch/training.md) - [文本检测](./doc/doc_ch/detection.md) - [文本识别](./doc/doc_ch/recognition.md) @@ -114,9 +114,10 @@ PaddleOCR旨在打造一套丰富、领先、且实用的OCR工具库，助力 - [其它数据标注工具](./doc/doc_ch/data_annotation.md) - [其它数据合成工具](./doc/doc_ch/data_synthesis.md) - OCR学术圈 - - [两阶段模型介绍与下载](./doc/doc_ch/algorithm_overview.md) + - [两阶段算法](./doc/doc_ch/algorithm_overview.md) - [端到端PGNet算法](./doc/doc_ch/pgnet.md) - [基于Python脚本预测引擎推理](./doc/doc_ch/inference.md) + - [使用PaddleOCR架构添加新算法](./doc/doc_ch/add_new_algorithm.md) - 数据集 - [通用中英文OCR数据集](./doc/doc_ch/datasets.md) - [手写中文OCR数据集](./doc/doc_ch/handwritten_datasets.md) diff --git a/doc/doc_ch/inference_ppocr.md b/doc/doc_ch/inference_ppocr.md index 4c37a695..c33401dc 100644 --- a/doc/doc_ch/inference_ppocr.md +++ b/doc/doc_ch/inference_ppocr.md @@ -1,4 +1,4 @@ -# PP-OCR模型库Python推理 +# 基于Python引擎的PP-OCR模型库推理 本文介绍针对PP-OCR模型库的Python推理引擎使用方法，内容依次为文本检测、文本识别、方向分类器以及三者串联在CPU、GPU上的预测方法。 diff --git a/doc/doc_en/add_new_algorithm_en.md b/doc/doc_en/add_new_algorithm_en.md index dc81f182..db72fe7d 100644 --- a/doc/doc_en/add_new_algorithm_en.md +++ b/doc/doc_en/add_new_algorithm_en.md @@ -1,4 +1,4 @@ -# Add new algorithm +# Add New Algorithm PaddleOCR decomposes an algorithm into the following parts, and modularizes each part to make it more convenient to develop new algorithms. @@ -263,7 +263,7 @@ Metric: main_indicator: acc ``` -## 优化器 +## Optimizer The optimizer is used to train the network. The optimizer also contains network regularization and learning rate decay modules. This part is under [ppocr/optimizer](../../ppocr/optimizer). PaddleOCR has built-in Commonly used optimizer modules such as `Momentum`, `Adam` and `RMSProp`, common regularization modules such as `Linear`, `Cosine`, `Step` and `Piecewise`, and common learning rate decay modules such as `L1Decay` and `L2Decay`. diff --git a/doc/doc_en/environment_en.md b/doc/doc_en/environment_en.md index 96a46cce..7c15add4 100644 --- a/doc/doc_en/environment_en.md +++ b/doc/doc_en/environment_en.md @@ -1,5 +1,7 @@ # Environment Preparation +Windows and Mac users are recommended to use Anaconda to build a Python environment, and Linux users are recommended to use docker to build a Python environment. If you are familiar with the Python environment, you can skip to step 2 to install PaddlePaddle. + * [1. Python Environment Setup](#1) + [1.1 Windows](#1.1) + [1.2 Mac](#1.2) -- GitLab