Skip to content

Commit 3afacc9

Browse files
committed
docs: update quickstart
1 parent 2050e9a commit 3afacc9

File tree

2 files changed

+111
-27
lines changed

2 files changed

+111
-27
lines changed

docs/quickstart.md

Lines changed: 111 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -8,55 +8,139 @@ hide:
88
### 1. 安装
99

1010
```bash linenums="1"
11-
pip install rapidocr_onnxruntime
11+
pip install rapidocr
1212
```
1313

1414
### 2. 使用
1515

1616
=== "命令行使用"
1717

1818
```bash linenums="1"
19-
rapidocr_onnxruntime -img tests/test_files/ch_en_num.jpg
19+
rapidocr -img tests/test_files/ch_en_num.jpg --vis_res
2020
```
2121

2222
=== "Python使用"
2323

2424
```python linenums="1"
25-
from rapidocr_onnxruntime import RapidOCR
25+
from rapidocr import RapidOCR, VisRes
2626

2727
engine = RapidOCR()
2828

29-
img_path = 'tests/test_files/ch_en_num.jpg'
30-
result, elapse = engine(img_path)
29+
img_path = "tests/test_files/ch_en_num.jpg"
30+
result = engine(img_path)
3131
print(result)
32+
33+
vis = VisRes()
34+
vis_img = vis(img, result.boxes, result.txts, result.scores)
35+
cv2.imwrite("vis.png", vis_img)
3236
```
3337

34-
### 3. 查看效果
38+
### 3. 返回`result`结果
39+
40+
返回结果是一个`RapidOCROutput`数据类,可以直接通过`result.boxes``result.txts`来访问使用。
3541

