diff --git a/README.md b/README.md index 6f43b17..491886d 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,10 @@ ocr-server/ ├── scripts/package-windows.ps1 # Windows exe 打包 ├── scripts/packaged_entry.py # PyInstaller 入口 ├── scripts/package-ubuntu.sh # Ubuntu ELF 打包 -├── scripts/download_models.py # 下载或补齐缺少的模型 -└── scripts/benchmark_ocr.py # 测量当前配置的 OCR 耗时 +├── scripts/download-models.bat # Windows 下载/补齐模型 +├── scripts/download-models.sh # Ubuntu/Linux 下载/补齐模型 +├── scripts/download_models.py # Python 下载入口 +└── scripts/benchmark_ocr.py # 测量当前配置的 OCR 耗时 ``` ## 模型位置和下载策略 @@ -50,13 +52,30 @@ model_dir: /opt/ocr-server/models 配置文件中的路径支持绝对路径,也支持相对于项目根目录的路径。服务启动时读取一次配置,修改后需要重启服务。 -也可以手动提前下载或补齐模型: +也可以手动提前下载或补齐模型。推荐使用对应平台的快捷脚本: + +Windows(PowerShell / CMD): + +```powershell +scripts\download-models.bat +``` + +Ubuntu/Linux: + +```bash +chmod +x scripts/download-models.sh +./scripts/download-models.sh +``` + +脚本会读取项目根目录的 `config.yaml`,把当前配置所需的检测模型和识别模型下载到 `model_dir/official_models/`。模型下载需要联网;完整分发包可以直接携带整个 `models/` 目录,从而不依赖首次启动联网。下载时不会覆盖已有完整模型目录。 + +也可以直接调用 Python 脚本: ```powershell uv run python scripts/download_models.py ``` -脚本会读取 `config.yaml`,把模型下载到 `model_dir` 指定的目录。模型下载需要联网;完整分发包可以直接携带整个 `models/` 目录,从而不依赖首次启动联网。下载时不会覆盖已有完整模型目录。 +如果配置切换了模型名称,重新执行下载脚本即可补齐新模型。脚本不会删除或修改已有的其它模型目录。 ## 不同速度档位和模型选择 diff --git a/scripts/download-models.bat b/scripts/download-models.bat new file mode 100644 index 0000000..c34cccb --- /dev/null +++ b/scripts/download-models.bat @@ -0,0 +1,28 @@ +@echo off +setlocal + +cd /d "%~dp0.." + +echo [OCR] 检查并下载缺失模型... + +where uv >nul 2>nul +if errorlevel 1 ( + echo [ERROR] 未找到 uv,请先安装 uv。 + exit /b 1 +) + +if not exist "config.yaml" ( + echo [ERROR] 未找到 config.yaml,请从项目根目录运行此脚本。 + exit /b 1 +) + +uv run python scripts\download_models.py +if errorlevel 1 ( + echo [ERROR] 模型下载失败。 + endlocal + exit /b 1 +) + +echo [OCR] 模型已就绪。 +endlocal +exit /b 0 diff --git a/scripts/download-models.sh b/scripts/download-models.sh new file mode 100644 index 0000000..abc626f --- /dev/null +++ b/scripts/download-models.sh @@ -0,0 +1,22 @@ +#!/usr/bin/env bash +set -euo pipefail + +cd "$(dirname "${BASH_SOURCE[0]}")/.." + +if [[ ! -f config.yaml ]]; then + printf '%s\n' '[ERROR] 未找到 config.yaml,请从项目根目录运行此脚本。' >&2 + exit 1 +fi + +if command -v uv >/dev/null 2>&1; then + printf '%s\n' '[OCR] 检查并下载缺失模型...' + uv run python scripts/download_models.py +elif [[ -x .venv/bin/python ]]; then + printf '%s\n' '[OCR] 检查并下载缺失模型(使用 .venv)...' + .venv/bin/python scripts/download_models.py +else + printf '%s\n' '[ERROR] 未找到 uv 或 .venv/bin/python,请先安装依赖。' >&2 + exit 1 +fi + +printf '%s\n' '[OCR] 模型已就绪。'