Donut (original) (raw)

Donut (Document Understanding Transformer) is a visual document understanding model that doesn’t require an Optical Character Recognition (OCR) engine. Unlike traditional approaches that extract text using OCR before processing, Donut employs an end-to-end Transformer-based architecture to directly analyze document images. This eliminates OCR-related inefficiencies making it more accurate and adaptable to diverse languages and formats.

Donut features vision encoder (Swin) and a text decoder (BART). Swin converts document images into embeddings and BART processes them into meaningful text sequences.

You can find all the original Donut checkpoints under the Naver Clova Information Extraction organization.

Click on the Donut models in the right sidebar for more examples of how to apply Donut to different language and vision tasks.

The examples below demonstrate how to perform document understanding tasks using Donut with Pipeline and AutoModel

import torch from transformers import pipeline from PIL import Image

pipeline = pipeline( task="document-question-answering", model="naver-clova-ix/donut-base-finetuned-docvqa", device=0, torch_dtype=torch.float16 ) dataset = load_dataset("hf-internal-testing/example-documents", split="test") image = dataset[0]["image"]

pipeline(image=image, question="What time is the coffee break?")

Quantization reduces the memory burden of large models by representing the weights in a lower precision. Refer to the Quantization overview for more available quantization backends.

The example below uses torchao to only quantize the weights to int4.

import torch from datasets import load_dataset from transformers import TorchAoConfig, AutoProcessor, AutoModelForVision2Seq

quantization_config = TorchAoConfig("int4_weight_only", group_size=128) processor = AutoProcessor.from_pretrained("naver-clova-ix/donut-base-finetuned-docvqa") model = AutoModelForVision2Seq.from_pretrained("naver-clova-ix/donut-base-finetuned-docvqa", quantization_config=quantization_config)

dataset = load_dataset("hf-internal-testing/example-documents", split="test") image = dataset[0]["image"] question = "What time is the coffee break?" task_prompt = f"{question}" inputs = processor(image, task_prompt, return_tensors="pt")

outputs = model.generate( input_ids=inputs.input_ids, pixel_values=inputs.pixel_values, max_length=512 ) answer = processor.decode(outputs[0], skip_special_tokens=True) print(answer)

Notes

• Use Donut for document image classification as shown below.

  import re
  from transformers import DonutProcessor, VisionEncoderDecoderModel
  from datasets import load_dataset
  import torch
  processor = DonutProcessor.from_pretrained("naver-clova-ix/donut-base-finetuned-rvlcdip")
  model = VisionEncoderDecoderModel.from_pretrained("naver-clova-ix/donut-base-finetuned-rvlcdip")
  device = "cuda" if torch.cuda.is_available() else "cpu"
  model.to(device)

  dataset = load_dataset("hf-internal-testing/example-documents", split="test")
  image = dataset[1]["image"]

  task_prompt = ""
  decoder_input_ids = processor.tokenizer(task_prompt, add_special_tokens=False, return_tensors="pt").input_ids
  pixel_values = processor(image, return_tensors="pt").pixel_values
  outputs = model.generate(
  ... pixel_values.to(device),
  ... decoder_input_ids=decoder_input_ids.to(device),
  ... max_length=model.decoder.config.max_position_embeddings,
  ... pad_token_id=processor.tokenizer.pad_token_id,
  ... eos_token_id=processor.tokenizer.eos_token_id,
  ... use_cache=True,
  ... bad_words_ids=[[processor.tokenizer.unk_token_id]],
  ... return_dict_in_generate=True,
  ... )
  sequence = processor.batch_decode(outputs.sequences)[0]
  sequence = sequence.replace(processor.tokenizer.eos_token, "").replace(processor.tokenizer.pad_token, "")
  sequence = re.sub(r"<.*?>", "", sequence, count=1).strip()
  print(processor.token2json(sequence))
  {'class': 'advertisement'}

