React Native OCR - v0.11.0
    Preparing search index...

    Variable modelsConst

    models: {
        documentModels: {
            PP_HELPERS: {
                COREML: DocumentModelsConfig;
                VULKAN: DocumentModelsConfig;
                XNNPACK: DocumentModelsConfig;
            } & { DEFAULT: DocumentModelsConfig };
        };
        layoutDetection: {
            PP_DOCLAYOUT: {
                COREML: ObjectDetectorModel<
                    "xyxy",
                    | "number"
                    | "abstract"
                    | "algorithm"
                    | "aside_text"
                    | "chart"
                    | "content"
                    | "display_formula"
                    | "doc_title"
                    | "figure_title"
                    | "footer"
                    | "footer_image"
                    | "footnote"
                    | "formula_number"
                    | "header"
                    | "header_image"
                    | "image"
                    | "inline_formula"
                    | "paragraph_title"
                    | "reference"
                    | "reference_content"
                    | "seal"
                    | "table"
                    | "text"
                    | "vertical_text"
                    | "vision_footnote",
                >;
                VULKAN: ObjectDetectorModel<
                    "xyxy",
                    | "number"
                    | "abstract"
                    | "algorithm"
                    | "aside_text"
                    | "chart"
                    | "content"
                    | "display_formula"
                    | "doc_title"
                    | "figure_title"
                    | "footer"
                    | "footer_image"
                    | "footnote"
                    | "formula_number"
                    | "header"
                    | "header_image"
                    | "image"
                    | "inline_formula"
                    | "paragraph_title"
                    | "reference"
                    | "reference_content"
                    | "seal"
                    | "table"
                    | "text"
                    | "vertical_text"
                    | "vision_footnote",
                >;
                XNNPACK: ObjectDetectorModel<
                    "xyxy",
                    | "number"
                    | "abstract"
                    | "algorithm"
                    | "aside_text"
                    | "chart"
                    | "content"
                    | "display_formula"
                    | "doc_title"
                    | "figure_title"
                    | "footer"
                    | "footer_image"
                    | "footnote"
                    | "formula_number"
                    | "header"
                    | "header_image"
                    | "image"
                    | "inline_formula"
                    | "paragraph_title"
                    | "reference"
                    | "reference_content"
                    | "seal"
                    | "table"
                    | "text"
                    | "vertical_text"
                    | "vision_footnote",
                >;
            } & {
                DEFAULT: ObjectDetectorModel<
                    "xyxy",
                    | "number"
                    | "abstract"
                    | "algorithm"
                    | "aside_text"
                    | "chart"
                    | "content"
                    | "display_formula"
                    | "doc_title"
                    | "figure_title"
                    | "footer"
                    | "footer_image"
                    | "footnote"
                    | "formula_number"
                    | "header"
                    | "header_image"
                    | "image"
                    | "inline_formula"
                    | "paragraph_title"
                    | "reference"
                    | "reference_content"
                    | "seal"
                    | "table"
                    | "text"
                    | "vertical_text"
                    | "vision_footnote",
                >;
            };
        };
        ocr: {
            EASYOCR: {
                CYRILLIC: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                    DEFAULT: OcrModel;
                };
                ENGLISH: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                    DEFAULT: OcrModel;
                };
                JAPANESE: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                    DEFAULT: OcrModel;
                };
                KANNADA: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                    DEFAULT: OcrModel;
                };
                KOREAN: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                    DEFAULT: OcrModel;
                };
                LATIN: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                    DEFAULT: OcrModel;
                };
                TELUGU: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                    DEFAULT: OcrModel;
                };
                ZH_SIM: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                    DEFAULT: OcrModel;
                };
            };
            PADDLE: {
                PPOCRV6_SMALL: {
                    COREML: OcrModel;
                    VULKAN: OcrModel;
                    XNNPACK: OcrModel;
                    XNNPACK_FP32: OcrModel;
                } & { DEFAULT: OcrModel };
            };
        };
    } = ...

    Registry of pre-configured models.

    Every group carries XNNPACK, COREML and VULKAN exports plus a DEFAULT that resolves to the fastest one the current platform can run: Core ML on an iOS device, XNNPACK on the simulator, Vulkan on Android when the app links that backend, else XNNPACK.

    Type Declaration

    • documentModels: {
          PP_HELPERS: {
              COREML: DocumentModelsConfig;
              VULKAN: DocumentModelsConfig;
              XNNPACK: DocumentModelsConfig;
          } & { DEFAULT: DocumentModelsConfig };
      }

      Document helpers, for the documentModels slot of an OCR model.

    • layoutDetection: {
          PP_DOCLAYOUT: {
              COREML: ObjectDetectorModel<
                  "xyxy",
                  | "number"
                  | "abstract"
                  | "algorithm"
                  | "aside_text"
                  | "chart"
                  | "content"
                  | "display_formula"
                  | "doc_title"
                  | "figure_title"
                  | "footer"
                  | "footer_image"
                  | "footnote"
                  | "formula_number"
                  | "header"
                  | "header_image"
                  | "image"
                  | "inline_formula"
                  | "paragraph_title"
                  | "reference"
                  | "reference_content"
                  | "seal"
                  | "table"
                  | "text"
                  | "vertical_text"
                  | "vision_footnote",
              >;
              VULKAN: ObjectDetectorModel<
                  "xyxy",
                  | "number"
                  | "abstract"
                  | "algorithm"
                  | "aside_text"
                  | "chart"
                  | "content"
                  | "display_formula"
                  | "doc_title"
                  | "figure_title"
                  | "footer"
                  | "footer_image"
                  | "footnote"
                  | "formula_number"
                  | "header"
                  | "header_image"
                  | "image"
                  | "inline_formula"
                  | "paragraph_title"
                  | "reference"
                  | "reference_content"
                  | "seal"
                  | "table"
                  | "text"
                  | "vertical_text"
                  | "vision_footnote",
              >;
              XNNPACK: ObjectDetectorModel<
                  "xyxy",
                  | "number"
                  | "abstract"
                  | "algorithm"
                  | "aside_text"
                  | "chart"
                  | "content"
                  | "display_formula"
                  | "doc_title"
                  | "figure_title"
                  | "footer"
                  | "footer_image"
                  | "footnote"
                  | "formula_number"
                  | "header"
                  | "header_image"
                  | "image"
                  | "inline_formula"
                  | "paragraph_title"
                  | "reference"
                  | "reference_content"
                  | "seal"
                  | "table"
                  | "text"
                  | "vertical_text"
                  | "vision_footnote",
              >;
          } & {
              DEFAULT: ObjectDetectorModel<
                  "xyxy",
                  | "number"
                  | "abstract"
                  | "algorithm"
                  | "aside_text"
                  | "chart"
                  | "content"
                  | "display_formula"
                  | "doc_title"
                  | "figure_title"
                  | "footer"
                  | "footer_image"
                  | "footnote"
                  | "formula_number"
                  | "header"
                  | "header_image"
                  | "image"
                  | "inline_formula"
                  | "paragraph_title"
                  | "reference"
                  | "reference_content"
                  | "seal"
                  | "table"
                  | "text"
                  | "vertical_text"
                  | "vision_footnote",
              >;
          };
      }

      Document layout detection, for the layout slot of an OCR model.

      • PP_DOCLAYOUT: {
            COREML: ObjectDetectorModel<
                "xyxy",
                | "number"
                | "abstract"
                | "algorithm"
                | "aside_text"
                | "chart"
                | "content"
                | "display_formula"
                | "doc_title"
                | "figure_title"
                | "footer"
                | "footer_image"
                | "footnote"
                | "formula_number"
                | "header"
                | "header_image"
                | "image"
                | "inline_formula"
                | "paragraph_title"
                | "reference"
                | "reference_content"
                | "seal"
                | "table"
                | "text"
                | "vertical_text"
                | "vision_footnote",
            >;
            VULKAN: ObjectDetectorModel<
                "xyxy",
                | "number"
                | "abstract"
                | "algorithm"
                | "aside_text"
                | "chart"
                | "content"
                | "display_formula"
                | "doc_title"
                | "figure_title"
                | "footer"
                | "footer_image"
                | "footnote"
                | "formula_number"
                | "header"
                | "header_image"
                | "image"
                | "inline_formula"
                | "paragraph_title"
                | "reference"
                | "reference_content"
                | "seal"
                | "table"
                | "text"
                | "vertical_text"
                | "vision_footnote",
            >;
            XNNPACK: ObjectDetectorModel<
                "xyxy",
                | "number"
                | "abstract"
                | "algorithm"
                | "aside_text"
                | "chart"
                | "content"
                | "display_formula"
                | "doc_title"
                | "figure_title"
                | "footer"
                | "footer_image"
                | "footnote"
                | "formula_number"
                | "header"
                | "header_image"
                | "image"
                | "inline_formula"
                | "paragraph_title"
                | "reference"
                | "reference_content"
                | "seal"
                | "table"
                | "text"
                | "vertical_text"
                | "vision_footnote",
            >;
        } & {
            DEFAULT: ObjectDetectorModel<
                "xyxy",
                | "number"
                | "abstract"
                | "algorithm"
                | "aside_text"
                | "chart"
                | "content"
                | "display_formula"
                | "doc_title"
                | "figure_title"
                | "footer"
                | "footer_image"
                | "footnote"
                | "formula_number"
                | "header"
                | "header_image"
                | "image"
                | "inline_formula"
                | "paragraph_title"
                | "reference"
                | "reference_content"
                | "seal"
                | "table"
                | "text"
                | "vertical_text"
                | "vision_footnote",
            >;
        }

        PP-DocLayoutV3: 25 region classes, see DOC_LAYOUT_LABELS.

    • ocr: {
          EASYOCR: {
              CYRILLIC: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                  DEFAULT: OcrModel;
              };
              ENGLISH: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                  DEFAULT: OcrModel;
              };
              JAPANESE: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                  DEFAULT: OcrModel;
              };
              KANNADA: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                  DEFAULT: OcrModel;
              };
              KOREAN: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                  DEFAULT: OcrModel;
              };
              LATIN: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                  DEFAULT: OcrModel;
              };
              TELUGU: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                  DEFAULT: OcrModel;
              };
              ZH_SIM: { COREML: OcrModel; VULKAN: OcrModel; XNNPACK: OcrModel } & {
                  DEFAULT: OcrModel;
              };
          };
          PADDLE: {
              PPOCRV6_SMALL: {
                  COREML: OcrModel;
                  VULKAN: OcrModel;
                  XNNPACK: OcrModel;
                  XNNPACK_FP32: OcrModel;
              } & { DEFAULT: OcrModel };
          };
      }

      Optical character recognition: a text detector paired with a text recognizer, exported as one fused program.