wehub-resource-sync
e06fe8e8c6
Secret Leaks / trufflehog (push) Failing after 1s
Build documentation / build (push) Failing after 1s
Build documentation / build_other_lang (push) Failing after 0s
CodeQL Security Analysis / CodeQL Analysis (push) Failing after 0s
PR CI / pr-ci (push) Failing after 1s
Slow tests on important models (on Push - A10) / Get all modified files (push) Failing after 1s
Slow tests on important models (on Push - A10) / Model CI (push) Has been skipped
Self-hosted runner (benchmark) / Benchmark (aws-g5-4xlarge-cache) (push) Has been cancelled
New model PR merged notification / Notify new model (push) Has been cancelled
Update Transformers metadata / build_and_package (push) Has been cancelled
52 lines
2.5 KiB
Markdown
52 lines
2.5 KiB
Markdown
<!--Copyright 2021 The HuggingFace 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.
|
|
|
|
⚠️ Note that this file is in Markdown but contain specific syntax for our doc-builder (similar to MDX) that may not be
|
|
rendered properly in your Markdown viewer.
|
|
|
|
-->
|
|
*This model was published in HF papers on 2021-11-15 and contributed to Hugging Face Transformers on 2021-11-30.*
|
|
|
|
# VisionTextDualEncoder
|
|
|
|
<div class="flex flex-wrap space-x-1">
|
|
<img alt="FlashAttention" src="https://img.shields.io/badge/%E2%9A%A1%EF%B8%8E%20FlashAttention-eae0c8?style=flat">
|
|
<img alt="SDPA" src="https://img.shields.io/badge/SDPA-DE3412?style=flat&logo=pytorch&logoColor=white">
|
|
</div>
|
|
|
|
## Overview
|
|
|
|
The [`VisionTextDualEncoderModel`] can be used to initialize a vision-text dual encoder model with
|
|
any pretrained vision autoencoding model as the vision encoder (*e.g.* [ViT](vit), [BEiT](beit), [DeiT](deit)) and any pretrained text autoencoding model as the text encoder (*e.g.* [RoBERTa](roberta), [BERT](bert)). Two projection layers are added on top of both the vision and text encoder to project the output embeddings
|
|
to a shared latent space. The projection layers are randomly initialized so the model should be fine-tuned on a
|
|
downstream task. This model can be used to align the vision-text embeddings using CLIP like contrastive image-text
|
|
training and then can be used for zero-shot vision tasks such image-classification or retrieval.
|
|
|
|
In [LiT: Zero-Shot Transfer with Locked-image Text Tuning](https://huggingface.co/papers/2111.07991) it is shown how
|
|
leveraging pre-trained (locked/frozen) image and text model for contrastive learning yields significant improvement on
|
|
new zero-shot vision tasks such as image classification or retrieval.
|
|
|
|
## VisionTextDualEncoderConfig
|
|
|
|
[[autodoc]] VisionTextDualEncoderConfig
|
|
|
|
## VisionTextDualEncoderProcessor
|
|
|
|
[[autodoc]] VisionTextDualEncoderProcessor
|
|
- __call__
|
|
|
|
## VisionTextDualEncoderModel
|
|
|
|
[[autodoc]] VisionTextDualEncoderModel
|
|
- forward
|
|
- get_text_features
|
|
- get_image_features
|