Transformers 文件
Data2Vec
並獲得增強的文件體驗
開始使用
Data2Vec
概述
Data2Vec 模型在 Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 的 data2vec: 語音、視覺和語言自監督學習的通用框架 中提出。Data2Vec 提出了一個統一的框架，用於跨不同資料模態（文字、音訊和影像）的自監督學習。重要的是，用於預訓練的預測目標是輸入的語境化潛在表示，而不是特定於模態的、獨立於語境的目標。
論文摘要如下：
雖然自監督學習的總體思想在不同模態中是相同的，但實際演算法和目標差異很大，因為它們是在考慮到單一模態的情況下開發的。為了使我們更接近通用自監督學習，我們提出了 data2vec，這是一個使用相同學習方法進行語音、NLP 或計算機視覺的框架。其核心思想是，在使用標準 Transformer 架構的自蒸餾設定中，根據輸入的掩碼檢視預測完整輸入資料的潛在表示。data2vec 不預測區域性性的模態特定目標（如單詞、視覺標記或人類語音單元），而是預測包含整個輸入資訊的語境化潛在表示。在語音識別、影像分類和自然語言理解的主要基準測試中的實驗表明，它達到了新的 SOTA 水平或與主流方法具有競爭力的效能。模型和程式碼可在 www.github.com/pytorch/fairseq/tree/master/examples/data2vec 獲取。
此模型由 edugp 和 patrickvonplaten 貢獻。sayakpaul 和 Rocketknight1 貢獻了 TensorFlow 中的 Data2Vec 視覺模型。
原始程式碼（用於 NLP 和語音）可在 此處 找到。原始視覺程式碼可在 此處 找到。
使用技巧
- Data2VecAudio、Data2VecText 和 Data2VecVision 均採用相同的自監督學習方法進行訓練。
- 對於 Data2VecAudio，預處理與 Wav2Vec2Model 相同，包括特徵提取。
- 對於 Data2VecText，預處理與 RobertaModel 相同，包括分詞。
- 對於 Data2VecVision，預處理與 BeitModel 相同，包括特徵提取。
- 在使用 “eager” 以外的所有注意力實現時，`head_mask` 引數將被忽略。如果你有 `head_mask` 並希望它生效，請使用 `XXXModel.from_pretrained(model_id, attn_implementation="eager")` 載入模型。
使用縮放點積注意力 (SDPA)
PyTorch 包含一個原生縮放點積注意力 (SDPA) 運算子，作為 `torch.nn.functional` 的一部分。此函式包含多種實現，可根據輸入和所用硬體進行應用。有關更多資訊，請參閱 官方文件 或 GPU 推理 頁面。
當實現可用時，SDPA 預設用於 `torch>=2.1.1`，但你也可以在 `from_pretrained()` 中設定 `attn_implementation="sdpa"` 來明確請求使用 SDPA。
SDPA 實現目前可用於 Data2VecAudio 和 Data2VecVision 模型。
from transformers import Data2VecVisionForImageClassification
model = Data2VecVisionForImageClassification.from_pretrained("facebook/data2vec-vision-base", attn_implementation="sdpa", torch_dtype=torch.float16)
...為了獲得最佳加速效果，我們建議以半精度（例如 `torch.float16` 或 `torch.bfloat16`）載入模型。
對於 Data2VecVision 模型，在本地基準測試（NVIDIA GeForce RTX 2060-8GB，PyTorch 2.5.1，OS Ubuntu 20.04）中，使用 `float16` 和 `facebook/data2vec-vision-base` 模型，我們在訓練和推理過程中觀察到以下改進：
訓練
| 訓練步數 | 批處理大小 | image_size | is_cuda | 每批次時間（Eager - 秒） | 每批次時間（SDPA - 秒） | 加速（%） | Eager 峰值記憶體（MB） | SDPA 峰值記憶體（MB） | 記憶體節省（%） |
|---|---|---|---|---|---|---|---|---|---|
| 50 | 2 | (1048, 640) | True | 0.996 | 0.754 | 32.147 | 6722.198 | 4264.653 | 57.626 |
推理
| 影像批次大小 | Eager (s/iter) | Eager CI, % | Eager 記憶體 (MB) | SDPA (s/iter) | SDPA CI, % | SDPA 記憶體 (MB) | SDPA 加速比 | SDPA 節省記憶體 |
|---|---|---|---|---|---|---|---|---|
| 1 | 0.011 | ±0.3% | 3.76143e+08 | 0.01 | ±0.3% | 3.74397e+08 | 1.101 | 0.466 |
| 4 | 0.014 | ±0.1% | 4.02756e+08 | 0.012 | ±0.2% | 3.91373e+08 | 1.219 | 2.909 |
| 16 | 0.046 | ±0.3% | 4.96482e+08 | 0.035 | ±0.2% | 4.51017e+08 | 1.314 | 10.081 |
| 32 | 0.088 | ±0.1% | 6.23903e+08 | 0.067 | ±0.1% | 5.32974e+08 | 1.33 | 17.061 |
資源
Hugging Face 官方和社群 (🌎) 資源列表，助您開始使用 Data2Vec。
- Data2VecVisionForImageClassification 由此 示例指令碼 和 notebook 支援。
- 要在自定義資料集上微調 TFData2VecVisionForImageClassification，請參閱 此 notebook。
Data2VecText 文件資源
Data2VecAudio 文件資源
Data2VecVision 文件資源
如果您有興趣在此處提交資源，請隨時開啟 Pull Request，我們將對其進行審查！該資源最好能展示一些新內容，而不是重複現有資源。
Data2VecTextConfig
類 transformers.Data2VecTextConfig
< 源 >( vocab_size = 30522 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout_prob = 0.1 attention_probs_dropout_prob = 0.1 max_position_embeddings = 512 type_vocab_size = 2 initializer_range = 0.02 layer_norm_eps = 1e-12 pad_token_id = 1 bos_token_id = 0 eos_token_id = 2 position_embedding_type = 'absolute' use_cache = True classifier_dropout = None **kwargs )
引數
- vocab_size (
int, 可選, 預設為 30522) — DATA2VEC 模型的詞彙表大小。定義了呼叫 `Data2VecModel` 時傳入的 `inputs_ids` 可以表示的不同標記的數量。 - hidden_size (
int, 可選, 預設為 768) — 編碼器層和池化層維度。 - num_hidden_layers (
int, 可選, 預設為 12) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int, 可選, 預設為 12) — Transformer 編碼器中每個注意力層的注意力頭數量。 - intermediate_size (
int, 可選, 預設為 3072) — Transformer 編碼器中“中間”（通常稱為前饋）層的維度。 - hidden_act (
str或Callable, 可選, 預設為"gelu") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果是字串，則支援"gelu"、"relu"、"silu"和"gelu_new"。 - hidden_dropout_prob (
float, 可選, 預設為 0.1) — 嵌入、編碼器和池化器中所有全連線層的 dropout 機率。 - attention_probs_dropout_prob (
float, 可選, 預設為 0.1) — 注意力機率的 dropout 比率。 - max_position_embeddings (
int, 可選, 預設為 512) — 此模型可能使用的最大序列長度。通常設定為一個較大的值以備不時之需（例如，512、1024 或 2048）。 - type_vocab_size (
int, 可選, 預設為 2) — 呼叫 `Data2VecModel` 時傳入的 `token_type_ids` 的詞彙表大小。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - position_embedding_type (
str, 可選, 預設為"absolute") — 位置嵌入的型別。選擇"absolute"、"relative_key"、"relative_key_query"之一。對於位置嵌入，使用"absolute"。有關"relative_key"的更多資訊，請參閱 Self-Attention with Relative Position Representations (Shaw et al.)。有關"relative_key_query"的更多資訊，請參閱 Improve Transformer Models with Better Relative Position Embeddings (Huang et al.) 中的 方法 4。 - is_decoder (
bool, 可選, 預設為False) — 模型是否用作解碼器。如果為False，則模型用作編碼器。 - use_cache (
bool, 可選, 預設為True) — 模型是否應返回最後一個 key/values attention（並非所有模型都使用）。僅當config.is_decoder=True時相關。 - classifier_dropout (
float, 可選) — 分類頭的 dropout 比率。
這是用於儲存 Data2VecTextModel 和 Data2VecTextModel 配置的配置類。它用於根據指定引數例項化 Data2VecText 模型，定義模型架構。使用預設值例項化配置將生成與 Data2VecText facebook/data2vec-text-base 架構類似的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 文件。
示例
>>> from transformers import Data2VecTextConfig, Data2VecTextModel
>>> # Initializing a Data2VecText facebook/data2vec-text-base style configuration
>>> configuration = Data2VecTextConfig()
>>> # Initializing a model (with random weights) from the facebook/data2vec-text-base style configuration
>>> model = Data2VecTextModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configData2VecAudioConfig
類 transformers.Data2VecAudioConfig
< 源 >( vocab_size = 32 hidden_size = 768 num_hidden_layers = 12 num_attention_heads = 12 intermediate_size = 3072 hidden_act = 'gelu' hidden_dropout = 0.1 activation_dropout = 0.1 attention_dropout = 0.1 feat_proj_dropout = 0.0 final_dropout = 0.1 layerdrop = 0.1 initializer_range = 0.02 layer_norm_eps = 1e-05 feat_extract_activation = 'gelu' conv_dim = (512, 512, 512, 512, 512, 512, 512) conv_stride = (5, 2, 2, 2, 2, 2, 2) conv_kernel = (10, 3, 3, 3, 3, 2, 2) conv_bias = False num_conv_pos_embedding_groups = 16 conv_pos_kernel_size = 19 num_conv_pos_embeddings = 5 mask_time_prob = 0.05 mask_time_length = 10 mask_time_min_masks = 2 mask_feature_prob = 0.0 mask_feature_length = 10 mask_feature_min_masks = 0 ctc_loss_reduction = 'sum' ctc_zero_infinity = False use_weighted_layer_sum = False classifier_proj_size = 256 tdnn_dim = (512, 512, 512, 512, 1500) tdnn_kernel = (5, 3, 3, 1, 1) tdnn_dilation = (1, 2, 3, 1, 1) xvector_output_dim = 512 pad_token_id = 0 bos_token_id = 1 eos_token_id = 2 add_adapter = False adapter_kernel_size = 3 adapter_stride = 2 num_adapter_layers = 3 output_hidden_size = None **kwargs )
引數
- vocab_size (
int, optional, defaults to 32) — Data2VecAudio 模型的詞彙表大小。定義了呼叫 Data2VecAudioModel 或TFData2VecAudioModel時傳入的inputs_ids可以表示的不同詞符的數量。模型的詞彙表大小。定義了傳入 Data2VecAudioModel 的 forward 方法的 *inputs_ids* 可以表示的不同詞符。 - hidden_size (
int, optional, defaults to 768) — 編碼器層和池化層維度。 - num_hidden_layers (
int, optional, defaults to 12) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int, optional, defaults to 12) — Transformer 編碼器中每個注意力層的注意力頭數量。 - intermediate_size (
int, optional, defaults to 3072) — Transformer 編碼器中“中間”（即，前饋）層的維度。 - hidden_act (
str或function, optional, defaults to"gelu") — 編碼器和池化器中的非線性啟用函式（函式或字串）。如果為字串，支援"gelu"、"relu"、"selu"和"gelu_new"。 - hidden_dropout (
float, optional, defaults to 0.1) — 嵌入層、編碼器和池化器中所有全連線層的 dropout 機率。 - activation_dropout (
float, optional, defaults to 0.1) — 全連線層內部啟用的 dropout 比率。 - attention_dropout (
float, optional, defaults to 0.1) — 注意力機率的 dropout 比率。 - final_dropout (
float, optional, defaults to 0.1) — Data2VecAudioForCTC 最終投影層的 dropout 機率。 - layerdrop (
float, optional, defaults to 0.1) — LayerDrop 機率。更多詳情請參見 [LayerDrop 論文](參見 https://huggingface.co/papers/1909.11556)。 - initializer_range (
float, optional, defaults to 0.02) — 用於初始化所有權重矩陣的 truncated_normal_initializer 的標準差。 - layer_norm_eps (
float, optional, defaults to 1e-12) — 層歸一化層使用的 epsilon 值。 - feat_proj_dropout (
float, optional, defaults to 0.0) — 特徵編碼器輸出的 dropout 機率。 - feat_extract_activation (
str,optional, defaults to“gelu”) -- 特徵提取器中 1D 卷積層的非線性啟用函式（函式或字串）。如果為字串，支援“gelu”,“relu”,“selu”和“gelu_new”`。 - conv_dim (
tuple[int]或list[int], optional, defaults to(512, 512, 512, 512, 512, 512, 512)) — 定義特徵編碼器中每個 1D 卷積層的輸入和輸出通道數的整數元組。*conv_dim* 的長度定義了 1D 卷積層的數量。 - conv_stride (
tuple[int]或list[int], optional, defaults to(5, 2, 2, 2, 2, 2, 2)) — 定義特徵編碼器中每個 1D 卷積層的步幅的整數元組。*conv_stride* 的長度定義了卷積層的數量，並且必須與 *conv_dim* 的長度匹配。 - conv_kernel (
tuple[int]或list[int], optional, defaults to(10, 3, 3, 3, 3, 3, 3)) — 定義特徵編碼器中每個 1D 卷積層的核大小的整數元組。*conv_kernel* 的長度定義了卷積層的數量，並且必須與 *conv_dim* 的長度匹配。 - conv_bias (
bool, optional, defaults toFalse) — 1D 卷積層是否有偏差。 - num_conv_pos_embeddings (
int, optional, defaults to 128) — 卷積位置嵌入的數量。定義了 1D 卷積位置嵌入層的核大小。 - num_conv_pos_embedding_groups (
int, optional, defaults to 16) — 1D 卷積位置嵌入層的組數。 - mask_time_prob (
float, optional, defaults to 0.05) — 沿時間軸所有特徵向量將被遮蔽的百分比（0 到 1 之間）。遮蔽過程沿軸生成“mask_time_prob * len(time_axis) / mask_time_length”個獨立遮罩。如果從每個特徵向量被選為要遮蔽的向量範圍開始的機率來推斷，則 *mask_time_prob* 應該是 `prob_vector_start * mask_time_length`。請注意，重疊可能會減少實際遮蔽向量的百分比。 - mask_time_length (
int, optional, defaults to 10) — 沿時間軸的向量範圍長度。 - mask_time_min_masks (
int, optional, defaults to 2) — 沿時間軸生成的長度為mask_feature_length的最小遮罩數，每個時間步都如此，與mask_feature_prob無關。僅當“mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks”時才相關。 - mask_feature_prob (
float, optional, defaults to 0.0) — 沿特徵軸所有特徵向量將被遮蔽的百分比（0 到 1 之間）。遮蔽過程沿軸生成“mask_feature_prob * len(feature_axis) / mask_time_length”個獨立遮罩。如果從每個特徵向量被選為要遮蔽的向量範圍開始的機率來推斷，則 *mask_feature_prob* 應該是 `prob_vector_start * mask_feature_length`。請注意，重疊可能會減少實際遮蔽向量的百分比。這僅在apply_spec_augment 為 True時相關。 - mask_feature_length (
int, optional, defaults to 10) — 沿特徵軸的向量範圍長度。 - mask_feature_min_masks (
int, optional, defaults to 0) — 沿特徵軸生成的長度為mask_feature_length的最小遮罩數，每個時間步都如此，與mask_feature_prob無關。僅當“mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks”時才相關。 - ctc_loss_reduction (
str, optional, defaults to"sum") — 指定應用於torch.nn.CTCLoss輸出的 reduction。僅在訓練 Data2VecAudioForCTC 例項時相關。 - ctc_zero_infinity (
bool, optional, defaults toFalse) — 是否將無限損失和torch.nn.CTCLoss的相關梯度置零。無限損失主要發生在輸入太短而無法與目標對齊時。僅在訓練 Data2VecAudioForCTC 例項時相關。 - use_weighted_layer_sum (
bool, optional, defaults toFalse) — 是否使用帶學習權重的層輸出的加權平均值。僅在使用 Data2VecAudioForSequenceClassification 例項時相關。 - classifier_proj_size (
int, optional, defaults to 256) — 分類前標記均值池化（token mean-pooling）的投影維度。 - tdnn_dim (
tuple[int]或list[int], optional, defaults to(512, 512, 512, 512, 1500)) — 定義 *XVector* 模型 *TDNN* 模組中每個 1D 卷積層輸出通道數的整數元組。*tdnn_dim* 的長度定義了 *TDNN* 層的數量。 - tdnn_kernel (
tuple[int]或list[int], optional, defaults to(5, 3, 3, 1, 1)) — 定義 *XVector* 模型 *TDNN* 模組中每個 1D 卷積層核大小的整數元組。*tdnn_kernel* 的長度必須與 *tdnn_dim* 的長度匹配。 - tdnn_dilation (
tuple[int]或list[int], optional, defaults to(1, 2, 3, 1, 1)) — 定義 *XVector* 模型 *TDNN* 模組中每個 1D 卷積層膨脹因子的整數元組。*tdnn_dilation* 的長度必須與 *tdnn_dim* 的長度匹配。 - xvector_output_dim (
int, optional, defaults to 512) — *XVector* 嵌入向量的維度。 - add_adapter (
bool, optional, defaults toFalse) — 卷積網路是否應堆疊在 Data2VecAudio 編碼器之上。對於 SpeechEncoderDecoder 模型的 Data2VecAudio 預熱（warm-starting）非常有用。 - adapter_kernel_size (
int, optional, defaults to 3) — 介面卡網路中卷積層的核大小。僅在add_adapter 為 True時相關。 - adapter_stride (
int, optional, defaults to 2) — 介面卡網路中卷積層的步長。僅在add_adapter 為 True時相關。 - num_adapter_layers (
int, optional, defaults to 3) — 介面卡網路中應使用的卷積層數。僅在add_adapter 為 True時相關。 - output_hidden_size (
int, optional) — 編碼器輸出層的維度。如果未定義，預設為 *hidden-size*。僅在add_adapter 為 True時相關。
這是用於儲存 Data2VecAudioModel 配置的配置類。它用於根據指定的引數例項化 Data2VecAudio 模型，定義模型架構。使用預設值例項化配置將產生類似於 Data2VecAudio facebook/data2vec-audio-base-960h 架構的配置。
配置物件繼承自 PretrainedConfig，可用於控制模型輸出。有關更多資訊，請閱讀 PretrainedConfig 文件。
示例
>>> from transformers import Data2VecAudioConfig, Data2VecAudioModel
>>> # Initializing a Data2VecAudio facebook/data2vec-audio-base-960h style configuration
>>> configuration = Data2VecAudioConfig()
>>> # Initializing a model (with random weights) from the facebook/data2vec-audio-base-960h style configuration
>>> model = Data2VecAudioModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configData2VecVisionConfig
class transformers.Data2VecVisionConfig
< source >( 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 out_indices = [3, 5, 7, 11] 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 **kwargs )
引數
- hidden_size (
int, optional, defaults to 768) — 編碼器層和池化層的維度。 - num_hidden_layers (
int, optional, defaults to 12) — Transformer 編碼器中的隱藏層數量。 - num_attention_heads (
int, optional, defaults to 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) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。 - layer_norm_eps (
float, 可選, 預設為 1e-12) — 層歸一化層使用的 epsilon 值。 - image_size (
int, 可選, 預設為 224) — 每張影像的大小（解析度）。 - patch_size (
int, 可選, 預設為 16) — 每個補丁的大小（解析度）。 - num_channels (
int, 可選, 預設為 3) — 輸入通道數。 - use_mask_token (
bool, 可選, 預設為False) — 是否使用掩碼 token 進行掩碼影像建模。 - use_absolute_position_embeddings (
bool, 可選, 預設為False) — 是否使用 BERT 風格的絕對位置嵌入。 - use_relative_position_bias (
bool, 可選, 預設為False) — 是否在自注意力層中使用 T5 風格的相對位置嵌入。 - use_shared_relative_position_bias (
bool, 可選, 預設為False) — 是否在 Transformer 的所有自注意力層中使用相同的相對位置嵌入。 - layer_scale_init_value (
float, 可選, 預設為 0.1) — 自注意力層中使用的縮放比例。基礎模型為 0.1，大型模型為 1e-5。設定為 0 可停用層縮放。 - drop_path_rate (
float, 可選, 預設為 0.1) — 每樣本的隨機深度率（應用於殘差層的主路徑時）。 - use_mean_pooling (
bool, 可選, 預設為True) — 在應用分類頭之前，是平均池化補丁的最終隱藏狀態，而不是使用 CLS token 的最終隱藏狀態。 - out_indices (
list[int], 可選, 預設為[3, 5, 7, 11]) — 用於語義分割的特徵圖索引。 - pool_scales (
tuple[int], 可選, 預設為[1, 2, 3, 6]) — 應用於最後一個特徵圖的池化金字塔模組中使用的池化比例。 - use_auxiliary_head (
bool, 可選, 預設為True) — 訓練期間是否使用輔助頭。 - auxiliary_loss_weight (
float, 可選, 預設為 0.4) — 輔助頭交叉熵損失的權重。 - auxiliary_channels (
int, 可選, 預設為 256) — 輔助頭中使用的通道數。 - auxiliary_num_convs (
int, 可選, 預設為 1) — 輔助頭中使用的卷積層數。 - auxiliary_concat_input (
bool, 可選, 預設為False) — 在分類層之前，是否將輔助頭的輸出與輸入拼接。 - semantic_loss_ignore_index (
int, 可選, 預設為 255) — 語義分割模型的損失函式忽略的索引。
這是用於儲存 Data2VecVisionModel 配置的配置類。它用於根據指定的引數例項化 Data2VecVision 模型，定義模型架構。使用預設值例項化配置將產生類似於 Data2VecVision facebook/data2vec-vision-base 架構的配置。
示例
>>> from transformers import Data2VecVisionConfig, Data2VecVisionModel
>>> # Initializing a Data2VecVision data2vec_vision-base-patch16-224-in22k style configuration
>>> configuration = Data2VecVisionConfig()
>>> # Initializing a model (with random weights) from the data2vec_vision-base-patch16-224-in22k style configuration
>>> model = Data2VecVisionModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configData2VecAudioModel
class transformers.Data2VecAudioModel
< source >( config: Data2VecAudioConfig )
引數
- config (Data2VecAudioConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，只加載配置。請查閱 from_pretrained() 方法以載入模型權重。
裸 Data2Vec 音訊模型輸出原始隱藏狀態，頂部沒有任何特定頭部。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None mask_time_indices: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
引數
- input_values (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 輸入原始語音波形的浮點值。可以透過將.flac或.wav音訊檔案載入到list[float]型別或numpy.ndarray陣列中獲取，例如 透過 soundfile 庫（pip install soundfile）。為了將陣列準備成input_values，應使用 AutoProcessor 進行填充和轉換為torch.FloatTensor型別張量。詳見{processor_class}.__call__。 - attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 掩碼，用於避免對填充 token 索引執行注意力操作。掩碼值選擇在[0, 1]：- 1 表示 未被掩碼 的 token，
- 0 表示 被掩碼 的 token。
- mask_time_indices (形狀為
(batch_size, sequence_length)的torch.BoolTensor, 可選) — 用於對比損失的掩碼提取特徵的索引。在訓練模式下，模型學習預測 config.proj_codevector_dim 空間中的掩碼提取特徵。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。詳見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。詳見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 torch.FloatTensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (Data2VecAudioConfig) 和輸入而定的各種元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
extract_features (
torch.FloatTensor形狀為(batch_size, sequence_length, conv_dim[-1])) — 模型最後一個卷積層的提取特徵向量序列。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecAudioModel 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
Data2VecAudioForAudioFrameClassification
class transformers.Data2VecAudioForAudioFrameClassification
< source >( config )
引數
- config (Data2VecAudioForAudioFrameClassification) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，只加載配置。請查閱 from_pretrained() 方法以載入模型權重。
帶有幀分類頭的 Data2Vec 音訊模型，用於揚聲器識別等任務。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_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 return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_values (形狀為
(batch_size, sequence_length)的torch.FloatTensor) — 輸入原始語音波形的浮點值。可以透過將.flac或.wav音訊檔案載入到list[float]型別或numpy.ndarray陣列中獲取，例如 透過 soundfile 庫（pip install soundfile）。為了將陣列準備成input_values，應使用 AutoProcessor 進行填充和轉換為torch.FloatTensor型別張量。詳見Data2VecAudioProcessor.__call__。 - attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 掩碼，用於避免對填充 token 索引執行注意力操作。掩碼值選擇在[0, 1]：- 1 表示 未被掩碼 的 token，
- 0 表示 被掩碼 的 token。
- labels (形狀為
(batch_size,)的torch.LongTensor, 可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失），如果config.num_labels > 1，則計算分類損失（交叉熵損失）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。詳見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。詳見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (Data2VecAudioConfig) 和輸入而定的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的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 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecAudioForAudioFrameClassification 的 forward 方法，覆蓋了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoFeatureExtractor, Data2VecAudioForAudioFrameClassification
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/data2vec-audio-base-960h")
>>> model = Data2VecAudioForAudioFrameClassification.from_pretrained("facebook/data2vec-audio-base-960h")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], return_tensors="pt", sampling_rate=sampling_rate)
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> probabilities = torch.sigmoid(logits[0])
>>> # labels is a one-hot array of shape (num_frames, num_speakers)
>>> labels = (probabilities > 0.5).long()
>>> labels[0].tolist()
...Data2VecAudioForCTC
class transformers.Data2VecAudioForCTC
< source >( config )
引數
- config (Data2VecAudioForCTC) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不載入與模型關聯的權重，只加載配置。請查閱 from_pretrained() 方法以載入模型權重。
Data2VecAudio 模型，頂部帶有 語言建模 頭，用於連線時序分類 (CTC)。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
引數
- input_values (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 輸入原始語音波形的浮點值。可以透過將.flac或.wav音訊檔案載入到list[float]型別或numpy.ndarray陣列中獲取，例如 透過 soundfile 庫（pip install soundfile）。為了將陣列準備成input_values，應使用 AutoProcessor 進行填充和轉換為torch.FloatTensor型別張量。詳見{processor_class}.__call__。 - attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示**未掩蓋**的標記，
- 0 表示**已掩蓋**的標記。
- output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而非普通元組。 - labels (
torch.LongTensor，形狀為(batch_size, target_length)，可選) — 用於連線主義時間分類的標籤。請注意，target_length必須小於或等於輸出 logits 的序列長度。索引選擇範圍為[-100, 0, ..., config.vocab_size - 1]。所有設定為-100的標籤將被忽略（掩蓋），損失僅針對[0, ..., config.vocab_size - 1]中的標籤計算。
返回
transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutput 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置（Data2VecAudioConfig）和輸入而定的各種元素。
-
loss (
torch.FloatTensor形狀為(1,)，可選，當提供labels時返回) — 語言建模損失（用於下一個 token 預測）。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
此 Data2VecAudioForCTC 前向方法重寫了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoProcessor, Data2VecAudioForCTC
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("facebook/data2vec-audio-base-960h")
>>> model = Data2VecAudioForCTC.from_pretrained("facebook/data2vec-audio-base-960h")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_ids = torch.argmax(logits, dim=-1)
>>> # transcribe speech
>>> transcription = processor.batch_decode(predicted_ids)
>>> transcription[0]
...
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
...Data2VecAudioForSequenceClassification
class transformers.Data2VecAudioForSequenceClassification
< source >( config )
引數
- config (Data2VecAudioForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請查閱 from_pretrained() 方法載入模型權重。
Data2VecAudio 模型，頂部帶有一個用於 SUPERB 關鍵詞識別等任務的序列分類頭（在池化輸出上方的線性層）。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_values (
torch.FloatTensor，形狀為(batch_size, sequence_length)) — 輸入原始語音波形的浮點值。可以透過將.flac或.wav音訊檔案載入到list[float]型別陣列或numpy.ndarray中來獲取值，例如透過 soundfile 庫（pip install soundfile）。為了將陣列準備到input_values中，應使用 AutoProcessor 進行填充並轉換為torch.FloatTensor型別的張量。有關詳細資訊，請參閱Data2VecAudioProcessor.__call__。 - attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示**未掩蓋**的標記，
- 0 表示**已掩蓋**的標記。
- output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而非普通元組。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失），如果config.num_labels > 1，則計算分類損失（交叉熵）。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置（Data2VecAudioConfig）和輸入而定的各種元素。
-
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, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
此 Data2VecAudioForSequenceClassification 前向方法重寫了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, Data2VecAudioForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-audio-base-960h")
>>> model = Data2VecAudioForSequenceClassification.from_pretrained("facebook/data2vec-audio-base-960h")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Data2VecAudioForSequenceClassification.from_pretrained("facebook/data2vec-audio-base-960h", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, Data2VecAudioForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-audio-base-960h")
>>> model = Data2VecAudioForSequenceClassification.from_pretrained("facebook/data2vec-audio-base-960h", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Data2VecAudioForSequenceClassification.from_pretrained(
... "facebook/data2vec-audio-base-960h", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossData2VecAudioForXVector
class transformers.Data2VecAudioForXVector
< source >( config )
引數
- config (Data2VecAudioForXVector) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請查閱 from_pretrained() 方法載入模型權重。
Data2VecAudio 模型，頂部帶有一個用於說話人驗證等任務的 XVector 特徵提取頭。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< source >( input_values: typing.Optional[torch.Tensor] attention_mask: typing.Optional[torch.Tensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None labels: typing.Optional[torch.Tensor] = None ) → transformers.modeling_outputs.XVectorOutput 或 tuple(torch.FloatTensor)
引數
- input_values (
torch.FloatTensor，形狀為(batch_size, sequence_length)) — 輸入原始語音波形的浮點值。可以透過將.flac或.wav音訊檔案載入到list[float]型別陣列或numpy.ndarray中來獲取值，例如透過 soundfile 庫（pip install soundfile）。為了將陣列準備到input_values中，應使用 AutoProcessor 進行填充並轉換為torch.FloatTensor型別的張量。有關詳細資訊，請參閱Data2VecAudioProcessor.__call__。 - attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示**未掩蓋**的標記，
- 0 表示**已掩蓋**的標記。
- output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而非普通元組。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失），如果config.num_labels > 1，則計算分類損失（交叉熵）。
返回
transformers.modeling_outputs.XVectorOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.XVectorOutput 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置（Data2VecAudioConfig）和輸入而定的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, config.xvector_output_dim)的torch.FloatTensor) — AMSoftmax 之前的分類隱藏狀態。 -
embeddings (形狀為
(batch_size, config.xvector_output_dim)的torch.FloatTensor) — 用於基於向量相似性檢索的話語嵌入。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
此 Data2VecAudioForXVector 前向方法重寫了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoFeatureExtractor, Data2VecAudioForXVector
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/data2vec-audio-base-960h")
>>> model = Data2VecAudioForXVector.from_pretrained("facebook/data2vec-audio-base-960h")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(
... [d["array"] for d in dataset[:2]["audio"]], sampling_rate=sampling_rate, return_tensors="pt", padding=True
... )
>>> with torch.no_grad():
... embeddings = model(**inputs).embeddings
>>> embeddings = torch.nn.functional.normalize(embeddings, dim=-1).cpu()
>>> # the resulting embeddings can be used for cosine similarity-based retrieval
>>> cosine_sim = torch.nn.CosineSimilarity(dim=-1)
>>> similarity = cosine_sim(embeddings[0], embeddings[1])
>>> threshold = 0.7 # the optimal threshold is dataset-dependent
>>> if similarity < threshold:
... print("Speakers are not the same!")
>>> round(similarity.item(), 2)
...Data2VecTextModel
class transformers.Data2VecTextModel
< source >( config add_pooling_layer = True )
引數
- config (Data2VecTextModel) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請查閱 from_pretrained() 方法載入模型權重。
- add_pooling_layer (
bool, 可選, 預設為True) — 是否新增池化層
裸 Data2Vec 文字模型，輸出原始隱藏狀態，不帶任何特定頭部。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None token_type_ids: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.Tensor] = None head_mask: typing.Optional[torch.Tensor] = None inputs_embeds: typing.Optional[torch.Tensor] = None encoder_hidden_states: typing.Optional[torch.Tensor] = None encoder_attention_mask: typing.Optional[torch.Tensor] = None past_key_values: typing.Optional[list[torch.FloatTensor]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。填充預設將被忽略。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示**未掩蓋**的標記，
- 0 表示**已掩蓋**的標記。
- token_type_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 分段標記索引，用於指示輸入的第一個和第二個部分。索引選擇範圍為[0, 1]：- 0 對應於**句子 A** 標記，
- 1 對應於**句子 B** 標記。
- position_ids (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.Tensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部**未掩蓋**，
- 0 表示頭部**已掩蓋**。
- inputs_embeds (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — （可選）您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您想對如何將input_ids索引轉換為相關向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - encoder_hidden_states (
torch.Tensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在編碼器輸入填充標記索引上執行注意力操作的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值選擇範圍為[0, 1]：- 1 表示**未掩蓋**的標記，
- 0 表示**已掩蓋**的標記。
- past_key_values (
list[torch.FloatTensor], 可選) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼上一階段返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量）。這也被稱為傳統快取格式。
模型將輸出與輸入相同的快取格式。如果沒有傳遞
past_key_values，則返回傳統快取格式。如果使用
past_key_values，使用者可以選擇只輸入最後一個input_ids（那些沒有將其過去的鍵值狀態提供給此模型的）的形狀(batch_size, 1)，而不是所有input_ids的形狀(batch_size, sequence_length)。 - use_cache (
bool, 可選) — 如果設定為True，則返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而非普通元組。
返回
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一個 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置（Data2VecTextConfig）和輸入而定的各種元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (
torch.FloatTensor，形狀為(batch_size, hidden_size)) — 經過用於輔助預訓練任務的層進一步處理後，序列中第一個標記（分類標記）的最後一層隱藏狀態。例如，對於 BERT 系列模型，這將返回透過線性層和 tanh 啟用函式處理後的分類標記。線性層權重在預訓練期間透過下一個句子預測（分類）目標進行訓練。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可選，當output_attentions=True和config.add_cross_attention=True傳入時或當config.output_attentions=True時返回) —torch.FloatTensor元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。解碼器交叉注意力層的注意力權重，在注意力 softmax 之後，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, 可選, 當use_cache=True傳入時或當config.use_cache=True時返回) — 它是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值，以及如果
config.is_encoder_decoder=True則可選地在交叉注意力塊中的鍵和值），可用於加速順序解碼（參見past_key_values輸入）。
此 Data2VecTextModel 前向方法重寫了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
Data2VecTextForCausalLM
class transformers.Data2VecTextForCausalLM
< source >( config )
引數
- config (Data2VecTextForCausalLM) — 包含模型所有引數的模型配置類。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請查閱 from_pretrained() 方法載入模型權重。
Data2VecText 模型，頂部帶有一個用於 CLM 微調的 language modeling 頭。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[tuple[tuple[torch.FloatTensor]]] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None **kwargs ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 token 未被遮蔽，
- 0 表示 token 已被遮蔽。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入中第一部分和第二部分的段 token 索引。索引選擇範圍為[0, 1]：- 0 對應於 句子 A token，
- 1 對應於 句子 B token。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.FloatTensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置空自注意力模組中選定頭部的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部未被遮蔽，
- 0 表示頭部已被遮蔽。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以直接傳遞嵌入表示，而不是傳遞input_ids。如果您想對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - encoder_hidden_states (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對編碼器輸入中的填充 token 索引執行注意力操作的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值選擇範圍為[0, 1]：- 1 表示 token 未被遮蔽，
- 0 表示 token 已被遮蔽。
- labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算從左到右語言建模損失（下一個詞預測）的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）索引設定為-100的 token 將被忽略（遮蔽），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的 token 計算。 - past_key_values (
tuple[tuple[torch.FloatTensor]]，可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速順序解碼。這通常包括模型在解碼前期階段返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv cache 指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量）。這也被稱為傳統快取格式。
模型將輸出與作為輸入提供的快取格式相同的快取格式。如果未傳遞
past_key_values，將返回傳統快取格式。如果使用
past_key_values，使用者可以選擇只輸入形狀為(batch_size, 1)的最後一個input_ids（那些沒有將其過去的鍵值狀態提供給此模型的 token），而不是形狀為(batch_size, sequence_length)的所有input_ids。 - use_cache (
bool，可選) — 如果設定為True，將返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的hidden_states。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (Data2VecTextConfig) 和輸入而變化的各種元素。
-
loss (
torch.FloatTensor形狀為(1,)，可選，當提供labels時返回) — 語言建模損失（用於下一個 token 預測）。 -
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
-
cross_attentions (
tuple(torch.FloatTensor)，可選，當傳遞output_attentions=True或當config.output_attentions=True時返回) —torch.FloatTensor元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的交叉注意力權重，用於計算交叉注意力頭中的加權平均。
-
past_key_values (
Cache, 可選, 當use_cache=True傳入時或當config.use_cache=True時返回) — 它是一個 Cache 例項。有關更多詳細資訊，請參閱我們的 kv 快取指南。包含預先計算的隱藏狀態（注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。
Data2VecTextForCausalLM 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoTokenizer, Data2VecTextForCausalLM, Data2VecTextConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-text-base")
>>> config = Data2VecTextConfig.from_pretrained("facebook/data2vec-text-base")
>>> config.is_decoder = True
>>> model = Data2VecTextForCausalLM.from_pretrained("facebook/data2vec-text-base", config=config)
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logitsData2VecTextForMaskedLM
class transformers.Data2VecTextForMaskedLM
< 源 >( config )
引數
- config (Data2VecTextForMaskedLM) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
Data2Vec 文字模型，頂部帶有一個 語言建模 頭。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None encoder_hidden_states: typing.Optional[torch.FloatTensor] = None encoder_attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 token 未被遮蔽，
- 0 表示 token 已被遮蔽。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入中第一部分和第二部分的段 token 索引。索引選擇範圍為[0, 1]：- 0 對應於 句子 A token，
- 1 對應於 句子 B token。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.FloatTensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置空自注意力模組中選定頭部的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部未被遮蔽，
- 0 表示頭部已被遮蔽。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以直接傳遞嵌入表示，而不是傳遞input_ids。如果您想對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - encoder_hidden_states (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 編碼器最後一層輸出的隱藏狀態序列。如果模型配置為解碼器，則用於交叉注意力。 - encoder_attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對編碼器輸入中的填充 token 索引執行注意力操作的掩碼。如果模型配置為解碼器，則此掩碼用於交叉注意力。掩碼值選擇範圍為[0, 1]：- 1 表示 token 未被遮蔽，
- 0 表示 token 已被遮蔽。
- labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算遮蔽語言建模損失的標籤。索引應在[-100, 0, ..., config.vocab_size]範圍內（參見input_ids文件字串）索引設定為-100的 token 將被忽略（遮蔽），損失僅針對標籤在[0, ..., config.vocab_size]範圍內的 token 計算。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參閱返回張量中的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參閱返回張量中的hidden_states。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.MaskedLMOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (Data2VecTextConfig) 和輸入而變化的各種元素。
-
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 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecTextForMaskedLM 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoTokenizer, Data2VecTextForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-text-base")
>>> model = Data2VecTextForMaskedLM.from_pretrained("facebook/data2vec-text-base")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of <mask>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
...
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
...Data2VecTextForSequenceClassification
class transformers.Data2VecTextForSequenceClassification
< 源 >( config )
引數
- config (Data2VecTextForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
Data2Vec 文字模型 Transformer，頂部帶有一個序列分類/迴歸頭（在池化輸出之上有一個線性層），例如用於 GLUE 任務。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列 token 的索引。預設情況下會忽略填充。索引可以使用 AutoTokenizer 獲取。詳情請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor，形狀為(batch_size, sequence_length)，可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示 token 未被遮蔽，
- 0 表示 token 已被遮蔽。
- token_type_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於指示輸入中第一部分和第二部分的段 token 索引。索引選擇範圍為[0, 1]：- 0 對應於 句子 A token，
- 1 對應於 句子 B token。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列 token 在位置嵌入中的位置索引。選擇範圍為[0, config.n_positions - 1]。 - head_mask (
torch.FloatTensor，形狀為(num_heads,)或(num_layers, num_heads)，可選) — 用於置空自注意力模組中選定頭部的掩碼。掩碼值選擇範圍為[0, 1]：- 1 表示頭部未被遮蔽，
- 0 表示頭部已被遮蔽。
- inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以直接傳遞嵌入表示，而不是傳遞input_ids。如果您想對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這會很有用。 - 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。 - return_dict (
bool，可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutput 或一個 torch.FloatTensor 元組（如果傳遞 return_dict=False 或當 config.return_dict=False 時），包含根據配置 (Data2VecTextConfig) 和輸入而變化的各種元素。
-
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, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecTextForSequenceClassification 的前向方法，重寫了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, Data2VecTextForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-text-base")
>>> model = Data2VecTextForSequenceClassification.from_pretrained("facebook/data2vec-text-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Data2VecTextForSequenceClassification.from_pretrained("facebook/data2vec-text-base", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, Data2VecTextForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-text-base")
>>> model = Data2VecTextForSequenceClassification.from_pretrained("facebook/data2vec-text-base", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Data2VecTextForSequenceClassification.from_pretrained(
... "facebook/data2vec-text-base", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossData2VecTextForMultipleChoice
class transformers.Data2VecTextForMultipleChoice
< 源 >( config )
引數
- config (Data2VecTextForMultipleChoice) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
Data2Vec 文字模型，頂部帶有一個多項選擇分類頭（在池化輸出之上有一個線性層和一個 softmax），例如用於 RocStories/SWAG 任務。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, num_choices, sequence_length)的torch.LongTensor) — 詞彙表中輸入序列 token 的索引。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- token_type_ids (形狀為
(batch_size, num_choices, sequence_length)的torch.LongTensor, 可選) — 用於指示輸入的第一部分和第二部分的 segment token 索引。索引在[0, 1]中選擇：- 0 對應於 句子 A token,
- 1 對應於 句子 B token。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值在[0, 1]中選擇：- 1 表示 token 未被掩碼,
- 0 表示 token 被掩碼。
- labels (形狀為
(batch_size,)的torch.LongTensor, 可選) — 用於計算多項選擇分類損失的標籤。索引應在[0, ..., num_choices-1]之間，其中num_choices是輸入張量第二維的大小。（參見上面的input_ids） - position_ids (形狀為
(batch_size, num_choices, sequence_length)的torch.LongTensor, 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。在[0, config.max_position_embeddings - 1]範圍內選擇。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭部未被掩碼,
- 0 表示頭部被掩碼。
- inputs_embeds (形狀為
(batch_size, num_choices, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.MultipleChoiceModelOutput 或 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置 (Data2VecTextConfig) 和輸入而變化的各種元素。
-
loss (形狀為 (1,) 的
torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, num_choices)的torch.FloatTensor) — num_choices 是輸入張量的第二維大小。（請參閱上面的 input_ids）。分類分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecTextForMultipleChoice 的前向方法，覆蓋了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoTokenizer, Data2VecTextForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-text-base")
>>> model = Data2VecTextForMultipleChoice.from_pretrained("facebook/data2vec-text-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsData2VecTextForTokenClassification
class transformers.Data2VecTextForTokenClassification
< 源 >( config )
引數
- config (Data2VecTextForTokenClassification) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Data2Vec 文字轉換器，頂部帶有一個 token 分類頭（隱藏狀態輸出頂部的線性層），例如用於命名實體識別 (NER) 任務。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 詞彙表中輸入序列 token 的索引。填充預設會被忽略。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值在[0, 1]中選擇：- 1 表示 token 未被掩碼,
- 0 表示 token 被掩碼。
- token_type_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於指示輸入的第一部分和第二部分的 segment token 索引。索引在[0, 1]中選擇：- 0 對應於 句子 A token,
- 1 對應於 句子 B token。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭部未被掩碼,
- 0 表示頭部被掩碼。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - labels (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於計算 token 分類損失的標籤。索引應在[0, ..., config.num_labels - 1]之間。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.TokenClassifierOutput 或 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置 (Data2VecTextConfig) 和輸入而變化的各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的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 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecTextForTokenClassification 的前向方法，覆蓋了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoTokenizer, Data2VecTextForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-text-base")
>>> model = Data2VecTextForTokenClassification.from_pretrained("facebook/data2vec-text-base")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...Data2VecTextForQuestionAnswering
class transformers.Data2VecTextForQuestionAnswering
< 源 >( config )
引數
- config (Data2VecTextForQuestionAnswering) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
Data2Vec 文字轉換器，頂部帶有一個用於 SQuAD 等抽取式問答任務的 span 分類頭（隱藏狀態輸出頂部的線性層，用於計算 span start logits 和 span end logits）。
此模型繼承自 PreTrainedModel。查閱超類文件以瞭解庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 PyTorch torch.nn.Module 子類。將其作為常規 PyTorch 模組使用，並參閱 PyTorch 文件以瞭解所有與一般用法和行為相關的事項。
forward
< 源 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.FloatTensor] = None token_type_ids: typing.Optional[torch.LongTensor] = None position_ids: typing.Optional[torch.LongTensor] = None head_mask: typing.Optional[torch.FloatTensor] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None start_positions: typing.Optional[torch.LongTensor] = None end_positions: typing.Optional[torch.LongTensor] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 詞彙表中輸入序列 token 的索引。填充預設會被忽略。索引可以使用 AutoTokenizer 獲取。有關詳細資訊，請參見 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.FloatTensor, 可選) — 用於避免對填充 token 索引執行注意力操作的掩碼。掩碼值在[0, 1]中選擇：- 1 表示 token 未被掩碼,
- 0 表示 token 被掩碼。
- token_type_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 用於指示輸入的第一部分和第二部分的 segment token 索引。索引在[0, 1]中選擇：- 0 對應於 句子 A token,
- 1 對應於 句子 B token。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 每個輸入序列 token 在位置嵌入中的位置索引。在[0, config.n_positions - 1]範圍內選擇。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.FloatTensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[0, 1]中選擇：- 1 表示頭部未被掩碼,
- 0 表示頭部被掩碼。
- inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量有比模型內部嵌入查詢矩陣更多的控制，這將非常有用。 - start_positions (形狀為
(batch_size,)的torch.LongTensor, 可選) — 用於計算 token 分類損失的標註 span 起始位置（索引）的標籤。位置被限制在序列長度（sequence_length）範圍內。序列外的位置不計入損失計算。 - end_positions (形狀為
(batch_size,)的torch.LongTensor, 可選) — 用於計算 token 分類損失的標註 span 結束位置（索引）的標籤。位置被限制在序列長度（sequence_length）範圍內。序列外的位置不計入損失計算。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。更多詳細資訊請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。更多詳細資訊請參見返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。
返回
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor 的元組（如果傳入 return_dict=False 或 config.return_dict=False），包含根據配置 (Data2VecTextConfig) 和輸入而變化的各種元素。
-
loss (
torch.FloatTensorof shape(1,), 可選, 當提供labels時返回) — 總範圍提取損失是起始位置和結束位置的交叉熵之和。 -
start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍起始分數（SoftMax 之前）。 -
end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 範圍結束分數（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 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecTextForQuestionAnswering 的前向方法，覆蓋了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoTokenizer, Data2VecTextForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-text-base")
>>> model = Data2VecTextForQuestionAnswering.from_pretrained("facebook/data2vec-text-base")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...Data2VecVisionModel
class transformers.Data2VecVisionModel
< 源 >( config: Data2VecVisionConfig add_pooling_layer: bool = False )
引數
- config (Data2VecVisionConfig) — 模型的配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法來載入模型權重。
- add_pooling_layer (
bool, 可選, 預設為False) — 是否新增池化層
裸露的 Data2Vec Vision 模型，輸出原始隱藏狀態，頂部沒有任何特定頭部。
此模型繼承自 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.data2vec.modeling_data2vec_vision.Data2VecVisionModelOutputWithPooling 或 tuple(torch.FloatTensor)
引數
- pixel_values (形狀為
(batch_size, num_channels, image_size, image_size)的torch.Tensor) — 對應於輸入影像的張量。畫素值可以使用{image_processor_class}獲取。有關詳細資訊，請參見{image_processor_class}.__call__（{processor_class}使用{image_processor_class}處理影像）。 - bool_masked_pos (形狀為
(batch_size, num_patches)的torch.BoolTensor, 可選) — 布林掩碼位置。指示哪些 patch 被掩碼 (1) 以及哪些未被掩碼 (0)。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.Tensor, 可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值在[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.data2vec.modeling_data2vec_vision.Data2VecVisionModelOutputWithPooling 或 tuple(torch.FloatTensor)
一個transformers.models.data2vec.modeling_data2vec_vision.Data2VecVisionModelOutputWithPooling或torch.FloatTensor的元組（如果傳入return_dict=False或config.return_dict=False），包含根據配置（Data2VecVisionConfig）和輸入而變化的各種元素。
-
last_hidden_state (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (形狀為
(batch_size, hidden_size)的torch.FloatTensor) — 如果config.use_mean_pooling設定為True，則為補丁標記的最後一層隱藏狀態（不包括[CLS]標記）的平均值。如果設定為False，則返回[CLS]標記的最終隱藏狀態。 -
hidden_states (
tuple[torch.FloatTensor, ...], 可選, 在傳入output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入層的輸出，加上每個層的輸出）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple[torch.FloatTensor, ...], 可選, 在傳入output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecVisionModel的forward方法，覆蓋了__call__特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
Data2VecVisionForImageClassification
類 transformers.Data2VecVisionForImageClassification
< 源 >( config: Data2VecVisionConfig )
引數
- config (Data2VecVisionConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只加載配置。請檢視from_pretrained()方法來載入模型權重。
Data2VecVision 模型轉換器，頂部帶有一個影像分類頭（在補丁標記最終隱藏狀態平均值之上新增一個線性層），例如用於 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 (形狀為
(batch_size, num_channels, image_size, image_size)的torch.Tensor, 可選) — 對應輸入影像的張量。畫素值可以使用{image_processor_class}獲得。詳情請參閱{image_processor_class}.__call__（{processor_class}使用{image_processor_class}處理影像）。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.Tensor, 可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值選擇在[0, 1]之間：- 1表示頭未被掩碼，
- 0表示頭被掩碼。
- labels (形狀為
(batch_size,)的torch.LongTensor, 可選) — 用於計算影像分類/迴歸損失的標籤。索引應在[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），包含根據配置（Data2VecVisionConfig）和輸入而變化的各種元素。
-
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時返回) — 形狀為(batch_size, sequence_length, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入層的輸出，加上每個階段的輸出）。模型在每個階段輸出的隱藏狀態（也稱為特徵圖）。 -
attentions (
tuple(torch.FloatTensor), 可選, 在傳入output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, patch_size, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecVisionForImageClassification的forward方法，覆蓋了__call__特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoImageProcessor, Data2VecVisionForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/data2vec-vision-base")
>>> model = Data2VecVisionForImageClassification.from_pretrained("facebook/data2vec-vision-base")
>>> 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])
...Data2VecVisionForSemanticSegmentation
類 transformers.Data2VecVisionForSemanticSegmentation
< 源 >( config: Data2VecVisionConfig )
引數
- config (Data2VecVisionConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只加載配置。請檢視from_pretrained()方法來載入模型權重。
Data2Vec 視覺模型，頂部帶有語義分割頭，例如用於 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 (形狀為
(batch_size, num_channels, image_size, image_size)的torch.Tensor, 可選) — 對應輸入影像的張量。畫素值可以使用{image_processor_class}獲得。詳情請參閱{image_processor_class}.__call__（{processor_class}使用{image_processor_class}處理影像）。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的torch.Tensor, 可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值選擇在[0, 1]之間：- 1表示頭未被掩碼，
- 0表示頭被掩碼。
- labels (形狀為
(batch_size, height, width)的torch.LongTensor, 可選) — 用於計算損失的真實語義分割圖。索引應在[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），包含根據配置（Data2VecVisionConfig）和輸入而變化的各種元素。
-
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時返回) — 形狀為(batch_size, patch_size, hidden_size)的torch.FloatTensor元組（如果模型有嵌入層，則一個用於嵌入層的輸出，加上每個層的輸出）。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 在傳入output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, patch_size, sequence_length)的torch.FloatTensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
Data2VecVisionForSemanticSegmentation的forward方法，覆蓋了__call__特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoImageProcessor, Data2VecVisionForSemanticSegmentation
>>> 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("facebook/data2vec-vision-base")
>>> model = Data2VecVisionForSemanticSegmentation.from_pretrained("facebook/data2vec-vision-base")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> # logits are of shape (batch_size, num_labels, height, width)
>>> logits = outputs.logitsTFData2VecVisionModel
類 transformers.TFData2VecVisionModel
< 源 >( config: Data2VecVisionConfig add_pooling_layer: bool = False *inputs **kwargs )
引數
- config (Data2VecVisionConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只加載配置。請檢視from_pretrained()方法來載入模型權重。
純Data2VecVision模型轉換器，輸出原始隱藏狀態，頂部沒有任何特定頭部。該模型繼承自TFPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事宜。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，Keras 方法在將輸入傳遞給模型和層時更偏愛這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，你可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 一個只包含
pixel_values的獨立張量：model(pixel_values) - 一個長度可變的列表，其中包含一個或多個輸入張量，按文件字串中給定的順序排列：
model([pixel_values, attention_mask])或model([pixel_values, attention_mask, token_type_ids]) - 一個字典，包含一個或多個與文件字串中給定的輸入名稱相關聯的輸入張量：
model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像將輸入傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( pixel_values: TFModelInputType | None = None bool_masked_pos: tf.Tensor | None = None head_mask: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) → transformers.models.data2vec.modeling_tf_data2vec_vision.TFData2VecVisionModelOutputWithPooling 或 tuple(tf.Tensor)
引數
- pixel_values (
np.ndarray,tf.Tensor,list[tf.Tensor]dict[str, tf.Tensor]或dict[str, np.ndarray]，且每個示例的形狀必須為(batch_size, num_channels, height, width)) — 畫素值。畫素值可以使用AutoImageProcessor獲得。詳情請參閱BeitImageProcessor.call()。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor, 可選) — 用於使自注意力模組的選定頭無效的掩碼。掩碼值選擇在[0, 1]之間：- 1表示頭未被掩碼，
- 0表示頭被掩碼。
- output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回ModelOutput而不是普通的元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為`False`) — 是否在訓練模式下使用模型（某些模組，如dropout模組在訓練和評估之間有不同的行為）。 - bool_masked_pos (形狀為
(batch_size, num_patches)的tf.Tensor, 可選) — 布林掩碼位置。指示哪些補丁被掩碼（1），哪些未被掩碼（0）。
返回
transformers.models.data2vec.modeling_tf_data2vec_vision.TFData2VecVisionModelOutputWithPooling 或 tuple(tf.Tensor)
一個transformers.models.data2vec.modeling_tf_data2vec_vision.TFData2VecVisionModelOutputWithPooling或tf.Tensor的元組（如果傳入return_dict=False或config.return_dict=False），包含根據配置（Data2VecVisionConfig）和輸入而變化的各種元素。
-
last_hidden_state (
tf.Tensorof shape(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。 -
pooler_output (形狀為
(batch_size, hidden_size)的tf.Tensor) — 如果config.use_mean_pooling設定為True，則為補丁標記的最後一層隱藏狀態（不包括[CLS]標記）的平均值。如果設定為False，則返回[CLS]標記的最終隱藏狀態。 -
hidden_states (
tuple(tf.Tensor), 可選, 在傳入output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的tf.Tensor元組（一個用於嵌入層的輸出，加上每個層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 在傳入output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFData2VecVisionModel的forward方法，覆蓋了__call__特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoImageProcessor, TFData2VecVisionModel
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/data2vec-vision-base")
>>> model = TFData2VecVisionModel.from_pretrained("facebook/data2vec-vision-base")
>>> inputs = image_processor(image, return_tensors="tf")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 197, 768]TFData2VecVisionForImageClassification
類 transformers.TFData2VecVisionForImageClassification
< 源 >( config: Data2VecVisionConfig *inputs **kwargs )
引數
- config (Data2VecVisionConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型關聯的權重，只加載配置。請檢視from_pretrained()方法來載入模型權重。
Data2VecVision 模型轉換器，頂部帶有一個影像分類頭（在補丁標記最終隱藏狀態平均值之上新增一個線性層），例如用於 ImageNet。
此模型繼承自TFPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事宜。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，Keras 方法在將輸入傳遞給模型和層時更偏愛這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，你可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 一個只包含
pixel_values的獨立張量：model(pixel_values) - 一個長度可變的列表，其中包含一個或多個輸入張量，按文件字串中給定的順序排列：
model([pixel_values, attention_mask])或model([pixel_values, attention_mask, token_type_ids]) - 一個字典，包含一個或多個與文件字串中給定的輸入名稱相關聯的輸入張量：
model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像將輸入傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< 源 >( pixel_values: TFModelInputType | None = None head_mask: np.ndarray | tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
引數
- pixel_values (
np.ndarray,tf.Tensor,list[tf.Tensor]dict[str, tf.Tensor]或dict[str, np.ndarray]，且每個示例必須具有(batch_size, num_channels, height, width)的形狀) — 畫素值。畫素值可以使用 AutoImageProcessor 獲取。有關詳細資訊，請參閱 BeitImageProcessor.call()。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未被掩碼，
- 0 表示頭部被掩碼。
- output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為 `False`) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間的行為不同）。 - labels (形狀為
(batch_size,)的tf.Tensor或np.ndarray，可選) — 用於計算影像分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]之間。如果config.num_labels == 1，則計算迴歸損失（均方誤差損失）；如果config.num_labels > 1，則計算分類損失（交叉熵損失）。
返回
transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFSequenceClassifierOutput 或一個 tf.Tensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），根據配置 (Data2VecVisionConfig) 和輸入包含各種元素。
-
loss (
tf.Tensor，形狀為(batch_size, )，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (
tf.Tensor，形狀為(batch_size, config.num_labels)) — 分類（或迴歸，如果 config.num_labels==1）分數（SoftMax 之前）。 -
hidden_states (
tuple(tf.Tensor), 可選, 在傳入output_hidden_states=True或config.output_hidden_states=True時返回) — 形狀為(batch_size, sequence_length, hidden_size)的tf.Tensor元組（一個用於嵌入層的輸出，加上每個層的輸出）。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 在傳入output_attentions=True或config.output_attentions=True時返回) — 形狀為(batch_size, num_heads, sequence_length, sequence_length)的tf.Tensor元組（每個層一個）。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFData2VecVisionForImageClassification 的前向傳播方法，覆蓋了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoImageProcessor, TFData2VecVisionForImageClassification
>>> import tensorflow as tf
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image"))
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/data2vec-vision-base-ft1k")
>>> model = TFData2VecVisionForImageClassification.from_pretrained("facebook/data2vec-vision-base-ft1k")
>>> inputs = image_processor(image, return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = int(tf.math.argmax(logits, axis=-1))
>>> print(model.config.id2label[predicted_label])
remote control, remoteTFData2VecVisionForSemanticSegmentation
class transformers.TFData2VecVisionForSemanticSegmentation
< source >( config: Data2VecVisionConfig *inputs **kwargs )
引數
- config (Data2VecVisionConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化並不會載入與模型相關的權重，只加載配置。請檢視 from_pretrained() 方法以載入模型權重。
Data2VecVision 模型轉換器，其頂部帶有一個語義分割頭，例如用於 ADE20k、CityScapes。
此模型繼承自TFPreTrainedModel。請檢視超類文件，瞭解庫為所有模型實現的通用方法（如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
此模型也是 keras.Model 的子類。將其作為常規 TF 2.0 Keras 模型使用，並參考 TF 2.0 文件瞭解所有與通用用法和行為相關的事宜。
transformers 中的 TensorFlow 模型和層接受兩種輸入格式
- 所有輸入作為關鍵字引數（如 PyTorch 模型），或
- 所有輸入作為第一個位置引數中的列表、元組或字典。
支援第二種格式的原因是，Keras 方法在將輸入傳遞給模型和層時更偏愛這種格式。由於這種支援，當使用 model.fit() 等方法時，一切都應該“正常工作”——只需以 model.fit() 支援的任何格式傳遞輸入和標籤即可！但是，如果你想在 Keras 方法（如 fit() 和 predict()）之外使用第二種格式，例如在使用 Keras Functional API 建立自己的層或模型時，你可以使用三種可能性來將所有輸入張量收集到第一個位置引數中
- 一個只包含
pixel_values的獨立張量：model(pixel_values) - 一個長度可變的列表，其中包含一個或多個輸入張量，按文件字串中給定的順序排列：
model([pixel_values, attention_mask])或model([pixel_values, attention_mask, token_type_ids]) - 一個字典，包含一個或多個與文件字串中給定的輸入名稱相關聯的輸入張量：
model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})
請注意，當使用子類化建立模型和層時，你無需擔心這些，因為你可以像將輸入傳遞給任何其他 Python 函式一樣傳遞輸入！
呼叫
< source >( pixel_values: tf.Tensor | None = None head_mask: tf.Tensor | None = None labels: tf.Tensor | None = None output_attentions: Optional[bool] = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None ) → transformers.modeling_tf_outputs.TFSemanticSegmenterOutput 或 tuple(tf.Tensor)
引數
- pixel_values (
np.ndarray,tf.Tensor,list[tf.Tensor]dict[str, tf.Tensor]或dict[str, np.ndarray]，且每個示例必須具有(batch_size, num_channels, height, width)的形狀) — 畫素值。畫素值可以使用 AutoImageProcessor 獲取。有關詳細資訊，請參閱 BeitImageProcessor.call()。 - head_mask (形狀為
(num_heads,)或(num_layers, num_heads)的np.ndarray或tf.Tensor，可選) — 用於使自注意力模組的選定頭部無效的掩碼。掩碼值選擇在[0, 1]之間：- 1 表示頭部未被掩碼，
- 0 表示頭部被掩碼。
- output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量中的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量中的hidden_states。 - return_dict (
bool, 可選) — 是否返回 ModelOutput 而不是普通元組。此引數可在即時模式下使用，在圖模式下該值將始終設定為 True。 - training (
bool, 可選, 預設為 `False`) — 是否在訓練模式下使用模型（某些模組如 dropout 模組在訓練和評估之間的行為不同）。 - labels (形狀為
(batch_size, height, width)的tf.Tensor，可選) — 用於計算損失的地面真實語義分割圖。索引應在[0, ..., config.num_labels - 1]之間。如果config.num_labels > 1，則計算分類損失（交叉熵）。
返回
transformers.modeling_tf_outputs.TFSemanticSegmenterOutput 或 tuple(tf.Tensor)
一個 transformers.modeling_tf_outputs.TFSemanticSegmenterOutput 或一個 tf.Tensor 元組（如果傳入 return_dict=False 或當 config.return_dict=False 時），根據配置 (Data2VecVisionConfig) 和輸入包含各種元素。
-
loss (形狀為
(1,)的tf.Tensor，可選，當提供labels時返回) — 分類（如果 config.num_labels==1，則為迴歸）損失。 -
logits (形狀為
(batch_size, config.num_labels, logits_height, logits_width)的tf.Tensor) — 每個畫素的分類分數。返回的 logits 大小不一定與作為輸入傳入的
pixel_values相同。這是為了避免兩次插值，並在使用者需要將 logits 調整到原始影像大小時，作為後處理步驟導致質量損失。您應始終檢查 logits 的形狀，並根據需要進行調整。 -
hidden_states (
tuple(tf.Tensor), 可選, 當傳入output_hidden_states=True或當config.output_hidden_states=True時返回) —tf.Tensor的元組（如果模型有嵌入層，則一個用於嵌入輸出，加上每個層的一個輸出），形狀為(batch_size, patch_size, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(tf.Tensor), 可選, 當傳入output_attentions=True或當config.output_attentions=True時返回) —tf.Tensor的元組（每個層一個），形狀為(batch_size, num_heads, patch_size, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
TFData2VecVisionForSemanticSegmentation 的前向傳播方法，覆蓋了 __call__ 特殊方法。
雖然前向傳播的定義需要在此函式中完成，但之後應呼叫 Module 例項，而不是此函式，因為前者負責執行預處理和後處理步驟，而後者則默默忽略它們。
示例
>>> from transformers import AutoImageProcessor, TFData2VecVisionForSemanticSegmentation
>>> 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("facebook/data2vec-vision-base")
>>> model = TFData2VecVisionForSemanticSegmentation.from_pretrained("facebook/data2vec-vision-base")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> # logits are of shape (batch_size, num_labels, height, width)
>>> logits = outputs.logits