• Use Donut for document parsing as shown below.

  import re
  from transformers import DonutProcessor, VisionEncoderDecoderModel
  from datasets import load_dataset
  import torch
  processor = DonutProcessor.from_pretrained("naver-clova-ix/donut-base-finetuned-cord-v2")
  model = VisionEncoderDecoderModel.from_pretrained("naver-clova-ix/donut-base-finetuned-cord-v2")
  device = "cuda" if torch.cuda.is_available() else "cpu"
  model.to(device)

  dataset = load_dataset("hf-internal-testing/example-documents", split="test")
  image = dataset[2]["image"]

  task_prompt = ""
  decoder_input_ids = processor.tokenizer(task_prompt, add_special_tokens=False, return_tensors="pt").input_ids
  pixel_values = processor(image, return_tensors="pt").pixel_values
  outputs = model.generate(
  ... pixel_values.to(device),
  ... decoder_input_ids=decoder_input_ids.to(device),
  ... max_length=model.decoder.config.max_position_embeddings,
  ... pad_token_id=processor.tokenizer.pad_token_id,
  ... eos_token_id=processor.tokenizer.eos_token_id,
  ... use_cache=True,
  ... bad_words_ids=[[processor.tokenizer.unk_token_id]],
  ... return_dict_in_generate=True,
  ... )
  sequence = processor.batch_decode(outputs.sequences)[0]
  sequence = sequence.replace(processor.tokenizer.eos_token, "").replace(processor.tokenizer.pad_token, "")
  sequence = re.sub(r"<.*?>", "", sequence, count=1).strip()
  print(processor.token2json(sequence))
  {'menu': {'nm': 'CINNAMON SUGAR', 'unitprice': '17,000', 'cnt': '1 x', 'price': '17,000'}, 'sub_total': {'subtotal_price': '17,000'}, 'total':
  {'total_price': '17,000', 'cashprice': '20,000', 'changeprice': '3,000'}}

DonutSwinConfig

class transformers.DonutSwinConfig

< source >

( image_size = 224 patch_size = 4 num_channels = 3 embed_dim = 96 depths = [2, 2, 6, 2] num_heads = [3, 6, 12, 24] window_size = 7 mlp_ratio = 4.0 qkv_bias = True hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 drop_path_rate = 0.1 hidden_act = 'gelu' use_absolute_embeddings = False initializer_range = 0.02 layer_norm_eps = 1e-05 **kwargs )

Parameters

• image_size (int, optional, defaults to 224) — The size (resolution) of each image.
• patch_size (int, optional, defaults to 4) — The size (resolution) of each patch.
• num_channels (int, optional, defaults to 3) — The number of input channels.
• embed_dim (int, optional, defaults to 96) — Dimensionality of patch embedding.
• depths (list(int), optional, defaults to [2, 2, 6, 2]) — Depth of each layer in the Transformer encoder.
• num_heads (list(int), optional, defaults to [3, 6, 12, 24]) — Number of attention heads in each layer of the Transformer encoder.
• window_size (int, optional, defaults to 7) — Size of windows.
• mlp_ratio (float, optional, defaults to 4.0) — Ratio of MLP hidden dimensionality to embedding dimensionality.
• qkv_bias (bool, optional, defaults to True) — Whether or not a learnable bias should be added to the queries, keys and values.
• hidden_dropout_prob (float, optional, defaults to 0.0) — The dropout probability for all fully connected layers in the embeddings and encoder.
• attention_probs_dropout_prob (float, optional, defaults to 0.0) — The dropout ratio for the attention probabilities.
• drop_path_rate (float, optional, defaults to 0.1) — Stochastic depth rate.
• hidden_act (str or function, optional, defaults to "gelu") — The non-linear activation function (function or string) in the encoder. If string, "gelu", "relu","selu" and "gelu_new" are supported.
• use_absolute_embeddings (bool, optional, defaults to False) — Whether or not to add absolute position embeddings to the patch embeddings.
• 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-05) — The epsilon used by the layer normalization layers.

This is the configuration class to store the configuration of a DonutSwinModel. It is used to instantiate a Donut 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 Donutnaver-clova-ix/donut-base architecture.

Configuration objects inherit from PretrainedConfig and can be used to control the model outputs. Read the documentation from PretrainedConfig for more information.

Example:

from transformers import DonutSwinConfig, DonutSwinModel

configuration = DonutSwinConfig()

model = DonutSwinModel(configuration)

configuration = model.config

DonutImageProcessor

class transformers.DonutImageProcessor

< source >

( do_resize: bool = True size: typing.Optional[typing.Dict[str, int]] = None resample: Resampling = <Resampling.BILINEAR: 2> do_thumbnail: bool = True do_align_long_axis: bool = False do_pad: bool = True do_rescale: bool = True rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_normalize: bool = True image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None **kwargs )

