Skip to content

Commit 0d9d21c

Browse files
update quickstart doc (#6171)
* update quickstart doc * update quickstart doc
1 parent 72102ec commit 0d9d21c

File tree

2 files changed

+11
-15
lines changed

2 files changed

+11
-15
lines changed

doc/doc_ch/quickstart.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,13 @@ cd /path/to/ppocr_img
5959

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

62-
**注意** whl包默认使用`PP-OCRv3`模型,识别模型使用的输入shape为`3,48,320`, 因此如果使用识别功能,需要添加参数`--rec_image_shape 3,48,320`,如果不使用默认的`PP-OCRv3`模型,则无需设置该参数。
63-
6462
<a name="211"></a>
6563
#### 2.1.1 中英文模型
6664

6765
* 检测+方向分类器+识别全流程:`--use_angle_cls true`设置使用方向分类器识别180度旋转文字,`--use_gpu false`设置不使用GPU
6866

6967
```bash
70-
paddleocr --image_dir ./imgs/11.jpg --use_angle_cls true --use_gpu false --rec_image_shape 3,48,320
68+
paddleocr --image_dir ./imgs/11.jpg --use_angle_cls true --use_gpu false
7169
```
7270

7371
结果是一个list,每个item包含了文本框,文字和识别置信度
@@ -94,7 +92,7 @@ cd /path/to/ppocr_img
9492
- 单独使用识别:设置`--det``false`
9593

9694
```bash
97-
paddleocr --image_dir ./imgs_words/ch/word_1.jpg --det false --rec_image_shape 3,48,320
95+
paddleocr --image_dir ./imgs_words/ch/word_1.jpg --det false
9896
```
9997

10098
结果是一个list,每个item只包含识别结果和识别置信度
@@ -104,16 +102,16 @@ cd /path/to/ppocr_img
104102
```
105103

106104

107-
如需使用2.0模型,请指定参数`--version PP-OCR`,paddleocr默认使用PP-OCRv3模型(`--versioin PP-OCRv3`)。更多whl包使用可参考[whl包文档](./whl.md)
105+
如需使用2.0模型,请指定参数`--ocr_version PP-OCR`,paddleocr默认使用PP-OCRv3模型(`--ocr_version PP-OCRv3`)。更多whl包使用可参考[whl包文档](./whl.md)
108106

109107
<a name="212"></a>
110108

111109
#### 2.1.2 多语言模型
112110

113-
PaddleOCR目前支持80个语种,可以通过修改`--lang`参数进行切换,对于英文模型,指定`--lang=en`, PP-OCRv3目前只支持中文和英文模型,其他多语言模型会陆续更新
111+
PaddleOCR目前支持80个语种,可以通过修改`--lang`参数进行切换,对于英文模型,指定`--lang=en`
114112

115113
``` bash
116-
paddleocr --image_dir ./imgs_en/254.jpg --lang=en --rec_image_shape 3,48,320
114+
paddleocr --image_dir ./imgs_en/254.jpg --lang=en
117115
```
118116

119117
<div align="center">

doc/doc_en/quickstart_en.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -73,16 +73,14 @@ cd /path/to/ppocr_img
7373

7474
If you do not use the provided test image, you can replace the following `--image_dir` parameter with the corresponding test image path
7575

76-
**Note**: The whl package uses the `PP-OCRv3` model by default, and the input shape used by the recognition model is `3,48,320`, so if you use the recognition function, you need to add the parameter `--rec_image_shape 3,48,320`, if you do not use the default `PP- OCRv3` model, you do not need to set this parameter.
77-
7876
<a name="211-english-and-chinese-model"></a>
7977

8078
#### 2.1.1 Chinese and English Model
8179

8280
* Detection, direction classification and recognition: set the parameter`--use_gpu false` to disable the gpu device
8381

8482
```bash
85-
paddleocr --image_dir ./imgs_en/img_12.jpg --use_angle_cls true --lang en --use_gpu false --rec_image_shape 3,48,320
83+
paddleocr --image_dir ./imgs_en/img_12.jpg --use_angle_cls true --lang en --use_gpu false
8684
```
8785

8886
Output will be a list, each item contains bounding box, text and recognition confidence
@@ -112,7 +110,7 @@ If you do not use the provided test image, you can replace the following `--imag
112110
* Only recognition: set `--det` to `false`
113111

114112
```bash
115-
paddleocr --image_dir ./imgs_words_en/word_10.png --det false --lang en --rec_image_shape 3,48,320
113+
paddleocr --image_dir ./imgs_words_en/word_10.png --det false --lang en
116114
```
117115

118116
Output will be a list, each item contains text and recognition confidence
@@ -121,15 +119,15 @@ If you do not use the provided test image, you can replace the following `--imag
121119
['PAIN', 0.9934559464454651]
122120
```
123121

124-
If you need to use the 2.0 model, please specify the parameter `--version PP-OCR`, paddleocr uses the PP-OCRv3 model by default(`--versioin PP-OCRv3`). More whl package usage can be found in [whl package](./whl_en.md)
122+
If you need to use the 2.0 model, please specify the parameter `--ocr_version PP-OCR`, paddleocr uses the PP-OCRv3 model by default(`--ocr_version PP-OCRv3`). More whl package usage can be found in [whl package](./whl_en.md)
125123
<a name="212-multi-language-model"></a>
126124

127125
#### 2.1.2 Multi-language Model
128126

129-
PaddleOCR currently supports 80 languages, which can be switched by modifying the `--lang` parameter. PP-OCRv3 currently only supports Chinese and English models, and other multilingual models will be updated one after another.
127+
PaddleOCR currently supports 80 languages, which can be switched by modifying the `--lang` parameter.
130128

131129
``` bash
132-
paddleocr --image_dir ./doc/imgs_en/254.jpg --lang=en --rec_image_shape 3,48,320
130+
paddleocr --image_dir ./doc/imgs_en/254.jpg --lang=en
133131
```
134132

135133
<div align="center">
@@ -210,4 +208,4 @@ Visualization of results
210208

211209
In this section, you have mastered the use of PaddleOCR whl package.
212210

213-
PaddleOCR is a rich and practical OCR tool library that get through the whole process of data production, model training, compression, inference and deployment, please refer to the [tutorials](../../README.md#tutorials) to start the journey of PaddleOCR.
211+
PaddleOCR is a rich and practical OCR tool library that get through the whole process of data production, model training, compression, inference and deployment, please refer to the [tutorials](../../README.md#tutorials) to start the journey of PaddleOCR.

0 commit comments

Comments
 (0)