TrOCR

概述

TrOCR 模型由 Minghao Li、Tengchao Lv、Lei Cui、Yijuan Lu、Dinei Florencio、Cha Zhang、Zhoujun Li、Furu Wei 在 TrOCR: Transformer-based Optical Character Recognition with Pre-trained Models 中提出。TrOCR 由一個影像 Transformer 編碼器和一個自迴歸文字 Transformer 解碼器組成，用於執行光學字元識別 (OCR)。

論文摘要如下：

文字識別是文件數字化領域的一個長期研究問題。現有的文字識別方法通常基於 CNN 進行影像理解，基於 RNN 進行字元級文字生成。此外，通常還需要另一個語言模型作為後處理步驟來提高整體準確性。在本文中，我們提出了一種基於預訓練影像 Transformer 和文字 Transformer 模型的端到端文字識別方法，即 TrOCR，它利用 Transformer 架構進行影像理解和詞元級文字生成。TrOCR 模型簡單但有效，可以利用大規模合成數據進行預訓練，並利用人工標註資料集進行微調。實驗表明，TrOCR 模型在印刷體和手寫體文字識別任務上均優於當前的 SOTA 模型。

TrOCR 架構。摘自原始論文。

請參閱 VisionEncoderDecoder 類以瞭解如何使用此模型。

此模型由 nielsr 貢獻。原始程式碼可在此處找到。

使用技巧

快速開始使用 TrOCR 的最快方法是檢視教程筆記本，其中展示瞭如何在推理時使用模型以及如何對自定義資料進行微調。
TrOCR 在下游資料集上進行微調之前，分 2 個階段進行預訓練。它在印刷體（例如 SROIE 資料集）和手寫體（例如 IAM 手寫資料集）文字識別任務上均取得了最先進的結果。有關更多資訊，請參閱官方模型。
在您自己的 OCR 資料集上微調 TrOCR.
TrOCR 始終在 VisionEncoderDecoder 框架內使用。

資源

Hugging Face 官方和社群（由 🌎 表示）資源列表，幫助您開始使用 TrOCR。如果您有興趣提交資源以供此處收錄，請隨時開啟拉取請求，我們將對其進行審查！資源理想情況下應展示一些新內容，而不是重複現有資源。

文字分類

一篇關於使用 TrOCR 加速文件 AI 的部落格文章。
一篇關於如何使用 TrOCR 文件 AI 的部落格文章。
一篇關於如何使用 Seq2SeqTrainer 在 IAM 手寫資料庫上微調 TrOCR 的筆記本。
一篇關於 TrOCR 推理和 Gradio 演示的筆記本。
一篇關於如何使用原生 PyTorch 在 IAM 手寫資料庫上微調 TrOCR 的筆記本。
一篇關於評估 IAM 測試集上的 TrOCR_base_handwritten 的筆記本。

文字生成

因果語言建模任務指南。

⚡️ 推理

一個關於 TrOCR 手寫字元識別的互動式演示。

推理

TrOCR 的 VisionEncoderDecoder 模型接受影像作為輸入，並利用 generate() 自迴歸地生成給定輸入影像的文字。

[ViTImageProcessor/DeiTImageProcessor] 類負責預處理輸入影像，[RobertaTokenizer/XLMRobertaTokenizer] 將生成的目標標記解碼為目標字串。TrOCRProcessor 將 [ViTImageProcessor/DeiTImageProcessor] 和 [RobertaTokenizer/XLMRobertaTokenizer] 封裝到單個例項中，以同時提取輸入特徵和解碼預測的標記 ID。

分步光學字元識別 (OCR)

>>> from transformers import TrOCRProcessor, VisionEncoderDecoderModel
>>> import requests
>>> from PIL import Image

>>> processor = TrOCRProcessor.from_pretrained("microsoft/trocr-base-handwritten")
>>> model = VisionEncoderDecoderModel.from_pretrained("microsoft/trocr-base-handwritten")

>>> # load image from the IAM dataset
>>> url = "https://fki.tic.heia-fr.ch/static/img/a01-122-02.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw).convert("RGB")

>>> pixel_values = processor(image, return_tensors="pt").pixel_values
>>> generated_ids = model.generate(pixel_values)

>>> generated_text = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]

請檢視模型中心以查詢 TrOCR 檢查點。

TrOCRConfig

class transformers.TrOCRConfig

< 來源 >

( vocab_size = 50265 d_model = 1024 decoder_layers = 12 decoder_attention_heads = 16 decoder_ffn_dim = 4096 activation_function = 'gelu' max_position_embeddings = 512 dropout = 0.1 attention_dropout = 0.0 activation_dropout = 0.0 decoder_start_token_id = 2 init_std = 0.02 decoder_layerdrop = 0.0 use_cache = True scale_embedding = False use_learned_position_embeddings = True layernorm_embedding = True pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 **kwargs )