Parameters

• do_resize (bool, optional, defaults to True) — Whether to resize the image’s (height, width) dimensions to the specified size. Can be overridden bydo_resize in the preprocess method.
• size (Dict[str, int] optional, defaults to {"shortest_edge" -- 224}): Size of the image after resizing. The shortest edge of the image is resized to size[“shortest_edge”], with the longest edge resized to keep the input aspect ratio. Can be overridden by size in the preprocessmethod.
• resample (PILImageResampling, optional, defaults to Resampling.BILINEAR) — Resampling filter to use if resizing the image. Can be overridden by resample in the preprocess method.
• do_thumbnail (bool, optional, defaults to True) — Whether to resize the image using thumbnail method.
• do_align_long_axis (bool, optional, defaults to False) — Whether to align the long axis of the image with the long axis of size by rotating by 90 degrees.
• do_pad (bool, optional, defaults to True) — Whether to pad the image. If random_padding is set to True in preprocess, each image is padded with a random amount of padding on each size, up to the largest image size in the batch. Otherwise, all images are padded to the largest image size in the batch.
• do_rescale (bool, optional, defaults to True) — Whether to rescale the image by the specified scale rescale_factor. Can be overridden by do_rescale in the preprocess method.
• rescale_factor (int or float, optional, defaults to 1/255) — Scale factor to use if rescaling the image. Can be overridden by rescale_factor in the preprocessmethod.
• do_normalize (bool, optional, defaults to True) — Whether to normalize the image. Can be overridden by do_normalize in the preprocess method.
• image_mean (float or List[float], optional, defaults to IMAGENET_STANDARD_MEAN) — Mean to use if normalizing the image. This is a float or list of floats the length of the number of channels in the image. Can be overridden by the image_mean parameter in the preprocess method.
• image_std (float or List[float], optional, defaults to IMAGENET_STANDARD_STD) — Image standard deviation.

Constructs a Donut image processor.

preprocess

< source >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] do_resize: typing.Optional[bool] = None size: typing.Optional[typing.Dict[str, int]] = None resample: Resampling = None do_thumbnail: typing.Optional[bool] = None do_align_long_axis: typing.Optional[bool] = None do_pad: typing.Optional[bool] = None random_padding: bool = False do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: typing.Optional[transformers.image_utils.ChannelDimension] = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )

Parameters

• images (ImageInput) — 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.
• do_resize (bool, optional, defaults to self.do_resize) — Whether to resize the image.
• size (Dict[str, int], optional, defaults to self.size) — Size of the image after resizing. Shortest edge of the image is resized to min(size[“height”], size[“width”]) with the longest edge resized to keep the input aspect ratio.
• resample (int, optional, defaults to self.resample) — Resampling filter to use if resizing the image. This can be one of the enum PILImageResampling. Only has an effect if do_resize is set to True.
• do_thumbnail (bool, optional, defaults to self.do_thumbnail) — Whether to resize the image using thumbnail method.
• do_align_long_axis (bool, optional, defaults to self.do_align_long_axis) — Whether to align the long axis of the image with the long axis of size by rotating by 90 degrees.
• do_pad (bool, optional, defaults to self.do_pad) — Whether to pad the image. If random_padding is set to True, each image is padded with a random amount of padding on each size, up to the largest image size in the batch. Otherwise, all images are padded to the largest image size in the batch.
• random_padding (bool, optional, defaults to self.random_padding) — Whether to use random padding when padding the image. If True, each image in the batch with be padded with a random amount of padding on each side up to the size of the largest image in the batch.
• do_rescale (bool, optional, defaults to self.do_rescale) — Whether to rescale the image pixel values.
• rescale_factor (float, optional, defaults to self.rescale_factor) — Rescale factor to rescale the image by if do_rescale is set to True.
• do_normalize (bool, optional, defaults to self.do_normalize) — Whether to normalize the image.
• image_mean (float or List[float], optional, defaults to self.image_mean) — Image mean to use for normalization.
• image_std (float or List[float], optional, defaults to self.image_std) — Image standard deviation to use for normalization.
• return_tensors (str or TensorType, optional) — The type of tensors to return. Can be one of:
  • Unset: Return a list of np.ndarray.
  • TensorType.TENSORFLOW or 'tf': Return a batch of type tf.Tensor.
  • TensorType.PYTORCH or 'pt': Return a batch of type torch.Tensor.
  • TensorType.NUMPY or 'np': Return a batch of type np.ndarray.
  • TensorType.JAX or 'jax': Return a batch of type jax.numpy.ndarray.
