Class: OCRModule

Defined in: packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:10

Module for Optical Character Recognition (OCR) tasks.

Constructors

Constructor

new OCRModule(): OCRModule

Defined in: packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:13

Returns

OCRModule

Methods

delete()

delete(): void

Defined in: packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:55

Release the memory held by the module. Calling forward afterwards is invalid. Note that you cannot delete model while it's generating.

Returns

void

---

forward()

forward(imageSource): Promise<OCRDetection[]>

Defined in: packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:47

Executes the model's forward pass, where imageSource can be a fetchable resource or a Base64-encoded string.

Parameters

imageSource

string

The image source to be processed.

Returns

Promise<OCRDetection[]>

The OCR result as a OCRDetection[].

---

load()

load(model, onDownloadProgressCallback): Promise<void>

Defined in: packages/react-native-executorch/src/modules/computer_vision/OCRModule.ts:25

Loads the model, where detectorSource is a string that specifies the location of the detector binary, recognizerSource is a string that specifies the location of the recognizer binary, and language is a parameter that specifies the language of the text to be recognized by the OCR.

Parameters

model

Object containing detectorSource, recognizerSource, and language.

detectorSource

ResourceSource

language

"abq" | "ady" | "af" | "ava" | "az" | "be" | "bg" | "bs" | "chSim" | "che" | "cs" | "cy" | "da" | "dar" | "de" | "en" | "es" | "et" | "fr" | "ga" | "hr" | "hu" | "id" | "inh" | "ic" | "it" | "ja" | "kbd" | "kn" | "ko" | "ku" | "la" | "lbe" | "lez" | "lt" | "lv" | "mi" | "mn" | "ms" | "mt" | "nl" | "no" | "oc" | "pi" | "pl" | "pt" | "ro" | "ru" | "rsCyrillic" | "rsLatin" | "sk" | "sl" | "sq" | "sv" | "sw" | "tab" | "te" | "tjk" | "tl" | "tr" | "uk" | "uz" | "vi"

recognizerSource

ResourceSource

onDownloadProgressCallback

(progress) => void

Optional callback to monitor download progress.

Returns

Promise<void>