引數

vocab_size (int, 可選, 預設值為 50265) — TrOCR 模型的詞彙表大小。定義了呼叫 TrOCRForCausalLM 時傳入的 inputs_ids 可以表示的不同標記的數量。
d_model (int, 可選, 預設值為 1024) — 層和池化層的維度。
decoder_layers (int, 可選, 預設值為 12) — 解碼器層數。
decoder_attention_heads (int, 可選, 預設值為 16) — Transformer 解碼器中每個注意力層的注意力頭數。
decoder_ffn_dim (int, 可選, 預設值為 4096) — 解碼器中“中間”（通常稱為前饋）層的維度。
activation_function (str 或 function, 可選, 預設值為 "gelu") — 池化器中的非線性啟用函式（函式或字串）。如果是字串，支援 "gelu"、"relu"、"silu" 和 "gelu_new"。
max_position_embeddings (int, 可選, 預設值為 512) — 此模型可能使用的最大序列長度。通常設定為一個較大的值以防萬一（例如 512、1024 或 2048）。
dropout (float, 可選, 預設值為 0.1) — 嵌入層和池化器中所有全連線層的 dropout 機率。
attention_dropout (float, 可選, 預設值為 0.0) — 注意力機率的 dropout 比率。
activation_dropout (float, 可選, 預設值為 0.0) — 全連線層內部啟用的 dropout 比率。
init_std (float, 可選, 預設值為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。
decoder_layerdrop (float, 可選, 預設值為 0.0) — 解碼器的 LayerDrop 機率。有關更多詳細資訊，請參閱 [LayerDrop 論文](參見 https://huggingface.co/papers/1909.11556)。
use_cache (bool, 可選, 預設值為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。
scale_embedding (bool, 可選, 預設值為 False) — 是否按 sqrt(d_model) 縮放詞嵌入。
use_learned_position_embeddings (bool, 可選, 預設值為 True) — 是否使用學習到的位置嵌入。如果不是，將使用正弦位置嵌入。
layernorm_embedding (bool, 可選, 預設值為 True) — 是否在詞 + 位置嵌入之後使用 layernorm。

這是儲存 TrOCRForCausalLM 配置的配置類。它用於根據指定的引數例項化 TrOCR 模型，定義模型架構。使用預設值例項化配置將產生與 TrOCR microsoft/trocr-base-handwritten 架構相似的配置。

配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 的文件。

示例

>>> from transformers import TrOCRConfig, TrOCRForCausalLM

>>> # Initializing a TrOCR-base style configuration
>>> configuration = TrOCRConfig()

>>> # Initializing a model (with random weights) from the TrOCR-base style configuration
>>> model = TrOCRForCausalLM(configuration)

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

TrOCRProcessor

class transformers.TrOCRProcessor

< 來源 >

( image_processor = None tokenizer = None **kwargs )

引數

image_processor ([ViTImageProcessor/DeiTImageProcessor], 可選) — [ViTImageProcessor/DeiTImageProcessor] 的例項。影像處理器是必需輸入。
tokenizer ([RobertaTokenizer/XLMRobertaTokenizer], 可選) — [RobertaTokenizer/XLMRobertaTokenizer] 的例項。分詞器是必需輸入。

構造一個 TrOCR 處理器，它將視覺影像處理器和 TrOCR 分詞器封裝到一個處理器中。

TrOCRProcessor 提供了 [ViTImageProcessor/DeiTImageProcessor] 和 [RobertaTokenizer/XLMRobertaTokenizer] 的所有功能。有關更多資訊，請參閱 call() 和 decode()。

call

< 來源 >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] = None text: typing.Union[str, list[str], list[list[str]]] = None audio = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.trocr.processing_trocr.TrOCRProcessorKwargs] )

在正常模式下使用時，此方法將其所有引數轉發給 AutoImageProcessor 的 __call__() 並返回其輸出。如果在 as_target_processor() 上下文中使用，此方法將其所有引數轉發給 TrOCRTokenizer 的 ~TrOCRTokenizer.__call__。請參閱上述兩種方法的文件字串以獲取更多資訊。

from_pretrained

< 來源 >

( pretrained_model_name_or_path: typing.Union[str, os.PathLike] cache_dir: typing.Union[str, os.PathLike, NoneType] = None force_download: bool = False local_files_only: bool = False token: typing.Union[str, bool, NoneType] = None revision: str = 'main' **kwargs )

引數

