MGP-STR

概述

MGP-STR 模型由 Peng Wang、Cheng Da 和 Cong Yao 在论文《Multi-Granularity Prediction for Scene Text Recognition》中提出。MGP-STR 是一个概念上简单但功能强大的视觉场景文本识别 (STR) 模型，它建立在视觉 Transformer (ViT) 的基础上。为了融合语言知识，提出了多粒度预测 (MGP) 策略，以隐式的方式将语言模态的信息注入模型。

论文摘要如下：

场景文本识别（STR）多年来一直是计算机视觉领域的一个活跃研究课题。为了解决这个具有挑战性的问题，大量创新方法相继被提出，将语言知识融入 STR 模型已成为近期的突出趋势。在这项工作中，我们首先从视觉 Transformer（ViT）的最新进展中汲取灵感，构建了一个概念简单但功能强大的视觉 STR 模型。该模型基于 ViT 构建，其性能优于以往最先进的场景文本识别模型，包括纯视觉模型和语言增强方法。为了融合语言知识，我们进一步提出了一种多粒度预测策略，以隐式的方式将语言模态的信息注入模型，即在传统的字符级表示之外，将 NLP 中广泛使用的子词表示（BPE 和 WordPiece）引入输出空间，而不采用独立的语言模型（LM）。由此产生的算法（称为 MGP-STR）能够将 STR 的性能提升到一个更高的水平。具体来说，它在标准基准测试中达到了 93.35% 的平均识别准确率。

MGP-STR 架构。摘自原始论文。

MGP-STR 在两个合成数据集 MJSynth (MJ) 和 SynthText (ST) 上进行训练，未在其他数据集上进行微调。它在六个标准的拉丁场景文本基准测试中取得了最先进的结果，包括3个常规文本数据集（IC13、SVT、IIIT）和3个不规则文本数据集（IC15、SVTP、CUTE）。此模型由 yuekun 贡献。原始代码可以在此处找到。

推理示例

MgpstrModel 接受图像作为输入，并生成三种类型的预测，这些预测代表了不同粒度的文本信息。这三种类型的预测被融合以得出最终的预测结果。

ViTImageProcessor 类负责预处理输入图像，而 MgpstrTokenizer 将生成的字符标记解码为目标字符串。MgpstrProcessor 将 ViTImageProcessor 和 MgpstrTokenizer 封装成一个实例，用于提取输入特征和解码预测的标记 ID。

分步光学字符识别 (OCR)

>>> from transformers import MgpstrProcessor, MgpstrForSceneTextRecognition
>>> import requests
>>> from PIL import Image

>>> processor = MgpstrProcessor.from_pretrained('alibaba-damo/mgp-str-base')
>>> model = MgpstrForSceneTextRecognition.from_pretrained('alibaba-damo/mgp-str-base')

>>> # load image from the IIIT-5k dataset
>>> url = "https://i.postimg.cc/ZKwLg2Gw/367-14.png"
>>> image = Image.open(requests.get(url, stream=True).raw).convert("RGB")

>>> pixel_values = processor(images=image, return_tensors="pt").pixel_values
>>> outputs = model(pixel_values)

>>> generated_text = processor.batch_decode(outputs.logits)['generated_text']

MgpstrConfig

class transformers.MgpstrConfig

< 来源 >

( image_size = [32, 128] patch_size = 4 num_channels = 3 max_token_length = 27 num_character_labels = 38 num_bpe_labels = 50257 num_wordpiece_labels = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 mlp_ratio = 4.0 qkv_bias = True distilled = False layer_norm_eps = 1e-05 drop_rate = 0.0 attn_drop_rate = 0.0 drop_path_rate = 0.0 output_a3_attentions = False initializer_range = 0.02 **kwargs )

参数

