Ocrs

ocrs 是一个用 Rust 编写的库和 CLI 工具，用于从图像中提取文本，也称为 OCR（光学字符识别）。

其目标是创建一个现代化的 OCR 引擎，具备以下特点：

• 能够很好地处理各种类型的图像（扫描文档、包含文本的照片、截图等），并且相比早期的引擎如 Tesseract，几乎无需或只需极少的预处理。这是通过在流水线中更广泛地使用机器学习来实现的。
• 易于编译并在多种平台上运行，包括 WebAssembly。
• 使用开放且许可宽松的数据集进行训练。
• 代码库易于理解和修改。

在底层，该库使用在 PyTorch 中训练的神经网络模型，随后导出为 ONNX 格式，并使用 RTen 引擎执行。更多详细信息请参阅 模型与数据集 部分。

状态

ocrs 目前处于早期预览阶段。错误率可能高于商业 OCR 引擎。

语言支持

ocrs 当前仅支持拉丁字母（例如英语）。更多语言的支持正在 计划中。

CLI 安装

要安装 CLI 工具，您需要先安装 Rust 和 Cargo。然后运行以下命令：

$ cargo install ocrs-cli --locked

若要启用从系统剪贴板读取图像的功能，请添加 clipboard 特性：

$ cargo install ocrs-cli --locked --features clipboard

CLI 使用

要从图像中提取文本，运行以下命令：

$ ocrs image.png

首次运行时，工具会自动下载所需的模型并将其存储在 ~/.cache/ocrs 目录下。

如果 ocrs 是带有 clipboard 特性的版本安装的，则可以从系统剪贴板中的图像提取文本：

$ ocrs --clipboard
$ ocrs -c  # 简写形式

其他示例

从图像中提取文本并写入 content.txt 文件：

$ ocrs image.png -o content.txt

以 JSON 格式提取图像中的文本和布局信息：

$ ocrs image.png --json -o content.json

对图像进行标注，显示检测到的单词和行的位置：

$ ocrs image.png --png -o annotated.png

库的使用

有关如何将 ocrs 作为 Rust 库使用的详细信息，请参阅 ocrs crate 的 README。

模型与数据集

ocrs 使用用 PyTorch 编写的神经网络模型。有关模型和数据集的更多信息，以及用于训练自定义模型的工具，请参阅 ocrs-models 仓库。这些模型也提供 ONNX 格式，以便与其他机器学习运行时一起使用。

开发

要在本地构建并运行 ocrs 库和 CLI 工具，您需要安装最新稳定版的 Rust。然后执行以下操作：

git clone https://github.com/robertknight/ocrs.git
cd ocrs
cargo run -p ocrs-cli -r -- image.png

测试

Ocrs 对 ML 模型处理前后运行的代码进行了单元测试，同时还提供了端到端测试，覆盖整个流程，包括模型部分。

在修改代码后，可以运行单元测试和 lint 检查：

make check

您也可以直接运行诸如 cargo test 之类的标准命令。

运行端到端测试：

make test-e2e

有关 ML 模型评估方式的详细信息，请参阅 ocrs-models 仓库。

ocrs 快速上手指南

ocrs 是一个基于 Rust 开发的现代化 OCR（光学字符识别）工具，旨在从各类图像（扫描文档、照片、截图等）中提取文本。相比传统引擎，它利用机器学习减少了预处理需求，并支持编译为 WebAssembly。

注意：目前仅支持拉丁字母（如英语），多语言支持正在规划中。项目处于早期预览阶段。

环境准备

在开始之前，请确保您的系统已安装以下依赖：

• Rust 工具链：包含 rustc 和 cargo。
  • 安装命令（Linux/macOS）：

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    

  • Windows 用户请访问 rustup.rs 下载 installer。
• 网络连接：首次运行时需自动下载模型文件（存储于 ~/.cache/ocrs）。

安装步骤

使用 Cargo 安装命令行工具：

基础安装

cargo install ocrs-cli --locked

启用剪贴板支持（可选）

若需直接从系统剪贴板读取图片，请添加 clipboard 特性：

cargo install ocrs-cli --locked --features clipboard

提示：国内开发者若遇到下载缓慢，可配置 Rust 镜像源（如中科大或清华源）加速 crate 下载。

基本使用

1. 识别本地图片

提取图片中的文本并输出到终端：

ocrs image.png

注：首次运行会自动下载所需模型。

2. 识别剪贴板图片（需启用 clipboard 特性）

ocrs --clipboard
# 或使用简写
ocrs -c

3. 常用进阶示例

• 保存结果到文件：

  ocrs image.png -o content.txt
  

• 输出 JSON 格式（含布局信息）：

  ocrs image.png --json -o content.json
  

• 生成标注图（显示检测到的文字位置）：

  ocrs image.png --png -o annotated.png