TrOCR

概述

TrOCR 模型在 TrOCR: 基于 Transformer 的光学字符识别与预训练模型一文中被提出，作者是 Minghao Li, Tengchao Lv, Lei Cui, Yijuan Lu, Dinei Florencio, Cha Zhang, Zhoujun Li, Furu Wei。TrOCR 由一个图像 Transformer 编码器和一个自回归文本 Transformer 解码器组成，用于执行光学字符识别 (OCR)。

该论文的摘要如下：

文本识别是文档数字化长期存在的研究问题。现有的文本识别方法通常基于 CNN 进行图像理解，基于 RNN 进行字符级文本生成。此外，通常还需要另一个语言模型作为后处理步骤来提高整体准确率。在本文中，我们提出了一种端到端的文本识别方法，该方法使用了预训练的图像 Transformer 和文本 Transformer 模型，即 TrOCR，它利用 Transformer 架构进行图像理解和 wordpiece 级别的文本生成。TrOCR 模型简单但有效，可以使用大规模合成数据进行预训练，并使用人工标注的数据集进行微调。实验表明，TrOCR 模型在印刷体和手写体文本识别任务上均优于当前最先进的模型。

TrOCR 架构。摘自原始论文。

请参考 VisionEncoderDecoder 类，了解如何使用此模型。

此模型由 nielsr 贡献。原始代码可以在这里找到。

使用技巧

快速开始使用 TrOCR 的方法是查看教程笔记本，其中展示了如何在推理时使用该模型以及在自定义数据上进行微调。
TrOCR 在下游数据集上进行微调之前，会经过 2 个阶段的预训练。它在印刷体（例如 SROIE 数据集）和手写体（例如 IAM 手写数据集）文本识别任务上取得了最先进的结果。有关更多信息，请参阅官方模型。
TrOCR 始终在 VisionEncoderDecoder 框架内使用。

资源

官方 Hugging Face 和社区（🌎 表示）资源的列表，可帮助您开始使用 TrOCR。如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将进行审核！理想情况下，资源应展示一些新内容，而不是重复现有资源。

文本分类

一篇关于使用 TrOCR 加速文档 AI 的博客文章。
一篇关于如何使用 TrOCR 进行文档 AI 的博客文章。
一个关于如何使用 Seq2SeqTrainer 在 IAM 手写数据库上微调 TrOCR 的笔记本。
一个关于使用 TrOCR 进行推理和 Gradio 演示的笔记本。
一个关于如何使用原生 PyTorch 在 IAM 手写数据库上微调 TrOCR 的笔记本。
一个关于在 IAM 测试集上评估 TrOCR 的笔记本。

文本生成

因果语言建模任务指南。

⚡️ 推理

一个关于 TrOCR 手写字符识别的交互式演示。

推理

TrOCR 的 VisionEncoderDecoder 模型接受图像作为输入，并利用 generate() 来自回归地生成文本。

[ViTImageProcessor/DeiTImageProcessor] 类负责预处理输入图像，而 [RobertaTokenizer/XLMRobertaTokenizer] 将生成的目标 tokens 解码为目标字符串。TrOCRProcessor 将 [ViTImageProcessor/DeiTImageProcessor] 和 [RobertaTokenizer/XLMRobertaTokenizer] 封装到一个实例中，以同时提取输入特征和解码预测的 token ids。

