From 96a73291901d9c8d72464487426de63da0a715cb Mon Sep 17 00:00:00 2001 From: Wang Xin Date: Sat, 15 Feb 2025 19:33:25 +0800 Subject: [PATCH] docs: update quick_start doc (#14690) --- docs/quick_start.en.md | 3 ++- docs/quick_start.md | 7 ++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/quick_start.en.md b/docs/quick_start.en.md index 43931507e6..56e0a1668c 100644 --- a/docs/quick_start.en.md +++ b/docs/quick_start.en.md @@ -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` diff --git a/docs/quick_start.md b/docs/quick_start.md index 611004e492..0bb8811d4a 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -31,6 +31,11 @@ hide: pip install paddleocr ``` +NOTE: 可以通过设置环境变量 `PADDLE_OCR_BASE_DIR` 来自定义 OCR 模型的存储位置。如果未设置此变量,模型将下载到以下默认位置: + +- 在Linux/macOS上路径为:`${HOME}/.paddleocr` +- 在Windows上路径为:`C:\Users\{username}\.paddleocr` + ### Python脚本使用 === "文本检测+方向分类+文本识别" @@ -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