Skip to content

Commit eb6d4f0

Browse files
committed
chore: format docs
1 parent 904958f commit eb6d4f0

File tree

5 files changed

+31
-14
lines changed

5 files changed

+31
-14
lines changed

docs/install_usage/rapidocr_web/desktop_usage.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@ comments: true
33
---
44

55
#### 引言
6+
67
- 说明:桌面版指的是可以直接解压,双击即可运行的版本。
78
- 通俗来说,对`rapidocr_web`做了打包,将相关依赖全部放到一个zip包中,不需要本地有额外的环境,降低使用门槛。
89
- 下面会以Windows版为例,作简要说明。
910

1011
#### 使用步骤
12+
1113
1. 下载对应的zip包
1214
- 目前已有的zip包如下:
1315
![image](https://github.com/RapidAI/RapidOCR/assets/28639377/e60a6411-7d3d-4063-9e0a-6d85df78de7a)
@@ -97,6 +99,7 @@ comments: true
9799
├── VCRUNTIME140.dll
98100
└── yaml
99101
```
102+
100103
</details>
101104
102105
3. 双击`RapidOCRWeb.exe`运行,界面如下图所示:
@@ -108,5 +111,3 @@ comments: true
108111
!!! note
109112
110113
如果遇到浏览器不显示界面的情况,可以尝试在黑框上按`Ctrl + C`
111-
112-

docs/install_usage/rapidocr_web/nuitka_package.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,21 @@ comments: true
55
--by [DeadWood8](https://github.com/DeadWood8)
66

77
#### 打包环境
8+
89
- `OS`: Windows11
910
- `Python`: 3.8.10
1011
- `rapidocr_onnxruntime`: 1.2.0
1112
- `nuitka`: 1.5.3
1213
- `onnxruntime`: 1.14.0
1314

1415
#### 打包步骤
16+
1517
1. 安装`Nuitka`
18+
1619
```bash linenums="1"
1720
pip install nuitka
1821
```
22+
1923
注:第一次安装会自动下载mingw和ccache,也可以手动配置,自行某度。
2024
2. 修改`rapidocr-onnxruntime`源码(修改后可以将所有依赖打包进文件)
2125
!!! note
@@ -25,10 +29,12 @@ comments: true
2529
- 用编辑器打开`rapid_ocr_api.py`,对**39-52行**进行修改,如下图:
2630
![image](https://user-images.githubusercontent.com/28639377/227765049-357c6670-56cb-44a4-a32c-f2dde479838e.png)
2731
3. `nuitka`打包
32+
2833
```bash linenums="1"
2934
cd rapidocr_web
3035
nuitka --mingw64 --standalone --show-memory --show-progress --nofollow-import-to=tkinter --output-dir=out ocrweb.py
3136
```
37+
3238
- 如下图所示:
3339
![image](https://user-images.githubusercontent.com/28639377/227765149-4ba15340-6199-49df-be85-6ef3263f5d2c.png)
3440
4. 拷贝静态文件
@@ -41,11 +47,11 @@ comments: true
4147
1. 打包好的exe下载:[百度网盘](https://pan.baidu.com/s/1nj_1rjuVu76drKBZDY9Bww?pwd=xnu7) | [Google Drive](https://drive.google.com/drive/folders/1okQj22XxLUptyhjKQcRU25eI8Ya693gf?usp=share_link) | [Gitee](https://gitee.com/RapidAI/RapidOCR/releases/download/v1.2.0/ocrweb.dist.rar)
4248
4349
#### 补充
50+
4451
- 如果不想运行程序后有黑框,可以在打包命令中加入以下参数
4552
`--windows-disable-console`
4653
- 完整命令为:
54+
4755
```bash linenums="1"
4856
nuitka --mingw64 --standalone --show-memory --show-progress --nofollow-import-to=tkinter --windows-disable-console --output-dir=out ocrweb.py
4957
```
50-
51-

docs/install_usage/rapidocr_web/ocrweb_multi.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,34 @@ comments: true
33
---
44

55
### 简介
6+
67
- 同时支持多种语言,可通过接口参数配置语言及预测过程中的其他参数
78
- 调整结果展示方式为基于canvas, 减少后端处理和接口数据传输
89
- 预测接口添加Token验证支持
910
- 添加pyinstaller打包脚本,简化安装步骤
1011
- 示例打包结果:[pyinstaller demo](https://github.com/AutumnSun1996/RapidOCR/releases/tag/v1.1.1-ocrweb-multi)
1112

1213
### 安装
14+
1315
1. 克隆项目到本地
16+
1417
```bash linenums="1"
1518
git clone -b main https://github.com/RapidAI/RapidOCR.git
1619
```
20+
1721
2. 安装运行所需环境
22+
1823
```bash linenums="1"
1924
cd ocrweb_multi
2025
pip install -r requirements.txt -i https://pypi.douban.com/simple/
2126
```
2227

2328
### 运行步骤
29+
2430
1. 下载`models`文件到当前目录下
2531
- 下载链接:[百度网盘](https://pan.baidu.com/s/1Z3v34wu0tE6lBndYyP0xOg?pwd=6urq) | [Google Drive](https://drive.google.com/drive/folders/1HZUzGplq_47xKmDVtplwrMmIjoHm7uKo?usp=sharing)
2632
- 最终目录结构如下:
33+
2734
```text linenums="1"
2835
ocr_web_multi
2936
|-- README.md
@@ -61,12 +68,13 @@ comments: true
6168
|-- wrapper.c
6269
`-- wrapper.rc
6370
```
71+
6472
2. 运行`main.py`
73+
6574
```bash linenums="1"
6675
python main.py
6776
```
68-
3. 打开 http://127.0.0.1:8001 即可, enjoy it!
69-
70-
![ocr_web_multi_demo](https://raw.githubusercontent.com/RapidAI/RapidOCR/main/ocrweb_multi/assets/ocr_web_multi.jpg)
7177

78+
3. 打开 <http://127.0.0.1:8001> 即可, enjoy it!
7279

80+
![ocr_web_multi_demo](https://raw.githubusercontent.com/RapidAI/RapidOCR/main/ocrweb_multi/assets/ocr_web_multi.jpg)

docs/install_usage/rapidocr_web/pyinstaller.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,3 @@ comments: true
33
---
44

55
参考Actions中写法,详情移步:[package_ocrweb.yml](https://github.com/RapidAI/RapidOCR/blob/2417a22be8a2f830f58c405c5f9d3d4f1fc1ed1e/.github/workflows/package_ocrweb.yml)
6-
7-

docs/install_usage/rapidocr_web/usage.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ comments: true
99
<a href="https://pepy.tech/project/rapidocr_web"><img src="https://static.pepy.tech/personalized-badge/rapidocr_web?period=total&units=abbreviation&left_color=grey&right_color=blue&left_text=Downloads"></a>
1010
</p>
1111

12-
1312
### 简介
13+
1414
- 该库是`rapidocr_onnxruntime`的web版本,依赖最新版本的[`rapidocr_onnxruntime`](../rapidocr/rapidocr_onnxruntime.md)库。
1515
- 如果想要离线部署,可以先手动下载[`rapidocr_onnxruntime`](https://pypi.org/project/rapidocr-onnxruntime/#files) whl包,再手动安装[`rapidocr_web`](https://pypi.org/project/rapidocr-web/#files) whl包来使用。
1616
- 网页上显示的推理时间具体解释如下:
@@ -20,12 +20,15 @@ comments: true
2020
</div>
2121

2222
### 安装
23+
2324
```bash linenums="1"
2425
pip install rapidocr_web
2526
```
2627

2728
### 使用
28-
#### 用法:
29+
30+
#### 用法
31+
2932
```bash linenums="1"
3033
$ rapidocr_web -h
3134
usage: rapidocr_web [-h] [-ip IP] [-p PORT]
@@ -35,12 +38,14 @@ optional arguments:
3538
-ip IP, --ip IP IP Address
3639
-p PORT, --port PORT IP port
3740
```
38-
#### 运行:
41+
42+
#### 运行
43+
3944
```bash linenums="1"
4045
rapidocr_web -ip 0.0.0.0 -p 9003
4146
```
4247

43-
#### 浏览器打开 http://localhost:9003/,enjoy it!
48+
#### 浏览器打开 <http://localhost:9003/,enjoy> it
4449

4550
!!! info
4651

@@ -49,4 +54,3 @@ rapidocr_web -ip 0.0.0.0 -p 9003
4954
<div align="center">
5055
<img src="https://github.com/RapidAI/RapidOCR/releases/download/v1.1.0/rapidocr_web_demo.gif" width="100%" height="100%">
5156
</div>
52-

0 commit comments

Comments
 (0)