pretrained_model_name_or_path (str 或 os.PathLike) — 這可以是以下任何一種：
- 一個字串，是託管在 huggingface.co 上模型倉庫中的預訓練 feature_extractor 的 *模型 ID*。
- 一個 *目錄* 的路徑，包含使用 save_pretrained() 方法儲存的特徵提取器檔案，例如 ./my_model_directory/。
- 一個儲存的特徵提取器 JSON *檔案* 的路徑或 URL，例如 ./my_model_directory/preprocessor_config.json。
**kwargs — 額外關鍵字引數，傳遞給 from_pretrained() 和 ~tokenization_utils_base.PreTrainedTokenizer.from_pretrained。

例項化與預訓練模型關聯的處理器。

此類別方法僅呼叫特徵提取器 from_pretrained()、影像處理器 ImageProcessingMixin 和分詞器 ~tokenization_utils_base.PreTrainedTokenizer.from_pretrained 方法。有關更多資訊，請參閱上述方法的文件字串。

save_pretrained

< 來源 >

( save_directory push_to_hub: bool = False **kwargs )

引數

save_directory (str 或 os.PathLike) — 特徵提取器 JSON 檔案和分詞器檔案將儲存的目錄（如果目錄不存在，將建立）。
push_to_hub (bool, 可選, 預設值為 False) — 是否在儲存模型後將其推送到 Hugging Face 模型中心。您可以使用 repo_id 指定要推送到的倉庫（將預設為您名稱空間中 save_directory 的名稱）。
kwargs (dict[str, Any], 可選) — 傳遞給 push_to_hub() 方法的額外關鍵字引數。

將此處理器（特徵提取器、分詞器…）的屬性儲存在指定目錄中，以便可以使用 from_pretrained() 方法重新載入。

此類別方法僅呼叫 save_pretrained() 和 save_pretrained()。有關更多資訊，請參閱上述方法的文件字串。

batch_decode

< 來源 >

( *args **kwargs )

此方法將其所有引數轉發給 TrOCRTokenizer 的 batch_decode()。有關更多資訊，請參閱此方法的文件字串。

decode

< source >

( *args **kwargs )

此方法將其所有引數轉發給 TrOCRTokenizer 的 decode()。有關更多資訊，請參閱此方法的文件字串。

TrOCRForCausalLM

class transformers.TrOCRForCausalLM

< source >

( config )

引數

config (TrOCRForCausalLM) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法載入模型權重。

帶有語言建模頭的 TrOCR 解碼器。可作為 EncoderDecoderModel 的解碼器部分使用。

此模型繼承自 PreTrainedModel。有關庫為其所有模型實現的通用方法（如下載或儲存、調整輸入嵌入、修剪頭部等），請檢視其超類文件。

此模型也是 PyTorch torch.nn.Module 的子類。將其作為常規 PyTorch 模組使用，並參考 PyTorch 文件中所有與一般使用和行為相關的事項。

forward

< source >

( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.Tensor] = None cross_attn_head_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)

引數

input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。填充預設會被忽略。