• data_format (ChannelDimension or str, optional, defaults to ChannelDimension.FIRST) — The channel dimension format for the output image. Can be one of:
  • ChannelDimension.FIRST: image in (num_channels, height, width) format.
  • ChannelDimension.LAST: image in (height, width, num_channels) format.
  • Unset: defaults to the channel dimension format of the input image.
• input_data_format (ChannelDimension or str, optional) — The channel dimension format for the input image. If unset, the channel dimension format is inferred from the input image. Can be one of:
  • "channels_first" or ChannelDimension.FIRST: image in (num_channels, height, width) format.
  • "channels_last" or ChannelDimension.LAST: image in (height, width, num_channels) format.
  • "none" or ChannelDimension.NONE: image in (height, width) format.

Preprocess an image or batch of images.

DonutImageProcessorFast

class transformers.DonutImageProcessorFast

< source >

( **kwargs: typing_extensions.Unpack[transformers.models.donut.image_processing_donut_fast.DonutFastImageProcessorKwargs] )

Parameters

• do_resize (bool, optional, defaults to True) — Whether to resize the image.
• size (dict[str, int], optional, defaults to {'height' -- 2560, 'width': 1920}): Describes the maximum input dimensions to the model.
• default_to_square (bool, optional, defaults to True) — Whether to default to a square image when resizing, if size is an int.
• resample (Union[PILImageResampling, F.InterpolationMode, NoneType], defaults to Resampling.BILINEAR) — Resampling filter to use if resizing the image. This can be one of the enum PILImageResampling. Only has an effect if do_resize is set to True.
• do_center_crop (bool, optional, defaults to None) — Whether to center crop the image.
• crop_size (dict[str, int], optional, defaults to None) — Size of the output image after applying center_crop.
• do_rescale (bool, optional, defaults to True) — Whether to rescale the image.
• rescale_factor (Union[int, float, NoneType], defaults to 0.00392156862745098) — Rescale factor to rescale the image by if do_rescale is set to True.
• do_normalize (bool, optional, defaults to True) — Whether to normalize the image.
• image_mean (Union[float, list[float], NoneType], defaults to [0.5, 0.5, 0.5]) — Image mean to use for normalization. Only has an effect if do_normalize is set to True.
• image_std (Union[float, list[float], NoneType], defaults to [0.5, 0.5, 0.5]) — Image standard deviation to use for normalization. Only has an effect if do_normalize is set toTrue.
• do_convert_rgb (bool, optional, defaults to None) — Whether to convert the image to RGB.
• return_tensors (Union[str, ~utils.generic.TensorType, NoneType], defaults to None) — Returns stacked tensors if set to `pt, otherwise returns a list of tensors.
• data_format (~image_utils.ChannelDimension, optional, defaults to ChannelDimension.FIRST) — Only ChannelDimension.FIRST is supported. Added for compatibility with slow processors.
• input_data_format (Union[~image_utils.ChannelDimension, str, NoneType], defaults to None) — The channel dimension format for the input image. If unset, the channel dimension format is inferred from the input image. Can be one of:
  • "channels_first" or ChannelDimension.FIRST: image in (num_channels, height, width) format.
  • "channels_last" or ChannelDimension.LAST: image in (height, width, num_channels) format.
  • "none" or ChannelDimension.NONE: image in (height, width) format.
• device (torch.device, optional, defaults to None) — The device to process the images on. If unset, the device is inferred from the input images.
• do_thumbnail (bool, optional, defaults to self.do_thumbnail) — Whether to resize the image using thumbnail method.
• do_align_long_axis (bool, optional, defaults to self.do_align_long_axis) — Whether to align the long axis of the image with the long axis of size by rotating by 90 degrees.
• do_pad (bool, optional, defaults to self.do_pad) — Whether to pad the image. If random_padding is set to True, each image is padded with a random amount of padding on each size, up to the largest image size in the batch. Otherwise, all images are padded to the largest image size in the batch.

Constructs a fast Donut image processor.

preprocess

< source >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] **kwargs: typing_extensions.Unpack[transformers.models.donut.image_processing_donut_fast.DonutFastImageProcessorKwargs] ) → <class 'transformers.image_processing_base.BatchFeature'>

Parameters

• 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.
• do_resize (bool, optional) — Whether to resize the image.
• size (dict[str, int], optional) — Describes the maximum input dimensions to the model.
• default_to_square (bool, optional) — Whether to default to a square image when resizing, if size is an int.
• resample (Union[PILImageResampling, F.InterpolationMode, NoneType]) — Resampling filter to use if resizing the image. This can be one of the enum PILImageResampling. Only has an effect if do_resize is set to True.
• do_center_crop (bool, optional) — Whether to center crop the image.
• crop_size (dict[str, int], optional) — Size of the output image after applying center_crop.
• do_rescale (bool, optional) — Whether to rescale the image.
• rescale_factor (Union[int, float, NoneType]) — Rescale factor to rescale the image by if do_rescale is set to True.
• do_normalize (bool, optional) — Whether to normalize the image.
• image_mean (Union[float, list[float], NoneType]) — Image mean to use for normalization. Only has an effect if do_normalize is set to True.
• image_std (Union[float, list[float], NoneType]) — Image standard deviation to use for normalization. Only has an effect if do_normalize is set toTrue.
• do_convert_rgb (bool, optional) — Whether to convert the image to RGB.
• return_tensors (Union[str, ~utils.generic.TensorType, NoneType]) — Returns stacked tensors if set to `pt, otherwise returns a list of tensors.
• data_format (~image_utils.ChannelDimension, optional) — Only ChannelDimension.FIRST is supported. Added for compatibility with slow processors.
• input_data_format (Union[~image_utils.ChannelDimension, str, NoneType]) — The channel dimension format for the input image. If unset, the channel dimension format is inferred from the input image. Can be one of:
  • "channels_first" or ChannelDimension.FIRST: image in (num_channels, height, width) format.
  • "channels_last" or ChannelDimension.LAST: image in (height, width, num_channels) format.
  • "none" or ChannelDimension.NONE: image in (height, width) format.
