Transformers 文件
BEiT
並獲得增強的文件體驗
開始使用
BEiT
概述
BEiT 模型由 Hangbo Bao, Li Dong 和 Furu Wei 在論文 BEiT: BERT Pre-Training of Image Transformers 中提出。受 BERT 的啟發,BEiT 是首篇使得 Vision Transformer (ViT) 的自監督預訓練效果優於有監督預訓練的論文。BEiT 模型不是像 原始 ViT 論文 那樣預訓練模型來預測影像的類別,而是預訓練模型來預測來自 OpenAI 的 DALL-E 模型 程式碼簿中的視覺詞元,給定的是被掩蓋的影像塊。
論文摘要如下:
我們引入了一種自監督視覺表示模型 BEiT,它是 Bidirectional Encoder representation from Image Transformers 的縮寫。遵循自然語言處理領域中 BERT 的發展,我們提出了一種掩碼影像建模任務來預訓練視覺 Transformer。具體來說,在我們的預訓練中,每張影像都有兩個檢視,即影像塊(例如 16x16 畫素)和視覺詞元(即離散詞元)。我們首先將原始影像“詞元化”為視覺詞元。然後我們隨機掩蓋一些影像塊,並將它們輸入到主幹 Transformer 中。預訓練的目標是根據損壞的影像塊恢復原始的視覺詞元。在預訓練 BEiT 之後,我們透過在預訓練的編碼器上附加任務層來直接在下游任務上微調模型引數。在影像分類和語義分割上的實驗結果表明,我們的模型與以前的預訓練方法相比取得了有競爭力的結果。例如,基礎尺寸的 BEiT 在 ImageNet-1K 上達到了 83.2% 的 top-1 準確率,顯著優於在相同設定下從頭開始訓練的 DeiT (81.8%)。此外,大尺寸的 BEiT 僅使用 ImageNet-1K 就達到了 86.3%,甚至超過了在 ImageNet-22K 上進行有監督預訓練的 ViT-L (85.2%)。
該模型由 nielsr 貢獻。該模型的 JAX/FLAX 版本由 kamalkraj 貢獻。原始程式碼可以在 這裡 找到。
使用技巧
- BEiT 模型是常規的 Vision Transformer,但採用自監督而非有監督的方式進行預訓練。當在 ImageNet-1K 和 CIFAR-100 上進行微調時,它們的效能優於 原始模型 (ViT) 以及 資料高效影像 Transformer (DeiT)。你可以在 這裡 檢視關於推理以及在自定義資料上進行微調的演示筆記本(你只需將 `ViTFeatureExtractor` 替換為 `BeitImageProcessor`,將 `ViTForImageClassification` 替換為 `BeitForImageClassification` 即可)。
- 還有一個演示筆記本,展示瞭如何將 DALL-E 的影像分詞器與 BEiT 結合起來執行掩碼影像建模。你可以在 這裡 找到它。
- 由於 BEiT 模型期望每張影像具有相同的大小(解析度),可以使用 `BeitImageProcessor` 來為模型調整影像大小(或縮放)和進行歸一化。
- 預訓練或微調期間使用的影像塊解析度和影像解析度都反映在每個檢查點的名稱中。例如,`microsoft/beit-base-patch16-224` 指的是一個基礎尺寸的架構,其影像塊解析度為 16x16,微調解析度為 224x224。所有檢查點都可以在 Hub 上找到。
- 可用的檢查點可以是 (1) 僅在 ImageNet-22k(一個包含 1400 萬張影像和 2.2 萬個類別的資料集)上預訓練的,(2) 也在 ImageNet-22k 上微調的,或者 (3) 也在 ImageNet-1k(也稱為 ILSVRC 2012,一個包含 130 萬張影像和 1000 個類別的資料集)上微調的。
- BEiT 使用了受 T5 模型啟發的相對位置嵌入。在預訓練期間,作者在多個自注意力層之間共享了相對位置偏置。在微調期間,每一層的相對位置偏置都使用預訓練後獲得的共享相對位置偏置進行初始化。請注意,如果想要從頭開始預訓練一個模型,需要將 `BeitConfig` 的 `use_relative_position_bias` 或 `use_absolute_position_embeddings` 屬性設定為 `True`,以便新增位置嵌入。

