Package com.itextpdf.pdfocr.onnxtr.recognition

Class OnnxRecognitionPredictorProperties

java.lang.Object

com.itextpdf.pdfocr.onnxtr.recognition.OnnxRecognitionPredictorProperties

       public class OnnxRecognitionPredictorProperties extends Object
      

Properties for configuring text recognition ONNX models.

It contains a path to the model, model input properties and a model output post-processor.

Constructor Summary

Constructors

Constructor	Description
OnnxRecognitionPredictorProperties(String modelPath, OnnxInputProperties inputProperties, IRecognitionPostProcessor postProcessor)	Creates new text recognition predictor properties.

Method Summary

Modifier and Type	Method	Description
static OnnxRecognitionPredictorProperties	crnnMobileNetV3(String modelPath)	Creates a new text recognition properties object for existing pre-trained CRNN models with a MobileNet V3 backbone, stored on disk.
static OnnxRecognitionPredictorProperties	crnnVgg16(String modelPath)	Creates a new text recognition properties object for existing pre-trained CRNN models with a VGG-16 backbone, stored on disk.
boolean	equals(Object o)
OnnxInputProperties	getInputProperties()	Returns the ONNX model input properties.
String	getModelPath()	Returns the path to the ONNX model.
IRecognitionPostProcessor	getPostProcessor()	Returns the ONNX model output post-processor.
int	hashCode()
static OnnxRecognitionPredictorProperties	master(String modelPath)	Creates a new text recognition properties object for existing pre-trained MASTER models, stored on disk.
static OnnxRecognitionPredictorProperties	parSeq(String modelPath)	Creates a new text recognition properties object for existing pre-trained PARSeq models, stored on disk.
static OnnxRecognitionPredictorProperties	parSeq(String modelPath, Vocabulary vocabulary, int additionalTokens)	Creates a new text recognition properties object for existing pre-trained PARSeq models, stored on disk.
static OnnxRecognitionPredictorProperties	sar(String modelPath)	Creates a new text recognition properties object for existing pre-trained SAR models, stored on disk.
String	toString()
static OnnxRecognitionPredictorProperties	viTstr(String modelPath)	Creates a new text recognition properties object for existing pre-trained ViTSTR models, stored on disk.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OnnxRecognitionPredictorProperties

             public OnnxRecognitionPredictorProperties
             (String modelPath, OnnxInputProperties inputProperties, IRecognitionPostProcessor postProcessor)
            

Creates new text recognition predictor properties.

Parameters:

modelPath - path to the ONNX model to load

inputProperties - ONNX model input properties

postProcessor - ONNX model output post-processor

Method Details

crnnVgg16

             public static OnnxRecognitionPredictorProperties crnnVgg16
             (String modelPath)
            

Creates a new text recognition properties object for existing pre-trained CRNN models with a VGG-16 backbone, stored on disk. This is the default text recognition model in OnnxTR.

This can be used to load the following models from OnnxTR:

• crnn_vgg16_bn
• crnn_vgg16_bn (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text recognition properties object for a CRNN model with a VGG-16 backbone

crnnMobileNetV3

             public static OnnxRecognitionPredictorProperties crnnMobileNetV3
             (String modelPath)
            

Creates a new text recognition properties object for existing pre-trained CRNN models with a MobileNet V3 backbone, stored on disk.

This can be used to load the following models from OnnxTR:

• crnn_mobilenet_v3_large
• crnn_mobilenet_v3_large (8-bit quantized)
• crnn_mobilenet_v3_small
• crnn_mobilenet_v3_small (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text recognition properties object for a CRNN model with a MobileNet V3 backbone

master

             public static OnnxRecognitionPredictorProperties master
             (String modelPath)
            

Creates a new text recognition properties object for existing pre-trained MASTER models, stored on disk.

This can be used to load the following models from OnnxTR:

• MASTER
• MASTER (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text recognition properties object for a MASTER model

parSeq

             public static OnnxRecognitionPredictorProperties parSeq
             (String modelPath)
            

Creates a new text recognition properties object for existing pre-trained PARSeq models, stored on disk.

This can be used to load the following models from OnnxTR:

• parseq
• parseq (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text recognition properties object for a PARSeq model

parSeq

             public static OnnxRecognitionPredictorProperties parSeq
             (String modelPath, Vocabulary vocabulary, int additionalTokens)
            

Creates a new text recognition properties object for existing pre-trained PARSeq models, stored on disk.

This can be used to load the following models from OnnxTR:

• parseq
• parseq (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

vocabulary - vocabulary used for the model output (without special tokens)

additionalTokens - amount of additional tokens in the total vocabulary after the end-of-string token

Returns:

a new text recognition properties object for a PARSeq model

sar

             public static OnnxRecognitionPredictorProperties sar
             (String modelPath)
            

Creates a new text recognition properties object for existing pre-trained SAR models, stored on disk.

This can be used to load the following models from OnnxTR:

• sar_resnet31
• sar_resnet31 (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text recognition properties object for a SAR model

viTstr

             public static OnnxRecognitionPredictorProperties viTstr
             (String modelPath)
            

Creates a new text recognition properties object for existing pre-trained ViTSTR models, stored on disk.

This can be used to load the following models from OnnxTR:

• vitstr_base
• vitstr_base (8-bit quantized)
• vitstr_small
• vitstr_small (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text recognition properties object for a ViTSTR model

getModelPath

             public String getModelPath()
            

Returns the path to the ONNX model.

Returns:

the path to the ONNX model

getInputProperties

             public OnnxInputProperties getInputProperties()
            

Returns the ONNX model input properties.

Returns:

the ONNX model input properties

getPostProcessor

             public IRecognitionPostProcessor getPostProcessor()
            

Returns the ONNX model output post-processor.

Returns:

the ONNX model output post-processor

equals

             public boolean equals
             (Object o)
            

Overrides:

equals in class Object

hashCode

             public int hashCode()
            

Overrides:

hashCode in class Object

toString

             public String toString()
            

Overrides:

toString in class Object