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