Data2Vec
概述
数据2Vec模型由Alexei Baevski,Wei-Ning Hsu,Qiantong Xu,Arun Babu,Jiatao Gu和Michael Auli在《data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language》中提出,该论文可在此处查阅:数据2vec:语音、视觉和自然语言中的自监督学习通用框架。数据2Vec提出了一个统一的框架,用于不同数据模态(文本、音频和图像)的自监督学习。重要的是,预训练的目标是通过输入的上下文隐含表示来预测,而不是模式特定的、上下文无关的目标。
该论文的摘要如下:
虽然自监督学习的一般思想在不同模态中是相同的,但由于它们是针对单个模态开发的,因此实际的算法和目标差异很大。为了使我们更接近通用自监督学习,我们提出了data2vec,这是一个使用相同学习方法的框架,无论是语音、自然语言处理还是计算机视觉。核心思想是基于数据自蒸馏设置中输入的遮蔽视图,使用标准的Transformer架构预测完整输入数据的隐含表示。与预测模态特定的目标(例如词语、视觉标记或人声单元)不同,这些目标在本质上具有局部性,data2vec预测包含整个输入信息的上下文隐含表示。在语音识别、图像分类和自然语言理解的主要基准测试中的实验证明了新的最优状态或与主导方法具有竞争力的性能。模型和代码可在以下网址找到: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相同,包括特征提取。
资源
官方Hugging Face及社区(以🌎表示)资源列表,帮助您开始使用Data2Vec。
- 支持Data2VecVisionForImageClassification的示例脚本和笔记本。
- 要在自定义数据集上微调TFData2VecVisionForImageClassification,请参阅此笔记本。
Data2VecText文档资源
Data2VecAudio文档资源
Data2VecVision文档资源
如果您想提交资源在此列出,请随时打开一个Pull Request,我们将进行审查!资源应理想地展示新事物,而不是重复现有资源。
Data2VecTextConfig
class transformers.Data2VecTextConfig
< source >( 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) — 隐藏层的丢弃概率,用于嵌入、编码器及池化器中的所有全连接层。 - attention_probs_dropout_prob (
float
, 可选, 默认为0.1) — 注意力概率的丢弃比率。 - 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"
的更多信息,请参阅 具有相对位置表示的自注意力 (Shaw et al.)。有关"relative_key_query"
的更多信息,请参阅 改进 Transformer 模型以获得更好的相对位置嵌入 (Huang et al.) 中的第4种方法。 - is_decoder (
bool
, 可选),默认为False
— 指定模型是否用作解码器。如果为False
,则将模型用作编码器。 - use_cache (
bool
, 可选),默认为True
— 指定模型是否返回最后的键/值注意力(并非所有模型都需要)。仅在config.is_decoder=True
时相关。 - classifier_dropout (
float
, 可选) — 分类头的dropout比率。
这是用于存储 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.config
Data2VecAudioConfig
类 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
, 可选, 默认为 32) — Data2VecAudio 模型的词汇量。定义了通过调用 Data2VecAudioModel 或TFData2VecAudioModel
时传入的inputs_ids
可以表示的不同标记的数量。模型的词汇量。定义了传递给 Data2VecAudioModel 前向方法的 inputs_ids 可以表示的不同标记。 - hidden_size (
int
, 可选, 默认为 768) — 编码层和池化层的维度。 - num_hidden_layers (
int
, 可选, 默认为 12) — Transformer 编码器中的隐藏层数量。 - num_attention_heads (
int
, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数。 - activation_dropout (
float
, 可选,默认为0.1) — 全连接层内激活函数的dropout比例。 - attention_dropout (
float
, 可选,默认为0.1) — 注意力概率的dropout比例。 - final_dropout (
float
, 可选,默认为0.1) — Data2VecAudioForCTC的最终投影层的dropout概率。 - layerdrop (
float
, 可选,默认为0.1) — LayerDrop概率。更详细的内容请参见[L_layerDrop论文](https://arxiv.org/abs/1909.11556)。 - initializer_range (
float
, 可选, 默认为 0.02) — 所有权重矩阵初始化时使用的截断正态初始化器的标准差。 - layer_norm_eps (
float
, 可选, 默认为 1e-12) — 层归一化层使用的 epsilon 值。 - feat_proj_dropout (
float
, 可选, 默认为 0.0) — 特征编码器输出的 dropout 概率。 - feat_extract_activation (
str
,可选,默认为“gelu”)— 特征提取器的1D卷积层中的非线性激活函数(函数或字符串)。如果为字符串,支持“gelu”、“relu”、“selu”和“gelu_new”。 - conv_dim (
Tuple[int]
或List[int]
,可选,默认为(512, 512, 512, 512, 512, 512, 512)
)— 定义特征编码器中每个1D卷积层的输入和输出通道数的整数元组。conv_dim的长度定义1D卷积层的数量。 - conv_stride (
Tuple[int]
或List[int]
,可选,默认为(5, 2, 2, 2, 2, 2, 2)
)— 定义特征编码器中每个1D卷积层步长的整数元组。conv_stride的长度定义卷积层数量,并必须与conv_dim的长度匹配。 - conv_kernel (
整数元组
或整数列表
,可选,默认为(10, 3, 3, 3, 3, 3, 3)
) — 定义特征编码器中每个一维卷积层核大小的整数元组。`conv_kernel` 的长度定义了卷积层的数量并必须与 `conv_dim` 的长度匹配。 - conv_bias (
布尔值
,可选,默认为False
) — 是否一维卷积层包含偏差。 - num_conv_pos_embeddings (
整数
,可选,默认为 128) — 卷积位置编码的数量。定义一维卷积位置编码层的核大小。 - num_conv_pos_embedding_groups (
int
, 可选,默认为16) — 一维卷积位置嵌入层的组数。 - mask_time_prob (
float
, 可选,默认为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
, 可选,默认为10) — 沿时间轴向量跨度的长度。 - mask_time_min_masks (
int
, 可选, 默认为2), — 沿时间轴生成的mask_feature_length
长度的最小mask数量,每个时间步长,与mask_feature_prob
无关。只有当 “mask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks” 时才相关。 - mask_feature_prob (
float
, 可选, 默认为0.0) — 所有特征向量中会被掩码的百分比(介于0和1之间)。掩码过程会在特征轴上生成 “mask_feature_prob*len(feature_axis)/mask_time_length” 个独立的mask。如果根据每个特征向量被选为被掩码向量范围的起始的概率推理,mask_feature_prob 应该是 `prob_vector_start*mask_feature_length`。请注意,重叠可能降低实际掩码向量的百分比。只有在apply_spec_augment
为 True 时才相关。 - mask_feature_length (
int
, 可选, 默认为10) — 特征轴上向量范围的长度的长度。 - mask_feature_min_masks (
int
, 可选, 默认为 0),—— 在特征轴上生成长度为mask_feature_length
的掩码的最小数量,每次时间步,无论mask_feature_prob
如何。只有在 “mask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks” 条件下才相关。 - ctc_loss_reduction (
str
, 可选, 默认为"sum"
) —— 指定对torch.nn.CTCLoss
输出应用哪种归一化方法。只有在训练 Data2VecAudioForCTC 实例时相关。 - ctc_zero_infinity (
bool
, 可选, 默认为False
) —— 是否将无限的损失及其相关的torch.nn.CTCLoss
梯度置零。无限损失主要发生在输入太短无法与目标对齐时。只有在训练 Data2VecAudioForCTC 实例时相关。 - use_weighted_layer_sum (
bool
, 可选,默认为False
) — 是否使用具有学习权重的加权层输出平均值。仅在使用 Data2VecAudioForSequenceClassification 实例时相关。 - classifier_proj_size (
int
, 可选,默认为 256) — 分类前token mean-pooling的投影维度。 - tdnn_dim (
Tuple[int]
或List[int]
, 可选,默认为(512, 512, 512, 512, 1500)
) — 定义XVector模型TDNN模块中每个1D卷积层输出通道数的整数元组。tdnn_dim的长度定义TDNN层的数量。 - tdnn_kernel (
int类型元组
或List[int]
,可选项,默认值(5, 3, 3, 1, 1)
) — 定义XVector模型中TDNN模块中每个1D卷积层核大小的整数元组。tdnn_kernel的长度必须与tdnn_dilation的长度匹配。 - tdnn_dilation (
List[int]
,可选项,默认值(1, 2, 3, 1, 1)
) — 定义XVector模型中TDNN模块中每个1D卷积层的膨胀因子。tdnn_dilation的长度必须与tdnn_dim的长度匹配。 - xvector_output_dim (
int
,可选项,默认值为512) — XVector嵌入向量的维度。 - add_adapter (布尔值,可选,默认
False
) — 是否在 Data2VecAudio 编码器之上堆叠卷积网络。对于预热启动 Data2VecAudio 以用于语音编码器-解码器模型非常有用。 - adapter_kernel_size (整数,可选,默认为 3) — 适配器网络中卷积层的核大小。仅在
add_adapter is True
时相关。 - adapter_stride (整数,可选,默认为 2) — 适配器网络中卷积层的步长。仅在
add_adapter is True
时相关。 - num_adapter_layers (
int
, 可选, 默认为 3) — 适配器网络中应使用的卷积层数量。只有当add_adapter
为 True 时才有效。 - output_hidden_size (
int
, 可选) — 编码器输出层的维度。如未定义,则默认为 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.config
Data2VecVisionConfig
类 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
, 可选, 默认为 12) — Transformer 编码器中每个注意力层的注意力头数量。 - intermediate_size (
int
, 可选, 默认为 3072) — Transformer 编码器中“中间”(即前馈)层的大小。 - hidden_act (
str
或function
, 可选, 默认为"gelu"
) — 将子编码器和池器中的非线性激活函数(函数或字符串)。如果是字符串,支持"gelu"
、"relu"
、"selu"
和"gelu_new"
。 - hidden_dropout_prob (
float
, 可选, 默认为 0.0) —— 全连接层(Embeddings层、Encoder层、Pooler层)的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
) — 是否使用掩码标记进行掩码图像建模。 - use_absolute_position_embeddings (
bool
, 可选, 默认值为False
) — 是否使用BERT风格的绝对位置嵌入。 - use_relative_position_bias (
bool
, 可选, 默认值为False
) — 是否在自注意力层中使用T5风格的相对位置嵌入。 - — 是否在 Transformer 的所有自注意力层使用相同的相对位置嵌入,默认值为 False。
familial_positional_bias - — 自注意力层中使用的缩放值。基础版本使用 0.1,大型版本使用 1e-5。设置为 0 将禁用层缩放。layer_scale_init_value
- — 在残差层主路径中应用的每个样本的随机深度比率。drop_path_rate
- use_mean_pooling (
bool
, 可选, 默认为True
) —— 在应用分类头之前,是否用平均值池化而不是使用 CLS 标记的最后隐藏状态来处理补丁的最后隐藏状态。 - out_indices (
整型列表
, 可选, 默认为[3, 5, 7, 11]
) —— 用于语义分割的特征图索引。 - pool_scales (
整型元组
, 可选, 默认为[1, 2, 3, 6]
) —— 在最后一个特征图上应用池化金字塔模块时使用的池化尺度。 - use_auxiliary_head (
bool
, 可选, 默认为True
) —— 是否在训练期间使用辅助头。 -
float,可选,默认为0.4) -
int,可选,默认为256) -
int,可选,默认为1) -
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.config
Data2VecAudioModel
类 transformers.Data2VecAudioModel
< 源 >( 配置: Data2VecAudioConfig )
参数
- config (Data2VecAudioConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。
裸露的 Data2VecAudio 模型转换器,输出原始的隐藏态,没有顶部的特定头。Data2VecAudio 由 Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 在 data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language 一文中提出。
此模型继承自 PreTrainedModel。请查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与前者的用法和表现相关的事项。
正向传播
< source >( input_values: 可选 attention_mask: 可选 = None mask_time_indices: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor
of shape(batch_size, sequence_length)
) — 输入原始语音波形浮点数值。这些值可以通过将.flac或.wav音频文件加载到类型为List[float]或numpy.ndarray的数组中,例如使用soundfile库(pip install soundfile)来获取。要将数组准备好以供input_values使用,应使用AutoProcessor进行填充并转换为类型为torch.FloatTensor的张量。有关详情,请参阅Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor
形状为(batch_size, sequence_length)
,可选) — 用以避免在填充token索引上执行卷积和注意力的掩码。掩码值的选定在[0, 1]
之间:- 1 用于未被掩码的 token,
- 0 用于被掩码的 token。
如果相应的处理器有
config.return_attention_mask == True
,则需要传递attention_mask
,这对于所有预训练的 Data2Vec 音频模型都是这样的情况。请注意,即使在传递attention_mask
的情况下,零填充的输入与未填充的输入相比,输出会有细微的差异,因为位置编码中有多于一个的卷积层。更详细的信息,请参见 此处。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。更多详细信息请参见返回张量下的attentions
。 - output_hidden_states (
bool
,可选) — 是否返回所有层的隐藏状态。更多详细信息请参见返回张量下的hidden_states
。 - return_dict (
bool
, optional) — 是否返回一个 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
of shape(batch_size, sequence_length, hidden_size)
) — 模型最后层输出的隐藏状态序列。 -
extract_features (
torch.FloatTensor
of shape(batch_size, sequence_length, conv_dim[-1])
) — 模型最后卷积层的提取特征向量序列。 -
hidden_states (
tuple(torch.FloatTensor)
, optional, returned whenoutput_hidden_states=True
is passed or whenconfig.output_hidden_states=True
) — 一个包含torch.FloatTensor
的元组(一个用于嵌入输出,一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型的每个层的隐藏状态输出以及初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 一个包含torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
虽然需要在函数内部定义前向传递的配方,但应该在之后调用 Module
实例而不是此方法,因为前者负责运行预和后处理步骤,而后者默默地忽略它们。
示例
>>> from transformers import AutoProcessor, Data2VecAudioModel
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("facebook/data2vec-audio-base-960h")
>>> model = Data2VecAudioModel.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():
... outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 292, 768]
Data2VecAudioForAudioFrameClassification
类 transformers.Data2VecAudioForAudioFrameClassification
< 源 >( 配置 )
参数
- 配置 (Data2VecAudioConfig) — 包含模型所有参数的模型配置类。用配置文件初始化时不加载与模型关联的权重,只加载配置。检查 from_pretrained() 方法来加载模型权重。
Data2VecAudio 模型,顶部带有帧分类头,用于像说话人分离这样的任务。
Data2VecAudio 由 Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 提出,发表在 data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language。
此模型继承自 PreTrainedModel。请查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与前者的用法和表现相关的事项。
正向传播
< source >( input_values: Optional attention_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.TokenClassifierOutput or tuple(torch.FloatTensor)
参数
- input_values(《input_values》:
torch.FloatTensor
的形状为(batch_size, sequence_length)
) — 输入原始语音波形的浮点值。值可以通过将 .flac 或 .wav 音频文件加载到一个_type_为 List[float] 或 numpy.ndarray 的数组中获取,例如,通过 soundfile 库(pip install soundfile)。要准备好数组为 input_values,应使用 AutoProcessor 对其进行填充并将其转换为类型为 torch.FloatTensor 的张量。有关详细信息,请参阅 Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor
of shape(batch_size, sequence_length)
, 可选) — 避免在对填充标记索引执行卷积和注意力操作时的掩码。掩码值在[0, 1]
中选择:- 1 代表未被 屏蔽 的标记,
- 0 代表被 屏蔽 的标记。
attention_mask
应当传递,如果对应的处理器具有config.return_attention_mask == True
,所有预训练的 Data2Vec Audio 模型都是这种情况。请注意,即使有attention_mask
,零填充的输入与非零填充的输入相比,输出仍会有细微差异,因为位置编码中有多于一个的卷积层。有关更详细的解释,请参见 这里。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。关于更多详细信息,请参见返回张量下的attentions
。// HTML_TAG_END --> - // HTML_TAG_START -->output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。关于更多详细信息,请参见返回张量下的hidden_states
。// HTML_TAG_END --> - 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.TokenClassifierOutput或tuple(torch.FloatTensor)
A transformers.modeling_outputs.TokenClassifierOutput 或一个包含多种元素的 torch.FloatTensor
的元组(如果传递了return_dict=False
或当config.return_dict=False
时),这些元素取决于配置(Data2VecAudioConfig)和输入。
-
loss (
torch.FloatTensor
,形状为(1,)
,可选,仅在提供labels
时返回)— 分类损失。 -
logits (
torch.FloatTensor
,形状为(batch_size, sequence_length, config.num_labels)
)— 分类分数(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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 一个包含torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
Data2VecAudioForAudioFrameClassification 前向方法,重写了 __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", trust_remote_code=True)
>>> 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()
Data2VecAudioForCTC
类 transformers.Data2VecAudioForCTC
< source >( 配置 )
参数
- 配置 (Data2VecAudioConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重,只有配置。请参阅从预训练中加载模型权重的方法。
Data2VecAudio 模型,顶部带有用于连接主义时序分类 (CTC) 的 语言建模
头。Data2VecAudio 由 Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 提出,并在data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language 中提出。
此模型继承自 PreTrainedModel。请查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与前者的用法和表现相关的事项。
正向传播
< source >( input_values: Optional attention_mask: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None labels: Optional = None ) → transformers.modeling_outputs.CausalLMOutput or tuple(torch.FloatTensor)
参数
- 输入值 (
torch.FloatTensor
,形状为(batch_size, sequence_length)
) — 输入原始语音波形的浮点值。这些值可以通过将.flac或.wav音频文件加载到类型为List[float]或numpy.ndarray的数组中获得,例如使用soundfile库(pip install soundfile)。为了将数组准备好为input_values,应使用AutoProcessor进行填充和转换为类型为torch.FloatTensor的张量。有关详细信息,请参阅Wav2Vec2Processor.call()。 - attention_mask(《torch.LongTensor》形式,形状为
(batch_size, sequence_length)
,可选)— 用于避免在填充标记索引上执行卷积和注意力的掩码。掩码值选择在[0, 1]
:- 1表示未掩码的标记,
- 0表示掩码的标记。
attention_mask
应该在相应的处理器有config.return_attention_mask == True
时传递,这是所有预训练Data2Vec Audio模型的默认情况。请注意,即使有attention_mask
,零填充输入的输出与非填充输入相比会略有不同,因为位置编码中有多于一个卷积层。针对更详细的解释,请参阅此处。 - output_attentions(《bool型’,可选)— 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的
attentions
。
返回值
transformers.modeling_outputs.CausalLMOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutput 或一个由 torch.FloatTensor
组成的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),包含根据配置(Data2VecAudioConfig)和输入的各种元素。
-
loss (
torch.FloatTensor
of shape(1,)
, 可选,在提供了labels
时返回) — 语言建模损耗(用于下一个标记预测)。 -
logits (
torch.FloatTensor
of shape(batch_size, sequence_length, config.vocab_size)
) — 语言建模头部的预测得分(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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.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", trust_remote_code=True)
>>> 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]
'MISTER QUILTER IS THE APOSTLE OF THE MIDDLE CLASSES AND WE ARE GLAD TO WELCOME HIS GOSPEL'
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
66.95
Data2VecAudioForSequenceClassification
类 transformers.Data2VecAudioForSequenceClassification
< source >( 配置 )
参数
- config (Data2VecAudioConfig) — 模型配置类,包含所有模型参数。使用配置文件初始化时不会加载模型相关的权重,仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
带序列分类头(累加输出之上的线性层)的数据2向量音频模型,适用于SUPERB关键词检测等任务。
Data2VecAudio 由 Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 提出,发表在 data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language。
此模型继承自 PreTrainedModel。请查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与前者的用法和表现相关的事项。
正向传播
< 来源 >( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = 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 的张量。参见 Wav2Vec2Processor.call() 以获取详细信息。 - attention_mask (
torch.LongTensor
of shape(batch_size, sequence_length)
, 可选) — 避免对填充标记索引执行卷积和注意力操作的掩码。掩码值选在[0, 1]
之间:- 1 代表 未掩码 的标记,
- 0 代表 掩码 的标记。
attention_mask
应当在对应的处理器有config.return_attention_mask == True
的情况下传递,这适用于所有预训练的 Data2Vec Audio 模型。请注意,即使在attention_mask
存在的情况下,零填充输入与未填充输入相比,输出可能会有细微的差异,因为位置编码中有多于一个卷积层。有关更详细的解释,请参阅 这里。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关返回张量中attentions
的更多详细信息,请参阅。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关返回张量中hidden_states
的更多详细信息,请参阅。 - 返回字典 (
bool
, 可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。 - 标签 (
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 (
torch.FloatTensor
形状为(1,)
, 可选, 当提供labels
时返回) — 分类(或回归,如果 config.num_labels==1)损失。 -
logits (
torch.FloatTensor
形状为(batch_size, config.num_labels)
) — 分类(或回归,如果 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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 一个包含torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
Data2VecAudioForSequenceClassification 的 forward 方法,覆盖了 __call__
特殊方法。
虽然需要在函数内部定义前向传递的配方,但应该在之后调用 Module
实例而不是此方法,因为前者负责运行预和后处理步骤,而后者默默地忽略它们。
示例
>>> from transformers import AutoFeatureExtractor, Data2VecAudioForSequenceClassification
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation", trust_remote_code=True)
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/data2vec-audio-base-960h")
>>> model = Data2VecAudioForSequenceClassification.from_pretrained("facebook/data2vec-audio-base-960h")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.argmax(logits, dim=-1).item()
>>> predicted_label = model.config.id2label[predicted_class_ids]
>>> # compute loss - target_label is e.g. "down"
>>> target_label = model.config.id2label[0]
>>> inputs["labels"] = torch.tensor([model.config.label2id[target_label]])
>>> loss = model(**inputs).loss
Data2VecAudioForXVector
类 transformers.Data2VecAudioForXVector
< 来源 >( 配置 )
参数
- 配置 (Data2VecAudioConfig) — 模型配置类,包含模型的全部参数。通过配置文件初始化不会加载模型关联的权重,只加载配置。查看 from_pretrained() 方法来加载模型权重。
Data2VecAudio模型,顶部集成了XVector特征提取头,适用于说话人验证等任务。
Data2VecAudio 由 Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 提出,发表在 data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language。
此模型继承自 PreTrainedModel。请查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存等)。
此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与前者的用法和表现相关的事项。
正向传播
< 来源 >( input_values: 可选 attention_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None labels: 可选 = None ) → transformers.modeling_outputs.XVectorOutput 或 tuple(torch.FloatTensor)
参数
- input_values (
torch.FloatTensor
of shape(batch_size, sequence_length)
) — 输入原始语音波形的浮点数值。数值可以通过将.flac或.wav音频文件加载到一个List[float]或numpy.ndarray类型的数组中来获取,例如通过soundfile库(《pip install soundfile》)来实现。要将数组准备为input_values,应使用AutoProcessor进行填充和转换为类型为torch.FloatTensor的张量。有关详细信息,请参阅Wav2Vec2Processor.call()。 - attention_mask (
torch.LongTensor
of shape(batch_size, sequence_length)
, optional) — 避免在填充token索引位置进行卷积和注意力操作的分页。Mask值选择在[0, 1]
:- 1代表没有被mask的token;
- 0代表被mask的token。
attention_mask
应该传递,如果对应的处理器有config.return_attention_mask == True
,这是所有预训练的Data2Vec Audio模型的情况。请注意,即使提供了attention_mask
,与未填充输入相比,零填充输入将产生略微不同的输出,因为在位置编码中有多于一个的卷积层。对于更详细的解释,请参阅这里。 - output_attentions (
bool
, optional) — 是否返回所有注意力层的注意力张量。更多信息请参阅返回的张量中的attentions
。
返回值
transformers.modeling_outputs.XVectorOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.XVectorOutput 或当 return_dict=False
被传递或当 config.return_dict=False
时,由 torch.FloatTensor
组成的元组(其元素取决于配置(Data2VecAudioConfig)和输入。
-
loss (
torch.FloatTensor
,形状为(1,)
,可选,仅在提供labels
时返回)— 分类损失。 -
logits (
torch.FloatTensor
形状(batch_size, config.xvector_output_dim)
) — AMSoftmax 之前的分类隐藏状态。 -
embeddings (
torch.FloatTensor
形状(batch_size, config.xvector_output_dim)
) — 用于基于向量相似度的检索的utterance 嵌入。 -
hidden_states (
tuple(torch.FloatTensor)
, optional, returned whenoutput_hidden_states=True
is passed or whenconfig.output_hidden_states=True
) — 一个包含torch.FloatTensor
的元组(一个用于嵌入输出,一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型的每个层的隐藏状态输出以及初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 一个包含torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
Data2VecAudioForXVector 的 forward 方法,重写了 __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", trust_remote_code=True)
>>> 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!")
Data2VecAudioForXVector
类 transformers.Data2VecTextModel
< source >( config add_pooling_layer = True )
参数
- config (Data2VecTextConfig) — 模型配置类,包含所有模型参数。使用配置文件初始化不会加载模型相关的权重,只会加载配置。请查看from_pretrained() 方法以加载模型权重。
用于文本变换器输出的裸露 Data2VecText 模型,不带有任何特定头部的原始隐藏状态。Data2VecText 由 Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 在data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language中提出。
该模型继承了PreTrainedModel。请查看超级类文档,了解库为所有模型实现的一般方法(如下载或保存、调整输入嵌入、剪枝头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与通用使用和行为相关的内容。
该模型可以行为编码器(仅使用自注意力)以及解码器,在这种情况下,在自注意力层之间添加了一个交叉注意力层,该结构遵循 Ashish Vaswani、Noam Shazeer、Niki Parmar、Jakob Uszkoreit、Llion Jones、Aidan N. Gomez、Lukasz Kaiser 和 Illia Polosukhin 在 Attention is all you need 中提出的架构。
要作为解码器使用,需要使用配置中的 is_decoder
参数将其初始化为 True
。要在 Seq2Seq 模型中使用该模型,需要将 is_decoder
参数和 add_cross_attention
都设置为 True
;向前传递时则需要期望一个 encoder_hidden_states
作为输入。
.. _Attention is all you need: https://arxiv.org/abs/1706.03762
正向传播
< source >( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None past_key_values: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
) — 输入序列单词在词汇表中的索引。可以通过使用 AutoTokenizer 来获取索引。关于详情,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)
的torch.FloatTensor
,可选) — 避免在填充标记索引上执行注意力的掩码。选择的掩码值在[0, 1]
:- 1 对应于 未被掩码 的标记,
- 0 对应于 被掩码 的标记。
- token_type_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 段标记索引,用于指示输入的第一部分和第二部分。选择的索引在[0, 1]
:- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 输入序列标记在每个位置嵌入中的索引。选择的范围在[0, config.max_position_embeddings - 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
。这在您想比模型的内部嵌入查找矩阵有更多控制权时非常有用。 - output_attentions (
bool
,可选) — 是否返回所有注意力的张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
,可选)— 是否返回所有层的隐藏状态。更多细节请参考返回张量中的hidden_states
。 - return_dict (
bool
,可选)— 是否返回 ModelOutput 而不是普通元组。 - 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。
- past_key_values (
长度为
— 包含注意块预计算的键和值隐藏状态。可用于加速解码。config.n_layers
的tuple(tuple(torch.FloatTensor))
,其中每个指针包含形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)
的 4 个张量)如果使用
past_key_values
,用户可以选择只输入decoder_input_ids
的最后(那些没有给此模型提供过去键值状态的)形状为(batch_size, 1)
的decoder_input_ids
,而不是输入所有形状为(batch_size, sequence_length)
的decoder_input_ids
。 - use_cache (
bool
,可选) — 如果设置为True
,则返回past_key_values
键值状态,并可用于加速解码(请参阅past_key_values
)。
返回值
transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.BaseModelOutputWithPoolingAndCrossAttentions 或一个 torch.FloatTensor
的元组(如果传递了 return_dict=False
或者当 config.return_dict=False
时),包含根据配置(Data2VecTextConfig)和输入而定制的各种元素。
-
last_hidden_state (
torch.FloatTensor
of shape(batch_size, sequence_length, hidden_size)
) — 模型最后层输出的隐藏状态序列。 -
pooler_output(形状为
(batch_size, hidden_size)
的torch.FloatTensor
)——序列(分类标记)中第一个标记(分类标记)经过辅助预训练任务所用的层进一步处理后最后的隐藏状态。例如,对于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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.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
时返回)——包含形状为(batch_size, num_heads, sequence_length, sequence_length)
的torch.FloatTensor
的元组(每个层一个)。解码器交叉注意力层的注意力权重,在注意力软最大化后使用,用于在交叉注意力头中进行加权平均。
-
past_key_values(
tuple(tuple(torch.FloatTensor))
,可选,当use_cache=True
传递或当config.use_cache=True
时返回)——长度为config.n_layers
的tuple(torch.FloatTensor)
的元组,每个元组有2个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)
的张量,如果config.is_encoder_decoder=True
,则还可以有2个额外的形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)
的张量。包含预先计算的隐藏状态(自注意力块中的键和值,以及可选的如果
config.is_encoder_decoder=True
,则跨注意力块中的状态),可以用来(请参阅past_key_values
输入)加速序列解码。
Data2VecTextModel 的 forward 方法覆盖了特殊的 __call__
方法。
虽然需要在函数内部定义前向传递的配方,但应该在之后调用 Module
实例而不是此方法,因为前者负责运行预和后处理步骤,而后者默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, Data2VecTextModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/data2vec-text-base")
>>> model = Data2VecTextModel.from_pretrained("facebook/data2vec-text-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
Data2VecTextForCausalLM
class transformers.Data2VecTextForCausalLM
< source >( 配置 )
参数
- config (Data2VecTextConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化时不加载与模型关联的权重,仅加载配置。检查from_pretrained()方法来加载模型权重。
Data2VecText 模型,顶部带有针对因果语言模型微调的 语言建模
头。Data2VecText 由Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu和Michael Auli在data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language中提出。
该模型继承了PreTrainedModel。请查看超级类文档,了解库为所有模型实现的一般方法(如下载或保存、调整输入嵌入、剪枝头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与通用使用和行为相关的内容。
正向传播
< source >( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None labels: 可选 = None past_key_values: 可选 = None use_cache: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
) — 输入序列词汇表中的输入序列标记索引。索引可以通过使用 AutoTokenizer 获取。有关详细信息,请参阅PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor
形状为(batch_size, sequence_length)
,可选) — 用来避免对padding 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.max_position_embeddings - 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
指数转换为相关向量时非常有用。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。请参阅返回张量下的attentions
获取更多细节。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多细节请查看返回的张量中的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是纯元组。 - encoder_hidden_states (
torch.FloatTensor
形状为(batch_size, sequence_length, hidden_size)
, 可选) — 映射到编码器最后一层的隐藏状态序列。如果该模型作为解码器配置,将用于交叉注意力。 - encoder_attention_mask (形状为
(batch_size, sequence_length)
的torch.FloatTensor
,可选)—— 避免在编码器输入中的填充标记索引上执行注意力操作的掩码。如果模型配置为解码器,则在此交叉注意力中使用此掩码。掩码值选择[0, 1]
:- 为 未屏蔽 的标记使用 1,
- 为 屏蔽 的标记使用 0。
- labels (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选)—— 用于计算左向右语言模型损失(下一个单词预测)的标签。索引应该是[-100, 0, ..., config.vocab_size]
(参见input_ids
的文档字符串)。设置为索引-100
的标记将被忽略(屏蔽),只对[0, ..., config.vocab_size]
中有标签的标记计算损失。—— HTML_TAG_END --> - past_key_values (长度为
config.n_layers
的tuple(tuple(torch.FloatTensor))
,每个元组包含 4 个形状为(batch_size, num_heads, sequence_length - 1, embed_size_per_head)
的张量)—— 包含注意力块预计算的键和值隐藏状态。可用于加速解码。如果使用past_key_values
,用户可以选择只输入最后decoder_input_ids
(那些没有给出此模型的过去键值状态)的形状为(batch_size, 1)
,而不是所有decoder_input_ids
(形状为(batch_size, sequence_length)
)—— HTML_TAG_END --> - use_cache (
bool
, 可选) — 如果设置为True
,将返回past_key_values
键值状态,并可用于加速解码(见past_key_values
)。
返回值
transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.CausalLMOutputWithCrossAttentions 或一个由 torch.FloatTensor
组成的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),各个元素取决于配置(Data2VecTextConfig)和输入。
-
loss (
torch.FloatTensor
of shape(1,)
, 可选,在提供了labels
时返回) — 语言建模损耗(用于下一个标记预测)。 -
logits (
torch.FloatTensor
of shape(batch_size, sequence_length, config.vocab_size)
) — 语言建模头部的预测得分(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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.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 (
tuple(tuple(torch.FloatTensor))
, 可选,当传递use_cache=True
或当config.use_cache=True
时返回) — 长度为config.n_layers
的torch.FloatTensor
元组的元组,每个元组包含如果在编码器-解码器设置中使用模型,则缓存的自我注意力和交叉注意力的键、值状态。只与config.is_decoder = True
相关。包含可用于加速顺序解码的预计算的隐藏状态(注意块中的键和值)。
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.logits
Data2VecTextForMaskedLM
class transformers.Data2VecTextForMaskedLM
< source >( 配置 )
参数
- config (Data2VecTextConfig) — 模型配置类,包括所有模型的参数。用配置文件初始化不会加载与模型相关的权重,只会加载配置。请参阅 from_pretrained() 方法以加载模型权重。
在顶部具有语言模型头的 data2vec 模型。Data2VecText 由 Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 提出,并在 data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language 文章中提出。
该模型继承了PreTrainedModel。请查看超级类文档,了解库为所有模型实现的一般方法(如下载或保存、调整输入嵌入、剪枝头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与通用使用和行为相关的内容。
正向传播
< source >( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None encoder_hidden_states: 可选 = None encoder_attention_mask: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs Маска LMOutput или tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
of shape(batch_size, sequence_length)
) — 输入序列标记在词汇表中的索引。索引可以通过 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.FloatTensor
的形状为(batch_size, sequence_length)
,可选) — 避免在填充标记的索引上执行注意力的掩码。掩码值在[0, 1]
范围内选择:- 1 表示 未被掩码 的标记,
- 0 表示 被掩码 的标记。
- token_type_ids (
torch.LongTensor
的形状为(batch_size, sequence_length)
,可选) — 表示输入的第一部分和第二部分的段标记索引。索引在[0, 1]
范围内选择:- 0 对应于 A 句 标记,
- 1 对应于 B 句 标记。
- position_ids (
torch.LongTensor
的形状为(batch_size, sequence_length)
,可选) — 每个输入序列标记在位置嵌入中的索引。选择范围在[0, config.max_position_embeddings - 1]
内。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关更详细说明,请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回一个 ModelOutput 而不是纯元组。 - labels (
torch.LongTensor
的形状为(batch_size, sequence_length)
, 可选) — 计算掩码语言模型损失的标签。索引应在[-100, 0, ..., config.vocab_size]
(参见input_ids
的文档字符串) 之間 (seeinput_ids
docstring) 设置为索引为-100
的标记将被忽略(掩码化),损失仅对具有标签的标记[0, ..., config.vocab_size]
计算损失。 - kwargs (
Dict[str, any]
,可选,默认为{}) — 用于隐藏已弃用的旧版参数。
返回值
transformers.modeling_outputs.MaskedLMOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.MaskedLMOutput 或一个由torch.FloatTensor
组成的元组(如果传递了return_dict=False
或当config.return_dict=False
),包含依赖于配置(《A Data2VecTextConfig》)和输入的各种元素。
-
loss (
torch.FloatTensor
of shape(1,)
,可选,当提供labels
时返回) — 抖露语言建模(MLM)损失。 -
logits (
torch.FloatTensor
of shape(batch_size, sequence_length, config.vocab_size)
) — 语言建模头部的预测得分(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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.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)
>>> 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)
Data2VecTextForSequenceClassification
类 transformers.Data2VecTextForSequenceClassification
< 来源 >( 配置 )
参数
- config (Data2VecTextConfig) — 模型配置类,包含所有模型参数。使用配置文件初始化不会加载与模型相关的权重,只有配置。请查看from_pretrained() 方法以加载模型权重。
Data2VecText 模型变换器,顶层具有序列分类/回归头(位于池化输出之上的线性层),例如用于 GLUE 任务。
Data2VecText 由Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 在data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language 中提出。
该模型继承了PreTrainedModel。请查看超级类文档,了解库为所有模型实现的一般方法(如下载或保存、调整输入嵌入、剪枝头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与通用使用和行为相关的内容。
正向传播
< source >( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.SequenceClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状为(batch_size, sequence_length)
) — 输入序列令牌在词汇表中的索引。索引可以通过使用 AutoTokenizer 获得查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 详细信息。
- attention_mask (形状为
(batch_size, sequence_length)
的torch.FloatTensor
,可选) — 避免在填充token索引上执行注意力操作的mask。选中的mask值在[0, 1]
范围内:- 1 代表未被mask的token,
- 0 代表被mask的token。
- token_type_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 指示输入的每一部分是第一段还是第二段的token类型索引。索引选在[0, 1]
范围内:- 0 代表 A句 token,
- 1 代表 B句 token。
- position_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 每个输入序列token在位置嵌入中的位置索引。选择的范围在[0, config.max_position_embeddings - 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
指数转换为相关向量时很有用。 - 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)
A transformers.modeling_outputs.SequenceClassifierOutput 或一个torch.FloatTensor
的元组(如果传递了return_dict=False
或者当config.return_dict=False
时),包含根据配置(Data2VecTextConfig)和输入的各种元素。
-
loss (
torch.FloatTensor
形状为(1,)
, 可选, 当提供labels
时返回) — 分类(或回归,如果 config.num_labels==1)损失。 -
logits (
torch.FloatTensor
形状为(batch_size, config.num_labels)
) — 分类(或回归,如果 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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 一个包含torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
Data2VecTextForSequenceClassification的forward方法重写了特殊方法__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()
>>> # 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
多标签分类的示例
>>> 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).loss
Data2VecTextForMultipleChoice
类 transformers.Data2VecTextForMultipleChoice
< 源代码 >( 配置 )
参数
- config (Data2VecTextConfig) — 模型配置类,包含所有模型参数。使用配置文件初始化不会加载模型相关的权重,仅加载配置。检查from_pretrained()方法来加载模型权重。
Data2VecText 模型,顶部带有多选题分类头(池化输出上方的线性层和softmax),例如用于 RocStories/SWAG 任务。
Data2VecText 由Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 在data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language 中提出。
该模型继承了PreTrainedModel。请查看超级类文档,了解库为所有模型实现的一般方法(如下载或保存、调整输入嵌入、剪枝头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与通用使用和行为相关的内容。
正向传播
< source >( input_ids: Optional = None token_type_ids: Optional = None attention_mask: Optional = None labels: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.getLongTensor
的形状为(batch_size, num_choices, sequence_length)
) — 词汇表中对输入序列标记的索引。可以通过使用 AutoTokenizer 来获得索引。请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。
- attention_mask (
torch.get.FloatTensor
的形状为(batch_size, num_choices, sequence_length)
, 可选) — 用于避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]
范围内被选中:- 1 代表未被 掩码 的标记,
- 0 代表被 掩码 的标记。
- token_type_ids (
torch.getLongTensor
的形状为(batch_size, num_choices, sequence_length)
, 可选) — 用于指示输入价段的段标记索引。索引在[0, 1]
范围内被选中:- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记。
- position_ids (
torch.LongTensor
,形状(batch_size, num_choices, sequence_length)
,可选)— 每个输入序列标记的位置嵌入中的索引。选择范围为[0, config.max_position_embeddings - 1]
。 - head_mask (
torch.FloatTensor
,形状(num_heads,) 或 (num_layers, num_heads)
,可选)— 将自注意力模块中的选定头禁用的掩码。掩码值选择范围为[0, 1]
:- 1 表示头没有被掩码,
- 0 表示头被掩码。
- inputs_embeds (
torch.FloatTensor
,形状(batch_size, num_choices, sequence_length, hidden_size)
,可选)— 可以选择直接传递嵌入表示,而不是传递input_ids
。这对于您想要比模型内部嵌入查找矩阵有更多控制权将input_ids
索引转换为相关向量时很有用。 - output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。详情请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。详情请参阅返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回ModelOutput而非普通元组。 - labels (
torch.LongTensor
的形状为(batch_size,)
,可选)—— 用于计算多选题分类损失的标签。索引应在[0, ..., num_choices-1]
范围内,其中num_choices
是输入张量的第二个维度的尺寸。(参见上面的input_ids
)
返回值
transformers.modeling_outputs.MultipleChoiceModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.MultipleChoiceModelOutput 或一个包含 torch.FloatTensor
的元组(如果 return_dict=False
传入或者当 config.return_dict=False
)包含根据配置(Data2VecTextConfig)和输入的各种元素。
-
loss (当提供
labels
时返回的torch.FloatTensor
的形状为 (1,),可选)—— 分类损失。 -
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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.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.logits
Data2VecTextForTokenClassification
类 transformers.Data2VecTextForTokenClassification
< source >( 配置 )
参数
- config (Data2VecTextConfig) — 模型配置类,包含模型的全部参数。使用配置文件初始化模型时,不会加载模型的相关权重,只有配置。查看from_pretrained() 方法来加载模型权重。
Data2VecText 模型带有顶端的标记分类头(一个在隐藏状态输出之上的线性层),例如用于命名实体识别(NER)任务。
Data2VecText 由Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 在data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language 中提出。
该模型继承了PreTrainedModel。请查看超级类文档,了解库为所有模型实现的一般方法(如下载或保存、调整输入嵌入、剪枝头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与通用使用和行为相关的内容。
正向传播
< source >( input_ids: 可选 = None attention_mask: 可选 = None token_type_ids: 可选 = None position_ids: 可选 = None head_mask: 可选 = None inputs_embeds: 可选 = None labels: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None return_dict: 可选 = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor
形状(batch_size, sequence_length)
) — 输入序列令牌在词汇表中的索引。索引可以通过 AutoTokenizer 获取。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)
的torch.FloatTensor
,可选) — 以避免在填充标记索引上执行关注。在[0, 1)
区间选择的掩码值:- 1 代表未被 屏蔽 的标记,
- 0 代表被 屏蔽 的标记。
- token_type_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 段标记索引,用于指示输入的第一和第二部分。在[0, 1]
区间选择的索引:- 0 对应于 句子 A 标记,
- 1 对应于 句子 B 标记。
- position_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 输入序列中每个标记在位置嵌入中的索引。在[0, config.max_position_embeddings - 1]
范围内选择。什么是位置 ID? - 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
索引转换为相关向量有更多控制时很有用,比模型内部的嵌入查找矩阵控制更多。 - output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 返回所有层的隐藏状态。更多细节参见返回张量下的hidden_states
。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通元组。 - labels (
torch.LongTensor
形状为(batch_size, sequence_length)
, 可选) — 计算标记分类损失的标签。索引应为[0, ..., config.num_labels - 1]
。
返回值
transformers.modeling_outputs.TokenClassifierOutput或tuple(torch.FloatTensor)
A transformers.modeling_outputs.TokenClassifierOutput 或一个元组,由 torch.FloatTensor
组成(如果通过 return_dict=False
或当 config.return_dict=False
),包含根据配置(Data2VecTextConfig)和输入依赖的各种元素。
-
loss (
torch.FloatTensor
,形状为(1,)
,可选,仅在提供labels
时返回)— 分类损失。 -
logits (
torch.FloatTensor
,形状为(batch_size, sequence_length, config.num_labels)
)— 分类分数(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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 一个包含torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
Data2VecTextForTokenClassification 的 forward 方法,覆盖了 __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]]
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
Data2VecTextForQuestionAnswering
类 transformers.Data2VecTextForQuestionAnswering
< 源代码 >( 配置 )
参数
- config (Data2VecTextConfig) — 包含所有模型参数的模型配置类。使用配置文件初始化不会加载模型关联的权重,只有配置。查看 from_pretrained() 方法来加载模型权重。
带有跨度分类头的Data2VecText模型,用于SQuAD等提取式问答任务(在hidden-states输出上添加线性层来计算跨度起始logits和跨度结束logits)。
Data2VecText 由Alexei Baevski、Wei-Ning Hsu、Qiantong Xu、Arun Babu、Jiatao Gu 和 Michael Auli 在data2vec: A General Framework for Self-supervised Learning in Speech, Vision and Language 中提出。
该模型继承了PreTrainedModel。请查看超级类文档,了解库为所有模型实现的一般方法(如下载或保存、调整输入嵌入、剪枝头部等)。
该模型也是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解所有与通用使用和行为相关的内容。
正向传播
< source >( input_ids: Optional = None attention_mask: Optional = None token_type_ids: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None start_positions: Optional = None end_positions: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
) — 词汇表中的输入序列标记索引。使用 AutoTokenizer 获取索引。有关详细信息,请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。 - attention_mask (形状为
(batch_size, sequence_length)
的torch.FloatTensor
,可选) — 避免对填充标记索引执行注意力操作的掩码。掩码值选择在[0, 1]
范围内:- 1 表示未掩码的 tokens,
- 0 表示掩码的 tokens。
- token_type_ids (形状为
(batch_size, sequence_length)
的torch.LongTensor
,可选) — 段标记索引以指示输入的第一和第二部分。索引选择在[0, 1]
范围内:- 0 代表 句子 A 标记,
- 1 代表 句子 B 标记。
- position_ids ( torch.LongTensor 形状的
(batch_size, sequence_length)
,可选) — 每个输入序列标记在位置嵌入中的索引。选择在范围[0, config.max_position_embeddings - 1]
内。 - head_mask ( torch.FloatTensor 形状的
(num_heads,)
或(num_layers, num_heads)
,可选) — 错过来自 L增强所选头部的自我注意力模块。掩码值选择在[0, 1]
范围内:- 1 表示头部没有被 掩蔽,
- 0 表示头部被 掩蔽。
- inputs_embeds ( torch.FloatTensor 形状的
(batch_size, sequence_length, hidden_size)
,可选) — 可选的,而不是传递input_ids
,您可以直接传递嵌入表示。在您想比模型内部嵌入查找矩阵拥有更多控制权地将input_ids
索引转换为相关向量的情况下很有用。 - — output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。关于返回张量下的更多信息,请见attentions
。 - — output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。关于返回张量下的更多信息,请见hidden_states
。 - — return_dict (
bool
, 可选) — 是否返回ModelOutput而不是一个普通元组。 - start_positions (
torch.LongTensor
形状为(batch_size,)
,可选) — 标记的跨度开始位置的标签,用于计算token分类损失。位置限制在序列长度(sequence_length
)内。序列外的位置不计入损失计算。 - end_positions (
torch.LongTensor
形状为(batch_size,)
,可选) — 标记的跨度结束位置的标签,用于计算token分类损失。位置限制在序列长度(sequence_length
)内。序列外的位置不计入损失计算。
返回值
transformers.modeling_outputs.QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.QuestionAnsweringModelOutput 或 torch.FloatTensor
的元组(如果传递了 return_dict=False
或 config.return_dict=False
),包含根据配置(Data2VecTextConfig)和输入的不同元素。
-
loss (
torch.FloatTensor
形状为(1,)
,可选,当提供labels
时返回) — 总跨度提取损耗是开始和结束位置的自交叉熵之和。 -
start_logits (
torch.FloatTensor
形状为(batch_size, sequence_length)
) — 跨度开始分数(在SoftMax之前)。 -
end_logits (
torch.FloatTensor
形状为(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)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 一个包含torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
Data2VecTextForQuestionAnswering 的 forward 方法重写了 __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]
>>> # 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
Data2VecVisionModel
类 transformers.Data2VecVisionModel
< 源代码 >( config: Data2VecVisionConfig add_pooling_layer: bool = False )
参数
- config (Data2VecVisionConfig) — 模型配置类,包含模型所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。检查from_pretrained()方法来加载模型权重。
一个裸露的Data2VecVision模型变换器,输出原始隐藏状态而不添加任何特定的头部。这个模型是PyTorch的torch.nn.Module子类。将其作为常规PyTorch模块使用,并参考PyTorch文档了解所有关于通用使用和行为的内容。
正向传播
< 源 >( pixel_values: Tensor bool_masked_pos: 可选 = None head_mask: 可选 = None output_attentions: 可选 = None output_hidden_states: 可选 = None interpolate_pos_encoding: bool = False return_dict: 可选 = None ) → transformers.models.data2vec.modeling_data2vec_vision.Data2VecVisionModelOutputWithPooling
或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
的形状为(批量大小, 通道数, 高度, 宽度)
) — 像素值。像素值可以使用 AutoImageProcessor 获取。有关详细信息,请参阅 BeitImageProcessor.call()。 - head_mask (
torch.FloatTensor
of shape(num_heads,)
or(num_layers, num_heads)
, 可选) — 用于禁用自注意力模块中选定的头的掩码。掩码值在[0, 1]
内选择:- 1 表示该头是未掩码,
- 0 表示该头是掩码。
- output_attentions (
bool
, 可选) — 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回的张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。有关详细信息,请参阅返回的张量下的hidden_states
。 - interpolate_pos_encoding (
bool
, 可选, 默认为False
) —— 是否插值预训练的位置编码。 - return_dict (
bool
, 可选) —— 是否以ModelOutput的形式返回,而不是普通的元组。 - bool_masked_pos (
torch.BoolTensor
的形状为(batch_size, num_patches)
, 可选) —— 表示哪些补丁被掩码(1)以及哪些没有被掩码(0)的布尔掩码位置。
返回值
[代码:transformers.models.data2vec.modeling_data2vec_vision.Data2VecVisionModelOutputWithPooling
或tuple(torch.FloatTensor)
]
如果传递了 return_dict=False
或当 config.return_dict=False
时,返回 transformers.models.data2vec.modeling_data2vec_vision.Data2VecVisionModelOutputWithPooling
或一个torch.FloatTensor
的元组(包含各种元素,具体取决于配置(Data2VecVisionConfig)和输入)。
-
last_hidden_state (
torch.FloatTensor
of shape(batch_size, sequence_length, hidden_size)
) — 模型最后层输出的隐藏状态序列。 -
pooler_output (
torch.FloatTensor
的形状为(batch_size, hidden_size)
) —— 如果设置config.use_mean_pooling 为 True,则返回补丁标记的最后一层隐藏状态的均值(不包括[CLS]标记)。如果设置为False,则返回[CLS]标记的最后隐藏状态。 -
hidden_states (
tuple(torch.FloatTensor)
, optional, returned whenoutput_hidden_states=True
is passed or whenconfig.output_hidden_states=True
) — 一个包含torch.FloatTensor
的元组(一个用于嵌入输出,一个用于每层的输出),形状为(batch_size, sequence_length, hidden_size)
。模型的每个层的隐藏状态输出以及初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)
, optional, returned whenoutput_attentions=True
is passed or whenconfig.output_attentions=True
) — 一个包含torch.FloatTensor
的元组(每个层一个),形状为(batch_size, num_heads, sequence_length, sequence_length)
。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
数据2vec视觉模型的 forward 方法会覆盖 __call__
特殊方法。
虽然需要在函数内部定义前向传递的配方,但应该在之后调用 Module
实例而不是此方法,因为前者负责运行预和后处理步骤,而后者默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, Data2VecVisionModel
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/data2vec-vision-base")
>>> model = Data2VecVisionModel.from_pretrained("facebook/data2vec-vision-base")
>>> inputs = image_processor(image, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 197, 768]
Data2VecVisionForImageClassification
类 transformers.Data2VecVisionForImageClassification
< 源 >( config: Data2VecVisionConfig )
参数
- config (Data2VecVisionConfig) — 所有模型参数的模型配置类。使用配置文件初始化时,不会加载与模型相关的权重,只会加载配置。请参考from_pretrained() 方法来加载模型权重。
Data2VecVision 模型变换器,顶部带有一个图像分类头(一个线性层,位于补丁标记的最终隐藏状态的平均值之上),例如用于 ImageNet。
此模型是 PyTorch torch.nn.Module 的子类。使用它作为常规 PyTorch Module,有关通用使用和行为的所有问题,请参阅 PyTorch 文档。
正向传播
< 来源 >( pixel_values: Optional = None head_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None interpolate_pos_encoding: bool = False return_dict: Optional = None ) → transformers.modeling_outputs.ImageClassifierOutput or tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
of shape(batch_size, num_channels, height, width)
) — 像素值。像素值可以通过AutoImageProcessor获取。有关详细信息,请参阅BeitImageProcessor.call()。 - head_mask (
torch.FloatTensor
形状为(num_heads,)
或(num_layers, num_heads)
,可选)—注销self-attention模块所选头部的掩码。选择的掩码值在[0, 1]
范围内:- 1表示头部没有被掩码;
- 0表示头部被掩码。
- output_attentions (
bool
,可选)—是否返回所有注意力层的注意力张量。更多详情请参见返回张量下的attentions
。 - output_hidden_states (
bool
,可选)—是否返回所有层的隐藏状态。更多详情请参见返回张量下的hidden_states
。 - interpolate_pos_encoding (
bool
, 可选, 默认值为False
) — 是否插值预训练的位置编码。 - 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.ImageClassifierOutput 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.ImageClassifierOutput 或是一个包含各种元素的 torch.FloatTensor
的元组(如果传递了 return_dict=False
或当 config.return_dict=False
时),这取决于配置(Data2VecVisionConfig)和输入。
-
loss (
torch.FloatTensor
形状为(1,)
, 可选, 当提供labels
时返回) — 分类(或回归,如果 config.num_labels==1)损失。 -
logits (
torch.FloatTensor
形状为(batch_size, config.num_labels)
) — 分类(或回归,如果 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
时返回) — 形状为(batch_size, num_heads, patch_size, sequence_length)
的torch.FloatTensor
元组(每个层一个),表示每个层的注意力。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
Data2VecVisionForImageClassification 前向方法覆盖了__call__
特殊方法。
虽然需要在函数内部定义前向传递的配方,但应该在之后调用 Module
实例而不是此方法,因为前者负责运行预和后处理步骤,而后者默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, Data2VecVisionForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("facebook/data2vec-vision-base-ft1k")
>>> model = Data2VecVisionForImageClassification.from_pretrained("facebook/data2vec-vision-base-ft1k")
>>> 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])
remote control, remote
Data2VecVisionForSemanticSegmentation
类 transformers.Data2VecVisionForSemanticSegmentation
< 源 >( config: Data2VecVisionConfig )
参数
- config (Data2VecVisionConfig) — 模型参数配置类。用配置文件初始化时不加载模型相关权重,只加载配置。请检查from_pretrained()方法以加载模型权重。
Data2VecVision 模型转换器,顶部带有语义分割头,例如用于ADE20k、CityScapes。
此模型是 PyTorch torch.nn.Module 的子类。使用它作为常规 PyTorch Module,有关通用使用和行为的所有问题,请参阅 PyTorch 文档。
正向传播
< source >( pixel_values: Optional = None head_mask: Optional = None labels: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None interpolate_pos_encoding: bool = False return_dict: Optional = None ) → transformers.modeling_outputs.SemanticSegmenterOutput or tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor
形状(batch_size, num_channels, height, width)
) — 像素值。使用 AutoImageProcessor 可以获取像素值。有关详细信息,请参阅 BeitImageProcessor.call()。 - head_mask (
torch.FloatTensor
形状(num_heads,)
或(num_layers, num_heads)
,可选) — 用于取消选中自注意力模块中选择的头的掩码。掩码值选择在[0, 1]
:- 1 表示该头 未掩码,
- 0 表示该头 已掩码。
- output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息,请参阅返回张量下的attentions
。 - output_hidden_states (
bool
, 可选) — 是否返回所有层的隐藏状态。更多详细信息请参阅返回张量下的hidden_states
。 - interpolate_pos_encoding (
bool
, 可选,默认为False
) — 是否插值预训练的位置编码。 - return_dict (
bool
, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - labels (
torch.LongTensor
of shape(batch_size, height, width)
, optional) — 计算损失的真实语义分割图。索引应在[0, ..., config.num_labels - 1]
内。如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回值
transformers.modeling_outputs.SemanticSegmenterOutput 或 tuple(torch.FloatTensor)
A transformers.modeling_outputs.SemanticSegmenterOutput 或一个torch.FloatTensor
的元组(如果`return_dict=False`被传递或当`config.return_dict=False`),包含根据配置(Data2VecVisionConfig)和输入的不同元素。
-
loss (
torch.FloatTensor
形状为(1,)
, 可选, 当提供labels
时返回) — 分类(或回归,如果 config.num_labels==1)损失。 -
logits (
torch.FloatTensor
of shape(batch_size, config.num_labels, logits_height, logits_width)
) — 对每个像素的分类得分。返回的logits不一定与作为输入传递的
pixel_values
大小相同。这是为了避免进行两次插值并且在将logits调整到原始图像大小时丢失一些质量。您应始终检查logits的形状并根据需要调整大小。 -
hidden_states (
tuple(torch.FloatTensor)
,optional,当传递 `output_hidden_states=True` 或当 `config.output_hidden_states=True` 时返回) — 一个torch.FloatTensor
元组(如果模型有一个嵌入层,则为嵌入层的输出 + 每层的输出)的序列,形状为(batch_size, patch_size, hidden_size)
。模型在每个输出层以及可选的初始嵌入输出的隐藏状态。
-
attentions (
tuple(torch.FloatTensor)
, 可选,当传递output_attentions=True
或配置中设置config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, patch_size, sequence_length)
的torch.FloatTensor
元组(每个层一个),表示每个层的注意力。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
Data2VecVisionForSemanticSegmentation 的前向方法覆盖了 `__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.logits
TFData2VecVisionModel
class transformers.TFData2VecVisionModel
< source >( 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()
支持的任何格式传递你的输入和标签即可!然而,如果你想在 fit()
和 predict()
等Keras方法之外使用第二种格式,例如在创建自己的层或使用Keras Functional
API创建的模型时,有三种可能的方式可以收集所有位于第一个位置参数的输入Tensors。
- 仅包含
pixel_values
的单个Tensor:model(pixel_values)
- 含有一个或多个输入Tensors的列表,其顺序与文档字符串中给出的顺序相同:
model([pixel_values, attention_mask])
或model([pixel_values, attention_mask, token_type_ids])
- 包含一个或多个输入Tensors的字典,与文档字符串中给出的输入名称相关联:
model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})
注意,当通过 子类化 创建模型和层时,您不必担心这些问题,因为您可以像传递给任何其他Python函数的输入一样传递输入!
调用
< source >( 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
or 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 (
np.ndarray
或tf.Tensor
形状为(num_heads,)
或(num_layers, num_heads)
,可选) — 用于取消选中自注意力模块的选定的头部的掩码。掩码值在[0, 1]
中选择:- 1 表示头部 未被掩码,
- 0 表示头部被 掩码。
- output_attentions (
bool
,可选) — 是否返回所有注意力层的注意力张量。更多信息请见返回张量下的attentions
。 - output_hidden_states (
bool
, optional) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回的张量下的hidden_states
。 - return_dict (
bool
, optional) — 是否返回 ModelOutput 而不是普通元组。此参数可用于延迟模式,在图模式下,该值始终设置为 True。 - training (
bool
, optional, 默认为 `False`) — 是否使用模型进行训练模式(某些模块,如dropout模块,在训练和评估模式下表现不同)。
返回值
transformers.models.data2vec.modeling_tf_data2vec_vision.TFData2VecVisionModelOutputWithPooling
或 tuple(tf.Tensor)
A transformers.models.data2vec.modeling_tf_data2vec_vision.TFData2VecVisionModelOutputWithPooling
或一个 tf.Tensor
的元组(如果传递了 return_dict=False
或当 config.return_dict=False
),根据配置(Data2VecVisionConfig)和输入来包含各种元素。
-
last_hidden_state (
tf.Tensor
of shape(batch_size, sequence_length, hidden_size)
) — 核心层最后输出的序列隐藏状态。 -
pooler_output (
tf.Tensor
of shape(batch_size, hidden_size)
) — 当 config.use_mean_pooling 设置为 True 时,为最后层补丁标记隐藏状态的加权平均(排除了 [CLS] 标记)。如果设置为 False,则返回 [CLS] 标记的最后隐藏状态。 -
hidden_states (
tuple(tf.Tensor)
,optional,在output_hidden_states=True
传递或当config.output_hidden_states=True
时返回) — 由形状为(batch_size, sequence_length, hidden_size)
的tf.Tensor
组成的元组(一个用于嵌入输出,一个用于每一层的输出)。模型的每个层的隐藏状态输出以及初始嵌入输出。
-
attentions (
tuple(tf.Tensor)
,optional,在output_attentions=True
传递或当config.output_attentions=True
时返回) — 原子形状为(batch_size, num_heads, sequence_length, sequence_length)
的tf.Tensor
的元组(一个用于每层)。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
TFData2VecVisionModel 前向方法,覆盖了 __call__
特殊方法。
虽然需要在函数内部定义前向传递的配方,但应该在之后调用 Module
实例而不是此方法,因为前者负责运行预和后处理步骤,而后者默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, TFData2VecVisionModel
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> 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
class 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()
支持的任何格式传递你的输入和标签即可!然而,如果你想在 fit()
和 predict()
等Keras方法之外使用第二种格式,例如在创建自己的层或使用Keras Functional
API创建的模型时,有三种可能的方式可以收集所有位于第一个位置参数的输入Tensors。
- 仅包含
pixel_values
的单个Tensor:model(pixel_values)
- 含有一个或多个输入Tensors的列表,其顺序与文档字符串中给出的顺序相同:
model([pixel_values, attention_mask])
或model([pixel_values, attention_mask, token_type_ids])
- 包含一个或多个输入Tensors的字典,与文档字符串中给出的输入名称相关联:
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 or tuple(tf.Tensor)
参数
- pixel_values (
np.ndarray
,tf.Tensor
,List[tf.Tensor]
Dict[str, tf.Tensor]
orDict[str, np.ndarray]
and each example must have the shape(batch_size, num_channels, height, width)
) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 BeitImageProcessor.call()。 - head_mask (
np.ndarray
或tf.Tensor
的形状为(num_heads,)
或(num_layers, num_heads)
,可选)— 用于取消选中头的自注意力模块的掩码。掩码值在[0,1]
中选择:- 1 表示该头未被掩码,
- 0 表示该头被掩码。
- output_attentions (
bool
,可选)— 是否返回所有注意力层的注意力张量。有关详细信息,请参阅返回的张量中的attentions
。 - output_hidden_states (
bool
,可选)— 是否返回所有层的隐藏状态。有关详细信息,请参阅返回的张量中的hidden_states
。 - return_dict (
bool
, optional) — 是否返回ModelOutput而不是一个普通的元组。此参数可以在急切模式中使用,在图形模式中,值始终设置为True。 - training (
bool
, optional, defaults to `False“) — 模型是否用于训练模式(某些模块,如dropout模块,在训练和评估之间具有不同的行为)。 - labels (
tf.Tensor
或np.ndarray
的形状为(batch_size,)
,optional) — 用于计算图像分类/回归损失的标签。索引应该在[0, ..., config.num_labels - 1]
范围内。如果config.num_labels == 1
,则计算回归损失(均方损失),如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回值
transformers.modeling_tf_outputs.TFSequenceClassifierOutput或tuple(tf.Tensor)
A transformers.modeling_tf_outputs.TFSequenceClassifierOutput或一个tf.Tensor
的元组(如果传递或config.return_dict=False
时),它包含不同的元素,这取决于配置(Data2VecVisionConfig)和输入。
-
损失 (
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)
,optional,在output_hidden_states=True
传递或当config.output_hidden_states=True
时返回) — 由形状为(batch_size, sequence_length, hidden_size)
的tf.Tensor
组成的元组(一个用于嵌入输出,一个用于每一层的输出)。模型的每个层的隐藏状态输出以及初始嵌入输出。
-
attentions (
tuple(tf.Tensor)
,optional,在output_attentions=True
传递或当config.output_attentions=True
时返回) — 原子形状为(batch_size, num_heads, sequence_length, sequence_length)
的tf.Tensor
的元组(一个用于每层)。注意力权重在注意力softmax之后,用于在自注意力头中计算加权平均。
TFData2VecVisionForImageClassification 的 forward 方法,覆盖了 __call__
特殊方法。
虽然需要在函数内部定义前向传递的配方,但应该在之后调用 Module
实例而不是此方法,因为前者负责运行预和后处理步骤,而后者默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, TFData2VecVisionForImageClassification
>>> import tensorflow as tf
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> 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, remote
TFData2VecVisionForSemanticSegmentation
类 transformers.TFData2VecVisionForSemanticSegmentation
< 来源 >( 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()
支持的任何格式传递你的输入和标签即可!然而,如果你想在 fit()
和 predict()
等Keras方法之外使用第二种格式,例如在创建自己的层或使用Keras Functional
API创建的模型时,有三种可能的方式可以收集所有位于第一个位置参数的输入Tensors。
- 仅包含
pixel_values
的单个Tensor:model(pixel_values)
- 含有一个或多个输入Tensors的列表,其顺序与文档字符串中给出的顺序相同:
model([pixel_values, attention_mask])
或model([pixel_values, attention_mask, token_type_ids])
- 包含一个或多个输入Tensors的字典,与文档字符串中给出的输入名称相关联:
model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})
注意,当通过 子类化 创建模型和层时,您不必担心这些问题,因为您可以像传递给任何其他Python函数的输入一样传递输入!
调用
< 来源 >( 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
or tuple(tf.Tensor)
参数
- pixel_values (
np.ndarray
,tf.Tensor
,List[tf.Tensor]
Dict[str, tf.Tensor]
orDict[str, np.ndarray]
and each example must have the shape(batch_size, num_channels, height, width)
) — 像素值。可以使用AutoImageProcessor获取像素值。详细信息请参阅BeitImageProcessor.call()。 - head_mask (numpy数组或形状为
(num_heads,)
或(num_layers, num_heads)
的 TensorFlow 张量,可选)— 用于取消选择自注意力模块中选择的头部的掩码。掩码值选择在[0, 1]
:- 1 表示头部未被 掩码;
- 0 表示头部被 掩码。
- output_attentions (布尔值,可选)— 是否返回所有注意力层的注意力张量。有关更多信息,请参阅返回张量下的
attentions
。 - output_hidden_states (布尔值,可选)— 是否返回所有层的隐藏状态。有关更多信息,请参阅返回张量下的
hidden_states
。 - return_dict (
bool
, 可选) — 是否返回ModelOutput 而不是普通元组。此参数可以在 eager 模式下使用,在 graph 模式下该值将始终设置为 True。 - training (
bool
, 可选,默认为 `False`) — 是否将模型用于训练模式(一些模块,如 dropout 模块,在训练和评估之间有不同的行为)。 - — 用于计算损失的真实语义分割图(
tf.Tensor
形状为(batch_size, height, width)
,可选)。索引应在[0, ...,config.num_labels - 1]
。如果config.num_labels > 1
,则计算分类损失(交叉熵)。
返回值
transformers.modeling_tf_outputs.TFSemanticSegmenterOutput
或 (tf.Tensor)
元组
transformers.modeling_tf_outputs.TFSemanticSegmenterOutput
或 tf.Tensor
元组(如果传递 return_dict=False
或当 config.return_dict=False
时),包含 various elements 依赖于配置(Data2VecVisionConfig)和输入。
-
loss (
tf.Tensor
形状为(1,)
,可选,当提供labels
时返回) — 分类(或当config.num_labels==1
时的回归)损失。 -
logits (
tf.Tensor
形状为(batch_size, config.num_labels, logits_height, logits_width)
) — 每个像素的分类分数。返回的logits不一定与作为输入传递的
pixel_values
大小相同。这是为了避免进行两次插值并且在将logits调整到原始图像大小时丢失一些质量。您应始终检查logits的形状并根据需要调整大小。 -
hidden_states (
tuple(tf.Tensor)
, 可选,当传递参数output_hidden_states=True
或当config.output_hidden_states=True
时返回) — 形状为(batch_size, patch_size, hidden_size)
的tf.Tensor
元组的元组(如果模型有嵌入层,则为嵌入层的输出 + 每层的输出)。模型在每个输出层以及可选的初始嵌入输出的隐藏状态。
-
attentions (
tuple(tf.Tensor)
, 可选,当传递参数output_attentions=True
或当config.output_attentions=True
时返回) — 形状为(batch_size, num_heads, patch_size, sequence_length)
的tf.Tensor
元组的元组(每个层的对应内容)。注意力权重在注意力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