Transformers 文档

MGP-STR

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

MGP-STR

概述

MGP-STR 模型由 Peng Wang、Cheng Da 和 Cong Yao 在 用于场景文本识别的多粒度预测 中提出。MGP-STR 是一个概念上简单强大的视觉场景文本识别 (STR) 模型,它建立在 Vision Transformer (ViT) 之上。为了整合语言知识,提出了多粒度预测 (MGP) 策略,以隐式方式将来自语言模态的信息注入到模型中。

以下是论文的摘要

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

drawing MGP-STR 架构。取自原始论文

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

推理示例

MgpstrModel 接受图像作为输入,并生成三种类型的预测,这些预测代表不同粒度的文本信息。这三种类型的预测融合在一起,给出最终的预测结果。

ViTImageProcessor 类负责预处理输入图像,MgpstrTokenizer 将生成的字符 tokens 解码为目标字符串。MgpstrProcessorViTImageProcessorMgpstrTokenizer 封装到一个实例中,以同时提取输入特征并解码预测的 token 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) — 每个 patch 的大小(分辨率)。
  • num_channels (int, 可选, 默认为 3) — 输入通道数。
  • max_token_length (int, 可选, 默认为 27) — 输出 tokens 的最大数量。
  • num_character_labels (int, 可选, 默认为 38) — 字符 head 的类别数。
  • num_bpe_labels (int, 可选, 默认为 50257) — bpe head 的类别数。
  • 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) — 是否向 queries, keys 和 values 添加偏置。
  • distilled (bool, 可选, 默认为 False) — 模型是否包含像 DeiT 模型中的蒸馏 token 和头部。
  • layer_norm_eps (float, 可选, 默认为 1e-05) — 层归一化层使用的 epsilon 值。
  • drop_rate (float, 可选, 默认为 0.0) — 嵌入层、编码器中所有全连接层的 dropout 概率。
  • attn_drop_rate (float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。
  • 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]") — 未知 token。词汇表中没有的 token 无法转换为 ID,而是设置为此 token。
  • bos_token (str, 可选, 默认为 "[GO]") — 序列开始 token。
  • eos_token (str, 可选, 默认为 "[s]") — 序列结束 token。
  • pad_token (strtokenizers.AddedToken, 可选, 默认为 "[GO]") — 一种用于使 token 数组大小相同的特殊 token,以便进行批量处理。然后会被注意力机制或损失计算忽略。

构建 MGP-STR 字符 tokenizer。

此 tokenizer 继承自 PreTrainedTokenizer,其中包含大多数主要方法。用户应参考此超类以获取有关这些方法的更多信息。

save_vocabulary

< >

( save_directory: str filename_prefix: Optional = None )

MgpstrProcessor

class transformers.MgpstrProcessor

< >

( image_processor = None tokenizer = None **kwargs )

参数

  • image_processor (ViTImageProcessor, 可选) — ViTImageProcessor 的实例。图像处理器是必需的输入。
  • tokenizer (MgpstrTokenizer, 可选) — tokenizer 是必需的输入。

构建 MGP-STR processor,它将图像处理器和 MGP-STR tokenizer 包装到单个处理器中

MgpstrProcessor 提供 ViTImageProcessorMgpstrTokenizer 的所有功能。有关更多信息,请参见 call()batch_decode()

__call__

< >

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

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

batch_decode

< >

( sequences ) Dict[str, any]

参数

  • sequences (torch.Tensor) — 令牌化输入 ID 列表。

返回值

Dict[str, any]

解码结果的所有输出的字典。 generated_text (List[str]):字符、bpe 和 wp 融合后的最终结果。 scores (List[float]):字符、bpe 和 wp 融合后的最终分数。 char_preds (List[str]):字符解码句子的列表。 bpe_preds (List[str]):bpe 解码句子的列表。 wp_preds (List[str]):wp 解码句子的列表。

通过调用 decode 将令牌 ID 列表转换为字符串列表。

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

MgpstrModel

class transformers.MgpstrModel

< >

( config: MgpstrConfig )

参数

  • config (MgpstrConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。

裸机 MGP-STR 模型 Transformer,输出原始隐藏状态,顶部没有任何特定的 Head。此模型是 PyTorch torch.nn.Module 子类。 可将其用作常规 PyTorch 模块,并参阅 PyTorch 文档,了解与通用用法和行为相关的所有事项。

forward

< >

( pixel_values: FloatTensor output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )

参数

  • pixel_values (torch.FloatTensor,形状为 (batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获得。 有关详细信息,请参阅 ViTImageProcessor.call()
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是纯元组。

MgpstrModel forward 方法,覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数中定义,但之后应调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

MgpstrForSceneTextRecognition

class transformers.MgpstrForSceneTextRecognition

< >

( config: MgpstrConfig )

参数

  • config (MgpstrConfig) — 带有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。

MGP-STR 模型 Transformer,顶部带有三个分类 Head(三个 A^3 模块和 Transformer 编码器输出顶部的三个线性层),用于场景文本识别 (STR)。

此模型是 PyTorch torch.nn.Module 子类。 可将其用作常规 PyTorch 模块,并参阅 PyTorch 文档,了解与通用用法和行为相关的所有事项。

forward

< >

( pixel_values: FloatTensor output_attentions: Optional = None output_a3_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.models.mgp_str.modeling_mgp_str.MgpstrModelOutput or tuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor,形状为 (batch_size, num_channels, height, width)) — 像素值。像素值可以使用 AutoImageProcessor 获得。 有关详细信息,请参阅 ViTImageProcessor.call()
  • output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是纯元组。
  • output_a3_attentions (bool, 可选) — 是否返回 a3 模块的注意力张量。 有关更多详细信息,请参见返回张量下的 a3_attentions

返回值

transformers.models.mgp_str.modeling_mgp_str.MgpstrModelOutputtuple(torch.FloatTensor)

一个 transformers.models.mgp_str.modeling_mgp_str.MgpstrModelOutputtorch.FloatTensor 元组(如果传递 return_dict=False 或当 config.return_dict=False 时),其中包含各种元素,具体取决于配置 (<class 'transformers.models.mgp_str.configuration_mgp_str.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), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 元组(一个用于嵌入的输出,如果模型具有嵌入层,+ 每个层的输出一个),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出端的隐藏状态,加上可选的初始嵌入输出。

  • attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个),形状为 (batch_size, config.max_token_length, sequence_length, sequence_length)

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

  • a3_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_a3_attentions=True 或当 config.output_a3_attentions=True 时返回) — torch.FloatTensor 元组(一个用于字符注意力,+ 一个用于 bpe 注意力,+ 一个用于 wordpiece 注意力),形状为 (batch_size, config.max_token_length, sequence_length)`。

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

MgpstrForSceneTextRecognition forward 方法,覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数中定义,但之后应调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者会默默地忽略它们。

示例

>>> 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 上更新