3642
```python linenums="1"
37-
[
38-
[[[9.0, 2.0], [321.0, 11.0], [318.0, 102.0], [6.0, 93.0]], '正品促销', '0.7986101984977723'],
39-
[[[70.0, 98.0], [251.0, 98.0], [251.0, 125.0], [70.0, 125.0]], '大桶装更划算', '0.7368737288883754'],
40-
[[[69.0, 144.0], [255.0, 144.0], [255.0, 164.0], [69.0, 164.0]], '强力去污符合国标', '0.8172478278477987'],
41-
[[[107.0, 170.0], [219.0, 170.0], [219.0, 182.0], [107.0, 182.0]], '-40深度防冻不结冰', '0.8655969283797524'],
42-
[[[35.0, 227.0], [63.0, 227.0], [63.0, 236.0], [35.0, 236.0]], '日常价?', '0.6502826035022735'],
43-
[[[141.0, 223.0], [187.0, 225.0], [185.0, 249.0], [139.0, 247.0]], '直击', '0.596031109491984'],
44-
[[[34.0, 234.0], [81.0, 236.0], [80.0, 254.0], [33.0, 252.0]], '10.0起', '0.8231529593467712'],
45-
[[[257.0, 234.0], [304.0, 236.0], [303.0, 253.0], [256.0, 251.0]], '10.0起', '0.8304102122783661'],
46-
[[[258.0, 227.0], [287.0, 226.0], [287.0, 236.0], [258.0, 237.0]], '日常价?', '0.5725070595741272'],
47-
[[[140.0, 245.0], [186.0, 246.0], [186.0, 272.0], [139.0, 271.0]], '底价', '0.5142453710238138'],
48-
[[[129.0, 290.0], [207.0, 292.0], [206.0, 339.0], [128.0, 337.0]], '5.8', '0.6341951936483383'],
49-
[[[98.0, 320.0], [129.0, 320.0], [129.0, 331.0], [98.0, 331.0]], '券后价?', '0.6209247708320618'],
50-
[[[114.0, 343.0], [210.0, 343.0], [210.0, 355.0], [114.0, 355.0]], '惊喜福利不容错过', '0.8640043867958916'],
51-
[[[69.0, 363.0], [151.0, 363.0], [151.0, 383.0], [69.0, 383.0]], '极速发货', '0.7552512288093567'],
52-
[[[201.0, 363.0], [285.0, 363.0], [285.0, 383.0], [201.0, 383.0]], '冰点标准', '0.7194759607315063'],
53-
[[[68.0, 392.0], [151.0, 392.0], [151.0, 412.0], [68.0, 412.0]], '破损就赔', '0.7711991906166077'],
54-
[[[202.0, 391.0], [285.0, 391.0], [285.0, 413.0], [202.0, 413.0]], '假一赔十', '0.6546663284301758']
55-
]
43+
RapidOCROutput(
44+
boxes=array([[[ 6., 2.],
45+
[322., 9.],
46+
[320., 104.],
47+
[ 4., 97.]],
48+
49+
[[ 70., 98.],
50+
[252., 98.],
51+
[252., 125.],
52+
[ 70., 125.]],
53+
54+
[[ 68., 144.],
55+
[256., 144.],
56+
[256., 165.],
57+
[ 68., 165.]],
58+
59+
[[108., 170.],
60+
[217., 170.],
61+
[217., 182.],
62+
[108., 182.]],
63+
64+
[[ 35., 227.],
65+
[ 62., 227.],
66+
[ 62., 236.],
67+
[ 35., 236.]],
68+
69+
[[139., 223.],
70+
[187., 223.],
71+
[187., 251.],
72+
[139., 251.]],
73+
74+
[[ 35., 233.],
75+
[ 81., 236.],
76+
[ 80., 255.],
77+
[ 33., 252.]],
78+
79+
[[257., 234.],
80+
[304., 236.],
81+
[303., 254.],
82+
[257., 253.]],
83+
84+
[[259., 227.],
85+
[286., 226.],
86+
[287., 236.],
87+
[259., 237.]],
88+
89+
[[140., 243.],
90+
[186., 245.],
91+
[186., 272.],
92+
[139., 271.]],
93+
94+
[[129., 289.],
95+
[207., 290.],
96+
[206., 340.],
97+
[128., 338.]],
98+
99+
[[ 98., 320.],
100+
[129., 320.],
101+
[129., 330.],
102+
[ 98., 330.]],
103+
104+
[[205., 316.],
105+
[223., 316.],
106+
[223., 335.],
107+
[205., 335.]],
108+
109+
[[114., 342.],
110+
[210., 342.],
111+
[210., 355.],
112+
[114., 355.]],
113+
114+
[[ 68., 362.],
115+
[151., 362.],
116+
[151., 384.],
117+
[ 68., 384.]],
118+
119+
[[202., 362.],
120+
[286., 362.],
121+
[286., 384.],
122+
[202., 384.]],
123+
124+
[[ 68., 391.],
125+
[151., 391.],
126+
[151., 413.],
127+
[ 68., 413.]],
128+
129+
[[202., 391.],
130+
[287., 391.],
131+
[287., 413.],
132+
[202., 413.]]], dtype=float32),
133+
txts=('正品促销', '大桶装更划算', '强力去污符合国标', '40°C深度防冻不结冰', '日常价¥', '真击', '10.0起', '10.0起', '日常价¥', '底价', '5.8', '券后价¥', '', '惊喜福利不容错过', '极速发货', '冰点标准', '破损就赔', '假一赔十'),
134+
scores=(0.99893, 0.9843, 0.97842, 0.93412, 0.81418, 0.66226, 0.99243, 0.99849, 0.81369, 0.99633, 0.9999, 0.83907, 0.99993, 0.99782, 0.99813, 0.99786, 0.92679, 0.99717),
135+
word_results=(None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None, None), elapse_list=[0.16008154186420143, 0.017705917358398438, 0.35501312371343374], elapse=0.5328005829360336)
56136
```
57137

58-
### 推荐阅读
138+
### 4. 查看可视化结果
59139

60-
#### [API](./install_usage/api/RapidOCR.md)
140+
<div align="center">
141+
<img src="./static/images/ch_en_num_vis.png" alt="Demo" width="100%">
142+
</div>
143+
144+
### 推荐阅读
61145

62146
#### [其他编程语言支持](./blog/posts/other_programing_lan.md)
244 KB
Loading

0 commit comments

Comments
 (0)