Table of Contents

Class SVTR<T>

Namespace
AiDotNet.Document.OCR.TextRecognition
Assembly
AiDotNet.dll

SVTR (Scene Text Visual Transformer) for text recognition.

public class SVTR<T> : DocumentNeuralNetworkBase<T>, INeuralNetworkModel<T>, INeuralNetwork<T>, IInterpretableModel<T>, IInputGradientComputable<T>, IDisposable, ITextRecognizer<T>, IDocumentModel<T>, IFullModel<T, Tensor<T>, Tensor<T>>, IModel<Tensor<T>, Tensor<T>, ModelMetadata<T>>, IModelSerializer, ICheckpointableModel, IParameterizable<T, Tensor<T>, Tensor<T>>, IFeatureAware, IFeatureImportance<T>, ICloneable<IFullModel<T, Tensor<T>, Tensor<T>>>, IGradientComputable<T, Tensor<T>, Tensor<T>>, IJitCompilable<T>

Type Parameters

T

The numeric type used for calculations.

Inheritance
SVTR<T>
Implements
IFullModel<T, Tensor<T>, Tensor<T>>
IModel<Tensor<T>, Tensor<T>, ModelMetadata<T>>
IParameterizable<T, Tensor<T>, Tensor<T>>
ICloneable<IFullModel<T, Tensor<T>, Tensor<T>>>
IGradientComputable<T, Tensor<T>, Tensor<T>>
Inherited Members
Extension Methods

Remarks

SVTR is a single-stream vision transformer for scene text recognition that processes text images as visual sequences without requiring recurrent networks.

For Beginners: SVTR modernizes text recognition: 1. Uses vision transformer (no RNN needed) 2. Handles various text heights and lengths 3. Multi-scale feature extraction 4. Efficient single-stream architecture

Key features:

  • Pure transformer architecture
  • Local + global mixing blocks
  • Height compression for efficiency
  • State-of-the-art accuracy

Example usage:

var model = new SVTR<float>(architecture);
var result = model.RecognizeText(textImage);
Console.WriteLine(result.Text);

Reference: "SVTR: Scene Text Recognition with a Single Visual Model" (IJCAI 2022) https://arxiv.org/abs/2205.00159

Constructors

SVTR(NeuralNetworkArchitecture<T>, int, int, int, int, int, int, string?, IOptimizer<T, Tensor<T>, Tensor<T>>?, ILossFunction<T>?)

Creates an SVTR model using native layers for training and inference.

public SVTR(NeuralNetworkArchitecture<T> architecture, int imageWidth = 256, int imageHeight = 32, int maxSequenceLength = 25, int embedDim = 192, int numLayers = 8, int numHeads = 6, string? charset = null, IOptimizer<T, Tensor<T>, Tensor<T>>? optimizer = null, ILossFunction<T>? lossFunction = null)

Parameters

architecture NeuralNetworkArchitecture<T>
imageWidth int
imageHeight int
maxSequenceLength int
embedDim int
numLayers int
numHeads int
charset string
optimizer IOptimizer<T, Tensor<T>, Tensor<T>>
lossFunction ILossFunction<T>

Remarks

Default Configuration (SVTR-Tiny from IJCAI 2022): - Patch embedding: 4×4 patches - Local + Global mixing blocks - Height compression - CTC decoder

SVTR(NeuralNetworkArchitecture<T>, string, int, int, int, int, int, int, string?, IOptimizer<T, Tensor<T>, Tensor<T>>?, ILossFunction<T>?)

Creates an SVTR model using a pre-trained ONNX model for inference.

public SVTR(NeuralNetworkArchitecture<T> architecture, string onnxModelPath, int imageWidth = 256, int imageHeight = 32, int maxSequenceLength = 25, int embedDim = 192, int numLayers = 8, int numHeads = 6, string? charset = null, IOptimizer<T, Tensor<T>, Tensor<T>>? optimizer = null, ILossFunction<T>? lossFunction = null)

Parameters

