Skip to content

docs: update quick_start doc #14690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 15, 2025
Merged

docs: update quick_start doc #14690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/quick_start.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ hide:
python -m pip install paddlepaddle-gpu==3.0.0rc1 -i https://www.paddlepaddle.org.cn/packages/stable/cu118/
```

You can customize the storage location for OCR models by setting the environment variable `PADDLE_OCR_BASE_DIR`. If this variable is not set, the models will be downloaded to the following default locations:
NOTE: You can customize the storage location for OCR models by setting the environment variable `PADDLE_OCR_BASE_DIR`. If this variable is not set, the models will be downloaded to the following default locations:

- On Linux/macOS: `${HOME}/.paddleocr`
- On Windows: `C:\Users\{username}\.paddleocr`

Expand Down
7 changes: 6 additions & 1 deletion docs/quick_start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@ hide:
pip install paddleocr
```

NOTE: 可以通过设置环境变量 `PADDLE_OCR_BASE_DIR` 来自定义 OCR 模型的存储位置。如果未设置此变量，模型将下载到以下默认位置：

- 在Linux/macOS上路径为：`${HOME}/.paddleocr`
- 在Windows上路径为：`C:\Users\{username}\.paddleocr`

### Python脚本使用

=== "文本检测+方向分类+文本识别"
Expand Down Expand Up @@ -213,7 +218,7 @@ paddleocr -h
......
```

还支持pdf文件，您可以使用`page_num`参数推断前几页，默认值为0，这意味着识别全部页面
还支持 PDF 文件，可以通过设置 `page_num` 参数来推理前几页，默认值为 0，这意味着处理全部页面。

```bash linenums="1"
paddleocr --image_dir ./xxx.pdf --use_angle_cls true --use_gpu false --page_num 2
Expand Down