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