| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342 |
- # coding=utf-8
- # Copyright 2022 Microsoft Research and The HuggingFace Inc. team. All rights reserved.
- #
- # Licensed under the Apache License, Version 2.0 (the "License");
- # you may not use this file except in compliance with the License.
- # You may obtain a copy of the License at
- #
- # http://www.apache.org/licenses/LICENSE-2.0
- #
- # Unless required by applicable law or agreed to in writing, software
- # distributed under the License is distributed on an "AS IS" BASIS,
- # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- # See the License for the specific language governing permissions and
- # limitations under the License.
- """PyTorch Swinv2 Transformer model."""
- import collections.abc
- import math
- import warnings
- from dataclasses import dataclass
- from typing import Optional, Union
- import torch
- from torch import Tensor, nn
- from ...activations import ACT2FN
- from ...modeling_layers import GradientCheckpointingLayer
- from ...modeling_outputs import BackboneOutput
- from ...modeling_utils import PreTrainedModel
- from ...pytorch_utils import find_pruneable_heads_and_indices, meshgrid, prune_linear_layer
- from ...utils import ModelOutput, auto_docstring, logging, torch_int
- from ...utils.backbone_utils import BackboneMixin
- from .configuration_swinv2 import Swinv2Config
- logger = logging.get_logger(__name__)
- # drop_path, Swinv2PatchEmbeddings, Swinv2PatchMerging and Swinv2DropPath are from https://github.com/rwightman/pytorch-image-models/blob/master/timm/models/swin_transformer_v2.py.
- @dataclass
- @auto_docstring(
- custom_intro="""
- Swinv2 encoder's outputs, with potential hidden states and attentions.
- """
- )
- # Copied from transformers.models.swin.modeling_swin.SwinEncoderOutput with Swin->Swinv2
- class Swinv2EncoderOutput(ModelOutput):
- r"""
- 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.
- """
- last_hidden_state: Optional[torch.FloatTensor] = None
- hidden_states: Optional[tuple[torch.FloatTensor, ...]] = None
- attentions: Optional[tuple[torch.FloatTensor, ...]] = None
- reshaped_hidden_states: Optional[tuple[torch.FloatTensor, ...]] = None
- @dataclass
- @auto_docstring(
- custom_intro="""
- Swinv2 model's outputs that also contains a pooling of the last hidden states.
- """
- )
- # Copied from transformers.models.swin.modeling_swin.SwinModelOutput with Swin->Swinv2
- class Swinv2ModelOutput(ModelOutput):
- r"""
- 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.
- 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.
- """
- last_hidden_state: Optional[torch.FloatTensor] = None
- pooler_output: Optional[torch.FloatTensor] = None
- hidden_states: Optional[tuple[torch.FloatTensor, ...]] = None
- attentions: Optional[tuple[torch.FloatTensor, ...]] = None
- reshaped_hidden_states: Optional[tuple[torch.FloatTensor, ...]] = None
- @dataclass
- @auto_docstring(
- custom_intro="""
- Swinv2 masked image model outputs.
- """
- )
- # Copied from transformers.models.swin.modeling_swin.SwinMaskedImageModelingOutput with Swin->Swinv2
- class Swinv2MaskedImageModelingOutput(ModelOutput):
- r"""
- loss (`torch.FloatTensor` of shape `(1,)`, *optional*, returned when `bool_masked_pos` is provided):
- Masked image modeling (MLM) loss.
- reconstruction (`torch.FloatTensor` of shape `(batch_size, num_channels, height, width)`):
- Reconstructed pixel values.
- 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.
- """
- loss: Optional[torch.FloatTensor] = None
- reconstruction: Optional[torch.FloatTensor] = None
- hidden_states: Optional[tuple[torch.FloatTensor, ...]] = None
- attentions: Optional[tuple[torch.FloatTensor, ...]] = None
- reshaped_hidden_states: Optional[tuple[torch.FloatTensor, ...]] = None
- @property
- def logits(self):
- warnings.warn(
- "logits attribute is deprecated and will be removed in version 5 of Transformers."
- " Please use the reconstruction attribute to retrieve the final output instead.",
- FutureWarning,
- )
- return self.reconstruction
- @dataclass
- @auto_docstring(
- custom_intro="""
- Swinv2 outputs for image classification.
- """
- )
- # Copied from transformers.models.swin.modeling_swin.SwinImageClassifierOutput with Swin->Swinv2
- class Swinv2ImageClassifierOutput(ModelOutput):
- r"""
- 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).
- 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.
- """
- loss: Optional[torch.FloatTensor] = None
- logits: Optional[torch.FloatTensor] = None
- hidden_states: Optional[tuple[torch.FloatTensor, ...]] = None
- attentions: Optional[tuple[torch.FloatTensor, ...]] = None
- reshaped_hidden_states: Optional[tuple[torch.FloatTensor, ...]] = None
- # Copied from transformers.models.swin.modeling_swin.window_partition
- def window_partition(input_feature, window_size):
- """
- Partitions the given input into windows.
- """
- batch_size, height, width, num_channels = input_feature.shape
- input_feature = input_feature.view(
- batch_size, height // window_size, window_size, width // window_size, window_size, num_channels
- )
- windows = input_feature.permute(0, 1, 3, 2, 4, 5).contiguous().view(-1, window_size, window_size, num_channels)
- return windows
- # Copied from transformers.models.swin.modeling_swin.window_reverse
- def window_reverse(windows, window_size, height, width):
- """
- Merges windows to produce higher resolution features.
- """
- num_channels = windows.shape[-1]
- windows = windows.view(-1, height // window_size, width // window_size, window_size, window_size, num_channels)
- windows = windows.permute(0, 1, 3, 2, 4, 5).contiguous().view(-1, height, width, num_channels)
- return windows
- # Copied from transformers.models.swin.modeling_swin.drop_path
- def drop_path(input: torch.Tensor, drop_prob: float = 0.0, training: bool = False) -> torch.Tensor:
- """
- Drop paths (Stochastic Depth) per sample (when applied in main path of residual blocks).
- Comment by Ross Wightman: This is the same as the DropConnect impl I created for EfficientNet, etc networks,
- however, the original name is misleading as 'Drop Connect' is a different form of dropout in a separate paper...
- See discussion: https://github.com/tensorflow/tpu/issues/494#issuecomment-532968956 ... I've opted for changing the
- layer and argument names to 'drop path' rather than mix DropConnect as a layer name and use 'survival rate' as the
- argument.
- """
- if drop_prob == 0.0 or not training:
- return input
- keep_prob = 1 - drop_prob
- shape = (input.shape[0],) + (1,) * (input.ndim - 1) # work with diff dim tensors, not just 2D ConvNets
- random_tensor = keep_prob + torch.rand(shape, dtype=input.dtype, device=input.device)
- random_tensor.floor_() # binarize
- output = input.div(keep_prob) * random_tensor
- return output
- # Copied from transformers.models.swin.modeling_swin.SwinDropPath with Swin->Swinv2
- class Swinv2DropPath(nn.Module):
- """Drop paths (Stochastic Depth) per sample (when applied in main path of residual blocks)."""
- def __init__(self, drop_prob: Optional[float] = None) -> None:
- super().__init__()
- self.drop_prob = drop_prob
- def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
- return drop_path(hidden_states, self.drop_prob, self.training)
- def extra_repr(self) -> str:
- return f"p={self.drop_prob}"
- # Copied from transformers.models.swin.modeling_swin.SwinEmbeddings with Swin->Swinv2
- class Swinv2Embeddings(nn.Module):
- """
- Construct the patch and position embeddings. Optionally, also the mask token.
- """
- def __init__(self, config, use_mask_token=False):
- super().__init__()
- self.patch_embeddings = Swinv2PatchEmbeddings(config)
- num_patches = self.patch_embeddings.num_patches
- self.patch_grid = self.patch_embeddings.grid_size
- self.mask_token = nn.Parameter(torch.zeros(1, 1, config.embed_dim)) if use_mask_token else None
- if config.use_absolute_embeddings:
- self.position_embeddings = nn.Parameter(torch.zeros(1, num_patches + 1, config.embed_dim))
- else:
- self.position_embeddings = None
- self.norm = nn.LayerNorm(config.embed_dim)
- self.dropout = nn.Dropout(config.hidden_dropout_prob)
- self.patch_size = config.patch_size
- self.config = config
- # Copied from transformers.models.vit.modeling_vit.ViTEmbeddings.interpolate_pos_encoding
- def interpolate_pos_encoding(self, embeddings: torch.Tensor, height: int, width: int) -> torch.Tensor:
- """
- This method allows to interpolate the pre-trained position encodings, to be able to use the model on higher resolution
- images. This method is also adapted to support torch.jit tracing.
- Adapted from:
- - https://github.com/facebookresearch/dino/blob/de9ee3df6cf39fac952ab558447af1fa1365362a/vision_transformer.py#L174-L194, and
- - https://github.com/facebookresearch/dinov2/blob/e1277af2ba9496fbadf7aec6eba56e8d882d1e35/dinov2/models/vision_transformer.py#L179-L211
- """
- num_patches = embeddings.shape[1] - 1
- num_positions = self.position_embeddings.shape[1] - 1
- # always interpolate when tracing to ensure the exported model works for dynamic input shapes
- if not torch.jit.is_tracing() and num_patches == num_positions and height == width:
- return self.position_embeddings
- class_pos_embed = self.position_embeddings[:, :1]
- patch_pos_embed = self.position_embeddings[:, 1:]
- dim = embeddings.shape[-1]
- new_height = height // self.patch_size
- new_width = width // self.patch_size
- sqrt_num_positions = torch_int(num_positions**0.5)
- patch_pos_embed = patch_pos_embed.reshape(1, sqrt_num_positions, sqrt_num_positions, dim)
- patch_pos_embed = patch_pos_embed.permute(0, 3, 1, 2)
- patch_pos_embed = nn.functional.interpolate(
- patch_pos_embed,
- size=(new_height, new_width),
- mode="bicubic",
- align_corners=False,
- )
- patch_pos_embed = patch_pos_embed.permute(0, 2, 3, 1).view(1, -1, dim)
- return torch.cat((class_pos_embed, patch_pos_embed), dim=1)
- def forward(
- self,
- pixel_values: Optional[torch.FloatTensor],
- bool_masked_pos: Optional[torch.BoolTensor] = None,
- interpolate_pos_encoding: bool = False,
- ) -> tuple[torch.Tensor]:
- _, num_channels, height, width = pixel_values.shape
- embeddings, output_dimensions = self.patch_embeddings(pixel_values)
- embeddings = self.norm(embeddings)
- batch_size, seq_len, _ = embeddings.size()
- if bool_masked_pos is not None:
- mask_tokens = self.mask_token.expand(batch_size, seq_len, -1)
- # replace the masked visual tokens by mask_tokens
- mask = bool_masked_pos.unsqueeze(-1).type_as(mask_tokens)
- embeddings = embeddings * (1.0 - mask) + mask_tokens * mask
- if self.position_embeddings is not None:
- if interpolate_pos_encoding:
- embeddings = embeddings + self.interpolate_pos_encoding(embeddings, height, width)
- else:
- embeddings = embeddings + self.position_embeddings
- embeddings = self.dropout(embeddings)
- return embeddings, output_dimensions
- # Copied from transformers.models.swin.modeling_swin.SwinPatchEmbeddings with Swin->Swinv2
- class Swinv2PatchEmbeddings(nn.Module):
- """
- This class turns `pixel_values` of shape `(batch_size, num_channels, height, width)` into the initial
- `hidden_states` (patch embeddings) of shape `(batch_size, seq_length, hidden_size)` to be consumed by a
- Transformer.
- """
- def __init__(self, config):
- super().__init__()
- image_size, patch_size = config.image_size, config.patch_size
- num_channels, hidden_size = config.num_channels, config.embed_dim
- image_size = image_size if isinstance(image_size, collections.abc.Iterable) else (image_size, image_size)
- patch_size = patch_size if isinstance(patch_size, collections.abc.Iterable) else (patch_size, patch_size)
- num_patches = (image_size[1] // patch_size[1]) * (image_size[0] // patch_size[0])
- self.image_size = image_size
- self.patch_size = patch_size
- self.num_channels = num_channels
- self.num_patches = num_patches
- self.grid_size = (image_size[0] // patch_size[0], image_size[1] // patch_size[1])
- self.projection = nn.Conv2d(num_channels, hidden_size, kernel_size=patch_size, stride=patch_size)
- def maybe_pad(self, pixel_values, height, width):
- if width % self.patch_size[1] != 0:
- pad_values = (0, self.patch_size[1] - width % self.patch_size[1])
- pixel_values = nn.functional.pad(pixel_values, pad_values)
- if height % self.patch_size[0] != 0:
- pad_values = (0, 0, 0, self.patch_size[0] - height % self.patch_size[0])
- pixel_values = nn.functional.pad(pixel_values, pad_values)
- return pixel_values
- def forward(self, pixel_values: Optional[torch.FloatTensor]) -> tuple[torch.Tensor, tuple[int]]:
- _, num_channels, height, width = pixel_values.shape
- # pad the input to be divisible by self.patch_size, if needed
- pixel_values = self.maybe_pad(pixel_values, height, width)
- embeddings = self.projection(pixel_values)
- _, _, height, width = embeddings.shape
- output_dimensions = (height, width)
- embeddings = embeddings.flatten(2).transpose(1, 2)
- return embeddings, output_dimensions
- class Swinv2PatchMerging(nn.Module):
- """
- Patch Merging Layer.
- Args:
- input_resolution (`tuple[int]`):
- Resolution of input feature.
- dim (`int`):
- Number of input channels.
- norm_layer (`nn.Module`, *optional*, defaults to `nn.LayerNorm`):
- Normalization layer class.
- """
- def __init__(self, input_resolution: tuple[int], dim: int, norm_layer: nn.Module = nn.LayerNorm) -> None:
- super().__init__()
- self.input_resolution = input_resolution
- self.dim = dim
- self.reduction = nn.Linear(4 * dim, 2 * dim, bias=False)
- self.norm = norm_layer(2 * dim)
- def maybe_pad(self, input_feature, height, width):
- should_pad = (height % 2 == 1) or (width % 2 == 1)
- if should_pad:
- pad_values = (0, 0, 0, width % 2, 0, height % 2)
- input_feature = nn.functional.pad(input_feature, pad_values)
- return input_feature
- def forward(self, input_feature: torch.Tensor, input_dimensions: tuple[int, int]) -> torch.Tensor:
- height, width = input_dimensions
- # `dim` is height * width
- batch_size, dim, num_channels = input_feature.shape
- input_feature = input_feature.view(batch_size, height, width, num_channels)
- # pad input to be divisible by width and height, if needed
- input_feature = self.maybe_pad(input_feature, height, width)
- # [batch_size, height/2, width/2, num_channels]
- input_feature_0 = input_feature[:, 0::2, 0::2, :]
- # [batch_size, height/2, width/2, num_channels]
- input_feature_1 = input_feature[:, 1::2, 0::2, :]
- # [batch_size, height/2, width/2, num_channels]
- input_feature_2 = input_feature[:, 0::2, 1::2, :]
- # [batch_size, height/2, width/2, num_channels]
- input_feature_3 = input_feature[:, 1::2, 1::2, :]
- # [batch_size, height/2 * width/2, 4*num_channels]
- input_feature = torch.cat([input_feature_0, input_feature_1, input_feature_2, input_feature_3], -1)
- input_feature = input_feature.view(batch_size, -1, 4 * num_channels) # [batch_size, height/2 * width/2, 4*C]
- input_feature = self.reduction(input_feature)
- input_feature = self.norm(input_feature)
- return input_feature
- class Swinv2SelfAttention(nn.Module):
- def __init__(self, config, dim, num_heads, window_size, pretrained_window_size=[0, 0]):
- super().__init__()
- if dim % num_heads != 0:
- raise ValueError(
- f"The hidden size ({dim}) is not a multiple of the number of attention heads ({num_heads})"
- )
- self.num_attention_heads = num_heads
- self.attention_head_size = int(dim / num_heads)
- self.all_head_size = self.num_attention_heads * self.attention_head_size
- self.window_size = (
- window_size if isinstance(window_size, collections.abc.Iterable) else (window_size, window_size)
- )
- self.pretrained_window_size = pretrained_window_size
- self.logit_scale = nn.Parameter(torch.log(10 * torch.ones((num_heads, 1, 1))))
- # mlp to generate continuous relative position bias
- self.continuous_position_bias_mlp = nn.Sequential(
- nn.Linear(2, 512, bias=True), nn.ReLU(inplace=True), nn.Linear(512, num_heads, bias=False)
- )
- # get relative_coords_table
- relative_coords_h = torch.arange(-(self.window_size[0] - 1), self.window_size[0], dtype=torch.int64).float()
- relative_coords_w = torch.arange(-(self.window_size[1] - 1), self.window_size[1], dtype=torch.int64).float()
- relative_coords_table = (
- torch.stack(meshgrid([relative_coords_h, relative_coords_w], indexing="ij"))
- .permute(1, 2, 0)
- .contiguous()
- .unsqueeze(0)
- ) # [1, 2*window_height - 1, 2*window_width - 1, 2]
- if pretrained_window_size[0] > 0:
- relative_coords_table[:, :, :, 0] /= pretrained_window_size[0] - 1
- relative_coords_table[:, :, :, 1] /= pretrained_window_size[1] - 1
- elif window_size > 1:
- relative_coords_table[:, :, :, 0] /= self.window_size[0] - 1
- relative_coords_table[:, :, :, 1] /= self.window_size[1] - 1
- relative_coords_table *= 8 # normalize to -8, 8
- relative_coords_table = (
- torch.sign(relative_coords_table) * torch.log2(torch.abs(relative_coords_table) + 1.0) / math.log2(8)
- )
- # set to same dtype as mlp weight
- relative_coords_table = relative_coords_table.to(next(self.continuous_position_bias_mlp.parameters()).dtype)
- self.register_buffer("relative_coords_table", relative_coords_table, persistent=False)
- # get pair-wise relative position index for each token inside the window
- coords_h = torch.arange(self.window_size[0])
- coords_w = torch.arange(self.window_size[1])
- coords = torch.stack(meshgrid([coords_h, coords_w], indexing="ij"))
- coords_flatten = torch.flatten(coords, 1)
- relative_coords = coords_flatten[:, :, None] - coords_flatten[:, None, :]
- relative_coords = relative_coords.permute(1, 2, 0).contiguous()
- relative_coords[:, :, 0] += self.window_size[0] - 1
- relative_coords[:, :, 1] += self.window_size[1] - 1
- relative_coords[:, :, 0] *= 2 * self.window_size[1] - 1
- relative_position_index = relative_coords.sum(-1)
- self.register_buffer("relative_position_index", relative_position_index, persistent=False)
- self.query = nn.Linear(self.all_head_size, self.all_head_size, bias=config.qkv_bias)
- self.key = nn.Linear(self.all_head_size, self.all_head_size, bias=False)
- self.value = nn.Linear(self.all_head_size, self.all_head_size, bias=config.qkv_bias)
- self.dropout = nn.Dropout(config.attention_probs_dropout_prob)
- def forward(
- self,
- hidden_states: torch.Tensor,
- attention_mask: Optional[torch.FloatTensor] = None,
- head_mask: Optional[torch.FloatTensor] = None,
- output_attentions: Optional[bool] = False,
- ) -> tuple[torch.Tensor]:
- batch_size, dim, num_channels = hidden_states.shape
- query_layer = (
- self.query(hidden_states)
- .view(batch_size, -1, self.num_attention_heads, self.attention_head_size)
- .transpose(1, 2)
- )
- key_layer = (
- self.key(hidden_states)
- .view(batch_size, -1, self.num_attention_heads, self.attention_head_size)
- .transpose(1, 2)
- )
- value_layer = (
- self.value(hidden_states)
- .view(batch_size, -1, self.num_attention_heads, self.attention_head_size)
- .transpose(1, 2)
- )
- # cosine attention
- attention_scores = nn.functional.normalize(query_layer, dim=-1) @ nn.functional.normalize(
- key_layer, dim=-1
- ).transpose(-2, -1)
- logit_scale = torch.clamp(self.logit_scale, max=math.log(1.0 / 0.01)).exp()
- attention_scores = attention_scores * logit_scale
- relative_position_bias_table = self.continuous_position_bias_mlp(self.relative_coords_table).view(
- -1, self.num_attention_heads
- )
- # [window_height*window_width,window_height*window_width,num_attention_heads]
- relative_position_bias = relative_position_bias_table[self.relative_position_index.view(-1)].view(
- self.window_size[0] * self.window_size[1], self.window_size[0] * self.window_size[1], -1
- )
- # [num_attention_heads,window_height*window_width,window_height*window_width]
- relative_position_bias = relative_position_bias.permute(2, 0, 1).contiguous() # nH, Wh*Ww, Wh*Ww
- relative_position_bias = 16 * torch.sigmoid(relative_position_bias)
- attention_scores = attention_scores + relative_position_bias.unsqueeze(0)
- if attention_mask is not None:
- # Apply the attention mask is (precomputed for all layers in Swinv2Model forward() function)
- mask_shape = attention_mask.shape[0]
- attention_scores = attention_scores.view(
- batch_size // mask_shape, mask_shape, self.num_attention_heads, dim, dim
- ) + attention_mask.unsqueeze(1).unsqueeze(0)
- attention_scores = attention_scores + attention_mask.unsqueeze(1).unsqueeze(0)
- attention_scores = attention_scores.view(-1, self.num_attention_heads, dim, dim)
- # Normalize the attention scores to probabilities.
- attention_probs = nn.functional.softmax(attention_scores, dim=-1)
- # This is actually dropping out entire tokens to attend to, which might
- # seem a bit unusual, but is taken from the original Transformer paper.
- attention_probs = self.dropout(attention_probs)
- # Mask heads if we want to
- if head_mask is not None:
- attention_probs = attention_probs * head_mask
- context_layer = torch.matmul(attention_probs, value_layer)
- context_layer = context_layer.permute(0, 2, 1, 3).contiguous()
- new_context_layer_shape = context_layer.size()[:-2] + (self.all_head_size,)
- context_layer = context_layer.view(new_context_layer_shape)
- outputs = (context_layer, attention_probs) if output_attentions else (context_layer,)
- return outputs
- # Copied from transformers.models.swin.modeling_swin.SwinSelfOutput with Swin->Swinv2
- class Swinv2SelfOutput(nn.Module):
- def __init__(self, config, dim):
- super().__init__()
- self.dense = nn.Linear(dim, dim)
- self.dropout = nn.Dropout(config.attention_probs_dropout_prob)
- def forward(self, hidden_states: torch.Tensor, input_tensor: torch.Tensor) -> torch.Tensor:
- hidden_states = self.dense(hidden_states)
- hidden_states = self.dropout(hidden_states)
- return hidden_states
- class Swinv2Attention(nn.Module):
- def __init__(self, config, dim, num_heads, window_size, pretrained_window_size=0):
- super().__init__()
- self.self = Swinv2SelfAttention(
- config=config,
- dim=dim,
- num_heads=num_heads,
- window_size=window_size,
- pretrained_window_size=pretrained_window_size
- if isinstance(pretrained_window_size, collections.abc.Iterable)
- else (pretrained_window_size, pretrained_window_size),
- )
- self.output = Swinv2SelfOutput(config, dim)
- self.pruned_heads = set()
- def prune_heads(self, heads):
- if len(heads) == 0:
- return
- heads, index = find_pruneable_heads_and_indices(
- heads, self.self.num_attention_heads, self.self.attention_head_size, self.pruned_heads
- )
- # Prune linear layers
- self.self.query = prune_linear_layer(self.self.query, index)
- self.self.key = prune_linear_layer(self.self.key, index)
- self.self.value = prune_linear_layer(self.self.value, index)
- self.output.dense = prune_linear_layer(self.output.dense, index, dim=1)
- # Update hyper params and store pruned heads
- self.self.num_attention_heads = self.self.num_attention_heads - len(heads)
- self.self.all_head_size = self.self.attention_head_size * self.self.num_attention_heads
- self.pruned_heads = self.pruned_heads.union(heads)
- def forward(
- self,
- hidden_states: torch.Tensor,
- attention_mask: Optional[torch.FloatTensor] = None,
- head_mask: Optional[torch.FloatTensor] = None,
- output_attentions: Optional[bool] = False,
- ) -> tuple[torch.Tensor]:
- self_outputs = self.self(hidden_states, attention_mask, head_mask, output_attentions)
- attention_output = self.output(self_outputs[0], hidden_states)
- outputs = (attention_output,) + self_outputs[1:] # add attentions if we output them
- return outputs
- # Copied from transformers.models.swin.modeling_swin.SwinIntermediate with Swin->Swinv2
- class Swinv2Intermediate(nn.Module):
- def __init__(self, config, dim):
- super().__init__()
- self.dense = nn.Linear(dim, int(config.mlp_ratio * dim))
- if isinstance(config.hidden_act, str):
- self.intermediate_act_fn = ACT2FN[config.hidden_act]
- else:
- self.intermediate_act_fn = config.hidden_act
- def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
- hidden_states = self.dense(hidden_states)
- hidden_states = self.intermediate_act_fn(hidden_states)
- return hidden_states
- # Copied from transformers.models.swin.modeling_swin.SwinOutput with Swin->Swinv2
- class Swinv2Output(nn.Module):
- def __init__(self, config, dim):
- super().__init__()
- self.dense = nn.Linear(int(config.mlp_ratio * dim), dim)
- self.dropout = nn.Dropout(config.hidden_dropout_prob)
- def forward(self, hidden_states: torch.Tensor) -> torch.Tensor:
- hidden_states = self.dense(hidden_states)
- hidden_states = self.dropout(hidden_states)
- return hidden_states
- class Swinv2Layer(nn.Module):
- def __init__(
- self, config, dim, input_resolution, num_heads, drop_path_rate=0.0, shift_size=0, pretrained_window_size=0
- ):
- super().__init__()
- self.input_resolution = input_resolution
- window_size, shift_size = self._compute_window_shift(
- (config.window_size, config.window_size), (shift_size, shift_size)
- )
- self.window_size = window_size[0]
- self.shift_size = shift_size[0]
- self.attention = Swinv2Attention(
- config=config,
- dim=dim,
- num_heads=num_heads,
- window_size=self.window_size,
- pretrained_window_size=pretrained_window_size
- if isinstance(pretrained_window_size, collections.abc.Iterable)
- else (pretrained_window_size, pretrained_window_size),
- )
- self.layernorm_before = nn.LayerNorm(dim, eps=config.layer_norm_eps)
- self.drop_path = Swinv2DropPath(drop_path_rate) if drop_path_rate > 0.0 else nn.Identity()
- self.intermediate = Swinv2Intermediate(config, dim)
- self.output = Swinv2Output(config, dim)
- self.layernorm_after = nn.LayerNorm(dim, eps=config.layer_norm_eps)
- def _compute_window_shift(self, target_window_size, target_shift_size) -> tuple[tuple[int, int], tuple[int, int]]:
- window_size = [r if r <= w else w for r, w in zip(self.input_resolution, target_window_size)]
- shift_size = [0 if r <= w else s for r, w, s in zip(self.input_resolution, window_size, target_shift_size)]
- return window_size, shift_size
- def get_attn_mask(self, height, width, dtype):
- if self.shift_size > 0:
- # calculate attention mask for shifted window multihead self attention
- img_mask = torch.zeros((1, height, width, 1), dtype=dtype)
- height_slices = (
- slice(0, -self.window_size),
- slice(-self.window_size, -self.shift_size),
- slice(-self.shift_size, None),
- )
- width_slices = (
- slice(0, -self.window_size),
- slice(-self.window_size, -self.shift_size),
- slice(-self.shift_size, None),
- )
- count = 0
- for height_slice in height_slices:
- for width_slice in width_slices:
- img_mask[:, height_slice, width_slice, :] = count
- count += 1
- mask_windows = window_partition(img_mask, self.window_size)
- mask_windows = mask_windows.view(-1, self.window_size * self.window_size)
- attn_mask = mask_windows.unsqueeze(1) - mask_windows.unsqueeze(2)
- attn_mask = attn_mask.masked_fill(attn_mask != 0, -100.0).masked_fill(attn_mask == 0, 0.0)
- else:
- attn_mask = None
- return attn_mask
- def maybe_pad(self, hidden_states, height, width):
- pad_right = (self.window_size - width % self.window_size) % self.window_size
- pad_bottom = (self.window_size - height % self.window_size) % self.window_size
- pad_values = (0, 0, 0, pad_right, 0, pad_bottom)
- hidden_states = nn.functional.pad(hidden_states, pad_values)
- return hidden_states, pad_values
- def forward(
- self,
- hidden_states: torch.Tensor,
- input_dimensions: tuple[int, int],
- head_mask: Optional[torch.FloatTensor] = None,
- output_attentions: Optional[bool] = False,
- ) -> tuple[torch.Tensor, torch.Tensor]:
- height, width = input_dimensions
- batch_size, _, channels = hidden_states.size()
- shortcut = hidden_states
- # pad hidden_states to multiples of window size
- hidden_states = hidden_states.view(batch_size, height, width, channels)
- hidden_states, pad_values = self.maybe_pad(hidden_states, height, width)
- _, height_pad, width_pad, _ = hidden_states.shape
- # cyclic shift
- if self.shift_size > 0:
- shifted_hidden_states = torch.roll(hidden_states, shifts=(-self.shift_size, -self.shift_size), dims=(1, 2))
- else:
- shifted_hidden_states = hidden_states
- # partition windows
- hidden_states_windows = window_partition(shifted_hidden_states, self.window_size)
- hidden_states_windows = hidden_states_windows.view(-1, self.window_size * self.window_size, channels)
- attn_mask = self.get_attn_mask(height_pad, width_pad, dtype=hidden_states.dtype)
- if attn_mask is not None:
- attn_mask = attn_mask.to(hidden_states_windows.device)
- attention_outputs = self.attention(
- hidden_states_windows, attn_mask, head_mask, output_attentions=output_attentions
- )
- attention_output = attention_outputs[0]
- attention_windows = attention_output.view(-1, self.window_size, self.window_size, channels)
- shifted_windows = window_reverse(attention_windows, self.window_size, height_pad, width_pad)
- # reverse cyclic shift
- if self.shift_size > 0:
- attention_windows = torch.roll(shifted_windows, shifts=(self.shift_size, self.shift_size), dims=(1, 2))
- else:
- attention_windows = shifted_windows
- was_padded = pad_values[3] > 0 or pad_values[5] > 0
- if was_padded:
- attention_windows = attention_windows[:, :height, :width, :].contiguous()
- attention_windows = attention_windows.view(batch_size, height * width, channels)
- hidden_states = self.layernorm_before(attention_windows)
- hidden_states = shortcut + self.drop_path(hidden_states)
- layer_output = self.intermediate(hidden_states)
- layer_output = self.output(layer_output)
- layer_output = hidden_states + self.drop_path(self.layernorm_after(layer_output))
- layer_outputs = (layer_output, attention_outputs[1]) if output_attentions else (layer_output,)
- return layer_outputs
- class Swinv2Stage(GradientCheckpointingLayer):
- def __init__(
- self, config, dim, input_resolution, depth, num_heads, drop_path, downsample, pretrained_window_size=0
- ):
- super().__init__()
- self.config = config
- self.dim = dim
- blocks = []
- for i in range(depth):
- block = Swinv2Layer(
- config=config,
- dim=dim,
- input_resolution=input_resolution,
- num_heads=num_heads,
- drop_path_rate=drop_path[i],
- shift_size=0 if (i % 2 == 0) else config.window_size // 2,
- pretrained_window_size=pretrained_window_size,
- )
- blocks.append(block)
- self.blocks = nn.ModuleList(blocks)
- # patch merging layer
- if downsample is not None:
- self.downsample = downsample(input_resolution, dim=dim, norm_layer=nn.LayerNorm)
- else:
- self.downsample = None
- self.pointing = False
- def forward(
- self,
- hidden_states: torch.Tensor,
- input_dimensions: tuple[int, int],
- head_mask: Optional[torch.FloatTensor] = None,
- output_attentions: Optional[bool] = False,
- ) -> tuple[torch.Tensor]:
- height, width = input_dimensions
- for i, layer_module in enumerate(self.blocks):
- layer_head_mask = head_mask[i] if head_mask is not None else None
- layer_outputs = layer_module(
- hidden_states,
- input_dimensions,
- layer_head_mask,
- output_attentions,
- )
- hidden_states = layer_outputs[0]
- hidden_states_before_downsampling = hidden_states
- if self.downsample is not None:
- height_downsampled, width_downsampled = (height + 1) // 2, (width + 1) // 2
- output_dimensions = (height, width, height_downsampled, width_downsampled)
- hidden_states = self.downsample(hidden_states_before_downsampling, input_dimensions)
- else:
- output_dimensions = (height, width, height, width)
- stage_outputs = (hidden_states, hidden_states_before_downsampling, output_dimensions)
- if output_attentions:
- stage_outputs += layer_outputs[1:]
- return stage_outputs
- class Swinv2Encoder(nn.Module):
- def __init__(self, config, grid_size, pretrained_window_sizes=(0, 0, 0, 0)):
- super().__init__()
- self.num_layers = len(config.depths)
- self.config = config
- if self.config.pretrained_window_sizes is not None:
- pretrained_window_sizes = config.pretrained_window_sizes
- dpr = [x.item() for x in torch.linspace(0, config.drop_path_rate, sum(config.depths), device="cpu")]
- layers = []
- for i_layer in range(self.num_layers):
- stage = Swinv2Stage(
- config=config,
- dim=int(config.embed_dim * 2**i_layer),
- input_resolution=(grid_size[0] // (2**i_layer), grid_size[1] // (2**i_layer)),
- depth=config.depths[i_layer],
- num_heads=config.num_heads[i_layer],
- drop_path=dpr[sum(config.depths[:i_layer]) : sum(config.depths[: i_layer + 1])],
- downsample=Swinv2PatchMerging if (i_layer < self.num_layers - 1) else None,
- pretrained_window_size=pretrained_window_sizes[i_layer],
- )
- layers.append(stage)
- self.layers = nn.ModuleList(layers)
- self.gradient_checkpointing = False
- def forward(
- self,
- hidden_states: torch.Tensor,
- input_dimensions: tuple[int, int],
- head_mask: Optional[torch.FloatTensor] = None,
- output_attentions: Optional[bool] = False,
- output_hidden_states: Optional[bool] = False,
- output_hidden_states_before_downsampling: Optional[bool] = False,
- return_dict: Optional[bool] = True,
- ) -> Union[tuple, Swinv2EncoderOutput]:
- all_hidden_states = () if output_hidden_states else None
- all_reshaped_hidden_states = () if output_hidden_states else None
- all_self_attentions = () if output_attentions else None
- if output_hidden_states:
- batch_size, _, hidden_size = hidden_states.shape
- # rearrange b (h w) c -> b c h w
- reshaped_hidden_state = hidden_states.view(batch_size, *input_dimensions, hidden_size)
- reshaped_hidden_state = reshaped_hidden_state.permute(0, 3, 1, 2)
- all_hidden_states += (hidden_states,)
- all_reshaped_hidden_states += (reshaped_hidden_state,)
- for i, layer_module in enumerate(self.layers):
- layer_head_mask = head_mask[i] if head_mask is not None else None
- layer_outputs = layer_module(
- hidden_states,
- input_dimensions,
- layer_head_mask,
- output_attentions,
- )
- hidden_states = layer_outputs[0]
- hidden_states_before_downsampling = layer_outputs[1]
- output_dimensions = layer_outputs[2]
- input_dimensions = (output_dimensions[-2], output_dimensions[-1])
- if output_hidden_states and output_hidden_states_before_downsampling:
- batch_size, _, hidden_size = hidden_states_before_downsampling.shape
- # rearrange b (h w) c -> b c h w
- # here we use the original (not downsampled) height and width
- reshaped_hidden_state = hidden_states_before_downsampling.view(
- batch_size, *(output_dimensions[0], output_dimensions[1]), hidden_size
- )
- reshaped_hidden_state = reshaped_hidden_state.permute(0, 3, 1, 2)
- all_hidden_states += (hidden_states_before_downsampling,)
- all_reshaped_hidden_states += (reshaped_hidden_state,)
- elif output_hidden_states and not output_hidden_states_before_downsampling:
- batch_size, _, hidden_size = hidden_states.shape
- # rearrange b (h w) c -> b c h w
- reshaped_hidden_state = hidden_states.view(batch_size, *input_dimensions, hidden_size)
- reshaped_hidden_state = reshaped_hidden_state.permute(0, 3, 1, 2)
- all_hidden_states += (hidden_states,)
- all_reshaped_hidden_states += (reshaped_hidden_state,)
- if output_attentions:
- all_self_attentions += layer_outputs[3:]
- if not return_dict:
- return tuple(
- v
- for v in [hidden_states, all_hidden_states, all_self_attentions, all_reshaped_hidden_states]
- if v is not None
- )
- return Swinv2EncoderOutput(
- last_hidden_state=hidden_states,
- hidden_states=all_hidden_states,
- attentions=all_self_attentions,
- reshaped_hidden_states=all_reshaped_hidden_states,
- )
- @auto_docstring
- class Swinv2PreTrainedModel(PreTrainedModel):
- config: Swinv2Config
- base_model_prefix = "swinv2"
- main_input_name = "pixel_values"
- supports_gradient_checkpointing = True
- _no_split_modules = ["Swinv2Stage"]
- def _init_weights(self, module):
- """Initialize the weights"""
- if isinstance(module, (nn.Linear, nn.Conv2d)):
- # Slightly different from the TF version which uses truncated_normal for initialization
- # cf https://github.com/pytorch/pytorch/pull/5617
- module.weight.data.normal_(mean=0.0, std=self.config.initializer_range)
- if module.bias is not None:
- module.bias.data.zero_()
- elif isinstance(module, nn.LayerNorm):
- module.bias.data.zero_()
- module.weight.data.fill_(1.0)
- elif isinstance(module, Swinv2Embeddings):
- if module.mask_token is not None:
- module.mask_token.data.zero_()
- if module.position_embeddings is not None:
- module.position_embeddings.data.zero_()
- elif isinstance(module, Swinv2SelfAttention):
- module.logit_scale.data.fill_(math.log(10))
- @auto_docstring
- # Copied from transformers.models.swin.modeling_swin.SwinModel with SWIN->SWINV2,Swin->Swinv2
- class Swinv2Model(Swinv2PreTrainedModel):
- def __init__(self, config, add_pooling_layer=True, use_mask_token=False):
- r"""
- add_pooling_layer (`bool`, *optional*, defaults to `True`):
- Whether or not to apply pooling layer.
- use_mask_token (`bool`, *optional*, defaults to `False`):
- Whether or not to create and apply mask tokens in the embedding layer.
- """
- super().__init__(config)
- self.config = config
- self.num_layers = len(config.depths)
- self.num_features = int(config.embed_dim * 2 ** (self.num_layers - 1))
- self.embeddings = Swinv2Embeddings(config, use_mask_token=use_mask_token)
- self.encoder = Swinv2Encoder(config, self.embeddings.patch_grid)
- self.layernorm = nn.LayerNorm(self.num_features, eps=config.layer_norm_eps)
- self.pooler = nn.AdaptiveAvgPool1d(1) if add_pooling_layer else None
- # Initialize weights and apply final processing
- self.post_init()
- def get_input_embeddings(self):
- return self.embeddings.patch_embeddings
- def _prune_heads(self, heads_to_prune):
- """
- Prunes heads of the model. heads_to_prune: dict of {layer_num: list of heads to prune in this layer} See base
- class PreTrainedModel
- """
- for layer, heads in heads_to_prune.items():
- self.encoder.layer[layer].attention.prune_heads(heads)
- @auto_docstring
- def forward(
- self,
- pixel_values: Optional[torch.FloatTensor] = None,
- bool_masked_pos: Optional[torch.BoolTensor] = None,
- head_mask: Optional[torch.FloatTensor] = None,
- output_attentions: Optional[bool] = None,
- output_hidden_states: Optional[bool] = None,
- interpolate_pos_encoding: bool = False,
- return_dict: Optional[bool] = None,
- ) -> Union[tuple, Swinv2ModelOutput]:
- r"""
- bool_masked_pos (`torch.BoolTensor` of shape `(batch_size, num_patches)`, *optional*):
- Boolean masked positions. Indicates which patches are masked (1) and which aren't (0).
- """
- output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions
- output_hidden_states = (
- output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states
- )
- return_dict = return_dict if return_dict is not None else self.config.use_return_dict
- if pixel_values is None:
- raise ValueError("You have to specify pixel_values")
- # Prepare head mask if needed
- # 1.0 in head_mask indicate we keep the head
- # attention_probs has shape bsz x n_heads x N x N
- # input head_mask has shape [num_heads] or [num_hidden_layers x num_heads]
- # and head_mask is converted to shape [num_hidden_layers x batch x num_heads x seq_length x seq_length]
- head_mask = self.get_head_mask(head_mask, len(self.config.depths))
- embedding_output, input_dimensions = self.embeddings(
- pixel_values, bool_masked_pos=bool_masked_pos, interpolate_pos_encoding=interpolate_pos_encoding
- )
- encoder_outputs = self.encoder(
- embedding_output,
- input_dimensions,
- head_mask=head_mask,
- output_attentions=output_attentions,
- output_hidden_states=output_hidden_states,
- return_dict=return_dict,
- )
- sequence_output = encoder_outputs[0]
- sequence_output = self.layernorm(sequence_output)
- pooled_output = None
- if self.pooler is not None:
- pooled_output = self.pooler(sequence_output.transpose(1, 2))
- pooled_output = torch.flatten(pooled_output, 1)
- if not return_dict:
- output = (sequence_output, pooled_output) + encoder_outputs[1:]
- return output
- return Swinv2ModelOutput(
- last_hidden_state=sequence_output,
- pooler_output=pooled_output,
- hidden_states=encoder_outputs.hidden_states,
- attentions=encoder_outputs.attentions,
- reshaped_hidden_states=encoder_outputs.reshaped_hidden_states,
- )
- @auto_docstring(
- custom_intro="""
- Swinv2 Model with a decoder on top for masked image modeling, as proposed in
- [SimMIM](https://huggingface.co/papers/2111.09886).
- <Tip>
- Note that we provide a script to pre-train this model on custom data in our [examples
- directory](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-pretraining).
- </Tip>
- """
- )
- # Copied from transformers.models.swin.modeling_swin.SwinForMaskedImageModeling with swin->swinv2, base-simmim-window6-192->tiny-patch4-window8-256,SWIN->SWINV2,Swin->Swinv2,192->256
- class Swinv2ForMaskedImageModeling(Swinv2PreTrainedModel):
- def __init__(self, config):
- super().__init__(config)
- self.swinv2 = Swinv2Model(config, add_pooling_layer=False, use_mask_token=True)
- num_features = int(config.embed_dim * 2 ** (config.num_layers - 1))
- self.decoder = nn.Sequential(
- nn.Conv2d(
- in_channels=num_features, out_channels=config.encoder_stride**2 * config.num_channels, kernel_size=1
- ),
- nn.PixelShuffle(config.encoder_stride),
- )
- # Initialize weights and apply final processing
- self.post_init()
- @auto_docstring
- def forward(
- self,
- pixel_values: Optional[torch.FloatTensor] = None,
- bool_masked_pos: Optional[torch.BoolTensor] = None,
- head_mask: Optional[torch.FloatTensor] = None,
- output_attentions: Optional[bool] = None,
- output_hidden_states: Optional[bool] = None,
- interpolate_pos_encoding: bool = False,
- return_dict: Optional[bool] = None,
- ) -> Union[tuple, Swinv2MaskedImageModelingOutput]:
- r"""
- 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).
- Examples:
- ```python
- >>> from transformers import AutoImageProcessor, Swinv2ForMaskedImageModeling
- >>> import torch
- >>> from PIL import Image
- >>> import requests
- >>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
- >>> image = Image.open(requests.get(url, stream=True).raw)
- >>> image_processor = AutoImageProcessor.from_pretrained("microsoft/swinv2-tiny-patch4-window8-256")
- >>> model = Swinv2ForMaskedImageModeling.from_pretrained("microsoft/swinv2-tiny-patch4-window8-256")
- >>> num_patches = (model.config.image_size // model.config.patch_size) ** 2
- >>> pixel_values = image_processor(images=image, return_tensors="pt").pixel_values
- >>> # create random boolean mask of shape (batch_size, num_patches)
- >>> bool_masked_pos = torch.randint(low=0, high=2, size=(1, num_patches)).bool()
- >>> outputs = model(pixel_values, bool_masked_pos=bool_masked_pos)
- >>> loss, reconstructed_pixel_values = outputs.loss, outputs.reconstruction
- >>> list(reconstructed_pixel_values.shape)
- [1, 3, 256, 256]
- ```"""
- return_dict = return_dict if return_dict is not None else self.config.use_return_dict
- outputs = self.swinv2(
- pixel_values,
- bool_masked_pos=bool_masked_pos,
- head_mask=head_mask,
- output_attentions=output_attentions,
- output_hidden_states=output_hidden_states,
- interpolate_pos_encoding=interpolate_pos_encoding,
- return_dict=return_dict,
- )
- sequence_output = outputs[0]
- # Reshape to (batch_size, num_channels, height, width)
- sequence_output = sequence_output.transpose(1, 2)
- batch_size, num_channels, sequence_length = sequence_output.shape
- height = width = math.floor(sequence_length**0.5)
- sequence_output = sequence_output.reshape(batch_size, num_channels, height, width)
- # Reconstruct pixel values
- reconstructed_pixel_values = self.decoder(sequence_output)
- masked_im_loss = None
- if bool_masked_pos is not None:
- size = self.config.image_size // self.config.patch_size
- bool_masked_pos = bool_masked_pos.reshape(-1, size, size)
- mask = (
- bool_masked_pos.repeat_interleave(self.config.patch_size, 1)
- .repeat_interleave(self.config.patch_size, 2)
- .unsqueeze(1)
- .contiguous()
- )
- reconstruction_loss = nn.functional.l1_loss(pixel_values, reconstructed_pixel_values, reduction="none")
- masked_im_loss = (reconstruction_loss * mask).sum() / (mask.sum() + 1e-5) / self.config.num_channels
- if not return_dict:
- output = (reconstructed_pixel_values,) + outputs[2:]
- return ((masked_im_loss,) + output) if masked_im_loss is not None else output
- return Swinv2MaskedImageModelingOutput(
- loss=masked_im_loss,
- reconstruction=reconstructed_pixel_values,
- hidden_states=outputs.hidden_states,
- attentions=outputs.attentions,
- reshaped_hidden_states=outputs.reshaped_hidden_states,
- )
- @auto_docstring(
- custom_intro="""
- Swinv2 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.
- <Tip>
- Note that it's possible to fine-tune SwinV2 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.
- </Tip>
- """
- )
- # Copied from transformers.models.swin.modeling_swin.SwinForImageClassification with SWIN->SWINV2,Swin->Swinv2,swin->swinv2
- class Swinv2ForImageClassification(Swinv2PreTrainedModel):
- def __init__(self, config):
- super().__init__(config)
- self.num_labels = config.num_labels
- self.swinv2 = Swinv2Model(config)
- # Classifier head
- self.classifier = (
- nn.Linear(self.swinv2.num_features, config.num_labels) if config.num_labels > 0 else nn.Identity()
- )
- # Initialize weights and apply final processing
- self.post_init()
- @auto_docstring
- def forward(
- self,
- pixel_values: Optional[torch.FloatTensor] = None,
- head_mask: Optional[torch.FloatTensor] = None,
- labels: Optional[torch.LongTensor] = None,
- output_attentions: Optional[bool] = None,
- output_hidden_states: Optional[bool] = None,
- interpolate_pos_encoding: bool = False,
- return_dict: Optional[bool] = None,
- ) -> Union[tuple, Swinv2ImageClassifierOutput]:
- r"""
- 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), If
- `config.num_labels > 1` a classification loss is computed (Cross-Entropy).
- """
- return_dict = return_dict if return_dict is not None else self.config.use_return_dict
- outputs = self.swinv2(
- pixel_values,
- head_mask=head_mask,
- output_attentions=output_attentions,
- output_hidden_states=output_hidden_states,
- interpolate_pos_encoding=interpolate_pos_encoding,
- return_dict=return_dict,
- )
- pooled_output = outputs[1]
- logits = self.classifier(pooled_output)
- loss = None
- if labels is not None:
- loss = self.loss_function(labels, logits, self.config)
- if not return_dict:
- output = (logits,) + outputs[2:]
- return ((loss,) + output) if loss is not None else output
- return Swinv2ImageClassifierOutput(
- loss=loss,
- logits=logits,
- hidden_states=outputs.hidden_states,
- attentions=outputs.attentions,
- reshaped_hidden_states=outputs.reshaped_hidden_states,
- )
- @auto_docstring(
- custom_intro="""
- Swinv2 backbone, to be used with frameworks like DETR and MaskFormer.
- """
- )
- class Swinv2Backbone(Swinv2PreTrainedModel, BackboneMixin):
- def __init__(self, config):
- super().__init__(config)
- super()._init_backbone(config)
- self.num_features = [config.embed_dim] + [int(config.embed_dim * 2**i) for i in range(len(config.depths))]
- self.embeddings = Swinv2Embeddings(config)
- self.encoder = Swinv2Encoder(config, self.embeddings.patch_grid)
- # initialize weights and apply final processing
- self.post_init()
- def get_input_embeddings(self):
- return self.embeddings.patch_embeddings
- @auto_docstring
- def forward(
- self,
- pixel_values: Tensor,
- output_attentions: Optional[bool] = None,
- output_hidden_states: Optional[bool] = None,
- return_dict: Optional[bool] = None,
- ) -> BackboneOutput:
- r"""
- Examples:
- ```python
- >>> from transformers import AutoImageProcessor, AutoBackbone
- >>> import torch
- >>> from PIL import Image
- >>> import requests
- >>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
- >>> image = Image.open(requests.get(url, stream=True).raw)
- >>> processor = AutoImageProcessor.from_pretrained("microsoft/swinv2-tiny-patch4-window8-256")
- >>> model = AutoBackbone.from_pretrained(
- ... "microsoft/swinv2-tiny-patch4-window8-256", out_features=["stage1", "stage2", "stage3", "stage4"]
- ... )
- >>> inputs = processor(image, return_tensors="pt")
- >>> outputs = model(**inputs)
- >>> feature_maps = outputs.feature_maps
- >>> list(feature_maps[-1].shape)
- [1, 2048, 7, 7]
- ```"""
- return_dict = return_dict if return_dict is not None else self.config.use_return_dict
- output_hidden_states = (
- output_hidden_states if output_hidden_states is not None else self.config.output_hidden_states
- )
- output_attentions = output_attentions if output_attentions is not None else self.config.output_attentions
- embedding_output, input_dimensions = self.embeddings(pixel_values)
- outputs = self.encoder(
- embedding_output,
- input_dimensions,
- head_mask=None,
- output_attentions=output_attentions,
- output_hidden_states=True,
- output_hidden_states_before_downsampling=True,
- return_dict=return_dict,
- )
- hidden_states = outputs.reshaped_hidden_states if return_dict else outputs[-1]
- feature_maps = ()
- for stage, hidden_state in zip(self.stage_names, hidden_states):
- if stage in self.out_features:
- feature_maps += (hidden_state,)
- if not return_dict:
- output = (feature_maps,)
- if output_hidden_states:
- output += (outputs[1],)
- if output_attentions:
- output += (outputs[2],)
- return output
- return BackboneOutput(
- feature_maps=feature_maps,
- hidden_states=outputs.hidden_states if output_hidden_states else None,
- attentions=outputs.attentions,
- )
- __all__ = [
- "Swinv2ForImageClassification",
- "Swinv2ForMaskedImageModeling",
- "Swinv2Model",
- "Swinv2PreTrainedModel",
- "Swinv2Backbone",
- ]
|