architecture NeuralNetworkArchitecture<T>
onnxModelPath string
imageWidth int
imageHeight int
maxSequenceLength int
embedDim int
numLayers int
numHeads int
charset string
optimizer IOptimizer<T, Tensor<T>, Tensor<T>>
lossFunction ILossFunction<T>

Properties

ExpectedImageSize

Gets the expected input image size (assumes square images).

public int ExpectedImageSize { get; }

Property Value

int

Remarks

Common values: 224 (ViT base), 384, 448, 512, 768, 1024. Input images will be resized to [ImageSize x ImageSize] before processing.

ImageHeight

Gets the input image height.

public int ImageHeight { get; }

Property Value

int

MaxSequenceLength

Gets the maximum sequence length this recognizer can output.

public int MaxSequenceLength { get; }

Property Value

int

RequiresOCR

Gets whether this model requires OCR preprocessing.

public override bool RequiresOCR { get; }

Property Value

bool

Remarks

Layout-aware models (LayoutLM, etc.) require OCR to provide text and bounding boxes. OCR-free models (Donut, Pix2Struct) process raw pixels directly.

SupportedCharacters

Gets the supported character set (alphabet) for this recognizer.

public string SupportedCharacters { get; }

Property Value

string

SupportedDocumentTypes

Gets the supported document types for this model.

public override DocumentType SupportedDocumentTypes { get; }

Property Value

DocumentType

SupportsAttentionVisualization

Gets whether this recognizer supports attention visualization.

public bool SupportsAttentionVisualization { get; }

Property Value

bool

Methods

ApplyDefaultPostprocessing(Tensor<T>)

Applies SVTR's industry-standard postprocessing: pass-through (transformer outputs are already final).

protected override Tensor<T> ApplyDefaultPostprocessing(Tensor<T> modelOutput)

Parameters

modelOutput Tensor<T>

Returns

Tensor<T>

ApplyDefaultPreprocessing(Tensor<T>)

Applies SVTR's industry-standard preprocessing: text image preprocessing.

protected override Tensor<T> ApplyDefaultPreprocessing(Tensor<T> rawImage)

Parameters

rawImage Tensor<T>

Returns

Tensor<T>

Remarks

SVTR (Scene Vision Transformer for Text Recognition) uses text-specific preprocessing with height normalization and patch-based encoding.

CreateNewInstance()

Creates a new instance of the same type as this neural network.

protected override IFullModel<T, Tensor<T>, Tensor<T>> CreateNewInstance()

Returns

IFullModel<T, Tensor<T>, Tensor<T>>

A new instance of the same neural network type.

Remarks

For Beginners: This creates a blank version of the same type of neural network.

It's used internally by methods like DeepCopy and Clone to create the right type of network before copying the data into it.

DeserializeNetworkSpecificData(BinaryReader)

Deserializes network-specific data that was not covered by the general deserialization process.

protected override void DeserializeNetworkSpecificData(BinaryReader reader)

Parameters

reader BinaryReader

The BinaryReader to read the data from.

Remarks

This method is called at the end of the general deserialization process to allow derived classes to read any additional data specific to their implementation.

For Beginners: Continuing the suitcase analogy, this is like unpacking that special compartment. After the main deserialization method has unpacked the common items (layers, parameters), this method allows each specific type of neural network to unpack its own unique items that were stored during serialization.

Dispose(bool)

Disposes of resources used by this model.

protected override void Dispose(bool disposing)

Parameters

disposing bool

True if disposing managed resources.

EncodeDocument(Tensor<T>)

Processes a document image and returns encoded features.

public Tensor<T> EncodeDocument(Tensor<T> documentImage)

Parameters

documentImage Tensor<T>

The document image tensor [batch, channels, height, width] or [channels, height, width].

Returns

Tensor<T>

Encoded document features suitable for downstream tasks.

Remarks

For Beginners: This method converts a document image into a numerical representation (feature vector) that captures the document's content and structure. These features can then be used for tasks like classification, QA, or information extraction.

GetAttentionWeights()

Gets the attention weights for visualization (if supported).

public Tensor<T>? GetAttentionWeights()

Returns

Tensor<T>

Attention tensor showing which image regions influenced each character.