• device (torch.device, optional) — The device to process the images on. If unset, the device is inferred from the input images.
• do_thumbnail (bool, optional, defaults to self.do_thumbnail) — Whether to resize the image using thumbnail method.
• do_align_long_axis (bool, optional, defaults to self.do_align_long_axis) — Whether to align the long axis of the image with the long axis of size by rotating by 90 degrees.
• do_pad (bool, optional, defaults to self.do_pad) — Whether to pad the image. If random_padding is set to True, each image is padded with a random amount of padding on each size, up to the largest image size in the batch. Otherwise, all images are padded to the largest image size in the batch.

Returns

<class 'transformers.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/TensorFlow/Numpy Tensors at initialization.

DonutFeatureExtractor

Preprocess an image or a batch of images.

DonutProcessor

class transformers.DonutProcessor

< source >

( image_processor = None tokenizer = None **kwargs )

Parameters

• image_processor (DonutImageProcessor, optional) — An instance of DonutImageProcessor. The image processor is a required input.
• tokenizer ([XLMRobertaTokenizer/XLMRobertaTokenizerFast], optional) — An instance of [XLMRobertaTokenizer/XLMRobertaTokenizerFast]. The tokenizer is a required input.

Constructs a Donut processor which wraps a Donut image processor and an XLMRoBERTa tokenizer into a single processor.

DonutProcessor offers all the functionalities of DonutImageProcessor and [XLMRobertaTokenizer/XLMRobertaTokenizerFast]. See the call() anddecode() for more information.

__call__

< source >

( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] = None text: typing.Union[str, typing.List[str], NoneType] = None audio = None videos = None **kwargs: typing_extensions.Unpack[transformers.models.donut.processing_donut.DonutProcessorKwargs] )

When used in normal mode, this method forwards all its arguments to AutoImageProcessor’s__call__() and returns its output. If used in the contextas_target_processor() this method forwards all its arguments to DonutTokenizer’s~DonutTokenizer.__call__. Please refer to the docstring of the above two methods for more information.

from_pretrained

< source >

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

Parameters

