Buckets:
| # LayoutLMV2 | |
| ## Overview | |
| The LayoutLMV2 model was proposed in [LayoutLMv2: Multi-modal Pre-training for Visually-Rich Document Understanding](https://huggingface.co/papers/2012.14740) by Yang Xu, Yiheng Xu, Tengchao Lv, Lei Cui, Furu Wei, Guoxin Wang, Yijuan Lu, | |
| Dinei Florencio, Cha Zhang, Wanxiang Che, Min Zhang, Lidong Zhou. LayoutLMV2 improves [LayoutLM](layoutlm) to obtain | |
| state-of-the-art results across several document image understanding benchmarks: | |
| - information extraction from scanned documents: the [FUNSD](https://guillaumejaume.github.io/FUNSD/) dataset (a | |
| collection of 199 annotated forms comprising more than 30,000 words), the [CORD](https://github.com/clovaai/cord) | |
| dataset (a collection of 800 receipts for training, 100 for validation and 100 for testing), the [SROIE](https://rrc.cvc.uab.es/?ch=13) dataset (a collection of 626 receipts for training and 347 receipts for testing) | |
| and the [Kleister-NDA](https://github.com/applicaai/kleister-nda) dataset (a collection of non-disclosure | |
| agreements from the EDGAR database, including 254 documents for training, 83 documents for validation, and 203 | |
| documents for testing). | |
| - document image classification: the [RVL-CDIP](https://www.cs.cmu.edu/~aharley/rvl-cdip/) dataset (a collection of | |
| 400,000 images belonging to one of 16 classes). | |
| - document visual question answering: the [DocVQA](https://huggingface.co/papers/2007.00398) dataset (a collection of 50,000 | |
| questions defined on 12,000+ document images). | |
| The abstract from the paper is the following: | |
| *Pre-training of text and layout has proved effective in a variety of visually-rich document understanding tasks due to | |
| its effective model architecture and the advantage of large-scale unlabeled scanned/digital-born documents. In this | |
| paper, we present LayoutLMv2 by pre-training text, layout and image in a multi-modal framework, where new model | |
| architectures and pre-training tasks are leveraged. Specifically, LayoutLMv2 not only uses the existing masked | |
| visual-language modeling task but also the new text-image alignment and text-image matching tasks in the pre-training | |
| stage, where cross-modality interaction is better learned. Meanwhile, it also integrates a spatial-aware self-attention | |
| mechanism into the Transformer architecture, so that the model can fully understand the relative positional | |
| relationship among different text blocks. Experiment results show that LayoutLMv2 outperforms strong baselines and | |
| achieves new state-of-the-art results on a wide variety of downstream visually-rich document understanding tasks, | |
| including FUNSD (0.7895 -> 0.8420), CORD (0.9493 -> 0.9601), SROIE (0.9524 -> 0.9781), Kleister-NDA (0.834 -> 0.852), | |
| RVL-CDIP (0.9443 -> 0.9564), and DocVQA (0.7295 -> 0.8672). The pre-trained LayoutLMv2 model is publicly available at | |
| this https URL.* | |
| LayoutLMv2 depends on `detectron2`, `torchvision` and `tesseract`. Run the | |
| following to install them: | |
| ```bash | |
| python -m pip install 'git+https://github.com/facebookresearch/detectron2.git' | |
| python -m pip install torchvision tesseract | |
| ``` | |
| (If you are developing for LayoutLMv2, note that passing the doctests also requires the installation of these packages.) | |
| ## Usage tips | |
| - The main difference between LayoutLMv1 and LayoutLMv2 is that the latter incorporates visual embeddings during | |
| pre-training (while LayoutLMv1 only adds visual embeddings during fine-tuning). | |
| - LayoutLMv2 adds both a relative 1D attention bias as well as a spatial 2D attention bias to the attention scores in | |
| the self-attention layers. Details can be found on page 5 of the [paper](https://huggingface.co/papers/2012.14740). | |
| - Demo notebooks on how to use the LayoutLMv2 model on RVL-CDIP, FUNSD, DocVQA, CORD can be found [here](https://github.com/NielsRogge/Transformers-Tutorials). | |
| - LayoutLMv2 uses Facebook AI's [Detectron2](https://github.com/facebookresearch/detectron2/) package for its visual | |
| backbone. See [this link](https://detectron2.readthedocs.io/en/latest/tutorials/install.html) for installation | |
| instructions. | |
| - In addition to `input_ids`, [forward()](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Model.forward) expects 2 additional inputs, namely | |
| `image` and `bbox`. The `image` input corresponds to the original document image in which the text | |
| tokens occur. The model expects each document image to be of size 224x224. This means that if you have a batch of | |
| document images, `image` should be a tensor of shape (batch_size, 3, 224, 224). This can be either a | |
| `torch.Tensor` or a `Detectron2.structures.ImageList`. You don't need to normalize the channels, as this is | |
| done by the model. Important to note is that the visual backbone expects BGR channels instead of RGB, as all models | |
| in Detectron2 are pre-trained using the BGR format. The `bbox` input are the bounding boxes (i.e. 2D-positions) | |
| of the input text tokens. This is identical to [LayoutLMModel](/docs/transformers/pr_43838/en/model_doc/layoutlm#transformers.LayoutLMModel). These can be obtained using an | |
| external OCR engine such as Google's [Tesseract](https://github.com/tesseract-ocr/tesseract) (there's a [Python | |
| wrapper](https://pypi.org/project/pytesseract/) available). Each bounding box should be in (x0, y0, x1, y1) | |
| format, where (x0, y0) corresponds to the position of the upper left corner in the bounding box, and (x1, y1) | |
| represents the position of the lower right corner. Note that one first needs to normalize the bounding boxes to be on | |
| a 0-1000 scale. To normalize, you can use the following function: | |
| ```python | |
| def normalize_bbox(bbox, width, height): | |
| return [ | |
| int(1000 * (bbox[0] / width)), | |
| int(1000 * (bbox[1] / height)), | |
| int(1000 * (bbox[2] / width)), | |
| int(1000 * (bbox[3] / height)), | |
| ] | |
| ``` | |
| Here, `width` and `height` correspond to the width and height of the original document in which the token | |
| occurs (before resizing the image). Those can be obtained using the Python Image Library (PIL) library for example, as | |
| follows: | |
| ```python | |
| from PIL import Image | |
| image = Image.open( | |
| "name_of_your_document - can be a png, jpg, etc. of your documents (PDFs must be converted to images)." | |
| ) | |
| width, height = image.size | |
| ``` | |
| However, this model includes a brand new [LayoutLMv2Processor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Processor) which can be used to directly | |
| prepare data for the model (including applying OCR under the hood). More information can be found in the "Usage" | |
| section below. | |
| - Internally, [LayoutLMv2Model](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Model) will send the `image` input through its visual backbone to | |
| obtain a lower-resolution feature map, whose shape is equal to the `image_feature_pool_shape` attribute of | |
| [LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config). This feature map is then flattened to obtain a sequence of image tokens. As | |
| the size of the feature map is 7x7 by default, one obtains 49 image tokens. These are then concatenated with the text | |
| tokens, and send through the Transformer encoder. This means that the last hidden states of the model will have a | |
| length of 512 + 49 = 561, if you pad the text tokens up to the max length. More generally, the last hidden states | |
| will have a shape of `seq_length` + `image_feature_pool_shape[0]` * | |
| `config.image_feature_pool_shape[1]`. | |
| - When calling [from_pretrained()](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel.from_pretrained), a warning will be printed with a long list of | |
| parameter names that are not initialized. This is not a problem, as these parameters are batch normalization | |
| statistics, which are going to have values when fine-tuning on a custom dataset. | |
| - If you want to train the model in a distributed environment, make sure to call `synchronize_batch_norm` on the | |
| model in order to properly synchronize the batch normalization layers of the visual backbone. | |
| In addition, there's LayoutXLM, which is a multilingual version of LayoutLMv2. More information can be found on | |
| [LayoutXLM's documentation page](layoutxlm). | |
| ## Resources | |
| A list of official Hugging Face and community (indicated by 🌎) resources to help you get started with LayoutLMv2. If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource. | |
| - A notebook on how to [finetune LayoutLMv2 for text-classification on RVL-CDIP dataset](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/RVL-CDIP/Fine_tuning_LayoutLMv2ForSequenceClassification_on_RVL_CDIP.ipynb). | |
| - See also: [Text classification task guide](../tasks/sequence_classification) | |
| - A notebook on how to [finetune LayoutLMv2 for question-answering on DocVQA dataset](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/DocVQA/Fine_tuning_LayoutLMv2ForQuestionAnswering_on_DocVQA.ipynb). | |
| - See also: [Question answering task guide](../tasks/question_answering) | |
| - See also: [Document question answering task guide](../tasks/document_question_answering) | |
| - A notebook on how to [finetune LayoutLMv2 for token-classification on CORD dataset](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/CORD/Fine_tuning_LayoutLMv2ForTokenClassification_on_CORD.ipynb). | |
| - A notebook on how to [finetune LayoutLMv2 for token-classification on FUNSD dataset](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/LayoutLMv2/FUNSD/Fine_tuning_LayoutLMv2ForTokenClassification_on_FUNSD_using_HuggingFace_Trainer.ipynb). | |
| - See also: [Token classification task guide](../tasks/token_classification) | |
| ## Usage: LayoutLMv2Processor | |
| The easiest way to prepare data for the model is to use [LayoutLMv2Processor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Processor), which internally | |
| combines a image processor ([LayoutLMv2ImageProcessor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ImageProcessor)) and a tokenizer | |
| ([LayoutLMv2Tokenizer](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Tokenizer) or [LayoutLMv2TokenizerFast](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Tokenizer)). The image processor | |
| handles the image modality, while the tokenizer handles the text modality. A processor combines both, which is ideal | |
| for a multi-modal model like LayoutLMv2. Note that you can still use both separately, if you only want to handle one | |
| modality. | |
| ```python | |
| from transformers import LayoutLMv2ImageProcessor, LayoutLMv2Processor, LayoutLMv2TokenizerFast | |
| image_processor = LayoutLMv2ImageProcessor() # apply_ocr is set to True by default | |
| tokenizer = LayoutLMv2TokenizerFast.from_pretrained("microsoft/layoutlmv2-base-uncased") | |
| processor = LayoutLMv2Processor(image_processor, tokenizer) | |
| ``` | |
| In short, one can provide a document image (and possibly additional data) to [LayoutLMv2Processor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Processor), | |
| and it will create the inputs expected by the model. Internally, the processor first uses | |
| [LayoutLMv2ImageProcessor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ImageProcessor) to apply OCR on the image to get a list of words and normalized | |
| bounding boxes, as well to resize the image to a given size in order to get the `image` input. The words and | |
| normalized bounding boxes are then provided to [LayoutLMv2Tokenizer](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Tokenizer) or | |
| [LayoutLMv2TokenizerFast](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Tokenizer), which converts them to token-level `input_ids`, | |
| `attention_mask`, `token_type_ids`, `bbox`. Optionally, one can provide word labels to the processor, | |
| which are turned into token-level `labels`. | |
| [LayoutLMv2Processor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Processor) uses [PyTesseract](https://pypi.org/project/pytesseract/), a Python | |
| wrapper around Google's Tesseract OCR engine, under the hood. Note that you can still use your own OCR engine of | |
| choice, and provide the words and normalized boxes yourself. This requires initializing | |
| [LayoutLMv2ImageProcessor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ImageProcessor) with `apply_ocr` set to `False`. | |
| In total, there are 5 use cases that are supported by the processor. Below, we list them all. Note that each of these | |
| use cases work for both batched and non-batched inputs (we illustrate them for non-batched inputs). | |
| **Use case 1: document image classification (training, inference) + token classification (inference), apply_ocr = | |
| True** | |
| This is the simplest case, in which the processor (actually the image processor) will perform OCR on the image to get | |
| the words and normalized bounding boxes. | |
| ```python | |
| from PIL import Image | |
| from transformers import LayoutLMv2Processor | |
| processor = LayoutLMv2Processor.from_pretrained("microsoft/layoutlmv2-base-uncased") | |
| image = Image.open( | |
| "name_of_your_document - can be a png, jpg, etc. of your documents (PDFs must be converted to images)." | |
| ).convert("RGB") | |
| encoding = processor( | |
| image, return_tensors="pt" | |
| ) # you can also add all tokenizer parameters here such as padding, truncation | |
| print(encoding.keys()) | |
| # dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'bbox', 'image']) | |
| ``` | |
| **Use case 2: document image classification (training, inference) + token classification (inference), apply_ocr=False** | |
| In case one wants to do OCR themselves, one can initialize the image processor with `apply_ocr` set to | |
| `False`. In that case, one should provide the words and corresponding (normalized) bounding boxes themselves to | |
| the processor. | |
| ```python | |
| from PIL import Image | |
| from transformers import LayoutLMv2Processor | |
| processor = LayoutLMv2Processor.from_pretrained("microsoft/layoutlmv2-base-uncased", revision="no_ocr") | |
| image = Image.open( | |
| "name_of_your_document - can be a png, jpg, etc. of your documents (PDFs must be converted to images)." | |
| ).convert("RGB") | |
| words = ["hello", "world"] | |
| boxes = [[1, 2, 3, 4], [5, 6, 7, 8]] # make sure to normalize your bounding boxes | |
| encoding = processor(image, words, boxes=boxes, return_tensors="pt").to(model.device) | |
| print(encoding.keys()) | |
| # dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'bbox', 'image']) | |
| ``` | |
| **Use case 3: token classification (training), apply_ocr=False** | |
| For token classification tasks (such as FUNSD, CORD, SROIE, Kleister-NDA), one can also provide the corresponding word | |
| labels in order to train a model. The processor will then convert these into token-level `labels`. By default, it | |
| will only label the first wordpiece of a word, and label the remaining wordpieces with -100, which is the | |
| `ignore_index` of PyTorch's CrossEntropyLoss. In case you want all wordpieces of a word to be labeled, you can | |
| initialize the tokenizer with `only_label_first_subword` set to `False`. | |
| ```python | |
| from PIL import Image | |
| from transformers import LayoutLMv2Processor | |
| processor = LayoutLMv2Processor.from_pretrained("microsoft/layoutlmv2-base-uncased", revision="no_ocr") | |
| image = Image.open( | |
| "name_of_your_document - can be a png, jpg, etc. of your documents (PDFs must be converted to images)." | |
| ).convert("RGB") | |
| words = ["hello", "world"] | |
| boxes = [[1, 2, 3, 4], [5, 6, 7, 8]] # make sure to normalize your bounding boxes | |
| word_labels = [1, 2] | |
| encoding = processor(image, words, boxes=boxes, word_labels=word_labels, return_tensors="pt").to(model.device) | |
| print(encoding.keys()) | |
| # dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'bbox', 'labels', 'image']) | |
| ``` | |
| **Use case 4: visual question answering (inference), apply_ocr=True** | |
| For visual question answering tasks (such as DocVQA), you can provide a question to the processor. By default, the | |
| processor will apply OCR on the image, and create [CLS] question tokens [SEP] word tokens [SEP]. | |
| ```python | |
| from PIL import Image | |
| from transformers import LayoutLMv2Processor | |
| processor = LayoutLMv2Processor.from_pretrained("microsoft/layoutlmv2-base-uncased") | |
| image = Image.open( | |
| "name_of_your_document - can be a png, jpg, etc. of your documents (PDFs must be converted to images)." | |
| ).convert("RGB") | |
| question = "What's his name?" | |
| encoding = processor(image, question, return_tensors="pt").to(model.device) | |
| print(encoding.keys()) | |
| # dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'bbox', 'image']) | |
| ``` | |
| **Use case 5: visual question answering (inference), apply_ocr=False** | |
| For visual question answering tasks (such as DocVQA), you can provide a question to the processor. If you want to | |
| perform OCR yourself, you can provide your own words and (normalized) bounding boxes to the processor. | |
| ```python | |
| from PIL import Image | |
| from transformers import LayoutLMv2Processor | |
| processor = LayoutLMv2Processor.from_pretrained("microsoft/layoutlmv2-base-uncased", revision="no_ocr") | |
| image = Image.open( | |
| "name_of_your_document - can be a png, jpg, etc. of your documents (PDFs must be converted to images)." | |
| ).convert("RGB") | |
| question = "What's his name?" | |
| words = ["hello", "world"] | |
| boxes = [[1, 2, 3, 4], [5, 6, 7, 8]] # make sure to normalize your bounding boxes | |
| encoding = processor(image, question, words, boxes=boxes, return_tensors="pt").to(model.device) | |
| print(encoding.keys()) | |
| # dict_keys(['input_ids', 'token_type_ids', 'attention_mask', 'bbox', 'image']) | |
| ``` | |
| ## LayoutLMv2Config[[transformers.LayoutLMv2Config]] | |
| #### transformers.LayoutLMv2Config[[transformers.LayoutLMv2Config]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/configuration_layoutlmv2.py#L29) | |
| This is the configuration class to store the configuration of a LayoutLMv2Model. It is used to instantiate a Layoutlmv2 | |
| model according to the specified arguments, defining the model architecture. Instantiating a configuration with the | |
| defaults will yield a similar configuration to that of the [microsoft/layoutlmv2-base-uncased](https://huggingface.co/microsoft/layoutlmv2-base-uncased) | |
| Configuration objects inherit from [PreTrainedConfig](/docs/transformers/pr_43838/en/main_classes/configuration#transformers.PreTrainedConfig) and can be used to control the model outputs. Read the | |
| documentation from [PreTrainedConfig](/docs/transformers/pr_43838/en/main_classes/configuration#transformers.PreTrainedConfig) for more information. | |
| Example: | |
| ```python | |
| >>> from transformers import LayoutLMv2Config, LayoutLMv2Model | |
| >>> # Initializing a LayoutLMv2 microsoft/layoutlmv2-base-uncased style configuration | |
| >>> configuration = LayoutLMv2Config() | |
| >>> # Initializing a model (with random weights) from the microsoft/layoutlmv2-base-uncased style configuration | |
| >>> model = LayoutLMv2Model(configuration) | |
| >>> # Accessing the model configuration | |
| >>> configuration = model.config | |
| ``` | |
| **Parameters:** | |
| vocab_size (`int`, *optional*, defaults to `30522`) : Vocabulary size of the model. Defines the number of different tokens that can be represented by the `input_ids`. | |
| hidden_size (`int`, *optional*, defaults to `768`) : Dimension of the hidden representations. | |
| num_hidden_layers (`int`, *optional*, defaults to `12`) : Number of hidden layers in the Transformer decoder. | |
| num_attention_heads (`int`, *optional*, defaults to `12`) : Number of attention heads for each attention layer in the Transformer decoder. | |
| intermediate_size (`int`, *optional*, defaults to `3072`) : Dimension of the MLP representations. | |
| hidden_act (`str`, *optional*, defaults to `gelu`) : The non-linear activation function (function or string) in the decoder. For example, `"gelu"`, `"relu"`, `"silu"`, etc. | |
| hidden_dropout_prob (`Union[float, int]`, *optional*, defaults to `0.1`) : The dropout probability for all fully connected layers in the embeddings, encoder, and pooler. | |
| attention_probs_dropout_prob (`Union[float, int]`, *optional*, defaults to `0.1`) : The dropout ratio for the attention probabilities. | |
| max_position_embeddings (`int`, *optional*, defaults to `512`) : The maximum sequence length that this model might ever be used with. | |
| type_vocab_size (`int`, *optional*, defaults to `2`) : The vocabulary size of the `token_type_ids`. | |
| initializer_range (`float`, *optional*, defaults to `0.02`) : The standard deviation of the truncated_normal_initializer for initializing all weight matrices. | |
| layer_norm_eps (`float`, *optional*, defaults to `1e-12`) : The epsilon used by the layer normalization layers. | |
| pad_token_id (`int`, *optional*, defaults to `0`) : Token id used for padding in the vocabulary. | |
| max_2d_position_embeddings (`int`, *optional*, defaults to 1024) : The maximum value that the 2D position embedding might ever be used with. Typically set this to something large just in case (e.g., 1024). | |
| max_rel_pos (`int`, *optional*, defaults to 128) : The maximum number of relative positions to be used in the self-attention mechanism. | |
| rel_pos_bins (`int`, *optional*, defaults to 32) : The number of relative position bins to be used in the self-attention mechanism. | |
| fast_qkv (`bool`, *optional*, defaults to `True`) : Whether or not to use a single matrix for the queries, keys, values in the self-attention layers. | |
| max_rel_2d_pos (`int`, *optional*, defaults to 256) : The maximum number of relative 2D positions in the self-attention mechanism. | |
| rel_2d_pos_bins (`int`, *optional*, defaults to 64) : The number of 2D relative position bins in the self-attention mechanism. | |
| convert_sync_batchnorm (`bool`, *optional*, defaults to `True`) : Whether or not to convert batch normalization layers to synchronized batch normalization layers. | |
| image_feature_pool_shape (`list[int]`, *optional*, defaults to `[7, 7, 256]`) : The shape of the average-pooled feature map. | |
| coordinate_size (`int`, *optional*, defaults to 128) : Dimension of the coordinate embeddings. | |
| shape_size (`int`, *optional*, defaults to 128) : Dimension of the width and height embeddings. | |
| has_relative_attention_bias (`bool`, *optional*, defaults to `True`) : Whether or not to use a relative attention bias in the self-attention mechanism. | |
| has_spatial_attention_bias (`bool`, *optional*, defaults to `True`) : Whether or not to use a spatial attention bias in the self-attention mechanism. | |
| has_visual_segment_embedding (`bool`, *optional*, defaults to `False`) : Whether or not to add visual segment embeddings. | |
| detectron2_config_args (`dict`, *optional*) : Dictionary containing the configuration arguments of the Detectron2 visual backbone. Refer to [this file](https://github.com/microsoft/unilm/blob/master/layoutlmft/layoutlmft/models/layoutlmv2/detectron2_config.py) for details regarding default values. | |
| ## LayoutLMv2ImageProcessor[[transformers.LayoutLMv2ImageProcessor]] | |
| #### transformers.LayoutLMv2ImageProcessor[[transformers.LayoutLMv2ImageProcessor]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/image_processing_layoutlmv2.py#L118) | |
| Constructs a LayoutLMv2ImageProcessor image processor. | |
| preprocesstransformers.LayoutLMv2ImageProcessor.preprocesshttps://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/image_processing_layoutlmv2.py#L131[{"name": "images", "val": ": typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]"}, {"name": "**kwargs", "val": ": typing_extensions.Unpack[transformers.models.layoutlmv2.image_processing_layoutlmv2.LayoutLMv2ImageProcessorKwargs]"}]- **images** (`Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list[PIL.Image.Image], list[numpy.ndarray], list[torch.Tensor]]`) -- | |
| Image to preprocess. Expects a single or batch of images with pixel values ranging from 0 to 255. If | |
| passing in images with pixel values between 0 and 1, set `do_rescale=False`. | |
| - **apply_ocr** (`bool`, *kwargs*, *optional*, defaults to `self.apply_ocr`) -- | |
| Whether to apply the Tesseract OCR engine to get words + normalized bounding boxes. Can be overridden by | |
| the `apply_ocr` parameter in the `preprocess` method. | |
| - **ocr_lang** (`str`, *kwargs*, *optional*) -- | |
| The language, specified by its ISO code, to be used by the Tesseract OCR engine. By default, English is | |
| used. Can be overridden by the `ocr_lang` parameter in the `preprocess` method. | |
| - **tesseract_config** (`str`, *kwargs*, *optional*) -- | |
| Any additional custom configuration flags that are forwarded to the `config` parameter when calling | |
| Tesseract. For example: '--psm 6'. Can be overridden by the `tesseract_config` parameter in the | |
| `preprocess` method. | |
| - **return_tensors** (`str` or [TensorType](/docs/transformers/pr_43838/en/internal/file_utils#transformers.TensorType), *optional*) -- | |
| Returns stacked tensors if set to `'pt'`, otherwise returns a list of tensors. | |
| - ****kwargs** ([ImagesKwargs](/docs/transformers/pr_43838/en/main_classes/processors#transformers.ImagesKwargs), *optional*) -- | |
| Additional image preprocessing options. Model-specific kwargs are listed above; see the TypedDict class | |
| for the complete list of supported arguments.0`~image_processing_base.BatchFeature`- **data** (`dict`) -- Dictionary of lists/arrays/tensors returned by the __call__ method ('pixel_values', etc.). | |
| - **tensor_type** (`Union[None, str, TensorType]`, *optional*) -- You can give a tensor_type here to convert the lists of integers in PyTorch/Numpy Tensors at | |
| initialization. | |
| **Parameters:** | |
| apply_ocr (`bool`, *kwargs*, *optional*, defaults to `self.apply_ocr`) : Whether to apply the Tesseract OCR engine to get words + normalized bounding boxes. Can be overridden by the `apply_ocr` parameter in the `preprocess` method. | |
| ocr_lang (`str`, *kwargs*, *optional*) : The language, specified by its ISO code, to be used by the Tesseract OCR engine. By default, English is used. Can be overridden by the `ocr_lang` parameter in the `preprocess` method. | |
| tesseract_config (`str`, *kwargs*, *optional*) : Any additional custom configuration flags that are forwarded to the `config` parameter when calling Tesseract. For example: '--psm 6'. Can be overridden by the `tesseract_config` parameter in the `preprocess` method. | |
| - ****kwargs** ([ImagesKwargs](/docs/transformers/pr_43838/en/main_classes/processors#transformers.ImagesKwargs), *optional*) : Additional image preprocessing options. Model-specific kwargs are listed above; see the TypedDict class for the complete list of supported arguments. | |
| **Returns:** | |
| ``~image_processing_base.BatchFeature`` | |
| - **data** (`dict`) -- Dictionary of lists/arrays/tensors returned by the __call__ method ('pixel_values', etc.). | |
| - **tensor_type** (`Union[None, str, TensorType]`, *optional*) -- You can give a tensor_type here to convert the lists of integers in PyTorch/Numpy Tensors at | |
| initialization. | |
| ## LayoutLMv2ImageProcessorPil[[transformers.LayoutLMv2ImageProcessorPil]] | |
| #### transformers.LayoutLMv2ImageProcessorPil[[transformers.LayoutLMv2ImageProcessorPil]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/image_processing_pil_layoutlmv2.py#L121) | |
| Constructs a LayoutLMv2ImageProcessor image processor. | |
| preprocesstransformers.LayoutLMv2ImageProcessorPil.preprocesshttps://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/image_processing_pil_layoutlmv2.py#L134[{"name": "images", "val": ": typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]"}, {"name": "**kwargs", "val": ": typing_extensions.Unpack[transformers.models.layoutlmv2.image_processing_pil_layoutlmv2.LayoutLMv2ImageProcessorKwargs]"}]- **images** (`Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list[PIL.Image.Image], list[numpy.ndarray], list[torch.Tensor]]`) -- | |
| Image to preprocess. Expects a single or batch of images with pixel values ranging from 0 to 255. If | |
| passing in images with pixel values between 0 and 1, set `do_rescale=False`. | |
| - **apply_ocr** (`bool`, *kwargs*, *optional*, defaults to `self.apply_ocr`) -- | |
| Whether to apply the Tesseract OCR engine to get words + normalized bounding boxes. Can be overridden by | |
| the `apply_ocr` parameter in the `preprocess` method. | |
| - **ocr_lang** (`str`, *kwargs*, *optional*) -- | |
| The language, specified by its ISO code, to be used by the Tesseract OCR engine. By default, English is | |
| used. Can be overridden by the `ocr_lang` parameter in the `preprocess` method. | |
| - **tesseract_config** (`str`, *kwargs*, *optional*) -- | |
| Any additional custom configuration flags that are forwarded to the `config` parameter when calling | |
| Tesseract. For example: '--psm 6'. Can be overridden by the `tesseract_config` parameter in the | |
| `preprocess` method. | |
| - **return_tensors** (`str` or [TensorType](/docs/transformers/pr_43838/en/internal/file_utils#transformers.TensorType), *optional*) -- | |
| Returns stacked tensors if set to `'pt'`, otherwise returns a list of tensors. | |
| - ****kwargs** ([ImagesKwargs](/docs/transformers/pr_43838/en/main_classes/processors#transformers.ImagesKwargs), *optional*) -- | |
| Additional image preprocessing options. Model-specific kwargs are listed above; see the TypedDict class | |
| for the complete list of supported arguments.0`~image_processing_base.BatchFeature`- **data** (`dict`) -- Dictionary of lists/arrays/tensors returned by the __call__ method ('pixel_values', etc.). | |
| - **tensor_type** (`Union[None, str, TensorType]`, *optional*) -- You can give a tensor_type here to convert the lists of integers in PyTorch/Numpy Tensors at | |
| initialization. | |
| **Parameters:** | |
| apply_ocr (`bool`, *kwargs*, *optional*, defaults to `self.apply_ocr`) : Whether to apply the Tesseract OCR engine to get words + normalized bounding boxes. Can be overridden by the `apply_ocr` parameter in the `preprocess` method. | |
| ocr_lang (`str`, *kwargs*, *optional*) : The language, specified by its ISO code, to be used by the Tesseract OCR engine. By default, English is used. Can be overridden by the `ocr_lang` parameter in the `preprocess` method. | |
| tesseract_config (`str`, *kwargs*, *optional*) : Any additional custom configuration flags that are forwarded to the `config` parameter when calling Tesseract. For example: '--psm 6'. Can be overridden by the `tesseract_config` parameter in the `preprocess` method. | |
| - ****kwargs** ([ImagesKwargs](/docs/transformers/pr_43838/en/main_classes/processors#transformers.ImagesKwargs), *optional*) : Additional image preprocessing options. Model-specific kwargs are listed above; see the TypedDict class for the complete list of supported arguments. | |
| **Returns:** | |
| ``~image_processing_base.BatchFeature`` | |
| - **data** (`dict`) -- Dictionary of lists/arrays/tensors returned by the __call__ method ('pixel_values', etc.). | |
| - **tensor_type** (`Union[None, str, TensorType]`, *optional*) -- You can give a tensor_type here to convert the lists of integers in PyTorch/Numpy Tensors at | |
| initialization. | |
| ## LayoutLMv2Tokenizer[[transformers.LayoutLMv2Tokenizer]] | |
| #### transformers.LayoutLMv2Tokenizer[[transformers.LayoutLMv2Tokenizer]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/tokenization_layoutlmv2.py#L112) | |
| Construct a "fast" LayoutLMv2 tokenizer (backed by HuggingFace's *tokenizers* library). Based on WordPiece. | |
| This tokenizer inherits from [PreTrainedTokenizerFast](/docs/transformers/pr_43838/en/main_classes/tokenizer#transformers.TokenizersBackend) which contains most of the main methods. Users should | |
| refer to this superclass for more information regarding those methods. | |
| __call__transformers.LayoutLMv2Tokenizer.__call__https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/tokenization_layoutlmv2.py#L243[{"name": "text", "val": ": str | list[str] | list[list[str]]"}, {"name": "text_pair", "val": ": list[str] | list[list[str]] | None = None"}, {"name": "boxes", "val": ": list[list[int]] | list[list[list[int]]] | None = None"}, {"name": "word_labels", "val": ": list[int] | list[list[int]] | None = None"}, {"name": "add_special_tokens", "val": ": bool = True"}, {"name": "padding", "val": ": bool | str | transformers.utils.generic.PaddingStrategy = False"}, {"name": "truncation", "val": ": bool | str | transformers.tokenization_utils_base.TruncationStrategy = None"}, {"name": "max_length", "val": ": int | None = None"}, {"name": "stride", "val": ": int = 0"}, {"name": "pad_to_multiple_of", "val": ": int | None = None"}, {"name": "padding_side", "val": ": str | None = None"}, {"name": "return_tensors", "val": ": str | transformers.utils.generic.TensorType | None = None"}, {"name": "return_token_type_ids", "val": ": bool | None = None"}, {"name": "return_attention_mask", "val": ": bool | None = None"}, {"name": "return_overflowing_tokens", "val": ": bool = False"}, {"name": "return_special_tokens_mask", "val": ": bool = False"}, {"name": "return_offsets_mapping", "val": ": bool = False"}, {"name": "return_length", "val": ": bool = False"}, {"name": "verbose", "val": ": bool = True"}, {"name": "**kwargs", "val": ""}]- **text** (`str`, `List[str]`, `List[List[str]]`) -- | |
| The sequence or batch of sequences to be encoded. Each sequence can be a string, a list of strings | |
| (words of a single example or questions of a batch of examples) or a list of list of strings (batch of | |
| words). | |
| - **text_pair** (`List[str]`, `List[List[str]]`) -- | |
| The sequence or batch of sequences to be encoded. Each sequence should be a list of strings | |
| (pretokenized string). | |
| - **boxes** (`List[List[int]]`, `List[List[List[int]]]`) -- | |
| Word-level bounding boxes. Each bounding box should be normalized to be on a 0-1000 scale. | |
| - **word_labels** (`List[int]`, `List[List[int]]`, *optional*) -- | |
| Word-level integer labels (for token classification tasks such as FUNSD, CORD). | |
| - **add_special_tokens** (`bool`, *optional*, defaults to `True`) -- | |
| Whether or not to encode the sequences with the special tokens relative to their model. | |
| - **padding** (`bool`, `str` or [PaddingStrategy](/docs/transformers/pr_43838/en/internal/file_utils#transformers.utils.PaddingStrategy), *optional*, defaults to `False`) -- | |
| Activates and controls padding. Accepts the following values: | |
| - `True` or `'longest'`: Pad to the longest sequence in the batch (or no padding if only a single | |
| sequence if provided). | |
| - `'max_length'`: Pad to a maximum length specified with the argument `max_length` or to the maximum | |
| acceptable input length for the model if that argument is not provided. | |
| - `False` or `'do_not_pad'` (default): No padding (i.e., can output a batch with sequences of different | |
| lengths). | |
| - **truncation** (`bool`, `str` or [TruncationStrategy](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.tokenization_utils_base.TruncationStrategy), *optional*, defaults to `False`) -- | |
| Activates and controls truncation. Accepts the following values: | |
| - `True` or `'longest_first'`: Truncate to a maximum length specified with the argument `max_length` or | |
| to the maximum acceptable input length for the model if that argument is not provided. This will | |
| truncate token by token, removing a token from the longest sequence in the pair if a pair of | |
| sequences (or a batch of pairs) is provided. | |
| - `'only_first'`: Truncate to a maximum length specified with the argument `max_length` or to the | |
| maximum acceptable input length for the model if that argument is not provided. This will only | |
| truncate the first sequence of a pair if a pair of sequences (or a batch of pairs) is provided. | |
| - `'only_second'`: Truncate to a maximum length specified with the argument `max_length` or to the | |
| maximum acceptable input length for the model if that argument is not provided. This will only | |
| truncate the second sequence of a pair if a pair of sequences (or a batch of pairs) is provided. | |
| - `False` or `'do_not_truncate'` (default): No truncation (i.e., can output batch with sequence lengths | |
| greater than the model maximum admissible input size). | |
| - **max_length** (`int`, *optional*) -- | |
| Controls the maximum length to use by one of the truncation/padding parameters. | |
| If left unset or set to `None`, this will use the predefined model maximum length if a maximum length | |
| is required by one of the truncation/padding parameters. If the model has no specific maximum input | |
| length (like XLNet) truncation/padding to a maximum length will be deactivated. | |
| - **stride** (`int`, *optional*, defaults to 0) -- | |
| If set to a number along with `max_length`, the overflowing tokens returned when | |
| `return_overflowing_tokens=True` will contain some tokens from the end of the truncated sequence | |
| returned to provide some overlap between truncated and overflowing sequences. The value of this | |
| argument defines the number of overlapping tokens. | |
| - **pad_to_multiple_of** (`int`, *optional*) -- | |
| If set will pad the sequence to a multiple of the provided value. This is especially useful to enable | |
| the use of Tensor Cores on NVIDIA hardware with compute capability `>= 7.5` (Volta). | |
| - **return_token_type_ids** (`bool`, *optional*) -- | |
| Whether to return token type IDs. If left to the default, will return the token type IDs according to | |
| the specific tokenizer's default, defined by the `return_outputs` attribute. | |
| [What are token type IDs?](../glossary#token-type-ids) | |
| - **return_attention_mask** (`bool`, *optional*) -- | |
| Whether to return the attention mask. If left to the default, will return the attention mask according | |
| to the specific tokenizer's default, defined by the `return_outputs` attribute. | |
| [What are attention masks?](../glossary#attention-mask) | |
| - **return_overflowing_tokens** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return overflowing token sequences. If a pair of sequences of input ids (or a batch | |
| of pairs) is provided with `truncation_strategy = longest_first` or `True`, an error is raised instead | |
| of returning overflowing tokens. | |
| - **return_special_tokens_mask** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return special tokens mask information. | |
| - **return_offsets_mapping** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return `(char_start, char_end)` for each token. | |
| This is only available on fast tokenizers inheriting from [PreTrainedTokenizerFast](/docs/transformers/pr_43838/en/main_classes/tokenizer#transformers.TokenizersBackend), if using | |
| Python's tokenizer, this method will raise `NotImplementedError`. | |
| - **return_length** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return the lengths of the encoded inputs. | |
| - **verbose** (`bool`, *optional*, defaults to `True`) -- | |
| Whether or not to print more information and warnings. | |
| - ****kwargs** -- passed to the `self.tokenize()` method0 | |
| Main method to tokenize and prepare for the model one or several sequence(s) or one or several pair(s) of | |
| sequences with word-level normalized bounding boxes and optional labels. | |
| **Parameters:** | |
| vocab_file (`str`) : File containing the vocabulary. | |
| do_lower_case (`bool`, *optional*, defaults to `True`) : Whether or not to lowercase the input when tokenizing. | |
| unk_token (`str`, *optional*, defaults to `"[UNK]"`) : The unknown token. A token that is not in the vocabulary cannot be converted to an ID and is set to be this token instead. | |
| sep_token (`str`, *optional*, defaults to `"[SEP]"`) : The separator token, which is used when building a sequence from multiple sequences, e.g. two sequences for sequence classification or for a text and a question for question answering. It is also used as the last token of a sequence built with special tokens. | |
| pad_token (`str`, *optional*, defaults to `"[PAD]"`) : The token used for padding, for example when batching sequences of different lengths. | |
| cls_token (`str`, *optional*, defaults to `"[CLS]"`) : The classifier token which is used when doing sequence classification (classification of the whole sequence instead of per-token classification). It is the first token of the sequence when built with special tokens. | |
| mask_token (`str`, *optional*, defaults to `"[MASK]"`) : The token used for masking values. This is the token used when training this model with masked language modeling. This is the token which the model will try to predict. | |
| cls_token_box (`List[int]`, *optional*, defaults to `[0, 0, 0, 0]`) : The bounding box to use for the special [CLS] token. | |
| sep_token_box (`List[int]`, *optional*, defaults to `[1000, 1000, 1000, 1000]`) : The bounding box to use for the special [SEP] token. | |
| pad_token_box (`List[int]`, *optional*, defaults to `[0, 0, 0, 0]`) : The bounding box to use for the special [PAD] token. | |
| pad_token_label (`int`, *optional*, defaults to -100) : The label to use for padding tokens. Defaults to -100, which is the `ignore_index` of PyTorch's CrossEntropyLoss. | |
| only_label_first_subword (`bool`, *optional*, defaults to `True`) : Whether or not to only label the first subword, in case word labels are provided. | |
| tokenize_chinese_chars (`bool`, *optional*, defaults to `True`) : Whether or not to tokenize Chinese characters. This should likely be deactivated for Japanese (see [this issue](https://github.com/huggingface/transformers/issues/328)). | |
| strip_accents (`bool`, *optional*) : Whether or not to strip all accents. If this option is not specified, then it will be determined by the value for `lowercase` (as in the original LayoutLMv2). | |
| #### save_vocabulary[[transformers.LayoutLMv2Tokenizer.save_vocabulary]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/tokenization_utils_tokenizers.py#L509) | |
| ## LayoutLMv2TokenizerFast[[transformers.LayoutLMv2Tokenizer]] | |
| #### transformers.LayoutLMv2Tokenizer[[transformers.LayoutLMv2Tokenizer]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/tokenization_layoutlmv2.py#L112) | |
| Construct a "fast" LayoutLMv2 tokenizer (backed by HuggingFace's *tokenizers* library). Based on WordPiece. | |
| This tokenizer inherits from [PreTrainedTokenizerFast](/docs/transformers/pr_43838/en/main_classes/tokenizer#transformers.TokenizersBackend) which contains most of the main methods. Users should | |
| refer to this superclass for more information regarding those methods. | |
| __call__transformers.LayoutLMv2Tokenizer.__call__https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/tokenization_layoutlmv2.py#L243[{"name": "text", "val": ": str | list[str] | list[list[str]]"}, {"name": "text_pair", "val": ": list[str] | list[list[str]] | None = None"}, {"name": "boxes", "val": ": list[list[int]] | list[list[list[int]]] | None = None"}, {"name": "word_labels", "val": ": list[int] | list[list[int]] | None = None"}, {"name": "add_special_tokens", "val": ": bool = True"}, {"name": "padding", "val": ": bool | str | transformers.utils.generic.PaddingStrategy = False"}, {"name": "truncation", "val": ": bool | str | transformers.tokenization_utils_base.TruncationStrategy = None"}, {"name": "max_length", "val": ": int | None = None"}, {"name": "stride", "val": ": int = 0"}, {"name": "pad_to_multiple_of", "val": ": int | None = None"}, {"name": "padding_side", "val": ": str | None = None"}, {"name": "return_tensors", "val": ": str | transformers.utils.generic.TensorType | None = None"}, {"name": "return_token_type_ids", "val": ": bool | None = None"}, {"name": "return_attention_mask", "val": ": bool | None = None"}, {"name": "return_overflowing_tokens", "val": ": bool = False"}, {"name": "return_special_tokens_mask", "val": ": bool = False"}, {"name": "return_offsets_mapping", "val": ": bool = False"}, {"name": "return_length", "val": ": bool = False"}, {"name": "verbose", "val": ": bool = True"}, {"name": "**kwargs", "val": ""}]- **text** (`str`, `List[str]`, `List[List[str]]`) -- | |
| The sequence or batch of sequences to be encoded. Each sequence can be a string, a list of strings | |
| (words of a single example or questions of a batch of examples) or a list of list of strings (batch of | |
| words). | |
| - **text_pair** (`List[str]`, `List[List[str]]`) -- | |
| The sequence or batch of sequences to be encoded. Each sequence should be a list of strings | |
| (pretokenized string). | |
| - **boxes** (`List[List[int]]`, `List[List[List[int]]]`) -- | |
| Word-level bounding boxes. Each bounding box should be normalized to be on a 0-1000 scale. | |
| - **word_labels** (`List[int]`, `List[List[int]]`, *optional*) -- | |
| Word-level integer labels (for token classification tasks such as FUNSD, CORD). | |
| - **add_special_tokens** (`bool`, *optional*, defaults to `True`) -- | |
| Whether or not to encode the sequences with the special tokens relative to their model. | |
| - **padding** (`bool`, `str` or [PaddingStrategy](/docs/transformers/pr_43838/en/internal/file_utils#transformers.utils.PaddingStrategy), *optional*, defaults to `False`) -- | |
| Activates and controls padding. Accepts the following values: | |
| - `True` or `'longest'`: Pad to the longest sequence in the batch (or no padding if only a single | |
| sequence if provided). | |
| - `'max_length'`: Pad to a maximum length specified with the argument `max_length` or to the maximum | |
| acceptable input length for the model if that argument is not provided. | |
| - `False` or `'do_not_pad'` (default): No padding (i.e., can output a batch with sequences of different | |
| lengths). | |
| - **truncation** (`bool`, `str` or [TruncationStrategy](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.tokenization_utils_base.TruncationStrategy), *optional*, defaults to `False`) -- | |
| Activates and controls truncation. Accepts the following values: | |
| - `True` or `'longest_first'`: Truncate to a maximum length specified with the argument `max_length` or | |
| to the maximum acceptable input length for the model if that argument is not provided. This will | |
| truncate token by token, removing a token from the longest sequence in the pair if a pair of | |
| sequences (or a batch of pairs) is provided. | |
| - `'only_first'`: Truncate to a maximum length specified with the argument `max_length` or to the | |
| maximum acceptable input length for the model if that argument is not provided. This will only | |
| truncate the first sequence of a pair if a pair of sequences (or a batch of pairs) is provided. | |
| - `'only_second'`: Truncate to a maximum length specified with the argument `max_length` or to the | |
| maximum acceptable input length for the model if that argument is not provided. This will only | |
| truncate the second sequence of a pair if a pair of sequences (or a batch of pairs) is provided. | |
| - `False` or `'do_not_truncate'` (default): No truncation (i.e., can output batch with sequence lengths | |
| greater than the model maximum admissible input size). | |
| - **max_length** (`int`, *optional*) -- | |
| Controls the maximum length to use by one of the truncation/padding parameters. | |
| If left unset or set to `None`, this will use the predefined model maximum length if a maximum length | |
| is required by one of the truncation/padding parameters. If the model has no specific maximum input | |
| length (like XLNet) truncation/padding to a maximum length will be deactivated. | |
| - **stride** (`int`, *optional*, defaults to 0) -- | |
| If set to a number along with `max_length`, the overflowing tokens returned when | |
| `return_overflowing_tokens=True` will contain some tokens from the end of the truncated sequence | |
| returned to provide some overlap between truncated and overflowing sequences. The value of this | |
| argument defines the number of overlapping tokens. | |
| - **pad_to_multiple_of** (`int`, *optional*) -- | |
| If set will pad the sequence to a multiple of the provided value. This is especially useful to enable | |
| the use of Tensor Cores on NVIDIA hardware with compute capability `>= 7.5` (Volta). | |
| - **return_token_type_ids** (`bool`, *optional*) -- | |
| Whether to return token type IDs. If left to the default, will return the token type IDs according to | |
| the specific tokenizer's default, defined by the `return_outputs` attribute. | |
| [What are token type IDs?](../glossary#token-type-ids) | |
| - **return_attention_mask** (`bool`, *optional*) -- | |
| Whether to return the attention mask. If left to the default, will return the attention mask according | |
| to the specific tokenizer's default, defined by the `return_outputs` attribute. | |
| [What are attention masks?](../glossary#attention-mask) | |
| - **return_overflowing_tokens** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return overflowing token sequences. If a pair of sequences of input ids (or a batch | |
| of pairs) is provided with `truncation_strategy = longest_first` or `True`, an error is raised instead | |
| of returning overflowing tokens. | |
| - **return_special_tokens_mask** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return special tokens mask information. | |
| - **return_offsets_mapping** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return `(char_start, char_end)` for each token. | |
| This is only available on fast tokenizers inheriting from [PreTrainedTokenizerFast](/docs/transformers/pr_43838/en/main_classes/tokenizer#transformers.TokenizersBackend), if using | |
| Python's tokenizer, this method will raise `NotImplementedError`. | |
| - **return_length** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return the lengths of the encoded inputs. | |
| - **verbose** (`bool`, *optional*, defaults to `True`) -- | |
| Whether or not to print more information and warnings. | |
| - ****kwargs** -- passed to the `self.tokenize()` method0 | |
| Main method to tokenize and prepare for the model one or several sequence(s) or one or several pair(s) of | |
| sequences with word-level normalized bounding boxes and optional labels. | |
| **Parameters:** | |
| vocab_file (`str`) : File containing the vocabulary. | |
| do_lower_case (`bool`, *optional*, defaults to `True`) : Whether or not to lowercase the input when tokenizing. | |
| unk_token (`str`, *optional*, defaults to `"[UNK]"`) : The unknown token. A token that is not in the vocabulary cannot be converted to an ID and is set to be this token instead. | |
| sep_token (`str`, *optional*, defaults to `"[SEP]"`) : The separator token, which is used when building a sequence from multiple sequences, e.g. two sequences for sequence classification or for a text and a question for question answering. It is also used as the last token of a sequence built with special tokens. | |
| pad_token (`str`, *optional*, defaults to `"[PAD]"`) : The token used for padding, for example when batching sequences of different lengths. | |
| cls_token (`str`, *optional*, defaults to `"[CLS]"`) : The classifier token which is used when doing sequence classification (classification of the whole sequence instead of per-token classification). It is the first token of the sequence when built with special tokens. | |
| mask_token (`str`, *optional*, defaults to `"[MASK]"`) : The token used for masking values. This is the token used when training this model with masked language modeling. This is the token which the model will try to predict. | |
| cls_token_box (`List[int]`, *optional*, defaults to `[0, 0, 0, 0]`) : The bounding box to use for the special [CLS] token. | |
| sep_token_box (`List[int]`, *optional*, defaults to `[1000, 1000, 1000, 1000]`) : The bounding box to use for the special [SEP] token. | |
| pad_token_box (`List[int]`, *optional*, defaults to `[0, 0, 0, 0]`) : The bounding box to use for the special [PAD] token. | |
| pad_token_label (`int`, *optional*, defaults to -100) : The label to use for padding tokens. Defaults to -100, which is the `ignore_index` of PyTorch's CrossEntropyLoss. | |
| only_label_first_subword (`bool`, *optional*, defaults to `True`) : Whether or not to only label the first subword, in case word labels are provided. | |
| tokenize_chinese_chars (`bool`, *optional*, defaults to `True`) : Whether or not to tokenize Chinese characters. This should likely be deactivated for Japanese (see [this issue](https://github.com/huggingface/transformers/issues/328)). | |
| strip_accents (`bool`, *optional*) : Whether or not to strip all accents. If this option is not specified, then it will be determined by the value for `lowercase` (as in the original LayoutLMv2). | |
| ## LayoutLMv2Processor[[transformers.LayoutLMv2Processor]] | |
| #### transformers.LayoutLMv2Processor[[transformers.LayoutLMv2Processor]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/processing_layoutlmv2.py#L24) | |
| Constructs a LayoutLMv2Processor which wraps a image processor and a tokenizer into a single processor. | |
| [LayoutLMv2Processor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Processor) offers all the functionalities of [LayoutLMv2ImageProcessor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ImageProcessor) and [LayoutLMv2Tokenizer](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Tokenizer). See the | |
| [~LayoutLMv2ImageProcessor](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ImageProcessor) and [~LayoutLMv2Tokenizer](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Tokenizer) for more information. | |
| __call__transformers.LayoutLMv2Processor.__call__https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/processing_layoutlmv2.py#L28[{"name": "images", "val": ""}, {"name": "text", "val": ": str | list[str] | list[list[str]] = None"}, {"name": "text_pair", "val": ": list[str] | list[list[str]] | None = None"}, {"name": "boxes", "val": ": list[list[int]] | list[list[list[int]]] | None = None"}, {"name": "word_labels", "val": ": list[int] | list[list[int]] | None = None"}, {"name": "add_special_tokens", "val": ": bool = True"}, {"name": "padding", "val": ": bool | str | transformers.utils.generic.PaddingStrategy = False"}, {"name": "truncation", "val": ": bool | str | transformers.tokenization_utils_base.TruncationStrategy = False"}, {"name": "max_length", "val": ": int | None = None"}, {"name": "stride", "val": ": int = 0"}, {"name": "pad_to_multiple_of", "val": ": int | None = None"}, {"name": "return_token_type_ids", "val": ": bool | None = None"}, {"name": "return_attention_mask", "val": ": bool | None = None"}, {"name": "return_overflowing_tokens", "val": ": bool = False"}, {"name": "return_special_tokens_mask", "val": ": bool = False"}, {"name": "return_offsets_mapping", "val": ": bool = False"}, {"name": "return_length", "val": ": bool = False"}, {"name": "verbose", "val": ": bool = True"}, {"name": "return_tensors", "val": ": str | transformers.utils.generic.TensorType | None = None"}, {"name": "**kwargs", "val": ""}]- **images** (``) -- | |
| Image to preprocess. Expects a single or batch of images with pixel values ranging from 0 to 255. If | |
| passing in images with pixel values between 0 and 1, set `do_rescale=False`. | |
| - **text** (`Union[str, list[str], list[list[str]]]`, *optional*) -- | |
| The sequence or batch of sequences to be encoded. Each sequence can be a string or a list of strings | |
| (pretokenized string). If you pass a pretokenized input, set `is_split_into_words=True` to avoid ambiguity with batched inputs. | |
| - **text_pair** (`str, list[str] or list[int]`, *optional*) -- | |
| Optional second sequence to be encoded. This can be a string, a list of strings (tokenized string using | |
| the `tokenize` method) or a list of integers (tokenized string ids using the `convert_tokens_to_ids` | |
| method). | |
| - **boxes** (`list[list[int]] or list[list[list[int]]]`, *optional*) -- | |
| Word-level bounding boxes. Each bounding box should be normalized to be on a 0-1000 scale. | |
| - **word_labels** (`list[int] or list[list[int]]`, *optional*) -- | |
| Word-level integer labels (for token classification tasks such as FUNSD, CORD). | |
| - **add_special_tokens** (`bool`, *optional*, defaults to `True`) -- | |
| Whether or not to add special tokens when encoding the sequences. This will use the underlying | |
| `PretrainedTokenizerBase.build_inputs_with_special_tokens` function, which defines which tokens are | |
| automatically added to the input ids. This is useful if you want to add `bos` or `eos` tokens | |
| automatically. | |
| - **padding** (bool, str or [PaddingStrategy](/docs/transformers/pr_43838/en/internal/file_utils#transformers.utils.PaddingStrategy), *optional*, defaults to `False`) -- | |
| Activates and controls padding. Accepts the following values: | |
| - `True` or `'longest'`: Pad to the longest sequence in the batch (or no padding if only a single | |
| sequence is provided). | |
| - `'max_length'`: Pad to a maximum length specified with the argument `max_length` or to the maximum | |
| acceptable input length for the model if that argument is not provided. | |
| - `False` or `'do_not_pad'` (default): No padding (i.e., can output a batch with sequences of different | |
| lengths). | |
| - **truncation** (bool, str or [TruncationStrategy](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.tokenization_utils_base.TruncationStrategy), *optional*, defaults to `False`) -- | |
| Activates and controls truncation. Accepts the following values: | |
| - `True` or `'longest_first'`: Truncate to a maximum length specified with the argument `max_length` or | |
| to the maximum acceptable input length for the model if that argument is not provided. This will | |
| truncate token by token, removing a token from the longest sequence in the pair if a pair of | |
| sequences (or a batch of pairs) is provided. | |
| - `'only_first'`: Truncate to a maximum length specified with the argument `max_length` or to the | |
| maximum acceptable input length for the model if that argument is not provided. This will only | |
| truncate the first sequence of a pair if a pair of sequences (or a batch of pairs) is provided. | |
| - `'only_second'`: Truncate to a maximum length specified with the argument `max_length` or to the | |
| maximum acceptable input length for the model if that argument is not provided. This will only | |
| truncate the second sequence of a pair if a pair of sequences (or a batch of pairs) is provided. | |
| - `False` or `'do_not_truncate'` (default): No truncation (i.e., can output batch with sequence lengths | |
| greater than the model maximum admissible input size). | |
| - **max_length** (`int`, *optional*) -- | |
| Controls the maximum length to use by one of the truncation/padding parameters. | |
| If left unset or set to `None`, this will use the predefined model maximum length if a maximum length | |
| is required by one of the truncation/padding parameters. If the model has no specific maximum input | |
| length (like XLNet) truncation/padding to a maximum length will be deactivated. | |
| - **stride** (`int`, *optional*, defaults to `0`) -- | |
| If set to a number along with `max_length`, the overflowing tokens returned when | |
| `return_overflowing_tokens=True` will contain some tokens from the end of the truncated sequence | |
| returned to provide some overlap between truncated and overflowing sequences. The value of this | |
| argument defines the number of overlapping tokens. | |
| - **pad_to_multiple_of** (`int`, *optional*) -- | |
| If set will pad the sequence to a multiple of the provided value. Requires `padding` to be activated. | |
| This is especially useful to enable using Tensor Cores on NVIDIA hardware with compute capability | |
| `>= 7.5` (Volta). | |
| - **return_token_type_ids** (`bool`, *optional*) -- | |
| Whether to return token type IDs. If left to the default, will return the token type IDs according to | |
| the specific tokenizer's default, defined by the `return_outputs` attribute. | |
| [What are token type IDs?](../glossary#token-type-ids) | |
| - **return_attention_mask** (`bool`, *optional*) -- | |
| Whether to return the attention mask. If left to the default, will return the attention mask according | |
| to the specific tokenizer's default, defined by the `return_outputs` attribute. | |
| [What are attention masks?](../glossary#attention-mask) | |
| - **return_overflowing_tokens** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return overflowing token sequences. If a pair of sequences of input ids (or a batch | |
| of pairs) is provided with `truncation_strategy = longest_first` or `True`, an error is raised instead | |
| of returning overflowing tokens. | |
| - **return_special_tokens_mask** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return special tokens mask information. | |
| - **return_offsets_mapping** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return `(char_start, char_end)` for each token. | |
| This is only available on fast tokenizers inheriting from [PreTrainedTokenizerFast](/docs/transformers/pr_43838/en/main_classes/tokenizer#transformers.TokenizersBackend), if using | |
| Python's tokenizer, this method will raise `NotImplementedError`. | |
| - **return_length** (`bool`, *optional*, defaults to `False`) -- | |
| Whether or not to return the lengths of the encoded inputs. | |
| - **verbose** (`bool`, *optional*, defaults to `True`) -- | |
| Whether or not to print more information and warnings. | |
| - **return_tensors** (`Union[str, ~utils.generic.TensorType]`, *optional*) -- | |
| If set, will return tensors of a particular framework. Acceptable values are: | |
| - `'pt'`: Return PyTorch `torch.Tensor` objects. | |
| - `'np'`: Return NumPy `np.ndarray` objects.0`~tokenization_utils_base.BatchEncoding`- **data** (`dict`, *optional*) -- Dictionary of lists/arrays/tensors returned by the `__call__`/`encode_plus`/`batch_encode_plus` methods | |
| ('input_ids', 'attention_mask', etc.). | |
| - **encoding** (`tokenizers.Encoding` or `Sequence[tokenizers.Encoding]`, *optional*) -- If the tokenizer is a fast tokenizer which outputs additional information like mapping from word/character | |
| space to token space the `tokenizers.Encoding` instance or list of instance (for batches) hold this | |
| information. | |
| - **tensor_type** (`Union[None, str, TensorType]`, *optional*) -- You can give a tensor_type here to convert the lists of integers in PyTorch/Numpy Tensors at | |
| initialization. | |
| - **prepend_batch_axis** (`bool`, *optional*, defaults to `False`) -- Whether or not to add a batch axis when converting to tensors (see `tensor_type` above). Note that this | |
| parameter has an effect if the parameter `tensor_type` is set, *otherwise has no effect*. | |
| - **n_sequences** (`int`, *optional*) -- You can give a tensor_type here to convert the lists of integers in PyTorch/Numpy Tensors at | |
| initialization. | |
| **Parameters:** | |
| image_processor (`LayoutLMv2ImageProcessor`) : The image processor is a required input. | |
| tokenizer (`LayoutLMv2Tokenizer`) : The tokenizer is a required input. | |
| **Returns:** | |
| ``~tokenization_utils_base.BatchEncoding`` | |
| - **data** (`dict`, *optional*) -- Dictionary of lists/arrays/tensors returned by the `__call__`/`encode_plus`/`batch_encode_plus` methods | |
| ('input_ids', 'attention_mask', etc.). | |
| - **encoding** (`tokenizers.Encoding` or `Sequence[tokenizers.Encoding]`, *optional*) -- If the tokenizer is a fast tokenizer which outputs additional information like mapping from word/character | |
| space to token space the `tokenizers.Encoding` instance or list of instance (for batches) hold this | |
| information. | |
| - **tensor_type** (`Union[None, str, TensorType]`, *optional*) -- You can give a tensor_type here to convert the lists of integers in PyTorch/Numpy Tensors at | |
| initialization. | |
| - **prepend_batch_axis** (`bool`, *optional*, defaults to `False`) -- Whether or not to add a batch axis when converting to tensors (see `tensor_type` above). Note that this | |
| parameter has an effect if the parameter `tensor_type` is set, *otherwise has no effect*. | |
| - **n_sequences** (`int`, *optional*) -- You can give a tensor_type here to convert the lists of integers in PyTorch/Numpy Tensors at | |
| initialization. | |
| ## LayoutLMv2Model[[transformers.LayoutLMv2Model]] | |
| #### transformers.LayoutLMv2Model[[transformers.LayoutLMv2Model]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/modeling_layoutlmv2.py#L559) | |
| The bare Layoutlmv2 Model outputting raw hidden-states without any specific head on top. | |
| This model inherits from [PreTrainedModel](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel). Check the superclass documentation for the generic methods the | |
| library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads | |
| etc.) | |
| This model is also a PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) subclass. | |
| Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage | |
| and behavior. | |
| forwardtransformers.LayoutLMv2Model.forwardhttps://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/modeling_layoutlmv2.py#L671[{"name": "input_ids", "val": ": torch.LongTensor | None = None"}, {"name": "bbox", "val": ": torch.LongTensor | None = None"}, {"name": "image", "val": ": torch.FloatTensor | None = None"}, {"name": "attention_mask", "val": ": torch.FloatTensor | None = None"}, {"name": "token_type_ids", "val": ": torch.LongTensor | None = None"}, {"name": "position_ids", "val": ": torch.LongTensor | None = None"}, {"name": "inputs_embeds", "val": ": torch.FloatTensor | None = None"}, {"name": "**kwargs", "val": ": typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs]"}]- **input_ids** (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*) -- | |
| Indices of input sequence tokens in the vocabulary. Padding will be ignored by default. | |
| Indices can be obtained using [AutoTokenizer](/docs/transformers/pr_43838/en/model_doc/auto#transformers.AutoTokenizer). See [PreTrainedTokenizer.encode()](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) and | |
| [PreTrainedTokenizer.__call__()](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) for details. | |
| [What are input IDs?](../glossary#input-ids) | |
| - **bbox** (`torch.LongTensor` of shape `((batch_size, sequence_length), 4)`, *optional*) -- | |
| Bounding boxes of each input sequence tokens. Selected in the range `[0, | |
| config.max_2d_position_embeddings-1]`. Each bounding box should be a normalized version in (x0, y0, x1, y1) | |
| format, where (x0, y0) corresponds to the position of the upper left corner in the bounding box, and (x1, | |
| y1) represents the position of the lower right corner. | |
| - **image** (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)` or `detectron.structures.ImageList` whose `tensors` is of shape `(batch_size, num_channels, height, width)`) -- | |
| Batch of document images. | |
| - **attention_mask** (`torch.FloatTensor` of shape `(batch_size, sequence_length)`, *optional*) -- | |
| Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`: | |
| - 1 for tokens that are **not masked**, | |
| - 0 for tokens that are **masked**. | |
| [What are attention masks?](../glossary#attention-mask) | |
| - **token_type_ids** (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*) -- | |
| Segment token indices to indicate first and second portions of the inputs. Indices are selected in `[0, 1]`: | |
| - 0 corresponds to a *sentence A* token, | |
| - 1 corresponds to a *sentence B* token. | |
| [What are token type IDs?](../glossary#token-type-ids) | |
| - **position_ids** (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*) -- | |
| Indices of positions of each input sequence tokens in the position embeddings. Selected in the range `[0, config.n_positions - 1]`. | |
| [What are position IDs?](../glossary#position-ids) | |
| - **inputs_embeds** (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`, *optional*) -- | |
| Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This | |
| is useful if you want more control over how to convert `input_ids` indices into associated vectors than the | |
| model's internal embedding lookup matrix.0[BaseModelOutputWithPooling](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPooling) or `tuple(torch.FloatTensor)`A [BaseModelOutputWithPooling](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPooling) or a tuple of | |
| `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various | |
| elements depending on the configuration ([LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config)) and inputs. | |
| The [LayoutLMv2Model](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Model) forward method, overrides the `__call__` special method. | |
| Although the recipe for forward pass needs to be defined within this function, one should call the `Module` | |
| instance afterwards instead of this since the former takes care of running the pre and post processing steps while | |
| the latter silently ignores them. | |
| - **last_hidden_state** (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`) -- Sequence of hidden-states at the output of the last layer of the model. | |
| - **pooler_output** (`torch.FloatTensor` of shape `(batch_size, hidden_size)`) -- Last layer hidden-state of the first token of the sequence (classification token) after further processing | |
| through the layers used for the auxiliary pretraining task. E.g. for BERT-family of models, this returns | |
| the classification token after processing through a linear layer and a tanh activation function. The linear | |
| layer weights are trained from the next sentence prediction (classification) objective during pretraining. | |
| - **hidden_states** (`tuple(torch.FloatTensor)`, *optional*, returned when `output_hidden_states=True` is passed or when `config.output_hidden_states=True`) -- Tuple of `torch.FloatTensor` (one for the output of the embeddings, if the model has an embedding layer, + | |
| one for the output of each layer) of shape `(batch_size, sequence_length, hidden_size)`. | |
| Hidden-states of the model at the output of each layer plus the optional initial embedding outputs. | |
| - **attentions** (`tuple(torch.FloatTensor)`, *optional*, returned when `output_attentions=True` is passed or when `config.output_attentions=True`) -- Tuple of `torch.FloatTensor` (one for each layer) of shape `(batch_size, num_heads, sequence_length, | |
| sequence_length)`. | |
| Attentions weights after the attention softmax, used to compute the weighted average in the self-attention | |
| heads. | |
| Examples: | |
| ```python | |
| >>> from transformers import AutoProcessor, LayoutLMv2Model, set_seed | |
| >>> from PIL import Image | |
| >>> import torch | |
| >>> from datasets import load_dataset | |
| >>> set_seed(0) | |
| >>> processor = AutoProcessor.from_pretrained("microsoft/layoutlmv2-base-uncased") | |
| >>> model = LayoutLMv2Model.from_pretrained("microsoft/layoutlmv2-base-uncased") | |
| >>> dataset = load_dataset("hf-internal-testing/fixtures_docvqa") | |
| >>> image = dataset["test"][0]["image"] | |
| >>> encoding = processor(image, return_tensors="pt") | |
| >>> outputs = model(**encoding) | |
| >>> last_hidden_states = outputs.last_hidden_state | |
| >>> last_hidden_states.shape | |
| torch.Size([1, 342, 768]) | |
| ``` | |
| **Parameters:** | |
| config ([LayoutLMv2Model](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Model)) : Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the [from_pretrained()](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel.from_pretrained) method to load the model weights. | |
| **Returns:** | |
| `[BaseModelOutputWithPooling](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPooling) or `tuple(torch.FloatTensor)`` | |
| A [BaseModelOutputWithPooling](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.BaseModelOutputWithPooling) or a tuple of | |
| `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various | |
| elements depending on the configuration ([LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config)) and inputs. | |
| ## LayoutLMv2ForSequenceClassification[[transformers.LayoutLMv2ForSequenceClassification]] | |
| #### transformers.LayoutLMv2ForSequenceClassification[[transformers.LayoutLMv2ForSequenceClassification]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/modeling_layoutlmv2.py#L800) | |
| LayoutLMv2 Model with a sequence classification head on top (a linear layer on top of the concatenation of the | |
| final hidden state of the [CLS] token, average-pooled initial visual embeddings and average-pooled final visual | |
| embeddings, e.g. for document image classification tasks such as the | |
| [RVL-CDIP](https://www.cs.cmu.edu/~aharley/rvl-cdip/) dataset. | |
| This model inherits from [PreTrainedModel](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel). Check the superclass documentation for the generic methods the | |
| library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads | |
| etc.) | |
| This model is also a PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) subclass. | |
| Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage | |
| and behavior. | |
| forwardtransformers.LayoutLMv2ForSequenceClassification.forwardhttps://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/modeling_layoutlmv2.py#L814[{"name": "input_ids", "val": ": torch.LongTensor | None = None"}, {"name": "bbox", "val": ": torch.LongTensor | None = None"}, {"name": "image", "val": ": torch.FloatTensor | None = None"}, {"name": "attention_mask", "val": ": torch.FloatTensor | None = None"}, {"name": "token_type_ids", "val": ": torch.LongTensor | None = None"}, {"name": "position_ids", "val": ": torch.LongTensor | None = None"}, {"name": "inputs_embeds", "val": ": torch.FloatTensor | None = None"}, {"name": "labels", "val": ": torch.LongTensor | None = None"}, {"name": "**kwargs", "val": ": typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs]"}]- **input_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`) -- | |
| Indices of input sequence tokens in the vocabulary. | |
| Indices can be obtained using [AutoTokenizer](/docs/transformers/pr_43838/en/model_doc/auto#transformers.AutoTokenizer). See [PreTrainedTokenizer.encode()](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) and | |
| [PreTrainedTokenizer.__call__()](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) for details. | |
| [What are input IDs?](../glossary#input-ids) | |
| - **bbox** (`torch.LongTensor` of shape `(batch_size, sequence_length, 4)`, *optional*) -- | |
| Bounding boxes of each input sequence tokens. Selected in the range `[0, | |
| config.max_2d_position_embeddings-1]`. Each bounding box should be a normalized version in (x0, y0, x1, y1) | |
| format, where (x0, y0) corresponds to the position of the upper left corner in the bounding box, and (x1, | |
| y1) represents the position of the lower right corner. | |
| - **image** (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)` or `detectron.structures.ImageList` whose `tensors` is of shape `(batch_size, num_channels, height, width)`) -- | |
| Batch of document images. | |
| - **attention_mask** (`torch.FloatTensor` of shape `(batch_size, sequence_length)`, *optional*) -- | |
| Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`: | |
| - 1 for tokens that are **not masked**, | |
| - 0 for tokens that are **masked**. | |
| [What are attention masks?](../glossary#attention-mask) | |
| - **token_type_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`, *optional*) -- | |
| Segment token indices to indicate first and second portions of the inputs. Indices are selected in `[0, | |
| 1]`: | |
| - 0 corresponds to a *sentence A* token, | |
| - 1 corresponds to a *sentence B* token. | |
| [What are token type IDs?](../glossary#token-type-ids) | |
| - **position_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`, *optional*) -- | |
| Indices of positions of each input sequence tokens in the position embeddings. Selected in the range `[0, | |
| config.max_position_embeddings - 1]`. | |
| [What are position IDs?](../glossary#position-ids) | |
| - **inputs_embeds** (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`, *optional*) -- | |
| Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This | |
| is useful if you want more control over how to convert `input_ids` indices into associated vectors than the | |
| model's internal embedding lookup matrix. | |
| - **labels** (`torch.LongTensor` of shape `(batch_size,)`, *optional*) -- | |
| Labels for computing the sequence classification/regression loss. Indices should be in `[0, ..., | |
| config.num_labels - 1]`. If `config.num_labels == 1` a regression loss is computed (Mean-Square loss), If | |
| `config.num_labels > 1` a classification loss is computed (Cross-Entropy).0[SequenceClassifierOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.SequenceClassifierOutput) or `tuple(torch.FloatTensor)`A [SequenceClassifierOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.SequenceClassifierOutput) or a tuple of | |
| `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various | |
| elements depending on the configuration ([LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config)) and inputs. | |
| The [LayoutLMv2ForSequenceClassification](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ForSequenceClassification) forward method, overrides the `__call__` special method. | |
| Although the recipe for forward pass needs to be defined within this function, one should call the `Module` | |
| instance afterwards instead of this since the former takes care of running the pre and post processing steps while | |
| the latter silently ignores them. | |
| - **loss** (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `labels` is provided) -- Classification (or regression if config.num_labels==1) loss. | |
| - **logits** (`torch.FloatTensor` of shape `(batch_size, config.num_labels)`) -- Classification (or regression if config.num_labels==1) scores (before SoftMax). | |
| - **hidden_states** (`tuple(torch.FloatTensor)`, *optional*, returned when `output_hidden_states=True` is passed or when `config.output_hidden_states=True`) -- Tuple of `torch.FloatTensor` (one for the output of the embeddings, if the model has an embedding layer, + | |
| one for the output of each layer) of shape `(batch_size, sequence_length, hidden_size)`. | |
| Hidden-states of the model at the output of each layer plus the optional initial embedding outputs. | |
| - **attentions** (`tuple(torch.FloatTensor)`, *optional*, returned when `output_attentions=True` is passed or when `config.output_attentions=True`) -- Tuple of `torch.FloatTensor` (one for each layer) of shape `(batch_size, num_heads, sequence_length, | |
| sequence_length)`. | |
| Attentions weights after the attention softmax, used to compute the weighted average in the self-attention | |
| heads. | |
| Example: | |
| ```python | |
| >>> from transformers import AutoProcessor, LayoutLMv2ForSequenceClassification, set_seed | |
| >>> from PIL import Image | |
| >>> import torch | |
| >>> from datasets import load_dataset | |
| >>> set_seed(0) | |
| >>> dataset = load_dataset("aharley/rvl_cdip", split="train", streaming=True) | |
| >>> data = next(iter(dataset)) | |
| >>> image = data["image"].convert("RGB") | |
| >>> processor = AutoProcessor.from_pretrained("microsoft/layoutlmv2-base-uncased") | |
| >>> model = LayoutLMv2ForSequenceClassification.from_pretrained( | |
| ... "microsoft/layoutlmv2-base-uncased", num_labels=dataset.info.features["label"].num_classes | |
| ... ) | |
| >>> encoding = processor(image, return_tensors="pt") | |
| >>> sequence_label = torch.tensor([data["label"]]) | |
| >>> outputs = model(**encoding, labels=sequence_label) | |
| >>> loss, logits = outputs.loss, outputs.logits | |
| >>> predicted_idx = logits.argmax(dim=-1).item() | |
| >>> predicted_answer = dataset.info.features["label"].names[4] | |
| >>> predicted_idx, predicted_answer # results are not good without further fine-tuning | |
| (7, 'advertisement') | |
| ``` | |
| **Parameters:** | |
| config ([LayoutLMv2ForSequenceClassification](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ForSequenceClassification)) : Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the [from_pretrained()](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel.from_pretrained) method to load the model weights. | |
| **Returns:** | |
| `[SequenceClassifierOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.SequenceClassifierOutput) or `tuple(torch.FloatTensor)`` | |
| A [SequenceClassifierOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.SequenceClassifierOutput) or a tuple of | |
| `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various | |
| elements depending on the configuration ([LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config)) and inputs. | |
| ## LayoutLMv2ForTokenClassification[[transformers.LayoutLMv2ForTokenClassification]] | |
| #### transformers.LayoutLMv2ForTokenClassification[[transformers.LayoutLMv2ForTokenClassification]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/modeling_layoutlmv2.py#L998) | |
| LayoutLMv2 Model with a token classification head on top (a linear layer on top of the text part of the hidden | |
| states) e.g. for sequence labeling (information extraction) tasks such as | |
| [FUNSD](https://guillaumejaume.github.io/FUNSD/), [SROIE](https://rrc.cvc.uab.es/?ch=13), | |
| [CORD](https://github.com/clovaai/cord) and [Kleister-NDA](https://github.com/applicaai/kleister-nda). | |
| This model inherits from [PreTrainedModel](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel). Check the superclass documentation for the generic methods the | |
| library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads | |
| etc.) | |
| This model is also a PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) subclass. | |
| Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage | |
| and behavior. | |
| forwardtransformers.LayoutLMv2ForTokenClassification.forwardhttps://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/modeling_layoutlmv2.py#L1012[{"name": "input_ids", "val": ": torch.LongTensor | None = None"}, {"name": "bbox", "val": ": torch.LongTensor | None = None"}, {"name": "image", "val": ": torch.FloatTensor | None = None"}, {"name": "attention_mask", "val": ": torch.FloatTensor | None = None"}, {"name": "token_type_ids", "val": ": torch.LongTensor | None = None"}, {"name": "position_ids", "val": ": torch.LongTensor | None = None"}, {"name": "inputs_embeds", "val": ": torch.FloatTensor | None = None"}, {"name": "labels", "val": ": torch.LongTensor | None = None"}, {"name": "**kwargs", "val": ": typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs]"}]- **input_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`) -- | |
| Indices of input sequence tokens in the vocabulary. | |
| Indices can be obtained using [AutoTokenizer](/docs/transformers/pr_43838/en/model_doc/auto#transformers.AutoTokenizer). See [PreTrainedTokenizer.encode()](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) and | |
| [PreTrainedTokenizer.__call__()](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) for details. | |
| [What are input IDs?](../glossary#input-ids) | |
| - **bbox** (`torch.LongTensor` of shape `(batch_size, sequence_length, 4)`, *optional*) -- | |
| Bounding boxes of each input sequence tokens. Selected in the range `[0, | |
| config.max_2d_position_embeddings-1]`. Each bounding box should be a normalized version in (x0, y0, x1, y1) | |
| format, where (x0, y0) corresponds to the position of the upper left corner in the bounding box, and (x1, | |
| y1) represents the position of the lower right corner. | |
| - **image** (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)` or `detectron.structures.ImageList` whose `tensors` is of shape `(batch_size, num_channels, height, width)`) -- | |
| Batch of document images. | |
| - **attention_mask** (`torch.FloatTensor` of shape `(batch_size, sequence_length)`, *optional*) -- | |
| Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`: | |
| - 1 for tokens that are **not masked**, | |
| - 0 for tokens that are **masked**. | |
| [What are attention masks?](../glossary#attention-mask) | |
| - **token_type_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`, *optional*) -- | |
| Segment token indices to indicate first and second portions of the inputs. Indices are selected in `[0, | |
| 1]`: | |
| - 0 corresponds to a *sentence A* token, | |
| - 1 corresponds to a *sentence B* token. | |
| [What are token type IDs?](../glossary#token-type-ids) | |
| - **position_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`, *optional*) -- | |
| Indices of positions of each input sequence tokens in the position embeddings. Selected in the range `[0, | |
| config.max_position_embeddings - 1]`. | |
| [What are position IDs?](../glossary#position-ids) | |
| - **inputs_embeds** (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`, *optional*) -- | |
| Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This | |
| is useful if you want more control over how to convert `input_ids` indices into associated vectors than the | |
| model's internal embedding lookup matrix. | |
| - **labels** (`torch.LongTensor` of shape `(batch_size, sequence_length)`, *optional*) -- | |
| Labels for computing the token classification loss. Indices should be in `[0, ..., config.num_labels - 1]`.0[TokenClassifierOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.TokenClassifierOutput) or `tuple(torch.FloatTensor)`A [TokenClassifierOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.TokenClassifierOutput) or a tuple of | |
| `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various | |
| elements depending on the configuration ([LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config)) and inputs. | |
| The [LayoutLMv2ForTokenClassification](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ForTokenClassification) forward method, overrides the `__call__` special method. | |
| Although the recipe for forward pass needs to be defined within this function, one should call the `Module` | |
| instance afterwards instead of this since the former takes care of running the pre and post processing steps while | |
| the latter silently ignores them. | |
| - **loss** (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `labels` is provided) -- Classification loss. | |
| - **logits** (`torch.FloatTensor` of shape `(batch_size, sequence_length, config.num_labels)`) -- Classification scores (before SoftMax). | |
| - **hidden_states** (`tuple(torch.FloatTensor)`, *optional*, returned when `output_hidden_states=True` is passed or when `config.output_hidden_states=True`) -- Tuple of `torch.FloatTensor` (one for the output of the embeddings, if the model has an embedding layer, + | |
| one for the output of each layer) of shape `(batch_size, sequence_length, hidden_size)`. | |
| Hidden-states of the model at the output of each layer plus the optional initial embedding outputs. | |
| - **attentions** (`tuple(torch.FloatTensor)`, *optional*, returned when `output_attentions=True` is passed or when `config.output_attentions=True`) -- Tuple of `torch.FloatTensor` (one for each layer) of shape `(batch_size, num_heads, sequence_length, | |
| sequence_length)`. | |
| Attentions weights after the attention softmax, used to compute the weighted average in the self-attention | |
| heads. | |
| Example: | |
| ```python | |
| >>> from transformers import AutoProcessor, LayoutLMv2ForTokenClassification, set_seed | |
| >>> from PIL import Image | |
| >>> from datasets import load_dataset | |
| >>> set_seed(0) | |
| >>> datasets = load_dataset("nielsr/funsd", split="test") | |
| >>> labels = datasets.features["ner_tags"].feature.names | |
| >>> id2label = {v: k for v, k in enumerate(labels)} | |
| >>> processor = AutoProcessor.from_pretrained("microsoft/layoutlmv2-base-uncased", revision="no_ocr") | |
| >>> model = LayoutLMv2ForTokenClassification.from_pretrained( | |
| ... "microsoft/layoutlmv2-base-uncased", num_labels=len(labels) | |
| ... ) | |
| >>> data = datasets[0] | |
| >>> image = Image.open(data["image_path"]).convert("RGB") | |
| >>> words = data["words"] | |
| >>> boxes = data["bboxes"] # make sure to normalize your bounding boxes | |
| >>> word_labels = data["ner_tags"] | |
| >>> encoding = processor( | |
| ... image, | |
| ... words, | |
| ... boxes=boxes, | |
| ... word_labels=word_labels, | |
| ... padding="max_length", | |
| ... truncation=True, | |
| ... return_tensors="pt", | |
| ... ) | |
| >>> outputs = model(**encoding) | |
| >>> logits, loss = outputs.logits, outputs.loss | |
| >>> predicted_token_class_ids = logits.argmax(-1) | |
| >>> predicted_tokens_classes = [id2label[t.item()] for t in predicted_token_class_ids[0]] | |
| >>> predicted_tokens_classes[:5] # results are not good without further fine-tuning | |
| ['I-HEADER', 'I-HEADER', 'I-QUESTION', 'I-HEADER', 'I-QUESTION'] | |
| ``` | |
| **Parameters:** | |
| config ([LayoutLMv2ForTokenClassification](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ForTokenClassification)) : Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the [from_pretrained()](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel.from_pretrained) method to load the model weights. | |
| **Returns:** | |
| `[TokenClassifierOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.TokenClassifierOutput) or `tuple(torch.FloatTensor)`` | |
| A [TokenClassifierOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.TokenClassifierOutput) or a tuple of | |
| `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various | |
| elements depending on the configuration ([LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config)) and inputs. | |
| ## LayoutLMv2ForQuestionAnswering[[transformers.LayoutLMv2ForQuestionAnswering]] | |
| #### transformers.LayoutLMv2ForQuestionAnswering[[transformers.LayoutLMv2ForQuestionAnswering]] | |
| [Source](https://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/modeling_layoutlmv2.py#L1135) | |
| The Layoutlmv2 transformer with a span classification head on top for extractive question-answering tasks like | |
| SQuAD (a linear layer on top of the hidden-states output to compute `span start logits` and `span end logits`). | |
| This model inherits from [PreTrainedModel](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel). Check the superclass documentation for the generic methods the | |
| library implements for all its model (such as downloading or saving, resizing the input embeddings, pruning heads | |
| etc.) | |
| This model is also a PyTorch [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) subclass. | |
| Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage | |
| and behavior. | |
| forwardtransformers.LayoutLMv2ForQuestionAnswering.forwardhttps://github.com/huggingface/transformers/blob/vr_43838/src/transformers/models/layoutlmv2/modeling_layoutlmv2.py#L1153[{"name": "input_ids", "val": ": torch.LongTensor | None = None"}, {"name": "bbox", "val": ": torch.LongTensor | None = None"}, {"name": "image", "val": ": torch.FloatTensor | None = None"}, {"name": "attention_mask", "val": ": torch.FloatTensor | None = None"}, {"name": "token_type_ids", "val": ": torch.LongTensor | None = None"}, {"name": "position_ids", "val": ": torch.LongTensor | None = None"}, {"name": "inputs_embeds", "val": ": torch.FloatTensor | None = None"}, {"name": "start_positions", "val": ": torch.LongTensor | None = None"}, {"name": "end_positions", "val": ": torch.LongTensor | None = None"}, {"name": "**kwargs", "val": ": typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs]"}]- **input_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`) -- | |
| Indices of input sequence tokens in the vocabulary. | |
| Indices can be obtained using [AutoTokenizer](/docs/transformers/pr_43838/en/model_doc/auto#transformers.AutoTokenizer). See [PreTrainedTokenizer.encode()](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) and | |
| [PreTrainedTokenizer.__call__()](/docs/transformers/pr_43838/en/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) for details. | |
| [What are input IDs?](../glossary#input-ids) | |
| - **bbox** (`torch.LongTensor` of shape `(batch_size, sequence_length, 4)`, *optional*) -- | |
| Bounding boxes of each input sequence tokens. Selected in the range `[0, | |
| config.max_2d_position_embeddings-1]`. Each bounding box should be a normalized version in (x0, y0, x1, y1) | |
| format, where (x0, y0) corresponds to the position of the upper left corner in the bounding box, and (x1, | |
| y1) represents the position of the lower right corner. | |
| - **image** (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)` or `detectron.structures.ImageList` whose `tensors` is of shape `(batch_size, num_channels, height, width)`) -- | |
| Batch of document images. | |
| - **attention_mask** (`torch.FloatTensor` of shape `(batch_size, sequence_length)`, *optional*) -- | |
| Mask to avoid performing attention on padding token indices. Mask values selected in `[0, 1]`: | |
| - 1 for tokens that are **not masked**, | |
| - 0 for tokens that are **masked**. | |
| [What are attention masks?](../glossary#attention-mask) | |
| - **token_type_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`, *optional*) -- | |
| Segment token indices to indicate first and second portions of the inputs. Indices are selected in `[0, | |
| 1]`: | |
| - 0 corresponds to a *sentence A* token, | |
| - 1 corresponds to a *sentence B* token. | |
| [What are token type IDs?](../glossary#token-type-ids) | |
| - **position_ids** (`torch.LongTensor` of shape `batch_size, sequence_length`, *optional*) -- | |
| Indices of positions of each input sequence tokens in the position embeddings. Selected in the range `[0, | |
| config.max_position_embeddings - 1]`. | |
| [What are position IDs?](../glossary#position-ids) | |
| - **inputs_embeds** (`torch.FloatTensor` of shape `(batch_size, sequence_length, hidden_size)`, *optional*) -- | |
| Optionally, instead of passing `input_ids` you can choose to directly pass an embedded representation. This | |
| is useful if you want more control over how to convert `input_ids` indices into associated vectors than the | |
| model's internal embedding lookup matrix. | |
| - **start_positions** (`torch.LongTensor` of shape `(batch_size,)`, *optional*) -- | |
| Labels for position (index) of the start of the labelled span for computing the token classification loss. | |
| Positions are clamped to the length of the sequence (`sequence_length`). Position outside of the sequence | |
| are not taken into account for computing the loss. | |
| - **end_positions** (`torch.LongTensor` of shape `(batch_size,)`, *optional*) -- | |
| Labels for position (index) of the end of the labelled span for computing the token classification loss. | |
| Positions are clamped to the length of the sequence (`sequence_length`). Position outside of the sequence | |
| are not taken into account for computing the loss.0[QuestionAnsweringModelOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.QuestionAnsweringModelOutput) or `tuple(torch.FloatTensor)`A [QuestionAnsweringModelOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.QuestionAnsweringModelOutput) or a tuple of | |
| `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various | |
| elements depending on the configuration ([LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config)) and inputs. | |
| The [LayoutLMv2ForQuestionAnswering](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ForQuestionAnswering) forward method, overrides the `__call__` special method. | |
| Although the recipe for forward pass needs to be defined within this function, one should call the `Module` | |
| instance afterwards instead of this since the former takes care of running the pre and post processing steps while | |
| the latter silently ignores them. | |
| - **loss** (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `labels` is provided) -- Total span extraction loss is the sum of a Cross-Entropy for the start and end positions. | |
| - **start_logits** (`torch.FloatTensor` of shape `(batch_size, sequence_length)`) -- Span-start scores (before SoftMax). | |
| - **end_logits** (`torch.FloatTensor` of shape `(batch_size, sequence_length)`) -- Span-end scores (before SoftMax). | |
| - **hidden_states** (`tuple(torch.FloatTensor)`, *optional*, returned when `output_hidden_states=True` is passed or when `config.output_hidden_states=True`) -- Tuple of `torch.FloatTensor` (one for the output of the embeddings, if the model has an embedding layer, + | |
| one for the output of each layer) of shape `(batch_size, sequence_length, hidden_size)`. | |
| Hidden-states of the model at the output of each layer plus the optional initial embedding outputs. | |
| - **attentions** (`tuple(torch.FloatTensor)`, *optional*, returned when `output_attentions=True` is passed or when `config.output_attentions=True`) -- Tuple of `torch.FloatTensor` (one for each layer) of shape `(batch_size, num_heads, sequence_length, | |
| sequence_length)`. | |
| Attentions weights after the attention softmax, used to compute the weighted average in the self-attention | |
| heads. | |
| Example: | |
| In this example below, we give the LayoutLMv2 model an image (of texts) and ask it a question. It will give us | |
| a prediction of what it thinks the answer is (the span of the answer within the texts parsed from the image). | |
| ```python | |
| >>> from transformers import AutoProcessor, LayoutLMv2ForQuestionAnswering, set_seed | |
| >>> import torch | |
| >>> from PIL import Image | |
| >>> from datasets import load_dataset | |
| >>> set_seed(0) | |
| >>> processor = AutoProcessor.from_pretrained("microsoft/layoutlmv2-base-uncased") | |
| >>> model = LayoutLMv2ForQuestionAnswering.from_pretrained("microsoft/layoutlmv2-base-uncased") | |
| >>> dataset = load_dataset("hf-internal-testing/fixtures_docvqa") | |
| >>> image = dataset["test"][0]["image"] | |
| >>> question = "When is coffee break?" | |
| >>> encoding = processor(image, question, return_tensors="pt") | |
| >>> outputs = model(**encoding) | |
| >>> predicted_start_idx = outputs.start_logits.argmax(-1).item() | |
| >>> predicted_end_idx = outputs.end_logits.argmax(-1).item() | |
| >>> predicted_start_idx, predicted_end_idx | |
| (30, 191) | |
| >>> predicted_answer_tokens = encoding.input_ids.squeeze()[predicted_start_idx : predicted_end_idx + 1] | |
| >>> predicted_answer = processor.tokenizer.decode(predicted_answer_tokens) | |
| >>> predicted_answer # results are not good without further fine-tuning | |
| '44 a. m. to 12 : 25 p. m. 12 : 25 to 12 : 58 p. m. 12 : 58 to 4 : 00 p. m. 2 : 00 to 5 : 00 p. m. coffee break coffee will be served for men and women in the lobby adjacent to exhibit area. please move into exhibit area. ( exhibits open ) trrf general session ( part | ) presiding : lee a. waller trrf vice president " introductory remarks " lee a. waller, trrf vice presi - dent individual interviews with trrf public board members and sci - entific advisory council mem - bers conducted by trrf treasurer philip g. kuehn to get answers which the public refrigerated warehousing industry is looking for. plus questions from' | |
| ``` | |
| ```python | |
| >>> target_start_index = torch.tensor([7]) | |
| >>> target_end_index = torch.tensor([14]) | |
| >>> outputs = model(**encoding, start_positions=target_start_index, end_positions=target_end_index) | |
| >>> predicted_answer_span_start = outputs.start_logits.argmax(-1).item() | |
| >>> predicted_answer_span_end = outputs.end_logits.argmax(-1).item() | |
| >>> predicted_answer_span_start, predicted_answer_span_end | |
| (30, 191) | |
| ``` | |
| **Parameters:** | |
| config ([LayoutLMv2ForQuestionAnswering](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2ForQuestionAnswering)) : Model configuration class with all the parameters of the model. Initializing with a config file does not load the weights associated with the model, only the configuration. Check out the [from_pretrained()](/docs/transformers/pr_43838/en/main_classes/model#transformers.PreTrainedModel.from_pretrained) method to load the model weights. | |
| has_visual_segment_embedding (`bool`, *optional*, defaults to `True`) : Whether or not to add visual segment embeddings. | |
| **Returns:** | |
| `[QuestionAnsweringModelOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.QuestionAnsweringModelOutput) or `tuple(torch.FloatTensor)`` | |
| A [QuestionAnsweringModelOutput](/docs/transformers/pr_43838/en/main_classes/output#transformers.modeling_outputs.QuestionAnsweringModelOutput) or a tuple of | |
| `torch.FloatTensor` (if `return_dict=False` is passed or when `config.return_dict=False`) comprising various | |
| elements depending on the configuration ([LayoutLMv2Config](/docs/transformers/pr_43838/en/model_doc/layoutlmv2#transformers.LayoutLMv2Config)) and inputs. | |
Xet Storage Details
- Size:
- 103 kB
- Xet hash:
- de0352b2b79c0b71f0a9da7c1213f29d51653d43986f8fde22e2c52a5f79eafd
·
Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.