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