You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(swin): Update Swin model card to standard format (huggingface#37628)
* docs(swin): Update Swin model card to standard format
* docs(swin): Refine link to Microsoft organization for Swin models
Apply suggestion from @stevhliu in PR huggingface#37628.
This change updates the link pointing to the official Microsoft Swin Transformer checkpoints on the Hugging Face Hub.
The link now directs users specifically to the Microsoft organization page, filtered for Swin models, providing a clearer and more canonical reference compared to the previous general search link.
Co-authored-by: Steven Liu <[email protected]>
* docs(swin): Clarify padding description and link to backbone docs
Apply suggestion from @stevhliu in PR huggingface#37628.
This change introduces two improvements to the Swin model card:
1. Refines the wording describing how Swin handles input padding for better clarity.
2. Adds an internal documentation link to the general "backbones" page when discussing Swin's capability as a backbone model.
These updates enhance readability and improve navigation within the Transformers documentation.
Co-authored-by: Steven Liu <[email protected]>
* docs(swin): Change Swin paper link to huggingface.co/papers as suggested
Co-authored-by: Steven Liu <[email protected]>
---------
Co-authored-by: Steven Liu <[email protected]>
The Swin Transformer was proposed in [Swin Transformer: Hierarchical Vision Transformer using Shifted Windows](https://arxiv.org/abs/2103.14030)
27
-
by Ze Liu, Yutong Lin, Yue Cao, Han Hu, Yixuan Wei, Zheng Zhang, Stephen Lin, Baining Guo.
26
+
[Swin Transformer](https://huggingface.co/papers/2103.14030) is a hierarchical vision transformer. Images are processed in patches and windowed self-attention is used to capture local information. These windows are shifted across the image to allow for cross-window connections, capturing global information more efficiently. This hierarchical approach with shifted windows allows the Swin Transformer to process images effectively at different scales and achieve linear computational complexity relative to image size, making it a versatile backbone for various vision tasks like image classification and object detection.
28
27
29
-
The abstract from the paper is the following:
28
+
You can find all official Swin Transformer checkpoints under the [Microsoft](https://huggingface.co/microsoft?search_models=swin) organization.
30
29
31
-
*This paper presents a new vision Transformer, called Swin Transformer, that capably serves as a general-purpose backbone
32
-
for computer vision. Challenges in adapting Transformer from language to vision arise from differences between the two domains,
33
-
such as large variations in the scale of visual entities and the high resolution of pixels in images compared to words in text.
34
-
To address these differences, we propose a hierarchical Transformer whose representation is computed with \bold{S}hifted
35
-
\bold{win}dows. The shifted windowing scheme brings greater efficiency by limiting self-attention computation to non-overlapping
36
-
local windows while also allowing for cross-window connection. This hierarchical architecture has the flexibility to model at
37
-
various scales and has linear computational complexity with respect to image size. These qualities of Swin Transformer make it
38
-
compatible with a broad range of vision tasks, including image classification (87.3 top-1 accuracy on ImageNet-1K) and dense
39
-
prediction tasks such as object detection (58.7 box AP and 51.1 mask AP on COCO test-dev) and semantic segmentation
40
-
(53.5 mIoU on ADE20K val). Its performance surpasses the previous state-of-the-art by a large margin of +2.7 box AP and
41
-
+2.6 mask AP on COCO, and +3.2 mIoU on ADE20K, demonstrating the potential of Transformer-based models as vision backbones.
42
-
The hierarchical design and the shifted window approach also prove beneficial for all-MLP architectures.*
30
+
> [!TIP]
31
+
> Click on the Swin Transformer models in the right sidebar for more examples of how to apply Swin Transformer to different image tasks.
The example below demonstrates how to classify an image with [`Pipeline`] or the [`AutoModel`] class.
46
34
47
-
<small> Swin Transformer architecture. Taken from the <ahref="https://arxiv.org/abs/2102.03334">original paper</a>.</small>
35
+
<hfoptionsid="usage">
36
+
<hfoptionid="Pipeline">
48
37
49
-
This model was contributed by [novice03](https://huggingface.co/novice03). The Tensorflow version of this model was contributed by [amyeroberts](https://huggingface.co/amyeroberts). The original code can be found [here](https://github.com/microsoft/Swin-Transformer).
- Swin pads the inputs supporting any input height and width (if divisible by `32`).
54
-
- Swin can be used as a *backbone*. When `output_hidden_states = True`, it will output both `hidden_states` and `reshaped_hidden_states`. The `reshaped_hidden_states` have a shape of `(batch, num_channels, height, width)` rather than `(batch_size, sequence_length, num_channels)`.
52
+
<hfoptionid="AutoModel">
55
53
56
-
## Resources
54
+
```py
55
+
import torch
56
+
import requests
57
+
fromPILimport Image
58
+
from transformers import AutoModelForImageClassification, AutoImageProcessor
57
59
58
-
A list of official Hugging Face and community (indicated by 🌎) resources to help you get started with Swin Transformer.
-[`SwinForImageClassification`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-classification) and [notebook](https://colab.research.google.com/github/huggingface/notebooks/blob/main/examples/image_classification.ipynb).
63
-
- See also: [Image classification task guide](../tasks/image_classification)
print(f"The predicted class label is: {predicted_class_label}")
80
+
```
81
+
</hfoption>
82
+
</hfoptions>
66
83
67
-
-[`SwinForMaskedImageModeling`] is supported by this [example script](https://github.com/huggingface/transformers/tree/main/examples/pytorch/image-pretraining).
84
+
## Notes
68
85
69
-
If you're interested in submitting a resource to be included here, please feel free to open a Pull Request and we'll review it! The resource should ideally demonstrate something new instead of duplicating an existing resource.
86
+
- Swin can pad the inputs for any input height and width divisible by `32`.
87
+
- Swin can be used as a [backbone](../backbones). When `output_hidden_states = True`, it outputs both `hidden_states` and `reshaped_hidden_states`. The `reshaped_hidden_states` have a shape of `(batch, num_channels, height, width)` rather than `(batch_size, sequence_length, num_channels)`.
0 commit comments