索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什麼是 input ID？
attention_mask (torch.Tensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇範圍為 [0, 1]:
- 1 表示 token 未被掩蓋，
- 0 表示 token 被掩蓋。
什麼是注意力掩碼？
encoder_hidden_states (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型被配置為解碼器，則用於交叉注意力。
encoder_attention_mask (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於避免對編碼器輸入填充 token 索引執行注意力的掩碼。如果模型被配置為解碼器，此掩碼用於交叉注意力。掩碼值選擇範圍為 [0, 1]:
- 1 表示 token 未被掩蓋，
- 0 表示 token 被掩蓋。
head_mask (torch.Tensor，形狀為 (num_heads,) 或 (num_layers, num_heads)，可選) — 用於遮蔽自注意力模組中選定頭部的掩碼。掩碼值選擇範圍為 [0, 1]:
- 1 表示頭部未被遮蔽，
- 0 表示頭部被遮蔽。
cross_attn_head_mask (torch.Tensor，形狀為 (decoder_layers, decoder_attention_heads)，可選) — 用於遮蔽交叉注意力模組中選定頭部的掩碼。掩碼值選擇範圍為 [0, 1]:
- 1 表示頭部未被遮蔽，
- 0 表示頭部被遮蔽。
past_key_values (tuple[tuple[torch.FloatTensor]]，可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的 past_key_values，當 use_cache=True 或 config.use_cache=True 時。

允許兩種格式：
- 一個 Cache 例項，請參見我們的 kv 快取指南；
- 長度為 config.n_layers 的 tuple(torch.FloatTensor) 元組，每個元組包含兩個形狀為 (batch_size, num_heads, sequence_length, embed_size_per_head) 的張量。這也被稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳入 past_key_values，將返回舊版快取格式。

如果使用 past_key_values，使用者可以選擇僅輸入形狀為 (batch_size, 1) 的最新 input_ids（那些未將其過去的鍵值狀態提供給此模型的 token），而不是形狀為 (batch_size, sequence_length) 的所有 input_ids。
inputs_embeds (torch.FloatTensor，形狀為 (batch_size, sequence_length, hidden_size)，可選) — 可選地，你可以選擇直接傳遞嵌入表示，而不是傳遞 input_ids。如果你想對 input_ids 索引如何轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這將很有用。
labels (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 用於計算 masked language modeling 損失的標籤。索引應在 [0, ..., config.vocab_size] 或 -100 之間（參見 input_ids 文件字串）。索引設定為 -100 的 token 將被忽略（被掩蓋），損失僅針對標籤在 [0, ..., config.vocab_size] 中的 token 計算。
use_cache (bool，可選) — 如果設定為 True，將返回 past_key_values 鍵值狀態，可用於加速解碼（參見 past_key_values）。
output_attentions (bool，可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量中的 attentions。
output_hidden_states (bool，可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量中的 hidden_states。
return_dict (bool，可選) — 是否返回 ModelOutput 而不是普通元組。

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

一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），根據配置（TrOCRConfig）和輸入包含各種元素。

loss (torch.FloatTensor 形狀為 (1,)，可選，當提供 labels 時返回) — 語言建模損失（用於下一個 token 預測）。
logits (形狀為 (batch_size, sequence_length, config.vocab_size) 的 torch.FloatTensor) — 語言建模頭部的預測分數（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, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
cross_attentions (tuple(torch.FloatTensor)，可選，當傳入 output_attentions=True 或當 config.output_attentions=True 時返回) — torch.FloatTensor 的元組（每層一個）形狀為 (batch_size, num_heads, sequence_length, sequence_length)。

注意力 softmax 後的交叉注意力權重，用於計算交叉注意力頭中的加權平均。
past_key_values (Cache，可選，當傳入 use_cache=True 或當 config.use_cache=True 時返回) — 它是一個 Cache 例項。有關更多詳細資訊，請參見我們的 kv 快取指南。

包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見 past_key_values 輸入）加速順序解碼。

TrOCRForCausalLM 的 forward 方法，覆蓋了 __call__ 特殊方法。

儘管前向傳播的實現需要在該函式中定義，但之後應該呼叫 Module 例項，而不是直接呼叫該函式，因為前者會處理預處理和後處理步驟，而後者會默默忽略它們。

示例

>>> from transformers import (
...     TrOCRConfig,
...     TrOCRProcessor,
...     TrOCRForCausalLM,
...     ViTConfig,
...     ViTModel,
...     VisionEncoderDecoderModel,
... )
>>> import requests
>>> from PIL import Image

>>> # TrOCR is a decoder model and should be used within a VisionEncoderDecoderModel
>>> # init vision2text model with random weights
>>> encoder = ViTModel(ViTConfig())
>>> decoder = TrOCRForCausalLM(TrOCRConfig())
>>> model = VisionEncoderDecoderModel(encoder=encoder, decoder=decoder)

>>> # If you want to start from the pretrained model, load the checkpoint with `VisionEncoderDecoderModel`
>>> processor = TrOCRProcessor.from_pretrained("microsoft/trocr-base-handwritten")
>>> model = VisionEncoderDecoderModel.from_pretrained("microsoft/trocr-base-handwritten")

>>> # load image from the IAM dataset
>>> url = "https://fki.tic.heia-fr.ch/static/img/a01-122-02.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw).convert("RGB")
>>> pixel_values = processor(image, return_tensors="pt").pixel_values
>>> text = "industry, ' Mr. Brown commented icily. ' Let us have a"

>>> # training
>>> model.config.decoder_start_token_id = processor.tokenizer.eos_token_id
>>> model.config.pad_token_id = processor.tokenizer.pad_token_id
>>> model.config.vocab_size = model.config.decoder.vocab_size

>>> labels = processor.tokenizer(text, return_tensors="pt").input_ids
>>> outputs = model(pixel_values, labels=labels)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
5.30

>>> # inference
>>> generated_ids = model.generate(pixel_values)
>>> generated_text = processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
>>> generated_text
'industry, " Mr. Brown commented icily. " Let us have a'

< > 在 GitHub 上更新

Transformers

TrOCR

概述

使用技巧

資源

推理

TrOCRConfig

class transformers.TrOCRConfig

TrOCRProcessor

class transformers.TrOCRProcessor

__call__

from_pretrained

save_pretrained

batch_decode

decode

TrOCRForCausalLM

class transformers.TrOCRForCausalLM

forward

call