Guten OCR

Demo | Roadmap

an OCR Javascript library runs on Node.js, Browser, React Native and C++

Based on PaddleOCR and ONNX Runtime, supports PP-OCRv4 model

Getting Started

Node

Example

1bun add @gutenye/ocr-node
2import Ocr from '@gutenye/ocr-node'
3const ocr = await Ocr.create()
4const result = await ocr.detect('a.jpg')

Browser

Example

1bun add @gutenye/ocr-browser
2import Ocr from '@gutenye/ocr-browser'
3const ocr = await Ocr.create({
4  models: {
5    detectionPath: '/assets/ch_PP-OCRv4_det_infer.onnx',
6    recognitionPath: '/assets/ch_PP-OCRv4_rec_infer.onnx',
7    dictionaryPath: '/assets/ppocr_keys_v1.txt'
8  }
9})
10const result = await ocr.detect('/a.jpg')

React Native

Example

1bun add @gutenye/ocr-react-native
2import Ocr from '@guenye/ocr-react-native'
3const ocr = await Ocr.create()
4const result = await ocr.detect('a.jpg')

C++

Example

1#include "native-ocr.h"
2NativeOcr* ocr = new NativeOcr(..)
3auto result = ocr->detect("a.jpg");

API Reference

1Ocr.create({
2  models?: {
3    detectionPath: string
4    recognitionPath: string
5    dictionaryPath: string
6  },
7  isDebug?: boolean
8  debugOutputDir?: string // Node only
9  recognitionImageMaxSize?: number // RN only
10  detectionThreshold?: number // RN only
11  detectionBoxThreshold?: number // RN only
12  detectionUnclipRatiop?: number // RN only
13  detectionUseDilate?: boolean // RN only
14  detectionUsePolygonScore?: boolean // RN only
15  useDirectionClassify?: boolean // RN only
16  onnxOptions?: {}       // Node only. Pass to ONNX Runtime
17}): Promise<Ocr>
18
19ocr.detect(imagePath, { 
20  onnxOptions?: {}     // Node only. Pass to ONNX Runtime
21}): Promise<TextLine[]>
22
23TextLine {
24  text: string
25  score: number
26  frame: { top, left, width, height }
27}
28

Development

• Requires Git LFS to clone the repo

1brew install git-lfs 
2git clone git@github.com:gutenye/ocr.git

• Development

Related Projects

Name	Platforms	Note
eSearch-OCR	Electron
paddleocr-onnx	Node	Recogination part is incomplete
ocrjs	Node	Recogination part is incomplete
Paddle-Lite-Demo	Mobile, C++