TrOCR
概述
TrOCR 模型由李明浩、吕腾超、崔磊、陆毅娟、Dinei Florencio、张超、李周军、魏福如在 TrOCR: Transformer-based Optical Character Recognition with Pre-trained Models 中提出。TrOCR 由图像 Transformer 编码器和自回归文本 Transformer 解码器组成，用于执行 光学字符识别 (OCR)。
论文中的摘要如下：
文本识别是文档数字化中一个长期存在的研究问题。现有的文本识别方法通常基于 CNN 进行图像理解，基于 RNN 进行字符级文本生成。此外，通常还需要另一个语言模型作为后处理步骤来提高整体准确率。在本文中，我们提出了一种基于预训练图像 Transformer 和文本 Transformer 模型的端到端文本识别方法，即 TrOCR，它利用 Transformer 架构进行图像理解和词片级文本生成。TrOCR 模型简单但有效，可以用大规模合成数据进行预训练，并用人工标注的数据集进行微调。实验表明，TrOCR 模型在印刷文本和手写文本识别任务上都优于当前最先进的模型。
TrOCR 架构。摘自 原始论文。请参考 VisionEncoderDecoder 类了解如何使用此模型。
此模型由 nielsr 贡献。原始代码可以在这里找到 here。
使用技巧
- 开始使用 TrOCR 的最快方法是查看 教程笔记本，它展示了如何在推理时使用模型以及如何在自定义数据上进行微调。
- TrOCR 在对下游数据集进行微调之前，先进行两个阶段的预训练。它在印刷文本（例如 SROIE 数据集）和手写文本（例如 IAM 手写数据集）文本识别任务上都取得了最先进的结果。有关更多信息，请参阅 官方模型。
- TrOCR 始终在 VisionEncoderDecoder 框架内使用。
资源
以下是一些官方 Hugging Face 和社区（用 🌎 表示）资源，可以帮助您开始使用 TrOCR。如果您想提交要包含在此处的资源，请随时打开拉取请求，我们将对其进行审查！该资源最好能展示一些新内容，而不是重复现有资源。
- 关于 使用 TrOCR 加速文档 AI 的博文。
- 关于如何使用 文档 AI 的博文。
- 关于如何使用 使用 Seq2SeqTrainer 在 IAM 手写数据库上微调 TrOCR 的笔记本。
- 关于 使用 TrOCR 进行推理 以及 Gradio 演示的笔记本。
- 关于 使用原生 PyTorch 在 IAM 手写数据库上微调 TrOCR 的笔记本。
- 关于 在 IAM 测试集上评估 TrOCR 的笔记本。
- 因果语言建模 任务指南。
⚡️ 推理
- 关于 TrOCR 手写字符识别 的交互式演示。
推理
TrOCR 的 VisionEncoderDecoder 模型接受图像作为输入，并使用 generate() 根据输入图像自回归地生成文本。
The [ViTImageProcessor/DeiTImageProcessor] 类负责预处理输入图像，而 [RobertaTokenizer/XLMRobertaTokenizer] 将生成的目標标记解码为目标字符串。The 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) — 嵌入和池化器中所有全连接层的丢弃概率。 - init_std (
float, 可选, 默认值为 0.02) — 初始化所有权重矩阵的截断正态初始化的标准差。 - decoder_layerdrop (
float, 可选, 默认值为 0.0) — 解码器的 LayerDrop 概率。 更多详情请参见 [LayerDrop 论文](见 https://arxiv.org/abs/1909.11556)。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应该返回最后键/值注意力（并非所有模型都使用）。 - scale_embedding (
bool, 可选, 默认值为False) — 是否按 sqrt(d_model) 的比例缩放词嵌入。 - use_learned_position_embeddings (
bool, 可选, 默认值为True) — 是否使用学习到的位置嵌入。 否则，将使用正弦位置嵌入。 - layernorm_embedding (
bool, 可选, 默认值为True) — 是否在词语+位置嵌入之后使用层归一化。
这是用于存储 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.configTrOCRProcessor
class transformers.TrOCRProcessor
< source >( image_processor = None tokenizer = None **kwargs )
构建一个 TrOCR 处理器，它将一个视觉图像处理器和一个 TrOCR 分词器包装到一个单独的处理器中。
TrOCRProcessor 提供了 [ViTImageProcessor/DeiTImageProcessor] 和 [RobertaTokenizer/XLMRobertaTokenizer] 的所有功能。 请参阅 call() 和 decode() 以了解更多信息。
在正常模式下使用时，此方法将其所有参数转发给 AutoImageProcessor 的 __call__() 并返回其输出。 如果在 as_target_processor() 上下文中使用，此方法会将其所有参数转发给 TrOCRTokenizer 的 ~TrOCRTokenizer.__call__。 有关更多信息，请参阅上面两种方法的文档字符串。
from_pretrained
< 来源 >( pretrained_model_name_or_path: Union cache_dir: Union = None force_download: bool = False local_files_only: bool = False token: Union = None revision: str = 'main' **kwargs )
参数
- pretrained_model_name_or_path (
str或os.PathLike) — 这可以是：- 一个字符串，即托管在 huggingface.co 上的模型仓库中的预训练特征提取器的 模型 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()。有关更多信息，请参阅上述方法的文档字符串。
此方法将所有参数转发到 TrOCRTokenizer 的 batch_decode()。有关更多信息，请参阅此方法的文档字符串。
TrOCRForCausalLM
class transformers.TrOCRForCausalLM
< 源代码 >( config )
参数
- config (TrOCRConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法加载模型权重。
带有语言建模头的 TrOCR 解码器。可用作 EncoderDecoderModel 和 VisionEncoderDecoder 的解码器部分。此模型继承自 PreTrainedModel。查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入的大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与一般用法和行为相关的事项。
forward
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None encoder_hidden_states: Optional = None encoder_attention_mask: Optional = None head_mask: Optional = None cross_attn_head_mask: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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.FloatTensor形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充 token 索引执行注意力的掩码。如果模型配置为解码器，则此掩码在交叉注意力中使用。掩码值在[0, 1]中选择： - head_mask (
torch.Tensor形状为(decoder_layers, decoder_attention_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))，可选，在传递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的 token 将被忽略（掩码），仅对标签在[0, ..., config.vocab_size]中的 token 计算损失。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。- 1 表示未掩码的 token，
- 0 表示掩码的 token。
- output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。
返回
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)。注意力 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 (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或者当config.use_cache=True时返回) — 长度为config.n_layers的torch.FloatTensor元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态，如果模型用于编码器-解码器设置。仅在config.is_decoder = True时相关。包含预先计算的隐藏状态 (注意力块中的键和值)，可以用来 (参见
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'