Skip to content

Commit

Permalink
Complete quickstart_en
Browse files Browse the repository at this point in the history
  • Loading branch information
Evezerest committed Sep 3, 2021
1 parent 22838d5 commit 58114b6
Show file tree
Hide file tree
Showing 19 changed files with 199 additions and 104 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ PaddleOCR supports both dynamic graph and static graph programming paradigm
- Static graph: develop branch

**Recent updates**

- 2021.1.21 update more than 25+ multilingual recognition models [models list](./doc/doc_en/models_list_en.md), including:English, Chinese, German, French, Japanese,Spanish,Portuguese Russia Arabic and so on. Models for more languages will continue to be updated [Develop Plan](https://github.com/PaddlePaddle/PaddleOCR/issues/1048).
- 2020.12.15 update Data synthesis tool, i.e., [Style-Text](./StyleText/README.md),easy to synthesize a large number of images which are similar to the target scene image.
- 2020.11.25 Update a new data annotation tool, i.e., [PPOCRLabel](./PPOCRLabel/README.md), which is helpful to improve the labeling efficiency. Moreover, the labeling results can be used in training of the PP-OCR system directly.
Expand Down
2 changes: 0 additions & 2 deletions doc/doc_ch/environment.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# 零基础Python环境搭建

[toc]

## Windows

### 第1步:安装Anaconda
Expand Down
41 changes: 27 additions & 14 deletions doc/doc_ch/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,27 @@
# PaddleOCR快速开始

[TOC]

[PaddleOCR快速开始](#paddleocr)

* [1. 轻量安装](#1)
+ [1.0 运行环境准备](#10)
+ [1.1 安装PaddlePaddle2.0](#11)
+ [1.2 安装PaddleOCR whl包](#12)
* [2. 便捷使用](#2)
+ [2.1 命令行使用](#21)
- [2.1.1 中英文模型](#211)
- [2.1.2 多语言模型](#212)
- [2.1.3 版面分析](#213)
+ [2.2 Python脚本使用](#22)
- [2.2.1 中英文与多语言使用](#221)
- [2.2.2 版面分析使用](#222)

<a name="1"></a>

## 1. 轻量安装

<a name="10"></a>
### 1.0 运行环境准备

如果您未搭建过Python环境,可以通过[零基础Python环境搭建文档](./environment.)进行环境搭建

<a name="11"></a>
### 1.1 安装PaddlePaddle2.0

- 如果您的机器安装的是CUDA9或CUDA10,请运行以下命令安装
Expand All @@ -24,7 +37,7 @@ python3 -m pip install paddlepaddle -i https://mirror.baidu.com/pypi/simple
```

更多的版本需求,请参照[飞桨官网安装文档](https://www.paddlepaddle.org.cn/install/quick)中的说明进行操作。

<a name="12"></a>
### 1.2 安装PaddleOCR whl包

```bash
Expand All @@ -42,9 +55,9 @@ pip install "paddleocr>=2.0.1" # 推荐使用2.0.1+版本
```



<a name="2"></a>
## 2. 便捷使用

<a name="21"></a>
### 2.1 命令行使用

PaddleOCR提供了一系列测试图片,点击xx下载,然后在终端中切换到相应目录
Expand All @@ -54,7 +67,7 @@ cd /path/to/ppocr_img
```

如果不使用提供的测试图片,可以将下方`--image_dir`参数替换为相应的测试图片路径

<a name="211"></a>
#### 2.1.1 中英文模型

* 检测+方向分类器+识别全流程:设置方向分类器参数`--use_angle_cls true`后可对竖排文本进行识别。
Expand Down Expand Up @@ -103,7 +116,7 @@ cd /path/to/ppocr_img
更多whl包使用包括, whl包参数说明
<a name="212"></a>
#### 2.1.2 多语言模型
Paddleocr目前支持80个语种,可以通过修改`--lang`参数进行切换,对于英文模型,指定`--lang=en`
Expand Down Expand Up @@ -139,7 +152,7 @@ paddleocr --image_dir ./imgs_en/254.jpg --lang=en
| 繁体中文 | chinese_cht | | 意大利文 | it | | 俄罗斯文 | ru |
全部语种及其对应的缩写列表可查看[多语言模型教程](./multi_languages.md)
<a name="213"></a>
#### 2.1.3 版面分析
使用PaddleOCR的版面分析功能,需要指定`--type=structure`
Expand Down Expand Up @@ -192,8 +205,9 @@ paddleocr --image_dir=./table/1.png --type=structure
<a name="22"></a>
### 2.2 Python脚本使用
<a name="221"></a>
#### 2.2.1 中英文与多语言使用
通过脚本使用PaddleOCR whl包。whl包会自动下载ppocr轻量级模型作为默认模型,
Expand Down Expand Up @@ -237,7 +251,7 @@ im_show.save('result.jpg')
<div align="center">
<img src="../imgs_results/whl/11_det_rec.jpg" width="800">
</div>
<a name="222"></a>
#### 2.2.2 版面分析使用
```python
Expand Down Expand Up @@ -265,4 +279,3 @@ im_show = draw_structure_result(image, result,font_path=font_path)
im_show = Image.fromarray(im_show)
im_show.save('result.jpg')
```
Empty file added doc/doc_en/environment_en.md
Empty file.
14 changes: 7 additions & 7 deletions doc/doc_en/multi_languages_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,13 +198,13 @@ If necessary, you can read related documents:

| Language | Abbreviation | | Language | Abbreviation |
| --- | --- | --- | --- | --- |
|chinese and english|ch| |Arabic|ar|
|english|en| |Hindi|hi|
|french|fr| |Uyghur|ug|
|german|german| |Persian|fa|
|japan|japan| |Urdu|ur|
|korean|korean| | Serbian(latin) |rs_latin|
|chinese traditional |ch_tra| |Occitan |oc|
|Chinese & English|ch| |Arabic|ar|
|English|en| |Hindi|hi|
|French|fr| |Uyghur|ug|
|German|german| |Persian|fa|
|Japan|japan| |Urdu|ur|
|Korean|korean| | Serbian(latin) |rs_latin|
|Chinese Traditional |chinese_cht| |Occitan |oc|
| Italian |it| |Marathi|mr|
|Spanish |es| |Nepali|ne|
| Portuguese|pt| |Serbian(cyrillic)|rs_cyrillic|
Expand Down
Loading

0 comments on commit 58114b6

Please sign in to comment.