GetCharacterProbabilities()

Gets the character-level probabilities for the last recognition.

public Tensor<T> GetCharacterProbabilities()

Returns

Tensor<T>

Tensor of shape [sequence_length, vocab_size] with probabilities.

GetModelMetadata()

Gets the metadata for this neural network model.

public override ModelMetadata<T> GetModelMetadata()

Returns

ModelMetadata<T>

A ModelMetaData object containing information about the model.

GetModelSummary()

Gets a summary of the model architecture.

public string GetModelSummary()

Returns

string

A string describing the model's architecture, parameters, and capabilities.

InitializeLayers()

Initializes the layers of the neural network based on the architecture.

protected override void InitializeLayers()

Remarks

For Beginners: This method sets up all the layers in your neural network according to the architecture you've defined. It's like assembling the parts of your network before you can use it.

Predict(Tensor<T>)

Makes a prediction using the neural network.

public override Tensor<T> Predict(Tensor<T> input)

Parameters

input Tensor<T>

The input data to process.

Returns

Tensor<T>

The network's prediction.

Remarks

For Beginners: This is the main method you'll use to get results from your trained neural network. You provide some input data (like an image or text), and the network processes it through all its layers to produce an output (like a classification or prediction).

RecognizeText(Tensor<T>)

Recognizes text from a cropped image region.

public TextRecognitionResult<T> RecognizeText(Tensor<T> croppedImage)

Parameters

croppedImage Tensor<T>

Cropped image containing text (from text detector).

Returns

TextRecognitionResult<T>

Recognition result with text and confidence.

RecognizeTextBatch(IEnumerable<Tensor<T>>)

Recognizes text from multiple cropped image regions (batch processing).

public IEnumerable<TextRecognitionResult<T>> RecognizeTextBatch(IEnumerable<Tensor<T>> croppedImages)

Parameters

croppedImages IEnumerable<Tensor<T>>

List of cropped images containing text.

Returns

IEnumerable<TextRecognitionResult<T>>

List of recognition results.

SerializeNetworkSpecificData(BinaryWriter)

Serializes network-specific data that is not covered by the general serialization process.

protected override void SerializeNetworkSpecificData(BinaryWriter writer)

Parameters

writer BinaryWriter

The BinaryWriter to write the data to.

Remarks

This method is called at the end of the general serialization process to allow derived classes to write any additional data specific to their implementation.

For Beginners: Think of this as packing a special compartment in your suitcase. While the main serialization method packs the common items (layers, parameters), this method allows each specific type of neural network to pack its own unique items that other networks might not have.

Train(Tensor<T>, Tensor<T>)

Trains the neural network on a single input-output pair.

public override void Train(Tensor<T> input, Tensor<T> expectedOutput)

Parameters

input Tensor<T>

The input data.

expectedOutput Tensor<T>

The expected output for the given input.

Remarks

This method performs one training step on the neural network using the provided input and expected output. It updates the network's parameters to reduce the error between the network's prediction and the expected output.

For Beginners: This is how your neural network learns. You provide: - An input (what the network should process) - The expected output (what the correct answer should be)

The network then:

  1. Makes a prediction based on the input
  2. Compares its prediction to the expected output
  3. Calculates how wrong it was (the loss)
  4. Adjusts its internal values to do better next time

After training, you can get the loss value using the GetLastLoss() method to see how well the network is learning.

UpdateParameters(Vector<T>)

Updates the network's parameters with new values.

public override void UpdateParameters(Vector<T> gradients)

Parameters

gradients Vector<T>

Remarks

For Beginners: During training, a neural network's internal values (parameters) get adjusted to improve its performance. This method allows you to update all those values at once by providing a complete set of new parameters.

This is typically used by optimization algorithms that calculate better parameter values based on training data.

ValidateInputShape(Tensor<T>)

Validates that an input tensor has the correct shape for this model.

public void ValidateInputShape(Tensor<T> documentImage)

Parameters

documentImage Tensor<T>

The tensor to validate.

Exceptions

ArgumentException

Thrown if the tensor shape is invalid.

Edit this page