逐步光学字符识别 (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

< source >

( 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 可以表示的不同 tokens 的数量。
d_model (int, *可选的*，默认为 1024) — 层和 pooler 层的维度。
decoder_layers (int, *可选的*，默认为 12) — 解码器层数。
decoder_attention_heads (int, *可选的*，默认为 16) — Transformer 解码器中每个注意力层的注意力头数。
decoder_ffn_dim (int, *可选的*，默认为 4096) — 解码器中“中间”层（通常称为前馈层）的维度。
activation_function (str 或 function, *可选的*，默认为 "gelu") — pooler 中的非线性激活函数（函数或字符串）。如果为字符串，则支持 "gelu"、"relu"、"silu" 和 "gelu_new"。
max_position_embeddings (int, *可选的*，默认为 512) — 此模型可能使用的最大序列长度。通常将其设置为较大的值以防万一（例如，512 或 1024 或 2048）。
dropout (float, *可选的*，默认为 0.1) — embeddings 和 pooler 中所有全连接层的 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 论文](see https://arxiv.org/abs/1909.11556)。
use_cache (bool, *可选的*，默认为 True) — 模型是否应返回上次的键/值注意力（并非所有模型都使用）。
scale_embedding (bool, *可选的*，默认为 False) — 是否按 sqrt(d_model) 缩放词 embeddings。
use_learned_position_embeddings (bool, *可选的*，默认为 True) — 是否使用 learned position embeddings。如果不使用，将使用正弦位置 embeddings。
layernorm_embedding (bool, *可选的*，默认为 True) — 是否在 word + position embeddings 之后使用 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

< source >

( 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

< source >

( 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, typing.List[str], typing.List[typing.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__。有关更多信息，请参阅上述两种方法的 doctsring 。

from_pretrained

< source >

( 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 的额外关键字参数。

实例化与预训练模型相关的处理器。

此classmethod 只是简单地调用特征提取器 from_pretrained()、图像处理器 ImageProcessingMixin 和 tokenizer ~tokenization_utils_base.PreTrainedTokenizer.from_pretrained 方法。有关更多信息，请参阅上述方法的文档字符串。

save_pretrained

< source >

( save_directory push_to_hub: bool = False **kwargs )

参数

save_directory (str 或 os.PathLike) — 将在其中保存特征提取器 JSON 文件和 tokenizer 文件的目录（如果目录不存在，则会创建）。
push_to_hub (bool, 可选, 默认为 False) — 是否在保存模型后将其推送到 Hugging Face 模型中心。您可以使用 repo_id 指定要推送到的仓库（默认为命名空间中 save_directory 的名称）。
kwargs (Dict[str, Any], 可选) — 传递给 push_to_hub() 方法的附加关键字参数。

将此处理器（特征提取器、tokenizer…）的属性保存在指定目录中，以便可以使用 from_pretrained() 方法重新加载。

此 classmethod 只是简单地调用 save_pretrained() 和 save_pretrained()。有关更多信息，请参阅上述方法的文档字符串。

batch_decode

< source >

( *args **kwargs )

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

decode

< source >

( *args **kwargs )

此方法将其所有参数转发到 TrOCRTokenizer 的 decode()。有关更多信息，请参阅此方法的文档字符串。

TrOCRForCausalLM

class transformers.TrOCRForCausalLM

< source >

( config )

参数

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

带有语言建模头的 TrOCR 解码器。可以用作 EncoderDecoderModel 和 VisionEncoderDecoder 的解码器部分。此模型继承自 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[typing.Tuple[typing.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 (形状为 (batch_size, sequence_length) 的 torch.LongTensor) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下会忽略填充。

索引可以使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

什么是输入 ID？
attention_mask (形状为 (batch_size, sequence_length) 的 torch.Tensor, 可选) — 掩码，以避免在填充标记索引上执行注意力机制。掩码值在 [0, 1] 中选择：
- 1 表示标记未被掩码，
- 0 表示标记已被掩码。
什么是注意力掩码？
encoder_hidden_states (形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor, 可选) — 编码器最后一层输出的隐藏状态序列。如果模型配置为解码器，则在交叉注意力机制中使用。
encoder_attention_mask (形状为 (batch_size, sequence_length) 的 torch.FloatTensor, 可选) — 掩码，以避免在编码器输入的填充标记索引上执行注意力机制。如果模型配置为解码器，则此掩码在交叉注意力机制中使用。掩码值在 [0, 1] 中选择：
head_mask (形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor, 可选) — 掩码，用于使注意力模块的选定头无效。掩码值在 [0, 1] 中选择：
- 1 表示头未被掩码，
- 0 表示头已被掩码。
cross_attn_head_mask (形状为 (decoder_layers, decoder_attention_heads) 的 torch.Tensor, 可选) — 掩码，用于使交叉注意力模块的选定头无效。掩码值在 [0, 1] 中选择：
- 1 表示头未被掩码，
- 0 表示头已被掩码。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(tuple(torch.FloatTensor)) 元组，每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量和 2 个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的附加张量。仅当模型在序列到序列模型中用作解码器时，才需要这两个附加张量。

包含预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），这些状态可用于（请参阅 past_key_values 输入）加速顺序解码。

如果使用 past_key_values，则用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 decoder_input_ids（那些没有将其过去的键值状态提供给此模型的），而不是形状为 (batch_size, sequence_length) 的所有 decoder_input_ids。
labels (torch.LongTensor, 形状为 (batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。索引应该在 [0, ..., config.vocab_size] 或 -100 之间（参见 input_ids 文档字符串）。索引设置为 -100 的令牌将被忽略（掩码），损失仅针对标签在 [0, ..., config.vocab_size] 中的令牌计算。
use_cache (bool, 可选) — 如果设置为 True，则返回 past_key_values 键值状态，并可用于加速解码（参见 past_key_values）。
- 1 代表未被掩码的令牌，
- 0 代表被掩码的令牌。
output_attentions (bool, 可选) — 是否返回所有 attention 层的 attention 张量。有关更多详细信息，请参见返回张量下的 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 时返回) — 语言建模损失（用于预测下一个令牌）。
logits (torch.FloatTensor, 形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（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)。

attention softmax 之后的 Attention 权重，用于计算自注意力头中的加权平均值。
cross_attentions (tuple(torch.FloatTensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

attention softmax 之后的交叉 Attention 权重，用于计算交叉注意力头中的加权平均值。
past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — torch.FloatTensor 元组的元组，长度为 config.n_layers，每个元组包含自注意力层的缓存键、值状态，以及交叉注意力层（如果模型用于编码器-解码器设置中）。仅当 config.is_decoder = True 时相关。

包含预先计算的隐藏状态（attention 块中的键和值），可以用于（参见 past_key_values 输入）加速顺序解码。

示例

>>> 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