• pretrained_model_name_or_path (str or os.PathLike) — This can be either:
  • a string, the model id of a pretrained feature_extractor hosted inside a model repo on huggingface.co.
  • a path to a directory containing a feature extractor file saved using thesave_pretrained() method, e.g., ./my_model_directory/.
  • a path or url to a saved feature extractor JSON file, e.g.,./my_model_directory/preprocessor_config.json.
• * *kwargs — Additional keyword arguments passed along to bothfrom_pretrained() and~tokenization_utils_base.PreTrainedTokenizer.from_pretrained.

Instantiate a processor associated with a pretrained model.

This class method is simply calling the feature extractorfrom_pretrained(), image processorImageProcessingMixin and the tokenizer~tokenization_utils_base.PreTrainedTokenizer.from_pretrained methods. Please refer to the docstrings of the methods above for more information.

save_pretrained

< source >

( save_directory push_to_hub: bool = False **kwargs )

Parameters

• save_directory (str or os.PathLike) — Directory where the feature extractor JSON file and the tokenizer files will be saved (directory will be created if it does not exist).
• push_to_hub (bool, optional, defaults to False) — Whether or not to push your model to the Hugging Face model hub after saving it. You can specify the repository you want to push to with repo_id (will default to the name of save_directory in your namespace).
• kwargs (Dict[str, Any], optional) — Additional key word arguments passed along to the push_to_hub() method.

Saves the attributes of this processor (feature extractor, tokenizer…) in the specified directory so that it can be reloaded using the from_pretrained() method.

This class method is simply calling save_pretrained() andsave_pretrained(). Please refer to the docstrings of the methods above for more information.

This method forwards all its arguments to DonutTokenizer’s batch_decode(). Please refer to the docstring of this method for more information.

This method forwards all its arguments to DonutTokenizer’s decode(). Please refer to the docstring of this method for more information.

DonutSwinModel

class transformers.DonutSwinModel

< source >

( config add_pooling_layer = True use_mask_token = False )

Parameters

• config (DonutSwinModel) — 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 thefrom_pretrained() method to load the model weights.
• add_pooling_layer (bool, optional, defaults to True) — Whether to add a pooling layer
• use_mask_token (bool, optional, defaults to False) — Whether to use a mask token for masked image modeling.

The bare Donut Swin Model outputting raw hidden-states without any specific head on top.

This model inherits from 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 subclass. Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage and behavior.

forward

< source >

( pixel_values: typing.Optional[torch.FloatTensor] = None bool_masked_pos: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None interpolate_pos_encoding: bool = False return_dict: typing.Optional[bool] = None ) → transformers.models.donut.modeling_donut_swin.DonutSwinModelOutput or tuple(torch.FloatTensor)

Parameters

• pixel_values (torch.FloatTensor of shape (batch_size, num_channels, image_size, image_size), optional) — The tensors corresponding to the input images. Pixel values can be obtained using{image_processor_class}. See {image_processor_class}.__call__ for details ({processor_class} uses{image_processor_class} for processing images).
• bool_masked_pos (torch.BoolTensor of shape (batch_size, num_patches)) — Boolean masked positions. Indicates which patches are masked (1) and which aren’t (0).
• head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — Mask to nullify selected heads of the self-attention modules. Mask values selected in [0, 1]:
  • 1 indicates the head is not masked,
  • 0 indicates the head is masked.
• output_attentions (bool, optional) — Whether or not to return the attentions tensors of all attention layers. See attentions under returned tensors for more detail.
• output_hidden_states (bool, optional) — Whether or not to return the hidden states of all layers. See hidden_states under returned tensors for more detail.
• interpolate_pos_encoding (bool, defaults to False) — Whether to interpolate the pre-trained position encodings.
• return_dict (bool, optional) — Whether or not to return a ModelOutput instead of a plain tuple.

Returns

transformers.models.donut.modeling_donut_swin.DonutSwinModelOutput or tuple(torch.FloatTensor)

A transformers.models.donut.modeling_donut_swin.DonutSwinModelOutput or a tuple oftorch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (DonutSwinConfig) and inputs.

• 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), optional, returned when add_pooling_layer=True is passed) — Average pooling of the last layer hidden-state.
• 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 + one for the output of each stage) of shape (batch_size, sequence_length, hidden_size).
  Hidden-states of the model at the output of each layer plus the 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 stage) 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.