image_size (list[int], 可选, 默认为 [32, 128]) — 每张图像的大小（分辨率）。
patch_size (int, 可选, 默认为 4) — 每个图像块的大小（分辨率）。
num_channels (int, 可选, 默认为 3) — 输入通道的数量。
max_token_length (int, 可选, 默认为 27) — 输出标记的最大数量。
num_character_labels (int, 可选, 默认为 38) — 字符头的类别数量。
num_bpe_labels (int, 可选, 默认为 50257) — BPE 头的类别数量。
num_wordpiece_labels (int, 可选, 默认为 30522) — Wordpiece 头的类别数量。
hidden_size (int, 可选, 默认为 768) — 嵌入维度。
num_hidden_layers (int, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。
num_attention_heads (int, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。
mlp_ratio (float, 可选, 默认为 4.0) — MLP 隐藏维度与嵌入维度的比率。
qkv_bias (bool, 可选, 默认为 True) — 是否为查询、键和值添加偏置。
distilled (bool, 可选, 默认为 False) — 模型是否包含蒸馏标记和头，如 DeiT 模型。
layer_norm_eps (float, 可选, 默认为 1e-05) — 层归一化层使用的 epsilon 值。
drop_rate (float, 可选, 默认为 0.0) — 嵌入层和编码器中所有全连接层的丢弃概率。
attn_drop_rate (float, 可选, 默认为 0.0) — 注意力概率的丢弃率。
drop_path_rate (float, 可选, 默认为 0.0) — 随机深度率。
output_a3_attentions (bool, 可选, 默认为 False) — 模型是否应返回 A^3 模块的注意力。
initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。

这是用于存储 MgpstrModel 配置的配置类。它用于根据指定的参数实例化一个 MGP-STR 模型，定义模型架构。使用默认值实例化配置将产生与 MGP-STR alibaba-damo/mgp-str-base 架构类似的配置。

配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。

示例

>>> from transformers import MgpstrConfig, MgpstrForSceneTextRecognition

>>> # Initializing a Mgpstr mgp-str-base style configuration
>>> configuration = MgpstrConfig()

>>> # Initializing a model (with random weights) from the mgp-str-base style configuration
>>> model = MgpstrForSceneTextRecognition(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

MgpstrTokenizer

class transformers.MgpstrTokenizer

< 来源 >

( vocab_file unk_token = '[GO]' bos_token = '[GO]' eos_token = '[s]' pad_token = '[GO]' **kwargs )

参数

vocab_file (str) — 词汇表文件的路径。
unk_token (str, 可选, 默认为 "[GO]") — 未知标记。不在词汇表中的标记无法转换为 ID，将被设置为此标记。
bos_token (str, 可选, 默认为 "[GO]") — 序列开始标记。
eos_token (str, 可选, 默认为 "[s]") — 序列结束标记。
pad_token (str 或 tokenizers.AddedToken, 可选, 默认为 "[GO]") — 用于将标记数组填充到相同大小以进行批处理的特殊标记。它将被注意力机制或损失计算忽略。

构建一个 MGP-STR 字符分词器。

该分词器继承自 PreTrainedTokenizer，其中包含了大部分主要方法。用户应参考此超类以获取有关这些方法的更多信息。

save_vocabulary

< 来源 >

( save_directory: str filename_prefix: typing.Optional[str] = None )

MgpstrProcessor

class transformers.MgpstrProcessor

< 来源 >

( image_processor = None tokenizer = None **kwargs )

参数

image_processor (ViTImageProcessor, optional) — ViTImageProcessor 的一个实例。图像处理器是必需的输入。
tokenizer (MgpstrTokenizer, optional) — 分词器是必需的输入。

构建一个 MGP-STR 处理器，它将一个图像处理器和 MGP-STR 分词器包装成一个单一的处理器。

MgpstrProcessor 提供了 ViTImageProcessor] 和 MgpstrTokenizer 的所有功能。更多信息请参见 call() 和 batch_decode()。

call

< 源代码 >

( text = None images = None return_tensors = None **kwargs )

在正常模式下使用时，此方法将其所有参数转发给 ViTImageProcessor 的 call() 并返回其输出。如果 `text` 不为 `None`，此方法还会将 `text` 和 `kwargs` 参数转发给 MgpstrTokenizer 的 call() 以对文本进行编码。请参阅上述方法的文档字符串以获取更多信息。

batch_decode

< 源代码 >

( sequences ) → dict[str, any]

参数

sequences (torch.Tensor) — 分词后的输入 ID 列表。

dict[str, any]

包含所有解码结果输出的字典。generated_text (list[str])：融合字符、BPE 和词片后的最终结果。scores (list[float])：融合字符、BPE 和词片后的最终分数。char_preds (list[str])：字符解码的句子列表。bpe_preds (list[str])：BPE 解码的句子列表。wp_preds (list[str])：词片解码的句子列表。

通过调用 decode 将标记 ID 列表的列表转换为字符串列表。

此方法将其所有参数转发给 PreTrainedTokenizer 的 batch_decode()。请参阅此方法的文档字符串以获取更多信息。

MgpstrModel

class transformers.MgpstrModel

< 源代码 >

( config: MgpstrConfig )

参数

config (MgpstrConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。

基础的 Mgp Str 模型，输出原始的隐藏状态，顶部没有任何特定的头。

该模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< 源代码 >

( pixel_values: FloatTensor output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)

参数

pixel_values (torch.FloatTensor，形状为 (batch_size, num_channels, image_size, image_size)) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获得。详情请参见 {image_processor_class}.__call__ ({processor_class} 使用 {image_processor_class} 处理图像)。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多细节请参见返回张量下的 `attentions`。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的 `hidden_states`。
return_dict (bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。

transformers.modeling_outputs.BaseModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutput 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或者当 `config.return_dict=False` 时），包含各种元素，具体取决于配置 (MgpstrConfig) 和输入。

last_hidden_state (torch.FloatTensor, 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。
hidden_states (tuple(torch.FloatTensor), optional, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则第一个是嵌入层的输出，然后是每一层的输出），形状为 `(batch_size, sequence_length, hidden_size)`。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor), optional, 当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每一层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

MgpstrModel 的前向方法会覆盖 `__call__` 特殊方法。

尽管前向传播的逻辑需要在此函数内定义，但之后应该调用 `Module` 实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默地忽略它们。

MgpstrForSceneTextRecognition

class transformers.MgpstrForSceneTextRecognition

< 源代码 >

( config: MgpstrConfig )

参数

config (MgpstrConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。

MGP-STR 模型 transformer，顶部带有三个分类头（三个 A^3 模块和三个线性层位于 transformer 编码器输出之上），用于场景文本识别（STR）。

该模型继承自 PreTrainedModel。请查看超类文档，了解该库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。

该模型也是 PyTorch torch.nn.Module 的子类。可以像常规 PyTorch 模块一样使用它，并参考 PyTorch 文档了解所有与通用用法和行为相关的事项。

forward

< 源代码 >

( pixel_values: FloatTensor output_attentions: typing.Optional[bool] = None output_a3_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.mgp_str.modeling_mgp_str.MgpstrModelOutput 或 tuple(torch.FloatTensor)

参数

pixel_values (torch.FloatTensor，形状为 (batch_size, num_channels, image_size, image_size)) — 对应于输入图像的张量。像素值可以使用 {image_processor_class} 获得。详情请参见 {image_processor_class}.__call__ ({processor_class} 使用 {image_processor_class} 处理图像)。
output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。更多细节请参见返回张量下的 `attentions`。
output_a3_attentions (bool, optional) — 是否返回 a3 模块的注意力张量。更多细节请参见返回张量下的 `a3_attentions`。
output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。更多细节请参见返回张量下的 `hidden_states`。
return_dict (bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。

transformers.models.mgp_str.modeling_mgp_str.MgpstrModelOutput 或 tuple(torch.FloatTensor)

一个 `transformers.models.mgp_str.modeling_mgp_str.MgpstrModelOutput` 或一个 `torch.FloatTensor` 的元组（如果传递了 `return_dict=False` 或者当 `config.return_dict=False` 时），包含各种元素，具体取决于配置 (MgpstrConfig) 和输入。

logits (tuple(torch.FloatTensor)，形状为 (batch_size, config.num_character_labels)) — `torch.FloatTensor` 的元组（一个用于字符输出，形状为 `(batch_size, config.max_token_length, config.num_character_labels)`；一个用于 bpe 输出，形状为 `(batch_size, config.max_token_length, config.num_bpe_labels)`；一个用于 wordpiece 输出，形状为 `(batch_size, config.max_token_length, config.num_wordpiece_labels)`)。

字符、bpe 和 wordpiece 的分类分数（在 SoftMax 之前）。
hidden_states (tuple[torch.FloatTensor], optional, 当传递 `output_hidden_states=True` 或 `config.output_hidden_states=True` 时返回) — `torch.FloatTensor` 的元组（如果模型有嵌入层，则第一个是嵌入层的输出，然后是每一层的输出），形状为 `(batch_size, sequence_length, hidden_size)`。

模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple[torch.FloatTensor], optional, 当传递 `output_attentions=True` 或 `config.output_attentions=True` 时返回) — `torch.FloatTensor` 的元组（每一层一个），形状为 `(batch_size, num_heads, sequence_length, sequence_length)`。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
a3_attentions (tuple(torch.FloatTensor), optional, 当传递 `output_a3_attentions=True` 或 `config.output_a3_attentions=True` 时返回) — `torch.FloatTensor` 的元组（一个用于字符的注意力，一个用于 bpe 的注意力，一个用于 wordpiece 的注意力），形状为 `(batch_size, config.max_token_length, sequence_length)`。

注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。

MgpstrForSceneTextRecognition 的前向方法会覆盖 `__call__` 特殊方法。

示例

>>> from transformers import (
...     MgpstrProcessor,
...     MgpstrForSceneTextRecognition,
... )
>>> import requests
>>> from PIL import Image

>>> # load image from the IIIT-5k dataset
>>> url = "https://i.postimg.cc/ZKwLg2Gw/367-14.png"
>>> image = Image.open(requests.get(url, stream=True).raw).convert("RGB")

>>> processor = MgpstrProcessor.from_pretrained("alibaba-damo/mgp-str-base")
>>> pixel_values = processor(images=image, return_tensors="pt").pixel_values

>>> model = MgpstrForSceneTextRecognition.from_pretrained("alibaba-damo/mgp-str-base")

>>> # inference
>>> outputs = model(pixel_values)
>>> out_strs = processor.batch_decode(outputs.logits)
>>> out_strs["generated_text"]
'["ticket"]'

< > 在 GitHub 上更新

Transformers

MGP-STR

概述

推理示例

MgpstrConfig

class transformers.MgpstrConfig

MgpstrTokenizer

class transformers.MgpstrTokenizer

save_vocabulary

MgpstrProcessor

class transformers.MgpstrProcessor

__call__

batch_decode

MgpstrModel

class transformers.MgpstrModel

forward

MgpstrForSceneTextRecognition

class transformers.MgpstrForSceneTextRecognition

forward

call