使用縮放點積注意力 (SDPA)
PyTorch 包含一個原生的縮放點積注意力 (SDPA) 運算元,作為 `torch.nn.functional` 的一部分。該函式包含多種實現,可根據輸入和所用硬體進行應用。更多資訊請參閱官方文件或GPU 推理頁面。
當實現可用時,SDPA 預設用於 `torch>=2.1.1`,但你也可以在 `from_pretrained()` 中設定 `attn_implementation="sdpa"` 來明確請求使用 SDPA。
from transformers import BeitForImageClassification
model = BeitForImageClassification.from_pretrained("microsoft/beit-base-patch16-224", attn_implementation="sdpa", torch_dtype=torch.float16)
...
為了獲得最佳加速效果,我們建議以半精度(例如 `torch.float16` 或 `torch.bfloat16`)載入模型。
在本地基準測試(NVIDIA GeForce RTX 2060-8GB, PyTorch 2.5.1, OS Ubuntu 20.04)中,使用 `float16` 和 `microsoft/beit-base-patch16-224` 模型,我們在訓練和推理過程中觀察到了以下改進:
訓練
訓練步數 | 批處理大小 | 影像尺寸 | is_cuda | 每批次時間(Eager - 秒) | 每批次時間(SDPA - 秒) | 加速(%) | Eager 峰值記憶體(MB) | SDPA 峰值記憶體(MB) | 記憶體節省(%) |
---|---|---|---|---|---|---|---|---|---|
50 | 2 | (1048, 640) | True | 0.984 | 0.746 | 31.975 | 6738.915 | 4319.886 | 55.998 |
推理
影像批次大小 | Eager (秒/迭代) | Eager 置信區間, % | Eager 記憶體 (MB) | SDPA (秒/迭代) | SDPA 置信區間, % | SDPA 記憶體 (MB) | SDPA 速度提升 | SDPA 記憶體節省 (%) |
---|---|---|---|---|---|---|---|---|
1 | 0.012 | ±0.3% | 3.76657e+08 | 0.011 | ±0.5% | 3.75739e+08 | 1.05 | 0.244 |
4 | 0.013 | ±0.1% | 4.03147e+08 | 0.011 | ±0.2% | 3.90554e+08 | 1.178 | 3.225 |
16 | 0.045 | ±0.1% | 4.96697e+08 | 0.035 | ±0.1% | 4.51232e+08 | 1.304 | 10.076 |
32 | 0.088 | ±0.1% | 6.24417e+08 | 0.066 | ±0.1% | 5.33488e+08 | 1.325 | 17.044 |
資源
一系列官方 Hugging Face 和社群(由 🌎 標識)資源可幫助你開始使用 BEiT。
- `BeitForImageClassification` 受此示例指令碼和筆記本支援。
- 另請參閱:影像分類任務指南
語義分割
如果您有興趣在此處提交資源,請隨時開啟 Pull Request,我們將對其進行審查!該資源最好能展示一些新內容,而不是重複現有資源。
BEiT 特定輸出
class transformers.models.beit.modeling_beit.BeitModelOutputWithPooling
< 來源 >( last_hidden_state: typing.Optional[torch.FloatTensor] = None pooler_output: typing.Optional[torch.FloatTensor] = None hidden_states: typing.Optional[tuple[torch.FloatTensor, ...]] = None attentions: typing.Optional[tuple[torch.FloatTensor, ...]] = None )
引數
- last_hidden_state (
torch.FloatTensor
,形狀為(batch_size, sequence_length, hidden_size)
,可選) — 模型最後一層輸出的隱藏狀態序列。 - pooler_output (
torch.FloatTensor
,形狀為(batch_size, hidden_size)
) — 如果 *config.use_mean_pooling* 設定為 True,則為影像塊詞元(不包括 *[CLS]* 詞元)最後一層隱藏狀態的平均值。如果設定為 False,則返回 *[CLS]* 詞元的最終隱藏狀態。 - hidden_states (
tuple[torch.FloatTensor, ...]
,可選,在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) —torch.FloatTensor
的元組(如果模型有嵌入層,則第一個是嵌入層的輸出,之後是每一層的輸出),形狀為(batch_size, sequence_length, hidden_size)
。模型在每一層輸出的隱藏狀態以及可選的初始嵌入輸出。
- attentions (
tuple[torch.FloatTensor, ...]
,可選,在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) —torch.FloatTensor
的元組(每一層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。經過注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
`BeitModel` 輸出的類。
class transformers.models.beit.modeling_flax_beit.FlaxBeitModelOutputWithPooling
< 來源 >( last_hidden_state: typing.Optional[jax.Array] = None pooler_output: typing.Optional[jax.Array] = None hidden_states: typing.Optional[tuple[jax.Array]] = None attentions: typing.Optional[tuple[jax.Array]] = None )
引數
- last_hidden_state (
jnp.ndarray
,形狀為(batch_size, sequence_length, hidden_size)
) — 模型最後一層輸出的隱藏狀態序列。 - pooler_output (
jnp.ndarray
,形狀為(batch_size, hidden_size)
) — 如果 *config.use_mean_pooling* 設定為 True,則為影像塊詞元(不包括 *[CLS]* 詞元)最後一層隱藏狀態的平均值。如果設定為 False,則返回 *[CLS]* 詞元的最終隱藏狀態。 - hidden_states (
tuple(jnp.ndarray)
,可選,在傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) —jnp.ndarray
的元組(第一個是嵌入層的輸出,之後是每一層的輸出),形狀為(batch_size, sequence_length, hidden_size)
。模型在每一層輸出的隱藏狀態以及初始嵌入輸出。 - attentions (
tuple(jnp.ndarray)
,可選,在傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) —jnp.ndarray
的元組(每一層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。經過注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
`FlaxBeitModel` 輸出的類。
BeitConfig
class transformers.BeitConfig
< 來源 >( vocab_size = 8192 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.0 attention_probs_dropout_prob = 0.0 initializer_range = 0.02 layer_norm_eps = 1e-12 image_size = 224 patch_size = 16 num_channels = 3 use_mask_token = False use_absolute_position_embeddings = False use_relative_position_bias = False use_shared_relative_position_bias = False layer_scale_init_value = 0.1 drop_path_rate = 0.1 use_mean_pooling = True pool_scales = [1, 2, 3, 6] use_auxiliary_head = True auxiliary_loss_weight = 0.4 auxiliary_channels = 256 auxiliary_num_convs = 1 auxiliary_concat_input = False semantic_loss_ignore_index = 255 out_features = None out_indices = None add_fpn = False reshape_hidden_states = True **kwargs )
引數
- vocab_size (
int
,可選,預設為 8192) — BEiT 模型的詞彙表大小。定義了預訓練期間可以使用的不同影像詞元的數量。 - hidden_size (
int
,可選,預設為 768) — 編碼器層和池化層的維度。 - num_hidden_layers (
int
,可選,預設為 12) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int
,可選,預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。 - intermediate_size (
int
,可選,預設為 3072) — Transformer 編碼器中“中間”(即前饋)層的維度。 - hidden_act (
str
或function
,可選,預設為"gelu"
) — 編碼器和池化層中的非線性啟用函式(函式或字串)。如果為字串,支援 `"gelu"`、`"relu"`、`"selu"` 和 `"gelu_new"`。 - hidden_dropout_prob (
float
,可選,預設為 0.0) — 嵌入層、編碼器和池化層中所有全連線層的 dropout 機率。 - attention_probs_dropout_prob (
float
,可選,預設為 0.0) — 注意力機率的 dropout 比率。 - initializer_range (
float
,可選,預設為 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float
,可選,預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - image_size (
int
,可選,預設為 224) — 每張影像的大小(解析度)。 - patch_size (
int
,可選,預設為 16) — 每個影像塊的大小(解析度)。 - num_channels (
int
,可選,預設為 3) — 輸入通道的數量。 - use_mask_token (
bool
,可選,預設為False
) — 是否在掩碼影像建模中使用掩碼詞元。 - use_absolute_position_embeddings (
bool
,可選,預設為False
) — 是否使用 BERT 風格的絕對位置嵌入。 - use_relative_position_bias (
bool
,可選,預設為False
) — 是否在自注意力層中使用 T5 風格的相對位置嵌入。 - use_shared_relative_position_bias (
bool
, optional, defaults toFalse
) — 是否在 Transformer 的所有自注意力層中使用相同的相對位置嵌入。 - layer_scale_init_value (
float
, optional, defaults to 0.1) — 在自注意力層中使用的縮放值。base 模型為 0.1,large 模型為 1e-5。設為 0 可停用層縮放。 - drop_path_rate (
float
, optional, defaults to 0.1) — 每個樣本的隨機深度率(應用於殘差層的主路徑時)。 - use_mean_pooling (
bool
, optional, defaults toTrue
) — 在應用分類頭之前,是否對影像塊的最終隱藏狀態進行平均池化,而不是使用 CLS 令牌的最終隱藏狀態。 - pool_scales (
tuple[int]
, optional, defaults to[1, 2, 3, 6]
) — 應用於最後一個特徵圖的池化金字塔模組中使用的池化尺度。 - use_auxiliary_head (
bool
, optional, defaults toTrue
) — 是否在訓練期間使用輔助頭。 - auxiliary_loss_weight (
float
, optional, defaults to 0.4) — 輔助頭的交叉熵損失權重。 - auxiliary_channels (
int
, optional, defaults to 256) — 在輔助頭中使用的通道數。 - auxiliary_num_convs (
int
, optional, defaults to 1) — 在輔助頭中使用的卷積層數。 - auxiliary_concat_input (
bool
, optional, defaults toFalse
) — 是否在分類層之前將輔助頭的輸出與輸入連線起來。 - semantic_loss_ignore_index (
int
, optional, defaults to 255) — 語義分割模型的損失函式所忽略的索引。 - out_features (
list[str]
, optional) — 當用作主幹網路時,要輸出的特徵列表。可以是"stem"
、"stage1"
、"stage2"
等中的任何一個(取決於模型有多少個階段)。如果未設定而out_indices
已設定,則將預設為相應的階段。如果未設定且out_indices
也未設定,則將預設為最後一個階段。必須與stage_names
屬性中定義的順序相同。 - out_indices (
list[int]
, optional) — 當用作主幹網路時,要輸出的特徵索引列表。可以是 0、1、2 等中的任何一個(取決於模型有多少個階段)。如果未設定而out_features
已設定,則將預設為相應的階段。如果未設定且out_features
也未設定,則將預設為最後一個階段。必須與stage_names
屬性中定義的順序相同。 - add_fpn (
bool
, optional, defaults toFalse
) — 是否將 FPN 作為主幹網路的一部分新增。僅與BeitBackbone
相關。 - reshape_hidden_states (
bool
, optional, defaults toTrue
) — 在模型用作主幹網路時,是否將特徵圖重塑為形狀為 `(batch_size, hidden_size, height, width)` 的 4D 張量。如果為 `False`,特徵圖將是形狀為 `(batch_size, seq_len, hidden_size)` 的 3D 張量。僅與 `BeitBackbone` 相關。
這是用於儲存 BeitModel 配置的配置類。它用於根據指定的引數例項化一個 BEiT 模型,定義模型架構。使用預設值例項化配置將產生與 BEiT microsoft/beit-base-patch16-224-pt22k 架構類似的配置。
示例
>>> from transformers import BeitConfig, BeitModel
>>> # Initializing a BEiT beit-base-patch16-224-pt22k style configuration
>>> configuration = BeitConfig()
>>> # Initializing a model (with random weights) from the beit-base-patch16-224-pt22k style configuration
>>> model = BeitModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config
BeitFeatureExtractor
post_process_semantic_segmentation
< 來源 >( outputs target_sizes: typing.Optional[list[tuple]] = None ) → semantic_segmentation
引數
- outputs (BeitForSemanticSegmentation) — 模型的原始輸出。
- target_sizes (
list[Tuple]
of lengthbatch_size
, optional) — 與每個預測請求的最終尺寸(高度,寬度)相對應的元組列表。如果未設定,預測將不會被調整大小。
返回
語義分割
長度為 `batch_size` 的 `list[torch.Tensor]`,其中每個專案是形狀為 (height, width) 的語義分割圖,對應於 target_sizes 條目(如果指定了 `target_sizes`)。每個 `torch.Tensor` 的每個條目對應一個語義類別 ID。
將 BeitForSemanticSegmentation 的輸出轉換為語義分割圖。僅支援 PyTorch。
BeitImageProcessor
class transformers.BeitImageProcessor
< 來源 >( do_resize: bool = True size: typing.Optional[dict[str, int]] = None resample: Resampling = <Resampling.BICUBIC: 3> do_center_crop: bool = True crop_size: typing.Optional[dict[str, int]] = None rescale_factor: typing.Union[int, float] = 0.00392156862745098 do_rescale: bool = True do_normalize: bool = True image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_reduce_labels: bool = False **kwargs )
引數
- do_resize (
bool
, optional, defaults toTrue
) — 是否將影像的(高度,寬度)尺寸調整為指定的 `size`。可在 `preprocess` 方法中透過 `do_resize` 引數覆蓋。 - size (
dict[str, int]
optional, defaults to{"height" -- 256, "width": 256}
): 調整大小後輸出影像的尺寸。可在 `preprocess` 方法中透過 `size` 引數覆蓋。 - resample (
PILImageResampling
, optional, defaults toResampling.BICUBIC
) — 如果調整影像大小,要使用的重取樣過濾器。可在 `preprocess` 方法中透過 `resample` 引數覆蓋。 - do_center_crop (
bool
, optional, defaults toTrue
) — 是否對影像進行中心裁剪。如果輸入的任一邊緣尺寸小於 `crop_size`,影像將用 0 填充,然後進行中心裁剪。可在 `preprocess` 方法中透過 `do_center_crop` 引數覆蓋。 - crop_size (
dict[str, int]
, optional, defaults to{"height" -- 224, "width": 224}
): 應用中心裁剪時期望的輸出尺寸。僅當 `do_center_crop` 設定為 `True` 時有效。可在 `preprocess` 方法中透過 `crop_size` 引數覆蓋。 - rescale_factor (
int
orfloat
, optional, defaults to1/255
) — 如果重縮放影像,要使用的縮放因子。可在 `preprocess` 方法中透過 `rescale_factor` 引數覆蓋。 - do_rescale (
bool
, optional, defaults toTrue
) — 是否透過指定的 `rescale_factor` 縮放影像。可在 `preprocess` 方法中透過 `do_rescale` 引數覆蓋。 - do_normalize (
bool
, optional, defaults toTrue
) — 是否對影像進行歸一化。可在 `preprocess` 方法中透過 `do_normalize` 引數覆蓋。 - image_mean (
float
orlist[float]
, optional, defaults toIMAGENET_STANDARD_MEAN
) — 如果對影像進行歸一化,使用的均值。這是一個浮點數或長度等於影像通道數的浮點數列表。可在 `preprocess` 方法中透過 `image_mean` 引數覆蓋。 - image_std (
float
orlist[float]
, optional, defaults toIMAGENET_STANDARD_STD
) — 如果對影像進行歸一化,使用的標準差。這是一個浮點數或長度等於影像通道數的浮點數列表。可在 `preprocess` 方法中透過 `image_std` 引數覆蓋。 - do_reduce_labels (
bool
, optional, defaults toFalse
) — 是否將分割圖的所有標籤值減 1。通常用於背景使用 0 且背景本身不包含在資料集所有類別中的資料集(例如 ADE20k)。背景標籤將被替換為 255。可在 `preprocess` 方法中透過 `do_reduce_labels` 引數覆蓋。
構建一個 BEiT 影像處理器。
preprocess
< 來源 >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] segmentation_maps: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor'], NoneType] = None do_resize: typing.Optional[bool] = None size: typing.Optional[dict[str, int]] = None resample: Resampling = None do_center_crop: typing.Optional[bool] = None crop_size: typing.Optional[dict[str, int]] = None do_rescale: typing.Optional[bool] = None rescale_factor: typing.Optional[float] = None do_normalize: typing.Optional[bool] = None image_mean: typing.Union[float, list[float], NoneType] = None image_std: typing.Union[float, list[float], NoneType] = None do_reduce_labels: typing.Optional[bool] = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None )
引數
- images (
ImageInput
) — 要預處理的影像。期望是單個或一批畫素值在 0 到 255 範圍內的影像。如果傳入畫素值在 0 到 1 之間的影像,請設定 `do_rescale=False`。 - segmentation_maps (
ImageInput
, optional) — 要預處理的分割圖。期望是單個或一批畫素值在 0 到 255 範圍內的影像。如果傳入畫素值在 0 到 1 之間的影像,請設定 `do_rescale=False`。 - do_resize (
bool
, optional, defaults toself.do_resize
) — 是否調整影像大小。 - size (
dict[str, int]
, optional, defaults toself.size
) — 調整大小後的影像尺寸。 - resample (
int
, optional, defaults toself.resample
) — 如果調整影像大小,要使用的重取樣過濾器。可以是列舉 `PILImageResampling` 中的一種,僅當 `do_resize` 設定為 `True` 時有效。 - do_center_crop (
bool
, optional, defaults toself.do_center_crop
) — 是否對影像進行中心裁剪。 - crop_size (
dict[str, int]
, optional, defaults toself.crop_size
) — 中心裁剪後圖像的尺寸。如果影像的某個邊緣小於 `crop_size`,它將被填充零然後進行裁剪。 - do_rescale (
bool
, optional, defaults toself.do_rescale
) — 是否將影像值重縮放到 [0 - 1] 之間。 - rescale_factor (
float
, optional, defaults toself.rescale_factor
) — 如果 `do_rescale` 設定為 `True`,用於重縮放影像的縮放因子。 - do_normalize (
bool
, optional, defaults toself.do_normalize
) — 是否對影像進行歸一化。 - image_mean (
float
orlist[float]
, optional, defaults toself.image_mean
) — 影像均值。 - image_std (
float
orlist[float]
, optional, defaults toself.image_std
) — 影像標準差。 - do_reduce_labels (
bool
, optional, defaults toself.do_reduce_labels
) — 是否將分割圖的所有標籤值減 1。通常用於背景使用 0 且背景本身不包含在資料集所有類別中的資料集(例如 ADE20k)。背景標籤將被替換為 255。 - return_tensors (
str
orTensorType
, optional) — 要返回的張量型別。可以是以下之一:- 未設定:返回一個 `np.ndarray` 列表。
- `TensorType.TENSORFLOW` 或 `'tf'`:返回一個 `tf.Tensor` 型別的批次。
- `TensorType.PYTORCH` 或 `'pt'`:返回一個 `torch.Tensor` 型別的批次。
- `TensorType.NUMPY` 或 `'np'`:返回一個 `np.ndarray` 型別的批次。
- `TensorType.JAX` 或 `'jax'`:返回一個 `jax.numpy.ndarray` 型別的批次。
- data_format (
ChannelDimension
orstr
, optional, defaults toChannelDimension.FIRST
) — 輸出影像的通道維度格式。可以是以下之一:- `"channels_first"` 或 `ChannelDimension.FIRST`:影像格式為 (num_channels, height, width)。
- `"channels_last"` 或 `ChannelDimension.LAST`:影像格式為 (height, width, num_channels)。
- 未設定:使用輸入影像的通道維度格式。
- input_data_format (
ChannelDimension
orstr
, optional) — 輸入影像的通道維度格式。如果未設定,將從輸入影像中推斷通道維度格式。可以是以下之一:- `"channels_first"` 或 `ChannelDimension.FIRST`:影像格式為 (num_channels, height, width)。
- `"channels_last"` 或 `ChannelDimension.LAST`:影像格式為 (height, width, num_channels)。
- `"none"` 或 `ChannelDimension.NONE`:影像格式為 (height, width)。
預處理一張或一批影像。
post_process_semantic_segmentation
< 來源 >( outputs target_sizes: typing.Optional[list[tuple]] = None ) → semantic_segmentation
引數
- outputs (BeitForSemanticSegmentation) — 模型的原始輸出。
- target_sizes (
list[Tuple]
of lengthbatch_size
, optional) — 與每個預測請求的最終尺寸(高度,寬度)相對應的元組列表。如果未設定,預測將不會被調整大小。
返回
語義分割
長度為 `batch_size` 的 `list[torch.Tensor]`,其中每個專案是形狀為 (height, width) 的語義分割圖,對應於 target_sizes 條目(如果指定了 `target_sizes`)。每個 `torch.Tensor` 的每個條目對應一個語義類別 ID。
將 BeitForSemanticSegmentation 的輸出轉換為語義分割圖。僅支援 PyTorch。
BeitImageProcessorFast
class transformers.BeitImageProcessorFast
< 來源 >( **kwargs: typing_extensions.Unpack[transformers.models.beit.image_processing_beit_fast.BeitFastImageProcessorKwargs] )
構建一個快速的 Beit 影像處理器。
preprocess
< 來源 >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] segmentation_maps: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor'], NoneType] = None **kwargs: typing_extensions.Unpack[transformers.models.beit.image_processing_beit_fast.BeitFastImageProcessorKwargs] ) → <class 'transformers.image_processing_base.BatchFeature'>
引數
- images (
Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]
) — 待預處理的影像。需要單個或一批畫素值範圍在 0 到 255 之間的影像。如果傳入的影像畫素值在 0 到 1 之間,請設定 `do_rescale=False`。 - segmentation_maps (
ImageInput
, 可選) — 待預處理的分割圖。 - do_resize (
bool
, 可選) — 是否調整影像大小。 - size (
dict[str, int]
, 可選) — 描述模型的最大輸入尺寸。 - default_to_square (
bool
, 可選) — 當 size 是一個整數時,在調整大小時是否預設為正方形影像。 - resample (
Union[PILImageResampling, F.InterpolationMode, NoneType]
) — 如果調整影像大小,使用的重取樣過濾器。可以是 `PILImageResampling` 列舉之一。僅當 `do_resize` 設定為 `True` 時有效。 - do_center_crop (
bool
, 可選) — 是否對影像進行中心裁剪。 - crop_size (
dict[str, int]
, 可選) — 應用 `center_crop` 後輸出影像的尺寸。 - do_rescale (
bool
, 可選) — 是否對影像進行縮放。 - rescale_factor (
Union[int, float, NoneType]
) — 如果 `do_rescale` 設定為 `True`,用於縮放影像的比例因子。 - do_normalize (
bool
, 可選) — 是否對影像進行歸一化。 - image_mean (
Union[float, list[float], NoneType]
) — 用於歸一化的影像均值。僅當 `do_normalize` 設定為 `True` 時有效。 - image_std (
Union[float, list[float], NoneType]
) — 用於歸一化的影像標準差。僅當 `do_normalize` 設定為 `True` 時有效。 - do_convert_rgb (
bool
, 可選) — 是否將影像轉換為 RGB。 - return_tensors (
Union[str, ~utils.generic.TensorType, NoneType]
) — 如果設定為 `pt`,返回堆疊的張量,否則返回一個張量列表。 - data_format (
~image_utils.ChannelDimension
, 可選) — 僅支援 `ChannelDimension.FIRST`。為與慢速處理器相容而新增。 - input_data_format (
Union[str, ~image_utils.ChannelDimension, NoneType]
) — 輸入影像的通道維度格式。如果未設定,則從輸入影像中推斷通道維度格式。可以是以下之一:- `"channels_first"` 或 `ChannelDimension.FIRST`: 影像格式為 (num_channels, height, width)。
- `"channels_last"` 或 `ChannelDimension.LAST`: 影像格式為 (height, width, num_channels)。
- `"none"` 或 `ChannelDimension.NONE`: 影像格式為 (height, width)。
- device (
torch.device
, 可選) — 用於處理影像的裝置。如果未設定,則從輸入影像中推斷裝置。 - disable_grouping (
bool
, 可選) — 是否停用按尺寸對影像進行分組,以便單獨處理而不是批次處理。如果為 None,當影像在 CPU 上時將設定為 True,否則為 False。此選擇基於經驗觀察,詳情請見:https://github.com/huggingface/transformers/pull/38157 - do_reduce_labels (
bool
, 可選, 預設為 `self.do_reduce_labels`) — 是否將分割圖的所有標籤值減 1。通常用於 0 代表背景,且背景本身不包含在資料集所有類別中的資料集(例如 ADE20k)。背景標籤將被替換為 255。
返回
<class 'transformers.image_processing_base.BatchFeature'>
- data (
dict
) — 由 call 方法返回的列表/陣列/張量字典(“pixel_values”等)。 - tensor_type (
Union[None, str, TensorType]
, 可選) — 您可以在此處提供一個`tensor_type`,以便在初始化時將整數列表轉換為PyTorch/TensorFlow/Numpy張量。
post_process_semantic_segmentation
< 原始碼 >( outputs target_sizes: typing.Optional[list[tuple]] = None ) → semantic_segmentation
引數
- outputs (BeitForSemanticSegmentation) — 模型的原始輸出。
- target_sizes (長度為 `batch_size` 的 `list[Tuple]`,可選) — 對應於每個預測請求的最終尺寸(高,寬)的元組列表。如果未設定,預測將不會被調整大小。
返回
語義分割
長度為 `batch_size` 的 `list[torch.Tensor]`,其中每個專案是形狀為 (height, width) 的語義分割圖,對應於 target_sizes 條目(如果指定了 `target_sizes`)。每個 `torch.Tensor` 的每個條目對應一個語義類別 ID。
將 BeitForSemanticSegmentation 的輸出轉換為語義分割圖。僅支援 PyTorch。
BeitModel
class transformers.BeitModel
< 原始碼 >( config: BeitConfig add_pooling_layer: bool = True )
引數
- config (BeitConfig) — 模型配置類,包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重,僅載入配置。請檢視 from_pretrained() 方法來載入模型權重。
- add_pooling_layer (
bool
, 可選, 預設為 `True`) — 是否新增池化層
裸的 Beit 模型,輸出原始的隱藏狀態,頂部沒有任何特定的頭。
該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 原始碼 >( pixel_values: Tensor bool_masked_pos: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.Tensor] = 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.beit.modeling_beit.BeitModelOutputWithPooling 或 tuple(torch.FloatTensor)
引數
- pixel_values (`torch.Tensor`,形狀為 `(batch_size, num_channels, image_size, image_size)`) — 對應輸入影像的張量。畫素值可以透過 `{image_processor_class}` 獲得。詳見 `{image_processor_class}.__call__`(`{processor_class}` 使用 `{image_processor_class}` 處理影像)。
- bool_masked_pos (`torch.BoolTensor`,形狀為 `(batch_size, num_patches)`,可選) — 布林掩碼位置。指示哪些補丁被掩碼(1),哪些沒有(0)。
- head_mask (`torch.Tensor`,形狀為 `(num_heads,)` 或 `(num_layers, num_heads)`,可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在 `[0, 1]` 中選擇:
- 1 表示頭未被掩碼,
- 0 表示頭被掩碼。
- output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。詳見返回張量下的 `attentions`。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。詳見返回張量下的 `hidden_states`。 - interpolate_pos_encoding (
bool
, 預設為 `False`) — 是否對預訓練的位置編碼進行插值。 - return_dict (
bool
, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.models.beit.modeling_beit.BeitModelOutputWithPooling 或 tuple(torch.FloatTensor)
一個 transformers.models.beit.modeling_beit.BeitModelOutputWithPooling 或一個 `torch.FloatTensor` 的元組(如果傳遞了 `return_dict=False` 或 `config.return_dict=False`),根據配置 (BeitConfig) 和輸入包含不同的元素。
-
last_hidden_state (形狀為
(batch_size, sequence_length, hidden_size)
的torch.FloatTensor
, 可選) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (`torch.FloatTensor`,形狀為 `(batch_size, hidden_size)`) — 如果 *config.use_mean_pooling* 設定為 True,則為補丁標記的最後一層隱藏狀態的平均值(不包括 *[CLS]* 標記)。如果設定為 False,則返回 *[CLS]* 標記的最終隱藏狀態。
-
hidden_states (`tuple[torch.FloatTensor, ...]`,可選,當傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組(一個用於嵌入層的輸出(如果模型有嵌入層),+ 每個層的輸出一個),形狀為 `(batch_size, sequence_length, hidden_size)`。
模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (`tuple[torch.FloatTensor, ...]`,可選,當傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組(每層一個),形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
BeitModel 的 forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義,但之後應該呼叫 `Module` 例項而不是這個函式,因為前者會處理前處理和後處理步驟,而後者會靜默地忽略它們。
BeitForMaskedImageModeling
class transformers.BeitForMaskedImageModeling
< 原始碼 >( config: BeitConfig )
引數
- config (BeitConfig) — 模型配置類,包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重,僅載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Beit Transformer 模型,頂部帶有“語言”建模頭。BEiT 透過預測向量量化變分自編碼器(VQ-VAE)的視覺標記來進行掩碼影像建模,而像 ViT 和 DeiT 這樣的其他視覺模型則預測 RGB 畫素值。因此,該類與 AutoModelForMaskedImageModeling 不相容,因此如果您希望使用 BEiT 進行掩碼影像建模,則需要直接使用 BeitForMaskedImageModeling。
該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 原始碼 >( pixel_values: typing.Optional[torch.Tensor] = None bool_masked_pos: typing.Optional[torch.BoolTensor] = None head_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = 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.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- pixel_values (`torch.Tensor`,形狀為 `(batch_size, num_channels, image_size, image_size)`,可選) — 對應輸入影像的張量。畫素值可以透過 `{image_processor_class}` 獲得。詳見 `{image_processor_class}.__call__`(`{processor_class}` 使用 `{image_processor_class}` 處理影像)。
- bool_masked_pos (`torch.BoolTensor`,形狀為 `(batch_size, num_patches)`) — 布林掩碼位置。指示哪些補丁被掩碼(1),哪些沒有(0)。
- head_mask (`torch.Tensor`,形狀為 `(num_heads,)` 或 `(num_layers, num_heads)`,可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在 `[0, 1]` 中選擇:
- 1 表示頭未被掩碼,
- 0 表示頭被掩碼。
- labels (`torch.LongTensor`,形狀為 `(batch_size,)`,可選) — 用於計算影像分類/迴歸損失的標籤。索引應在 `[0, ..., config.num_labels - 1]` 範圍內。如果 `config.num_labels == 1`,則計算迴歸損失(均方損失),如果 `config.num_labels > 1`,則計算分類損失(交叉熵)。
- output_attentions (
bool
, 可選) — 是否返回所有注意力層的注意力張量。詳見返回張量下的 `attentions`。 - output_hidden_states (
bool
, 可選) — 是否返回所有層的隱藏狀態。詳見返回張量下的 `hidden_states`。 - interpolate_pos_encoding (
bool
, 預設為 `False`) — 是否對預訓練的位置編碼進行插值。 - return_dict (
bool
, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MaskedLMOutput 或一個 `torch.FloatTensor` 的元組(如果傳遞了 `return_dict=False` 或 `config.return_dict=False`),根據配置 (BeitConfig) 和輸入包含不同的元素。
-
loss (形狀為
(1,)
的torch.FloatTensor
,可選,當提供labels
時返回) — 掩碼語言建模 (MLM) 損失。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)
的torch.FloatTensor
) — 語言建模頭部的預測分數(SoftMax 之前的每個詞彙標記的分數)。 -
hidden_states (`tuple(torch.FloatTensor)`,可選,當傳遞 `output_hidden_states=True` 或 `config.output_hidden_states=True` 時返回) — `torch.FloatTensor` 的元組(一個用於嵌入層的輸出(如果模型有嵌入層),+ 每個層的輸出一個),形狀為 `(batch_size, sequence_length, hidden_size)`。
模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (`tuple(torch.FloatTensor)`,可選,當傳遞 `output_attentions=True` 或 `config.output_attentions=True` 時返回) — `torch.FloatTensor` 的元組(每層一個),形狀為 `(batch_size, num_heads, sequence_length, sequence_length)`。
注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
該 BeitForMaskedImageModeling forward 方法重寫了 `__call__` 特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義,但之後應該呼叫 `Module` 例項而不是這個函式,因為前者會處理前處理和後處理步驟,而後者會靜默地忽略它們。
示例
>>> from transformers import AutoImageProcessor, BeitForMaskedImageModeling
>>> 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/beit-base-patch16-224-pt22k")
>>> model = BeitForMaskedImageModeling.from_pretrained("microsoft/beit-base-patch16-224-pt22k")
>>> 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, logits = outputs.loss, outputs.logits
>>> list(logits.shape)
[1, 196, 8192]
BeitForImageClassification
class transformers.BeitForImageClassification
< 原始碼 >( config: BeitConfig )
引數
- config (BeitConfig) — 模型配置類,包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重,僅載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Beit Transformer 模型,頂部帶有影像分類頭(在補丁標記的最終隱藏狀態平均值之上加一個線性層),例如用於 ImageNet。
該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 原始碼 >( pixel_values: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = 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.modeling_outputs.ImageClassifierOutput 或 tuple(torch.FloatTensor)
引數
- pixel_values (
torch.Tensor
,形狀為(batch_size, num_channels, image_size, image_size)
,可選) — 對應於輸入影像的張量。畫素值可以使用{image_processor_class}
獲取。有關詳細資訊,請參閱{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
處理影像)。 - head_mask (
torch.Tensor
,形狀為(num_heads,)
或(num_layers, num_heads)
,可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示頭未被遮蔽,
- 0 表示頭已被遮蔽。
- labels (
torch.LongTensor
,形狀為(batch_size,)
,可選) — 用於計算影像分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]
範圍內。如果config.num_labels == 1
,則計算迴歸損失 (均方損失);如果config.num_labels > 1
,則計算分類損失 (交叉熵)。 - output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的hidden_states
。 - interpolate_pos_encoding (
bool
,預設為False
) — 是否對預訓練的位置編碼進行插值。 - return_dict (
bool
,可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.ImageClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.ImageClassifierOutput 或一個 torch.FloatTensor
的元組(如果傳遞 return_dict=False
或 config.return_dict=False
),根據配置 (BeitConfig) 和輸入包含不同的元素。
-
loss (形狀為
(1,)
的torch.FloatTensor
,可選,當提供labels
時返回) — 分類損失(如果 config.num_labels==1,則為迴歸損失)。 -
logits (形狀為
(batch_size, config.num_labels)
的torch.FloatTensor
) — 分類(如果 config.num_labels==1,則為迴歸)分數(SoftMax 之前)。 -
hidden_states (
tuple(torch.FloatTensor)
,可選,在傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) —torch.FloatTensor
的元組 (如果模型有嵌入層,則一個用於嵌入層的輸出,+ 一個用於每個階段的輸出),形狀為(batch_size, sequence_length, hidden_size)
。模型在每個階段輸出的隱藏狀態 (也稱為特徵圖)。 -
attentions (
tuple(torch.FloatTensor)
,可選,在傳遞output_attentions=True
或config.output_attentions=True
時返回) —torch.FloatTensor
的元組 (每層一個),形狀為(batch_size, num_heads, patch_size, sequence_length)
。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
BeitForImageClassification 的 forward 方法,覆蓋了 __call__
特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義,但之後應該呼叫 `Module` 例項而不是這個函式,因為前者會處理前處理和後處理步驟,而後者會靜默地忽略它們。
示例
>>> from transformers import AutoImageProcessor, BeitForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("microsoft/beit-base-patch16-224-pt22k")
>>> model = BeitForImageClassification.from_pretrained("microsoft/beit-base-patch16-224-pt22k")
>>> inputs = image_processor(image, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = logits.argmax(-1).item()
>>> print(model.config.id2label[predicted_label])
...
BeitForSemanticSegmentation
class transformers.BeitForSemanticSegmentation
< 源 >( config: BeitConfig )
引數
- config (BeitConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
帶有語義分割頭的 Beit 模型,例如用於 ADE20K、CityScapes。
該模型繼承自 PreTrainedModel。請檢視超類文件以瞭解該庫為所有模型實現的通用方法(例如下載或儲存、調整輸入嵌入大小、修剪頭部等)。
該模型也是 PyTorch torch.nn.Module 的子類。可以像常規 PyTorch 模組一樣使用它,並參考 PyTorch 文件瞭解所有與常規用法和行為相關的事項。
forward
< 源 >( pixel_values: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None labels: typing.Optional[torch.Tensor] = 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.modeling_outputs.SemanticSegmenterOutput 或 tuple(torch.FloatTensor)
引數
- pixel_values (
torch.Tensor
,形狀為(batch_size, num_channels, image_size, image_size)
,可選) — 對應於輸入影像的張量。畫素值可以使用{image_processor_class}
獲取。有關詳細資訊,請參閱{image_processor_class}.__call__
({processor_class}
使用{image_processor_class}
處理影像)。 - head_mask (
torch.Tensor
,形狀為(num_heads,)
或(num_layers, num_heads)
,可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值在[0, 1]
中選擇:- 1 表示頭未被遮蔽,
- 0 表示頭已被遮蔽。
- labels (
torch.LongTensor
,形狀為(batch_size, height, width)
,可選) — 用於計算損失的真實語義分割圖。索引應在[0, ..., config.num_labels - 1]
範圍內。如果config.num_labels > 1
,則計算分類損失 (交叉熵)。 - output_attentions (
bool
,可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊,請參閱返回張量下的attentions
。 - output_hidden_states (
bool
,可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊,請參閱返回張量下的hidden_states
。 - interpolate_pos_encoding (
bool
,預設為False
) — 是否對預訓練的位置編碼進行插值。 - return_dict (
bool
,可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_outputs.SemanticSegmenterOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SemanticSegmenterOutput 或一個 torch.FloatTensor
的元組(如果傳遞 return_dict=False
或 config.return_dict=False
),根據配置 (BeitConfig) 和輸入包含不同的元素。
-
loss (形狀為
(1,)
的torch.FloatTensor
,可選,當提供labels
時返回) — 分類損失(如果 config.num_labels==1,則為迴歸損失)。 -
logits (形狀為
(batch_size, config.num_labels, logits_height, logits_width)
的torch.FloatTensor
) — 每個畫素的分類分數。返回的 logits 的大小不一定與作為輸入的
pixel_values
相同。這是為了避免當用戶需要將 logits 調整到原始影像大小作為後處理時進行兩次插值而損失一些質量。您應該始終檢查 logits 的形狀並根據需要進行調整。 -
hidden_states (
tuple(torch.FloatTensor)
,可選,在傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) —torch.FloatTensor
的元組 (如果模型有嵌入層,則一個用於嵌入層的輸出,+ 一個用於每層的輸出),形狀為(batch_size, patch_size, hidden_size)
。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor)
,可選,在傳遞output_attentions=True
或config.output_attentions=True
時返回) —torch.FloatTensor
的元組 (每層一個),形狀為(batch_size, num_heads, patch_size, sequence_length)
。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
BeitForSemanticSegmentation 的 forward 方法,覆蓋了 __call__
特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義,但之後應該呼叫 `Module` 例項而不是這個函式,因為前者會處理前處理和後處理步驟,而後者會靜默地忽略它們。
示例
>>> from transformers import AutoImageProcessor, BeitForSemanticSegmentation
>>> 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/beit-base-finetuned-ade-640-640")
>>> model = BeitForSemanticSegmentation.from_pretrained("microsoft/beit-base-finetuned-ade-640-640")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> # logits are of shape (batch_size, num_labels, height, width)
>>> logits = outputs.logits
FlaxBeitModel
class transformers.FlaxBeitModel
< 源 >( config: BeitConfig input_shape = None seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (BeitConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
- dtype (
jax.numpy.dtype
,可選,預設為jax.numpy.float32
) — 計算的資料型別。可以是jax.numpy.float32
、jax.numpy.float16
(在 GPU 上) 和jax.numpy.bfloat16
(在 TPU 上) 之一。這可用於在 GPU 或 TPU 上啟用混合精度訓練或半精度推理。如果指定,所有計算都將使用給定的
dtype
執行。請注意,這隻指定了計算的資料型別,並不影響模型引數的資料型別。
基礎的 Beit 模型 Transformer,輸出原始的隱藏狀態,沒有任何特定的頭在其之上。
該模型繼承自 FlaxPreTrainedModel。請檢視超類的文件,瞭解該庫為其所有模型實現的通用方法 (例如下載、儲存和轉換 PyTorch 模型權重)。
該模型也是 flax.linen.Module 的子類。請將其作為常規的 Flax linen Module 使用,並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後,此模型支援固有的 JAX 功能,例如
__call__
< 源 >( pixel_values bool_masked_pos = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.models.beit.modeling_flax_beit.FlaxBeitModelOutputWithPooling 或 tuple(torch.FloatTensor)
返回
transformers.models.beit.modeling_flax_beit.FlaxBeitModelOutputWithPooling 或 tuple(torch.FloatTensor)
一個 transformers.models.beit.modeling_flax_beit.FlaxBeitModelOutputWithPooling 或一個 torch.FloatTensor
的元組(如果傳遞 return_dict=False
或 config.return_dict=False
),根據配置 (<class 'transformers.models.beit.configuration_beit.BeitConfig'>
) 和輸入包含不同的元素。
- last_hidden_state (形狀為
(batch_size, sequence_length, hidden_size)
的jnp.ndarray
) — 模型最後一層輸出的隱藏狀態序列。 - pooler_output (
jnp.ndarray
,形狀為(batch_size, hidden_size)
) — 如果 config.use_mean_pooling 設定為 True,則為 patch tokens 的最後一層隱藏狀態的平均值 (不包括 [CLS] token)。如果設定為 False,則將返回 [CLS] token 的最終隱藏狀態。 - hidden_states (
tuple(jnp.ndarray)
,可選,在傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) —jnp.ndarray
的元組 (一個用於嵌入層的輸出 + 一個用於每層的輸出),形狀為(batch_size, sequence_length, hidden_size)
。模型在每層輸出的隱藏狀態以及初始嵌入輸出。 - attentions (
tuple(jnp.ndarray)
,可選,在傳遞output_attentions=True
或config.output_attentions=True
時返回) —jnp.ndarray
的元組 (每層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。在注意力 softmax 之後的注意力權重,用於在自注意力頭中計算加權平均值。
FlaxBeitPreTrainedModel
的 forward 方法,覆蓋了 __call__
特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義,但之後應該呼叫 `Module` 例項而不是這個函式,因為前者會處理前處理和後處理步驟,而後者會靜默地忽略它們。
示例
>>> from transformers import AutoImageProcessor, FlaxBeitModel
>>> 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/beit-base-patch16-224-pt22k-ft22k")
>>> model = FlaxBeitModel.from_pretrained("microsoft/beit-base-patch16-224-pt22k-ft22k")
>>> inputs = image_processor(images=image, return_tensors="np")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
FlaxBeitForMaskedImageModeling
class transformers.FlaxBeitForMaskedImageModeling
< 源 >( config: BeitConfig input_shape = None seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (BeitConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
- dtype (
jax.numpy.dtype
,可選,預設為jax.numpy.float32
) — 計算的資料型別。可以是jax.numpy.float32
、jax.numpy.float16
(在 GPU 上) 和jax.numpy.bfloat16
(在 TPU 上) 之一。這可用於在 GPU 或 TPU 上啟用混合精度訓練或半精度推理。如果指定,所有計算都將使用給定的
dtype
執行。請注意,這隻指定了計算的資料型別,並不影響模型引數的資料型別。
帶有“語言”建模頭的 Beit 模型 Transformer (用於預測視覺標記)。
該模型繼承自 FlaxPreTrainedModel。請檢視超類的文件,瞭解該庫為其所有模型實現的通用方法 (例如下載、儲存和轉換 PyTorch 模型權重)。
該模型也是 flax.linen.Module 的子類。請將其作為常規的 Flax linen Module 使用,並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後,此模型支援固有的 JAX 功能,例如
__call__
< 源 >( pixel_values bool_masked_pos = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
返回
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一個 torch.FloatTensor
的元組(如果傳遞 return_dict=False
或 config.return_dict=False
),根據配置 (<class 'transformers.models.beit.configuration_beit.BeitConfig'>
) 和輸入包含不同的元素。
-
logits (形狀為
(batch_size, sequence_length, config.vocab_size)
的jnp.ndarray
) — 語言建模頭的預測分數(SoftMax 之前每個詞彙 token 的分數)。 -
hidden_states (
tuple(jnp.ndarray)
,可選,在傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) —jnp.ndarray
的元組 (一個用於嵌入層的輸出 + 一個用於每層的輸出),形狀為(batch_size, sequence_length, hidden_size)
。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray)
,可選,在傳遞output_attentions=True
或config.output_attentions=True
時返回) —jnp.ndarray
的元組 (每層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
FlaxBeitPreTrainedModel
的 forward 方法,覆蓋了 __call__
特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義,但之後應該呼叫 `Module` 例項而不是這個函式,因為前者會處理前處理和後處理步驟,而後者會靜默地忽略它們。
bool_masked_pos (numpy.ndarray
,形狀為 (batch_size, num_patches)
):布林掩碼位置。指示哪些 patch 被掩碼 (1),哪些沒有 (0)。
示例
>>> from transformers import AutoImageProcessor, BeitForMaskedImageModeling
>>> 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/beit-base-patch16-224-pt22k")
>>> model = BeitForMaskedImageModeling.from_pretrained("microsoft/beit-base-patch16-224-pt22k")
>>> inputs = image_processor(images=image, return_tensors="np")
>>> outputs = model(**inputs)
>>> logits = outputs.logits
FlaxBeitForImageClassification
class transformers.FlaxBeitForImageClassification
< 源 >( config: BeitConfig input_shape = None seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (BeitConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重,只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
- dtype (
jax.numpy.dtype
,可選,預設為jax.numpy.float32
) — 計算的資料型別。可以是jax.numpy.float32
、jax.numpy.float16
(在 GPU 上) 和jax.numpy.bfloat16
(在 TPU 上) 之一。這可用於在 GPU 或 TPU 上啟用混合精度訓練或半精度推理。如果指定,所有計算都將使用給定的
dtype
執行。請注意,這隻指定了計算的資料型別,並不影響模型引數的資料型別。
Beit Transformer 模型,頂部帶有影像分類頭(在補丁標記的最終隱藏狀態平均值之上加一個線性層),例如用於 ImageNet。
該模型繼承自 FlaxPreTrainedModel。請檢視超類的文件,瞭解該庫為其所有模型實現的通用方法 (例如下載、儲存和轉換 PyTorch 模型權重)。
該模型也是 flax.linen.Module 的子類。請將其作為常規的 Flax linen Module 使用,並參考 Flax 文件瞭解所有與一般用法和行為相關的事項。
最後,此模型支援固有的 JAX 功能,例如
__call__
< 源 >( pixel_values bool_masked_pos = None params: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
返回
transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一個 torch.FloatTensor
的元組(如果傳遞 return_dict=False
或 config.return_dict=False
),根據配置 (<class 'transformers.models.beit.configuration_beit.BeitConfig'>
) 和輸入包含不同的元素。
-
logits (形狀為
(batch_size, config.num_labels)
的jnp.ndarray
) — 分類(如果 config.num_labels==1,則為迴歸)分數(SoftMax 之前)。 -
hidden_states (
tuple(jnp.ndarray)
,可選,在傳遞output_hidden_states=True
或config.output_hidden_states=True
時返回) —jnp.ndarray
的元組 (一個用於嵌入層的輸出 + 一個用於每層的輸出),形狀為(batch_size, sequence_length, hidden_size)
。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray)
,可選,在傳遞output_attentions=True
或config.output_attentions=True
時返回) —jnp.ndarray
的元組 (每層一個),形狀為(batch_size, num_heads, sequence_length, sequence_length)
。注意力 softmax 後的注意力權重,用於計算自注意力頭中的加權平均值。
FlaxBeitPreTrainedModel
的 forward 方法,覆蓋了 __call__
特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義,但之後應該呼叫 `Module` 例項而不是這個函式,因為前者會處理前處理和後處理步驟,而後者會靜默地忽略它們。
示例
>>> from transformers import AutoImageProcessor, FlaxBeitForImageClassification
>>> 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/beit-base-patch16-224")
>>> model = FlaxBeitForImageClassification.from_pretrained("microsoft/beit-base-patch16-224")
>>> inputs = image_processor(images=image, return_tensors="np")
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_class_idx = logits.argmax(-1).item()
>>> print("Predicted class:", model.config.id2label[predicted_class_idx])