• reshaped_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 + one for the output of each stage) of shape (batch_size, hidden_size, height, width).
  Hidden-states of the model at the output of each layer plus the initial embedding outputs reshaped to include the spatial dimensions.

The DonutSwinModel forward method, overrides the __call__ special method.

Although the recipe for forward pass needs to be defined within this function, one should call the Moduleinstance afterwards instead of this since the former takes care of running the pre and post processing steps while the latter silently ignores them.

DonutSwinForImageClassification

class transformers.DonutSwinForImageClassification

< source >

( config )

Parameters

• config (DonutSwinForImageClassification) — 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 thefrom_pretrained() method to load the model weights.

DonutSwin Model transformer with an image classification head on top (a linear layer on top of the final hidden state of the [CLS] token) e.g. for ImageNet.

Note that it’s possible to fine-tune DonutSwin on higher resolution images than the ones it has been trained on, by setting interpolate_pos_encoding to True in the forward of the model. This will interpolate the pre-trained position embeddings to the higher resolution.

This model inherits from 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 subclass. Use it as a regular PyTorch Module and refer to the PyTorch documentation for all matter related to general usage and behavior.

forward

< source >

( pixel_values: typing.Optional[torch.FloatTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None interpolate_pos_encoding: bool = False return_dict: typing.Optional[bool] = None ) → transformers.models.donut.modeling_donut_swin.DonutSwinImageClassifierOutput or tuple(torch.FloatTensor)

Parameters

• pixel_values (torch.FloatTensor of shape (batch_size, num_channels, image_size, image_size), optional) — The tensors corresponding to the input images. Pixel values can be obtained using{image_processor_class}. See {image_processor_class}.__call__ for details ({processor_class} uses{image_processor_class} for processing images).
• head_mask (torch.FloatTensor of shape (num_heads,) or (num_layers, num_heads), optional) — Mask to nullify selected heads of the self-attention modules. Mask values selected in [0, 1]:
  • 1 indicates the head is not masked,
  • 0 indicates the head is masked.
• labels (torch.LongTensor of shape (batch_size,), optional) — Labels for computing the image 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), Ifconfig.num_labels > 1 a classification loss is computed (Cross-Entropy).
• output_attentions (bool, optional) — Whether or not to return the attentions tensors of all attention layers. See attentions under returned tensors for more detail.
• output_hidden_states (bool, optional) — Whether or not to return the hidden states of all layers. See hidden_states under returned tensors for more detail.
• interpolate_pos_encoding (bool, defaults to False) — Whether to interpolate the pre-trained position encodings.
• return_dict (bool, optional) — Whether or not to return a ModelOutput instead of a plain tuple.

Returns

transformers.models.donut.modeling_donut_swin.DonutSwinImageClassifierOutput or tuple(torch.FloatTensor)

A transformers.models.donut.modeling_donut_swin.DonutSwinImageClassifierOutput or a tuple oftorch.FloatTensor (if return_dict=False is passed or when config.return_dict=False) comprising various elements depending on the configuration (DonutSwinConfig) and inputs.

• 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 + one for the output of each stage) of shape (batch_size, sequence_length, hidden_size).
  Hidden-states of the model at the output of each layer plus the 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 stage) 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.
• reshaped_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 + one for the output of each stage) of shape (batch_size, hidden_size, height, width).
  Hidden-states of the model at the output of each layer plus the initial embedding outputs reshaped to include the spatial dimensions.

The DonutSwinForImageClassification forward method, overrides the __call__ special method.

Although the recipe for forward pass needs to be defined within this function, one should call the Moduleinstance afterwards instead of this since the former takes care of running the pre and post processing steps while the latter silently ignores them.

Example:

from transformers import AutoImageProcessor, DonutSwinForImageClassification import torch from datasets import load_dataset

dataset = load_dataset("huggingface/cats-image", trust_remote_code=True) image = dataset["test"]["image"][0]

image_processor = AutoImageProcessor.from_pretrained("naver-clova-ix/donut-base") model = DonutSwinForImageClassification.from_pretrained("naver-clova-ix/donut-base")

inputs = image_processor(image, return_tensors="pt")

with torch.no_grad(): ... logits = model(**inputs).logits

predicted_label = logits.argmax(-1).item() print(model.config.id2label[predicted_label]) ...

< > Update on GitHub